Xero Tasks
A Xero task is a single synchronisation job, such as posting an invoice or recording a payment in Xero. Tasks are created by the Xero integration as you bill and take payments, so the API exposes them for monitoring the sync. See Xero Tasks for the full picture.
Methods
Section titled “Methods”Retrieve Single Xero Task
Section titled “Retrieve Single Xero Task”/backend/api/v1/xeroTasks/ID - fetch the Xero task with the specified ID.
List Xero Tasks
Section titled “List Xero Tasks”/backend/api/v1/xeroTasks/ - list all Xero tasks.
Additional Query Parameters
Section titled “Additional Query Parameters”| Parameter | Type | Required | Description |
|---|---|---|---|
idAfter | integer | No | Only include tasks with a higher ID |
createdSince | datetime | No | Only include tasks created since the given time |
updatedSince | datetime | No | Only include tasks updated since the given time |
Fields
Section titled “Fields”| Field | Name | Type | Description |
|---|---|---|---|
| xeroTaskType | Xero Task Type | Preset Value | The type of Xero integration task to perform |
| status | Xero Task Status | Preset Value | Current status of this Xero task |
| customerID | Customer | Preset Value | The customer this task is associated with (if any) |
| dealerCode | Dealer Code | Preset Value | The dealer this task applies to |
| addedDate | Added Date | Date | The date this task was added to the queue |
| endedDate | Completed Date | Date | The date this task was completed |
| id | Xero Task ID | Text | The unique identifier for this Xero task |
| revisionNumber | Revision | Text | Internal version tracking number for this Xero task |
| parameters | Parameters | Text | JSON parameters for this Xero task |