API docs by Redocly

Acrual API Documentation (v1.0)

Developer Support: info@acrual.com URL: https://acrual.com/contact Terms of Service

Welcome to the Acrual API documentation 👋

The Acrual API is the backbone of Acrual, giving access to most data and allowing most functions to be performed programmatically.

If you are interested in using the Acrual API, please reach out to us using the contact details above.

Clients

Return a single client by id

Authorizations:
Bearer
path Parameters
id
required
integer or string <int32> ^-?(?:0|[1-9]\d*)$

Responses

Response Schema: application/json
id
integer or string <int32> ^-?(?:0|[1-9]\d*)$
name
required
string
address
null or string
suburb
null or string
postcode
null or string
state
null or string
country
null or string
company_name
null or string
phone
null or string
alternate_phone1
null or string
alternate_phone2
null or string
email
null or string
abn
null or string
acn
null or string
Array of objects or null (ClientContactOverview)
null or UserOverview (object)
null or object
created
string <date-time>
modified
string <date-time>

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "address": null,
  • "suburb": null,
  • "postcode": null,
  • "state": null,
  • "country": null,
  • "company_name": null,
  • "phone": null,
  • "alternate_phone1": null,
  • "alternate_phone2": null,
  • "email": null,
  • "abn": null,
  • "acn": null,
  • "contacts": null,
  • "user": { },
  • "external_ids": null,
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z"
}

Returns a list of all clients

Authorizations:
Bearer
query Parameters
Filters
string
Sorts
string
Page
integer or string <int32> ^-?(?:0|[1-9]\d*)$
PageSize
integer or string <int32> ^-?(?:0|[1-9]\d*)$

Responses

Response Schema: application/json
Array
id
integer or string <int32> ^-?(?:0|[1-9]\d*)$
name
required
string
address
null or string
suburb
null or string
postcode
null or string
state
null or string
country
null or string
company_name
null or string
phone
null or string
alternate_phone1
null or string
alternate_phone2
null or string
email
null or string
abn
null or string
acn
null or string
Array of objects or null (ClientContactOverview)
null or UserOverview (object)
null or object
created
string <date-time>
modified
string <date-time>

Response samples

Content type
application/json
[
  • {
    }
]

Employees

Returns a list of all employees

Authorizations:
Bearer
query Parameters
Filters
string
Sorts
string
Page
integer or string <int32> ^-?(?:0|[1-9]\d*)$
PageSize
integer or string <int32> ^-?(?:0|[1-9]\d*)$

Responses

Response Schema: application/json
Array
id
integer or string <int32> ^-?(?:0|[1-9]\d*)$
name
required
string
address
null or string
suburb
null or string
postcode
null or string
state
null or string
country
null or string
phone
null or string
alternate_phone1
null or string
alternate_phone2
null or string
email
null or string
tfn
null or string
abn
null or string
reference
null or string
null or UserOverview (object)
null or object
created
string <date-time>
modified
string <date-time>

Response samples

Content type
application/json
[
  • {
    }
]

Hooks

Create a hook subscription

Authorizations:
Bearer
Request Body schema: application/json
required
event_name
required
null or string
target_url
required
null or string

Responses

Response Schema: application/json
id
string <uuid>
event_name
null or string
target_url
null or string
created
string <date-time>
modified
string <date-time>

Request samples

Content type
application/json
{
  • "event_name": null,
  • "target_url": null
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "event_name": null,
  • "target_url": null,
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z"
}

Returns a list of all hook subscriptions

Authorizations:
Bearer

Responses

Response Schema: application/json
Array
id
string <uuid>
event_name
null or string
target_url
null or string
created
string <date-time>
modified
string <date-time>

Response samples

Content type
application/json
[
  • {
    }
]

Delete a hook subscription

Authorizations:
Bearer
path Parameters
id
required
string

Responses

Return a single hook subscription by id

Authorizations:
Bearer
path Parameters
id
required
string

Responses

Response Schema: application/json
id
string <uuid>
event_name
null or string
target_url
null or string
created
string <date-time>
modified
string <date-time>

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "event_name": null,
  • "target_url": null,
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z"
}

Integrations

Complete the connection process to the specified integration

Authorizations:
Bearer
path Parameters
integrationKey
required
string
Request Body schema: application/json
required
required
null or object

Responses

Request samples

Content type
application/json
{
  • "parameters": null
}

Get data from the specified integration

Authorizations:
Bearer
path Parameters
integrationKey
required
string
dataKey
required
string

Responses

Response Schema: application/json
Array
key
required
string
value
required
string
null or object

Response samples

Content type
application/json
[
  • {
    }
]

Initiate the connection process to the specified integration

Authorizations:
Bearer
path Parameters
integrationKey
required
string
Request Body schema: application/json
One of
null

Responses

Response Schema: application/json
connection_type
any (ProviderConnectionType)
Value: "REDIRECT"
redirect_url
null or string

Request samples

Content type
application/json
Example
null

Response samples

Content type
application/json
{
  • "connection_type": "REDIRECT",
  • "redirect_url": null
}

Unlink from the specified integration

Authorizations:
Bearer
path Parameters
integrationKey
required
string

Responses

Invoices

Create an invoice

