Action

Description

Required scopes

List Contacts

Retrieve a paged collection of contacts

Get Contact

Retrieve the details of a single contact

Create Contact

Create a new contact

Update Contact

Update the details of a single contact

List Contact Groups

Retrieve a paged collection of contact groups

Get Contact Group

Retrieve the details of a single contact group

Create Contact Group

Create a new contact group

Update Contact Group

Update an existing contact group

List Department Codes

Retrieve a paged collection of department codes

Get Department Code

Retrieve the details of a single department code

List Invoices

Retrieve a paged collection of invoices

Get Invoice

Retrieve the details of a single invoice

Create Invoice

Create a new invoice

Update Invoice

Update an existing invoice

Cancel Invoice

Mark an invoice as cancelled

Create Invoice Document

Create a PDF document for an invoice

List Invoice Line Items

Retrieve a paged list of line items for an invoice

Get Invoice Line Item

Retrieve the details of a single invoice line item

Create Invoice Line Item

Create a new invoice line item

Update Invoice Line Item

Update an existing invoice line item

Delete Invoice Line Item

Delete a line item from an invoice

Mark Invoice Paid

Mark an invoice as paid

Mark Invoice Sent

Mark an invoice as sent

List Jobs

Retrieve a paged collection of jobs. At least one of the filters \[Id, Reference] must be set, or at least one of the dat...

Get Job

Retrieve the details of a single job

Create Job

Create a new job

Update Job

Update an existing job

Cancel Job

Cancel a specific job. The job cannot be cancelled if it has already been started, suspended or completed.

List Job Constraints

Retrieve a paged collection of a job's constraints

Create Job Constraint

Create a new job constraint

Delete Job Constraint

Delete a job constraint

Set Job Result

Set a job's result

List Job Stocks

Retrieve a paged collection of job stocks

Get Job Stock

Retrieve the details of a single job stock

Create Job Stock

Create a new job stock

Delete Job Stock

Permanently delete a job stock

List Job Worksheets

Retrieve a paged collection of worksheets for a given job

Get Job Worksheet

Retrieve the details of a single job worksheet

List Job Groups

Retrieve a paged collection of job groups

Get Job Group

Retrieve the details of a single job group

Get Job Group Status History

Get the status history of a job group showing all status changes over time

Create Job Group

Create a new job group

Update Job Group

Update an existing job group

Complete Job Group

Mark a job group as complete

Complete Job Group Financially

Mark a job group as financially complete

List Job Types

Retrieve a paged collection of job types

Get Job Type

Retrieve the details of a single job type

List Nominal Codes

Retrieve a paged collection of nominal codes

Get Nominal Code

Retrieve the details of a single nominal code

List Notes

Retrieve a paged collection of notes

Get Note

Retrieve the details of a single note

Create Note

Create a new note

Update Note

Update an existing note

Update Note Progress

Update a note's progress percentage

Get Note Progress History

Get the history of progress updates for a note

List Note Types

Retrieve a paged collection of note types

Get Note Type

Retrieve the details of a single note type

List Persons

Retrieve a paged collection of persons

Get Person

Retrieve the details of a single person

Create Person

Create a new person

Update Person

Update an existing person

Set Person Data Consent

Set a person's data consent status

Get Person Consent History

Get the complete consent history for a person showing all consent changes over time

List Resources

Retrieve a paged collection of resources (workforce/employees)

Get Resource

Retrieve the details of a single resource

Create Resource

Create a new resource (workforce/employee)

Update Resource

Update an existing resource

List Resource Groups

Retrieve a paged collection of resource groups for organizing workforce teams

Get Resource Group

Retrieve the details of a single resource group

List Product Categories

Retrieve a paged collection of product categories

Get Product Category

Retrieve the details of a single product category

List Stock Details

Retrieve a paged collection of stock details

Get Stock Details

Retrieve the details of a single stock details entity

Create Stock Details

Create a new stock details entity

Update Stock Details

Update an existing stock details entity

List Stock Suppliers

Retrieve a paged collection of stock suppliers

Get Stock Supplier

Retrieve a stock supplier by its ID

Create Stock Supplier

Create a new stock supplier

Update Stock Supplier

Update the details of a stock supplier

List Stock Items

Retrieve a paged collection of stock items

Get Stock Item

Retrieve a single stock item

Create Stock Item

Create a new stock item

Update Stock Item

Update an existing stock item

List Stock Movements

Retrieve a paged collection of stock movements

List Users

Retrieve a paged collection of users

Get User

Retrieve the details of a single user

Create User

Create a new user

Update User

Update an existing user

List Vehicles

Retrieve a paged collection of vehicles

Get Vehicle

Retrieve the details of a single vehicle

Create Vehicle

Create a new vehicle

Update Vehicle

Update an existing vehicle

List Worksheets

Retrieve a paged collection of worksheets

Get Worksheet

Retrieve the details of a single worksheet

List Worksheet Questions

Retrieve the worksheet questions for a given worksheet

List Worksheet Answers

Retrieve a paged collection of worksheet answers

List Worksheet Groups

Retrieve a paged collection of worksheet groups

Get Worksheet Group

Retrieve the details of a single worksheet group