Jobs

Return a list of all jobs.

Select

Note: Because of Xero WorkflowMax API restrictions the Job ID filters will not work properly while using custom Job numbers which have punctuation in them. This is a known issue that Xero refuses to fix. Please change the Job number so there is no punctuation and try again. In case you are using custom Job numbers with punctuation in them you may encounter 404 Not Found error in Jobs and JobCosts tables.

The driver will use the Xero WorkflowMax API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the driver. Specifically, the following are processed server-side:

Id supports the '=' operator.
AssignedStaffUUID supports the '=' operator.
ClientUUID supports the '=' operator.
CreatedDate supports the '<=,<,=,>,>=' operators.

All filterable columns allow multiple values to be specified by using the IN operator. Response time from the server can be improved by identifying only the rows you want to retrieve.

SELECT * FROM Jobs WHERE CreatedDate>='2020-12-12' AND CreatedDate<='2020-12-12'
SELECT * FROM Jobs WHERE CreatedDate='2020-12-12'
SELECT * FROM Jobs WHERE CreatedDate>='2020-12-12'
SELECT * FROM Jobs WHERE ID='J000001'
SELECT * FROM Jobs WHERE AssignedStaffUUID='9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'
SELECT * FROM Jobs WHERE ClientUUID='9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'
SELECT * FROM Jobs WHERE ID IN ('23423', '34534')
SELECT * FROM Jobs WHERE AssignedStaffUUID IN ('9d382fcf-7013-4d97-8dd8-c08e8b26a8f6', '9d382fcf-7013-4d97-8dd8-c08e8b26a4d2')
SELECT * FROM Jobs WHERE ClientUUID IN ('9d382fcf-7013-4d97-8dd8-c08e8b26a0b2', '9d382fcf-7013-4d97-8dd8-c08e8b26a6i1')

Notes:
-When executing a simple SELECT * query the driver will retrieve only your current Invoices.
-When specifying CreatedDate the driver will retrieve the current and archived Jobs.

Insert

Name, ClientUUID, StartDate, DueDate are required to insert. The following query creates a new Job:

INSERT INTO Jobs (Name, ClientUUID, StartDate, DueDate) VALUES ('Job Name', '9d382fcf-7013-4d97-8dd8-c08e8b26a0b2', '2019-07-17T00:00:00', '2019-07-17T00:00:00')

Update

You can update by specifying the Job ID:

UPDATE Jobs SET StartDate='2007-07-16T00:00:00' WHERE Id='J000003'

Delete

Delete a Job by specifying the Job ID:

DELETE FROM Jobs WHERE ID='J000003'

Columns


Name	Type	ReadOnly	Description
ID [KEY]	String	False	Job identifier.
Name	String	False	The name of the job.
Description	String	False	The description related to the job.
State	String	True	The state of the job.
ClientOrderNumber	String	False	Order number assoicated with this job.
StartDate	Datetime	False	The date when the job has started.
DueDate	Datetime	False	The date when the job should be completed.
CompletedDate	Datetime	False	The date when the job has been completed.
ClientUUID	String	False	The client identifier related to the job.
ClientName	String	False	The client name related to the job.
ContactUUID	String	False	The client identifier related to the job.
ContactName	String	False	The client name related to the job.
ManagerUUID	String	False	The manager identifier related to the job.
ManagerName	String	False	The manager name related to the job.
PartnerUUID	String	False	The partner identifier related to the job.
PartnerName	String	False	The partner name related to the job.
AssignedStaff	String	True	List of staff members assigned to the job in xml format.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
TemplateUUID	String	Used while inserting a job to determine its initial template.
CategoryUUID	String	Used while inserting a job to determine its initial category.
AssignedStaffUUID	String	Used to filter jobs based on the staff member assigned.
CreatedDate	Date	Used to filter jobs from their date of creation.