Authorizations:
Bearer
Request Body schema: application/json
required
job_id
required
null or integer or string <int32> ^-?(?:0|[1-9]\d*)$
user_id
required
null or integer or string <int32> ^-?(?:0|[1-9]\d*)$
required
null or InvoiceTypeKey (any)
required
null or InvoiceStatusKey (any)
issued
required
null or string <date-time>
payment_due
required
null or string <date-time>
payment_terms
required
null or string
hidden_quote_section_ids
required
Array of integers or strings or null <int32> [ items <int32 >^-?(?:0|[1-9]\d*)$ ]
comments
required
null or string
required
Array of objects or null (CreateInvoiceRequestItem)

Responses

Response Schema: application/json
id
integer or string <int32> ^-?(?:0|[1-9]\d*)$
gst_exempt
null or boolean
cost_gross
number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
cost
number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
gst
number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
total
number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
description
null or string
issued
null or string <date-time>
payment_due
null or string <date-time>
payment_terms
null or string
retention_value
null or number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
comments
null or string
type
any (InvoiceTypeKey)
Enum: "GENERAL" "CLAIM"
status
any (InvoiceStatusKey)
Enum: "DRAFT" "SUBMITTED" "APPROVED" "PARTIALLY_PAID" "FULLY_PAID" "VOIDED"
Array of objects or null (InvoiceItem)
hidden_quote_section_ids
Array of integers or strings or null <int32> [ items <int32 >^-?(?:0|[1-9]\d*)$ ]
required
object (JobOverview)
required
object (ClientOverview)
number
required
string
sequence_number
required
integer or string <int32> ^-?(?:0|[1-9]\d*)$
claim_number
null or string
sequence_claim_number
null or integer or string <int32> ^-?(?:0|[1-9]\d*)$
null or UserOverview (object)
null or object
created
string <date-time>
modified
string <date-time>

Request samples

Content type
application/json
{
  • "job_id": null,
  • "user_id": null,
  • "type": { },
  • "status": { },
  • "issued": null,
  • "payment_due": null,
  • "payment_terms": null,
  • "hidden_quote_section_ids": null,
  • "comments": null,
  • "items": null
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "gst_exempt": null,
  • "cost_gross": 0,
  • "cost": 0,
  • "gst": 0,
  • "total": 0,
  • "description": null,
  • "issued": null,
  • "payment_due": null,
  • "payment_terms": null,
  • "retention_value": null,
  • "comments": null,
  • "type": "GENERAL",
  • "status": "DRAFT",
  • "items": null,
  • "hidden_quote_section_ids": null,
  • "job": {
    },
  • "client": {
    },
  • "number": "string",
  • "sequence_number": 0,
  • "claim_number": null,
  • "sequence_claim_number": null,
  • "user": { },
  • "external_ids": null,
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z"
}

Returns a list of all invoices

Authorizations:
Bearer
query Parameters
Filters
string
Sorts
string
Page
integer or string <int32> ^-?(?:0|[1-9]\d*)$
PageSize
integer or string <int32> ^-?(?:0|[1-9]\d*)$

Responses

Response Schema: application/json
Array
id
integer or string <int32> ^-?(?:0|[1-9]\d*)$
gst_exempt
null or boolean
cost_gross
number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
cost
number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
gst
number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
total
number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
description
null or string
issued
null or string <date-time>
payment_due
null or string <date-time>
payment_terms
null or string
retention_value
null or number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
comments
null or string
type
any (InvoiceTypeKey)
Enum: "GENERAL" "CLAIM"
status
any (InvoiceStatusKey)
Enum: "DRAFT" "SUBMITTED" "APPROVED" "PARTIALLY_PAID" "FULLY_PAID" "VOIDED"
Array of objects or null (InvoiceItem)
hidden_quote_section_ids
Array of integers or strings or null <int32> [ items <int32 >^-?(?:0|[1-9]\d*)$ ]
required
object (JobOverview)
required
object (ClientOverview)
number
required
string
sequence_number
required
integer or string <int32> ^-?(?:0|[1-9]\d*)$
claim_number
null or string
sequence_claim_number
null or integer or string <int32> ^-?(?:0|[1-9]\d*)$
null or UserOverview (object)
null or object
created
string <date-time>
modified
string <date-time>

Response samples

Content type
application/json
[
  • {
    }
]

Return a single invoice by id

Authorizations:
Bearer
path Parameters
id
required
integer or string <int32> ^-?(?:0|[1-9]\d*)$

Responses

Response Schema: application/json
id
integer or string <int32> ^-?(?:0|[1-9]\d*)$
gst_exempt
null or boolean
cost_gross
number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
cost
number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
gst
number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
total
number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
description
null or string
issued
null or string <date-time>
payment_due
null or string <date-time>
payment_terms
null or string
retention_value
null or number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
comments
null or string
type
any (InvoiceTypeKey)
Enum: "GENERAL" "CLAIM"
status
any (InvoiceStatusKey)
Enum: "DRAFT" "SUBMITTED" "APPROVED" "PARTIALLY_PAID" "FULLY_PAID" "VOIDED"
Array of objects or null (InvoiceItem)
hidden_quote_section_ids
Array of integers or strings or null <int32> [ items <int32 >^-?(?:0|[1-9]\d*)$ ]
required
object (JobOverview)
required
object (ClientOverview)
number
required
string
sequence_number
required
integer or string <int32> ^-?(?:0|[1-9]\d*)$
claim_number
null or string
sequence_claim_number
null or integer or string <int32> ^-?(?:0|[1-9]\d*)$
null or UserOverview (object)
null or object
created
string <date-time>
modified
string <date-time>

Response samples

Content type
application/json
{
  • "id": 0,
  • "gst_exempt": null,
  • "cost_gross": 0,
  • "cost": 0,
  • "gst": 0,
  • "total": 0,
  • "description": null,
  • "issued": null,
  • "payment_due": null,
  • "payment_terms": null,
  • "retention_value": null,
  • "comments": null,
  • "type": "GENERAL",
  • "status": "DRAFT",
  • "items": null,
  • "hidden_quote_section_ids": null,
  • "job": {
    },
  • "client": {
    },
  • "number": "string",
  • "sequence_number": 0,
  • "claim_number": null,
  • "sequence_claim_number": null,
  • "user": { },
  • "external_ids": null,
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z"
}

Update an invoice

Authorizations:
Bearer
path Parameters
id
required
integer or string <int32> ^-?(?:0|[1-9]\d*)$
Request Body schema: application/json
required
job_id
required
null or integer or string <int32> ^-?(?:0|[1-9]\d*)$
user_id
required
null or integer or string <int32> ^-?(?:0|[1-9]\d*)$
required
null or InvoiceTypeKey (any)
required
null or InvoiceStatusKey (any)
issued
required
null or string <date-time>
payment_due
required
null or string <date-time>
payment_terms
required
null or string
hidden_quote_section_ids
required
Array of integers or strings or null <int32> [ items <int32 >^-?(?:0|[1-9]\d*)$ ]
comments
required
null or string
required
Array of objects or null (UpdateInvoiceRequestItem)

Responses

Response Schema: application/json
id
integer or string <int32> ^-?(?:0|[1-9]\d*)$
gst_exempt
null or boolean
cost_gross
number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
cost
number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
gst
number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
total
number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
description
null or string
issued
null or string <date-time>
payment_due
null or string <date-time>
payment_terms
null or string
retention_value
null or number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
comments
null or string
type
any (InvoiceTypeKey)
Enum: "GENERAL" "CLAIM"
status
any (InvoiceStatusKey)
Enum: "DRAFT" "SUBMITTED" "APPROVED" "PARTIALLY_PAID" "FULLY_PAID" "VOIDED"
Array of objects or null (InvoiceItem)
hidden_quote_section_ids
Array of integers or strings or null <int32> [ items <int32 >^-?(?:0|[1-9]\d*)$ ]
required
object (JobOverview)
required
object (ClientOverview)
number
required
string
sequence_number
required
integer or string <int32> ^-?(?:0|[1-9]\d*)$
claim_number
null or string
sequence_claim_number
null or integer or string <int32> ^-?(?:0|[1-9]\d*)$
null or UserOverview (object)
null or object
created
string <date-time>
modified
string <date-time>

Request samples

Content type
application/json
{
  • "job_id": null,
  • "user_id": null,
  • "type": { },
  • "status": { },
  • "issued": null,
  • "payment_due": null,
  • "payment_terms": null,
  • "hidden_quote_section_ids": null,
  • "comments": null,
  • "items": null
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "gst_exempt": null,
  • "cost_gross": 0,
  • "cost": 0,
  • "gst": 0,
  • "total": 0,
  • "description": null,
  • "issued": null,
  • "payment_due": null,
  • "payment_terms": null,
  • "retention_value": null,
  • "comments": null,
  • "type": "GENERAL",
  • "status": "DRAFT",
  • "items": null,
  • "hidden_quote_section_ids": null,
  • "job": {
    },
  • "client": {
    },
  • "number": "string",
  • "sequence_number": 0,
  • "claim_number": null,
  • "sequence_claim_number": null,
  • "user": { },
  • "external_ids": null,
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z"
}

Jobs

Create a folder for the specified job

Authorizations:
Bearer
path Parameters
id
required
integer or string <int32> ^-?(?:0|[1-9]\d*)$
query Parameters
path
required
string

Responses

Delete a file or folder for the specified job

Authorizations:
Bearer
path Parameters
id
required
integer or string <int32> ^-?(?:0|[1-9]\d*)$
query Parameters
path
required
string

Responses

Return the files for the specified job

Authorizations:
Bearer
path Parameters
id
required
integer or string <int32> ^-?(?:0|[1-9]\d*)$
query Parameters
path
required
string
Filters
string
Sorts
string
Page
integer or string <int32> ^-?(?:0|[1-9]\d*)$
PageSize
integer or string <int32> ^-?(?:0|[1-9]\d*)$

Responses

Response Schema: application/json
Array
id
required
string
name
required
string
type
required
any (FileItemTypeKey)
Enum: "FOLDER" "FILE"
size
null or integer or string <int64> ^-?(?:0|[1-9]\d*)$
modified
null or string <date-time>

Response samples

Content type
application/json
[
  • {
    }
]

Return a single job by id

Authorizations:
Bearer
path Parameters
id
required
integer or string <int32> ^-?(?:0|[1-9]\d*)$

Responses

Response Schema: application/json
id
integer or string <int32> ^-?(?:0|[1-9]\d*)$
name
required
string
required
object (ClientOverview)
status
required
any (JobStatusKey)
Enum: "NEW" "CANCELLED" "IN_PROGRESS" "AWAITING_COMPLETION" "COMPLETE"
address
null or string
suburb
null or string
postcode
null or string
state
null or string
country
null or string
commissioned
string <date-time>
start
null or string <date-time>
due
null or string <date-time>
null or JobFinancial (object)
null or QuoteOverview (object)
number
required
string
null or UserOverview (object)
security_type
required
any (JobSecurityTypeKey)
Enum: "NONE" "RETENTION" "GUARANTEE"
retention_initial_withholding_rate
number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
retention_total_withholding_rate
number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
created
string <date-time>
modified
string <date-time>

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "client": {
    },
  • "status": "NEW",
  • "address": null,
  • "suburb": null,
  • "postcode": null,
  • "state": null,
  • "country": null,
  • "commissioned": "2019-08-24T14:15:22Z",
  • "start": null,
  • "due": null,
  • "financial": { },
  • "quote": { },
  • "number": "string",
  • "user": { },
  • "security_type": "NONE",
  • "retention_initial_withholding_rate": 0,
  • "retention_total_withholding_rate": 0,
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z"
}

Update a job

Authorizations:
Bearer
path Parameters
id
required
integer or string <int32> ^-?(?:0|[1-9]\d*)$
Request Body schema: application/json
required
name
required
null or string
client_id
required
null or integer or string <int32> ^-?(?:0|[1-9]\d*)$
user_id
required
null or integer or string <int32> ^-?(?:0|[1-9]\d*)$
required
null or JobStatusKey (any)
required
null or JobSecurityTypeKey (any)
address
required
null or string
suburb
required
null or string
postcode
required
null or string
state_id
required
null or integer or string <int32> ^-?(?:0|[1-9]\d*)$
country_id
required
null or integer or string <int32> ^-?(?:0|[1-9]\d*)$
commissioned
required
null or string <date-time>
start
required
null or string <date-time>
due
required
null or string <date-time>
quote_id
required
null or integer or string <int32> ^-?(?:0|[1-9]\d*)$
retention_initial_withholding_rate
required
null or number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
retention_total_withholding_rate
required
null or number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$

Responses

Response Schema: application/json
id
integer or string <int32> ^-?(?:0|[1-9]\d*)$
name
required
string
required
object (ClientOverview)
status
required
any (JobStatusKey)
Enum: "NEW" "CANCELLED" "IN_PROGRESS" "AWAITING_COMPLETION" "COMPLETE"
address
null or string
suburb
null or string
postcode
null or string
state
null or string
country
null or string
commissioned
string <date-time>
start
null or string <date-time>
due
null or string <date-time>
null or JobFinancial (object)
null or QuoteOverview (object)
number
required
string
null or UserOverview (object)
security_type
required
any (JobSecurityTypeKey)
Enum: "NONE" "RETENTION" "GUARANTEE"
retention_initial_withholding_rate
number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
retention_total_withholding_rate
number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
created
string <date-time>
modified
string <date-time>

Request samples

Content type
application/json
{
  • "name": null,
  • "client_id": null,
  • "user_id": null,
  • "status": { },
  • "security_type": { },
  • "address": null,
  • "suburb": null,
  • "postcode": null,
  • "state_id": null,
  • "country_id": null,
  • "commissioned": null,
  • "start": null,
  • "due": null,
  • "quote_id": null,
  • "retention_initial_withholding_rate": null,
  • "retention_total_withholding_rate": null
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "client": {
    },
  • "status": "NEW",
  • "address": null,
  • "suburb": null,
  • "postcode": null,
  • "state": null,
  • "country": null,
  • "commissioned": "2019-08-24T14:15:22Z",
  • "start": null,
  • "due": null,
  • "financial": { },
  • "quote": { },
  • "number": "string",
  • "user": { },
  • "security_type": "NONE",
  • "retention_initial_withholding_rate": 0,
  • "retention_total_withholding_rate": 0,
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z"
}

Returns a list of all jobs

Authorizations:
Bearer
query Parameters
Filters
string
Sorts
string
Page
integer or string <int32> ^-?(?:0|[1-9]\d*)$
PageSize
integer or string <int32> ^-?(?:0|[1-9]\d*)$

Responses

Response Schema: application/json
Array
id
integer or string <int32> ^-?(?:0|[1-9]\d*)$
name
required
string
required
object (ClientOverview)
status
required
any (JobStatusKey)
Enum: "NEW" "CANCELLED" "IN_PROGRESS" "AWAITING_COMPLETION" "COMPLETE"
address
null or string
suburb
null or string
postcode
null or string
state
null or string
country
null or string
commissioned
string <date-time>
start
null or string <date-time>
due
null or string <date-time>
null or JobFinancial (object)
null or QuoteOverview (object)
number
required
string
null or UserOverview (object)
security_type
required
any (JobSecurityTypeKey)
Enum: "NONE" "RETENTION" "GUARANTEE"
retention_initial_withholding_rate
number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
retention_total_withholding_rate
number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
created
string <date-time>
modified
string <date-time>

Response samples

Content type
application/json
[
  • {
    }
]

Get the status of a file that has been uploaded for the specified job

Authorizations:
Bearer
path Parameters
id
required
string
uploadId
required
string <uuid>

Responses

Response Schema: application/json
id
required
string <uuid>
uploaded
boolean
completed
boolean
modified
string <date-time>

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "uploaded": true,
  • "completed": true,
  • "modified": "2019-08-24T14:15:22Z"
}

Return the current invoicing amounts for a job

Authorizations:
Bearer
path Parameters
id
required
integer or string <int32> ^-?(?:0|[1-9]\d*)$
query Parameters
invoice_number
integer or string <int32> ^-?(?:0|[1-9]\d*)$

Responses

Response Schema: application/json
Array
section_id
null or integer or string <int32> ^-?(?:0|[1-9]\d*)$
section_name
string
total_charge
number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
total_invoiced
number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
children_hidden
boolean

Response samples

Content type
application/json
[
  • {
    }
]

Move a file or folder for the specified job

Authorizations:
Bearer
path Parameters
id
required
integer or string <int32> ^-?(?:0|[1-9]\d*)$
query Parameters
path
required
string
Request Body schema: application/json
required
destination_path
required
string

Responses

Request samples

Content type
application/json
{
  • "destination_path": "string"
}

Return a file for the specified job

Authorizations:
Bearer
path Parameters
id
required
integer or string <int32> ^-?(?:0|[1-9]\d*)$
query Parameters
path
required
string

Responses

Update the status of a job

Authorizations:
Bearer
path Parameters
id
required
integer or string <int32> ^-?(?:0|[1-9]\d*)$
Request Body schema: application/json
required
required
null or JobStatusKey (any)

Responses

Response Schema: application/json
id
integer or string <int32> ^-?(?:0|[1-9]\d*)$
name
required
string
required
object (ClientOverview)
status
required
any (JobStatusKey)
Enum: "NEW" "CANCELLED" "IN_PROGRESS" "AWAITING_COMPLETION" "COMPLETE"
address
null or string
suburb
null or string
postcode
null or string
state
null or string
country
null or string
commissioned
string <date-time>
start
null or string <date-time>
due
null or string <date-time>
null or JobFinancial (object)
null or QuoteOverview (object)
number
required
string
null or UserOverview (object)
security_type
required
any (JobSecurityTypeKey)
Enum: "NONE" "RETENTION" "GUARANTEE"
retention_initial_withholding_rate
number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
retention_total_withholding_rate
number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
created
string <date-time>
modified
string <date-time>

Request samples

Content type
application/json
{
  • "status": { }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "client": {
    },
  • "status": "NEW",
  • "address": null,
  • "suburb": null,
  • "postcode": null,
  • "state": null,
  • "country": null,
  • "commissioned": "2019-08-24T14:15:22Z",
  • "start": null,
  • "due": null,
  • "financial": { },
  • "quote": { },
  • "number": "string",
  • "user": { },
  • "security_type": "NONE",
  • "retention_initial_withholding_rate": 0,
  • "retention_total_withholding_rate": 0,
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z"
}

Request to upload a file for the specified job

Authorizations:
Bearer
path Parameters
id
required
integer or string <int32> ^-?(?:0|[1-9]\d*)$
query Parameters
path
required
string

Responses

Response Schema: application/json
file_id
string <uuid>
upload_url
required
string

Response samples

Content type
application/json
{
  • "file_id": "8a0cfb4f-ddc9-436d-91bb-75133c583767",
  • "upload_url": "string"
}

Purchase Orders

Return a single purchase order by id

Authorizations:
Bearer
path Parameters
id
required
integer or string <int32> ^-?(?:0|[1-9]\d*)$

Responses

Response Schema: application/json
id
integer or string <int32> ^-?(?:0|[1-9]\d*)$
gst_exempt
boolean
cost
number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
gst
number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
total
number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
address
null or string
suburb
null or string
postcode
null or string
state
null or string
country
null or string
description
null or string
reference
null or string
expected
null or string <date-time>
type
any (PurchaseOrderTypeKey)
Enum: "MATERIALS" "QUOTE" "LABOUR"
status
any (PurchaseOrderStatusKey)
Enum: "APPROVED" "VOIDED" "FULFILLED"
Array of objects or null (PurchaseOrderItem)
comments
null or string
null or SupplierOverview (object)
number
required
string
null or UserOverview (object)
null or object
created
string <date-time>
modified
string <date-time>

Response samples

Content type
application/json
{
  • "id": 0,
  • "gst_exempt": true,
  • "cost": 0,
  • "gst": 0,
  • "total": 0,
  • "address": null,
  • "suburb": null,
  • "postcode": null,
  • "state": null,
  • "country": null,
  • "description": null,
  • "reference": null,
  • "expected": null,
  • "type": "MATERIALS",
  • "status": "APPROVED",
  • "items": null,
  • "comments": null,
  • "supplier": { },
  • "number": "string",
  • "user": { },
  • "external_ids": null,
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z"
}

Returns a list of all purchase orders

Authorizations:
Bearer
query Parameters
job_id
integer or string <int32> ^-?(?:0|[1-9]\d*)$
Filters
string
Sorts
string
Page
integer or string <int32> ^-?(?:0|[1-9]\d*)$
PageSize
integer or string <int32> ^-?(?:0|[1-9]\d*)$

Responses

Response Schema: application/json
Array
id
integer or string <int32> ^-?(?:0|[1-9]\d*)$
gst_exempt
boolean
cost
number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
gst
number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
total
number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
address
null or string
suburb
null or string
postcode
null or string
state
null or string
country
null or string
description
null or string
reference
null or string
expected
null or string <date-time>
type
any (PurchaseOrderTypeKey)
Enum: "MATERIALS" "QUOTE" "LABOUR"
status
any (PurchaseOrderStatusKey)
Enum: "APPROVED" "VOIDED" "FULFILLED"
Array of objects or null (PurchaseOrderItem)
comments
null or string
null or SupplierOverview (object)
number
required
string
null or UserOverview (object)
null or object
created
string <date-time>
modified
string <date-time>

Response samples

Content type
application/json
[
  • {
    }
]

Quotes

Create a folder for the specified quote

Authorizations:
Bearer
path Parameters
id
required
integer or string <int32> ^-?(?:0|[1-9]\d*)$
query Parameters
path
required
string

Responses

Delete a file or folder for the specified quote

Authorizations:
Bearer
path Parameters
id
required
integer or string <int32> ^-?(?:0|[1-9]\d*)$
query Parameters
path
required
string

Responses

Return the files for the specified quote

Authorizations:
Bearer
path Parameters
id
required
integer or string <int32> ^-?(?:0|[1-9]\d*)$
query Parameters
path
required
string
Filters
string
Sorts
string
Page
integer or string <int32> ^-?(?:0|[1-9]\d*)$
PageSize
integer or string <int32> ^-?(?:0|[1-9]\d*)$

Responses

Response Schema: application/json
Array
id
required
string
name
required
string
type
required
any (FileItemTypeKey)
Enum: "FOLDER" "FILE"
size
null or integer or string <int64> ^-?(?:0|[1-9]\d*)$
modified
null or string <date-time>

Response samples

Content type
application/json
[
  • {
    }
]

Return a single quote by id

Authorizations:
Bearer
path Parameters
id
required
integer or string <int32> ^-?(?:0|[1-9]\d*)$

Responses

Response Schema: application/json
id
integer or string <int32> ^-?(?:0|[1-9]\d*)$
name
required
string
cost
number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
labour_cost
number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
materials_cost
number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
quotes_cost
number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
charge
number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
labour_charge
number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
materials_charge
number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
quotes_charge
number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
null or ClientOverview (object)
null or JobOverview (object)
status
any (QuoteStatusKey)
Enum: "NEW" "VOIDED" "IN_PROGRESS" "PENDING" "WON" "LOST"
null or QuoteItemOverview (object)
address
null or string
suburb
null or string
postcode
null or string
state
null or string
country
null or string
due
string <date-time>
number
null or string
null or QuoteRevisionOverview (object)
null or UserOverview (object)
created
string <date-time>
modified
string <date-time>

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "cost": 0,
  • "labour_cost": 0,
  • "materials_cost": 0,
  • "quotes_cost": 0,
  • "charge": 0,
  • "labour_charge": 0,
  • "materials_charge": 0,
  • "quotes_charge": 0,
  • "client": { },
  • "job": { },
  • "status": "NEW",
  • "quote_item": { },
  • "address": null,
  • "suburb": null,
  • "postcode": null,
  • "state": null,
  • "country": null,
  • "due": "2019-08-24T14:15:22Z",
  • "number": null,
  • "current_revision": { },
  • "user": { },
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z"
}

Returns a list of all quotes

Authorizations:
Bearer
query Parameters
Filters
string
Sorts
string
Page
integer or string <int32> ^-?(?:0|[1-9]\d*)$
PageSize
integer or string <int32> ^-?(?:0|[1-9]\d*)$

Responses

Response Schema: application/json
Array
id
integer or string <int32> ^-?(?:0|[1-9]\d*)$
name
required
string
cost
number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
labour_cost
number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
materials_cost
number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
quotes_cost
number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
charge
number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
labour_charge
number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
materials_charge
number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
quotes_charge
number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
null or ClientOverview (object)
null or JobOverview (object)
status
any (QuoteStatusKey)
Enum: "NEW" "VOIDED" "IN_PROGRESS" "PENDING" "WON" "LOST"
null or QuoteItemOverview (object)
address
null or string
suburb
null or string
postcode
null or string
state
null or string
country
null or string
due
string <date-time>
number
null or string
null or QuoteRevisionOverview (object)
null or UserOverview (object)
created
string <date-time>
modified
string <date-time>

Response samples

Content type
application/json
[
  • {
    }
]

Get the status of a file that has been uploaded for the specified quote

Authorizations:
Bearer
path Parameters
id
required
string
uploadId
required
string <uuid>

Responses

Response Schema: application/json
id
required
string <uuid>
uploaded
boolean
completed
boolean
modified
string <date-time>

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "uploaded": true,
  • "completed": true,
  • "modified": "2019-08-24T14:15:22Z"
}

Return a list of items in the specified quote

Authorizations:
Bearer
path Parameters
id
required
integer or string <int32> ^-?(?:0|[1-9]\d*)$
query Parameters
Filters
string
Sorts
string
Page
integer or string <int32> ^-?(?:0|[1-9]\d*)$
PageSize
integer or string <int32> ^-?(?:0|[1-9]\d*)$

Responses

Response Schema: application/json
Array
id
integer or string <int32> ^-?(?:0|[1-9]\d*)$
name
required
string
item_type
required
string
number
null or string
quantity
number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
unit_cost
number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
cost
number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
charge
number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
override_margins
null or boolean
labour_margin
null or number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
materials_margin
null or number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
quotes_margin
null or number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
unit_id
null or integer or string <int32> ^-?(?:0|[1-9]\d*)$
description
null or string
notes
null or string
sort
integer or string <int32> ^-?(?:0|[1-9]\d*)$
parent_id
null or integer or string <int32> ^-?(?:0|[1-9]\d*)$
source_id
null or integer or string <int32> ^-?(?:0|[1-9]\d*)$

Response samples

Content type
application/json
[
  • {
    }
]

Return a list of quote revisions for the specified quote

Authorizations:
Bearer
path Parameters
id
required
integer or string <int32> ^-?(?:0|[1-9]\d*)$
query Parameters
Filters
string
Sorts
string
Page
integer or string <int32> ^-?(?:0|[1-9]\d*)$
PageSize
integer or string <int32> ^-?(?:0|[1-9]\d*)$

Responses

Response Schema: application/json
Array
id
integer or string <int32> ^-?(?:0|[1-9]\d*)$
name
required
string
charge
number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
gst
number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
charge_gst
null or boolean
total
number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
number
integer or string <int32> ^-?(?:0|[1-9]\d*)$
created
string <date-time>
modified
string <date-time>

Response samples

Content type
application/json
[
  • {
    }
]

Move a file or folder for the specified quote

Authorizations:
Bearer
path Parameters
id
required
integer or string <int32> ^-?(?:0|[1-9]\d*)$
query Parameters
path
required
string
Request Body schema: application/json
required
destination_path
required
string

Responses

Request samples

Content type
application/json
{
  • "destination_path": "string"
}

Return a file for the specified quote

Authorizations:
Bearer
path Parameters
id
required
integer or string <int32> ^-?(?:0|[1-9]\d*)$
query Parameters
path
required
string

Responses

Request to upload a file for the specified quote

Authorizations:
Bearer
path Parameters
id
required
integer or string <int32> ^-?(?:0|[1-9]\d*)$
query Parameters
path
required
string

Responses

Response Schema: application/json
file_id
string <uuid>
upload_url
required
string

Response samples

Content type
application/json
{
  • "file_id": "8a0cfb4f-ddc9-436d-91bb-75133c583767",
  • "upload_url": "string"
}

Settings

Return the settings for the current account

Authorizations:
Bearer

Responses

Response Schema: application/json
property name*
additional property
string

Response samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

Suppliers

Return a single supplier by id

Authorizations:
Bearer
path Parameters
id
required
integer or string <int32> ^-?(?:0|[1-9]\d*)$

Responses

Response Schema: application/json
id
integer or string <int32> ^-?(?:0|[1-9]\d*)$
name
required
string
address
null or string
suburb
null or string
postcode
null or string
state
null or string
country
null or string
gst_exempt
null or boolean
phone
null or string
alternate_phone1
null or string
alternate_phone2
null or string
email
null or string
abn
null or string
acn
null or string
null or UserOverview (object)
null or object
created
string <date-time>
modified
string <date-time>

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "address": null,
  • "suburb": null,
  • "postcode": null,
  • "state": null,
  • "country": null,
  • "gst_exempt": null,
  • "phone": null,
  • "alternate_phone1": null,
  • "alternate_phone2": null,
  • "email": null,
  • "abn": null,
  • "acn": null,
  • "user": { },
  • "external_ids": null,
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z"
}

Returns a list of all suppliers

Authorizations:
Bearer
query Parameters
Filters
string
Sorts
string
Page
integer or string <int32> ^-?(?:0|[1-9]\d*)$
PageSize
integer or string <int32> ^-?(?:0|[1-9]\d*)$

Responses

Response Schema: application/json
Array
id
integer or string <int32> ^-?(?:0|[1-9]\d*)$
name
required
string
address
null or string
suburb
null or string
postcode
null or string
state
null or string
country
null or string
gst_exempt
null or boolean
phone
null or string
alternate_phone1
null or string
alternate_phone2
null or string
email
null or string
abn
null or string
acn
null or string
null or UserOverview (object)
null or object
created
string <date-time>
modified
string <date-time>

Response samples

Content type
application/json
[
  • {
    }
]

Time Entries

Create a time entry

Authorizations:
Bearer
Request Body schema: application/json
required
employee_id
required
null or integer or string <int32> ^-?(?:0|[1-9]\d*)$
job_id
required
null or integer or string <int32> ^-?(?:0|[1-9]\d*)$
quote_item_id
required
null or integer or string <int32> ^-?(?:0|[1-9]\d*)$
labour_id
required
null or integer or string <int32> ^-?(?:0|[1-9]\d*)$
description
required
null or string
date
required
null or string <date>
start
required
null or string <time>
end
required
null or string <time>
quantity
required
null or number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$

Responses

Response Schema: application/json
id
integer or string <int32> ^-?(?:0|[1-9]\d*)$
required
object (EmployeeOverview)
null or JobOverview (object)
null or QuoteItemOverview (object)
null or LibraryItemOverview (object)
date
string <date>
start
null or string <time>
end
null or string <time>
quantity
number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
description
null or string
created
string <date-time>
modified
string <date-time>

Request samples

Content type
application/json
{
  • "employee_id": null,
  • "job_id": null,
  • "quote_item_id": null,
  • "labour_id": null,
  • "description": null,
  • "date": null,
  • "start": null,
  • "end": null,
  • "quantity": null
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "employee": {
    },
  • "job": { },
  • "quote_item": { },
  • "labour": { },
  • "date": "2019-08-24",
  • "start": null,
  • "end": null,
  • "quantity": 0,
  • "description": null,
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z"
}

Returns a list of all time entries

Authorizations:
Bearer
query Parameters
Filters
string
Sorts
string
Page
integer or string <int32> ^-?(?:0|[1-9]\d*)$
PageSize
integer or string <int32> ^-?(?:0|[1-9]\d*)$

Responses

Response Schema: application/json
Array
id
integer or string <int32> ^-?(?:0|[1-9]\d*)$
required
object (EmployeeOverview)
null or JobOverview (object)
null or QuoteItemOverview (object)
null or LibraryItemOverview (object)
date
string <date>
start
null or string <time>
end
null or string <time>
quantity
number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
description
null or string
created
string <date-time>
modified
string <date-time>

Response samples

Content type
application/json
[
  • {
    }
]

Update time entries in a pay week

Authorizations:
Bearer
Request Body schema: application/json
required
employee_id
required
null or integer or string <int32> ^-?(?:0|[1-9]\d*)$
required
Array of objects or null (UpdateTimeEntriesRequestEntry)

Responses

Response Schema: application/json
Array
id
integer or string <int32> ^-?(?:0|[1-9]\d*)$
required
object (EmployeeOverview)
null or JobOverview (object)
null or QuoteItemOverview (object)
null or LibraryItemOverview (object)
date
string <date>
start
null or string <time>
end
null or string <time>
quantity
number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
description
null or string
created
string <date-time>
modified
string <date-time>

Request samples

Content type
application/json
{
  • "employee_id": null,
  • "entries": null
}

Response samples

Content type
application/json
[
  • {
    }
]

Update a time entry

Authorizations:
Bearer
path Parameters
id
required
integer or string <int32> ^-?(?:0|[1-9]\d*)$
Request Body schema: application/json
required
employee_id
required
null or integer or string <int32> ^-?(?:0|[1-9]\d*)$
job_id
required
null or integer or string <int32> ^-?(?:0|[1-9]\d*)$
quote_item_id
required
null or integer or string <int32> ^-?(?:0|[1-9]\d*)$
labour_id
required
null or integer or string <int32> ^-?(?:0|[1-9]\d*)$
description
required
null or string
date
required
null or string <date>
start
required
null or string <time>
end
required
null or string <time>
quantity
required
null or number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$

Responses

Response Schema: application/json
id
integer or string <int32> ^-?(?:0|[1-9]\d*)$
required
object (EmployeeOverview)
null or JobOverview (object)
null or QuoteItemOverview (object)
null or LibraryItemOverview (object)
date
string <date>
start
null or string <time>
end
null or string <time>
quantity
number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
description
null or string
created
string <date-time>
modified
string <date-time>

Request samples

Content type
application/json
{
  • "employee_id": null,
  • "job_id": null,
  • "quote_item_id": null,
  • "labour_id": null,
  • "description": null,
  • "date": null,
  • "start": null,
  • "end": null,
  • "quantity": null
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "employee": {
    },
  • "job": { },
  • "quote_item": { },
  • "labour": { },
  • "date": "2019-08-24",
  • "start": null,
  • "end": null,
  • "quantity": 0,
  • "description": null,
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z"
}

Variations

Return a single variation by id

Authorizations:
Bearer
path Parameters
id
required
integer or string <int32> ^-?(?:0|[1-9]\d*)$

Responses

Response Schema: application/json
id
integer or string <int32> ^-?(?:0|[1-9]\d*)$
name
required
string
cost
number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
labour_cost
number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
materials_cost
number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
quotes_cost
number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
charge
number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
labour_charge
number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
materials_charge
number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
quotes_charge
number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
null or QuoteOverview (object)
status
any (QuoteVariationStatusKey)
Enum: "PENDING" "APPROVED" "DECLINED"
null or QuoteItemOverview (object)
number
null or string
null or VariationRevisionOverview (object)
null or UserOverview (object)
created
string <date-time>
modified
string <date-time>

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "cost": 0,
  • "labour_cost": 0,
  • "materials_cost": 0,
  • "quotes_cost": 0,
  • "charge": 0,
  • "labour_charge": 0,
  • "materials_charge": 0,
  • "quotes_charge": 0,
  • "quote": { },
  • "status": "PENDING",
  • "quote_item": { },
  • "number": null,
  • "current_revision": { },
  • "user": { },
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z"
}

Returns a list of all variations

Authorizations:
Bearer
query Parameters
Filters
string
Sorts
string
Page
integer or string <int32> ^-?(?:0|[1-9]\d*)$
PageSize
integer or string <int32> ^-?(?:0|[1-9]\d*)$

Responses

Response Schema: application/json
Array
id
integer or string <int32> ^-?(?:0|[1-9]\d*)$
name
required
string
cost
number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
labour_cost
number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
materials_cost
number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
quotes_cost
number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
charge
number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
labour_charge
number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
materials_charge
number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
quotes_charge
number or string <double> ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
null or QuoteOverview (object)
status
any (QuoteVariationStatusKey)
Enum: "PENDING" "APPROVED" "DECLINED"
null or QuoteItemOverview (object)
number
null or string
null or VariationRevisionOverview (object)
null or UserOverview (object)
created
string <date-time>
modified
string <date-time>

Response samples

Content type
application/json
[
  • {
    }
]