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

path Parameters
id
required
integer <int32>

Responses

Response Schema: application/json
id
integer <int32>
name
required
string
address
string or null
suburb
string or null
postcode
string or null
state
string or null
country
string or null
company_name
string or null
phone
string or null
alternate_phone1
string or null
alternate_phone2
string or null
email
string or null
abn
string or null
acn
string or null
Array of objects or null (ClientContactOverview)
object or null (UserOverview)
object or null
created
string <date-time>
modified
string <date-time>

Response samples

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

Returns a list of all clients

query Parameters
Filters
string
Sorts
string
Page
integer <int32>
PageSize
integer <int32>

Responses

Response Schema: application/json
Array
id
integer <int32>
name
required
string
address
string or null
suburb
string or null
postcode
string or null
state
string or null
country
string or null
company_name
string or null
phone
string or null
alternate_phone1
string or null
alternate_phone2
string or null
email
string or null
abn
string or null
acn
string or null
Array of objects or null (ClientContactOverview)
object or null (UserOverview)
object or null
created
string <date-time>
modified
string <date-time>

Response samples

Content type
application/json
[
  • {
    }
]

Employees

Returns a list of all employees

query Parameters
Filters
string
Sorts
string
Page
integer <int32>
PageSize
integer <int32>

Responses

Response Schema: application/json
Array
id
integer <int32>
name
required
string
address
string or null
suburb
string or null
postcode
string or null
state
string or null
country
string or null
phone
string or null
alternate_phone1
string or null
alternate_phone2
string or null
email
string or null
tfn
string or null
abn
string or null
reference
string or null
object or null (UserOverview)
object or null
created
string <date-time>
modified
string <date-time>

Response samples

Content type
application/json
[
  • {
    }
]

Hooks

Create a hook subscription

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

Responses

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

Request samples

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

Response samples

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

Returns a list of all hook subscriptions

Responses

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

Response samples

Content type
application/json
[
  • {
    }
]

Delete a hook subscription

path Parameters
id
required
string

Responses

Return a single hook subscription by id

path Parameters
id
required
string

Responses

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

Response samples

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

Integrations

Complete the connection process to the specified integration

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

Responses

Request samples

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

Get data from the specified integration

path Parameters
integrationKey
required
string
dataKey
required
string

Responses

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

Response samples

Content type
application/json
[
  • {
    }
]

Initiate the connection process to the specified integration

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

Responses

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

Request samples

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

Response samples

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

Unlink from the specified integration

path Parameters
integrationKey
required
string

Responses

Invoices

Create an invoice

Request Body schema: application/json
required
job_id
required
integer or null <int32>
user_id
required
integer or null <int32>
type
required
any or null (NullableOfInvoiceTypeKey)
Enum: "GENERAL" "CLAIM" null
status
required
any or null (NullableOfInvoiceStatusKey)
Enum: "DRAFT" "SUBMITTED" "APPROVED" "PARTIALLY_PAID" "FULLY_PAID" "VOIDED" null
issued
required
string or null <date-time>
payment_due
required
string or null <date-time>
payment_terms
required
string or null
hidden_quote_section_ids
required
Array of integers or null <int32> [ items <int32 > ]
comments
required
string or null
required
Array of objects or null (CreateInvoiceRequestItem)

Responses

Response Schema: application/json
id
integer <int32>
gst_exempt
boolean or null
cost_gross
number <double>
cost
number <double>
gst
number <double>
total
number <double>
description
string or null
issued
string or null <date-time>
payment_due
string or null <date-time>
payment_terms
string or null
retention_value
number or null <double>
comments
string or null
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 null <int32> [ items <int32 > ]
required
object (JobOverview)
required
object (ClientOverview)
number
required
string
sequence_number
required
integer <int32>
object or null (UserOverview)
object or null
created
string <date-time>
modified
string <date-time>

Request samples

Content type
application/json
{
  • "job_id": 0,
  • "user_id": 0,
  • "type": "GENERAL",
  • "status": "DRAFT",
  • "issued": "2019-08-24T14:15:22Z",
  • "payment_due": "2019-08-24T14:15:22Z",
  • "payment_terms": "string",
  • "hidden_quote_section_ids": [
    ],
  • "comments": "string",
  • "items": [
    ]
}

Response samples

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

Returns a list of all invoices

query Parameters
Filters
string
Sorts
string
Page
integer <int32>
PageSize
integer <int32>

Responses

Response Schema: application/json
Array
id
integer <int32>
gst_exempt
boolean or null
cost_gross
number <double>
cost
number <double>
gst
number <double>
total
number <double>
description
string or null
issued
string or null <date-time>
payment_due
string or null <date-time>
payment_terms
string or null
retention_value
number or null <double>
comments
string or null
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 null <int32> [ items <int32 > ]
required
object (JobOverview)
required
object (ClientOverview)
number
required
string
sequence_number
required
integer <int32>
object or null (UserOverview)
object or null
created
string <date-time>
modified
string <date-time>

Response samples

Content type
application/json
[
  • {
    }
]

Return a single invoice by id

path Parameters
id
required
integer <int32>

Responses

Response Schema: application/json
id
integer <int32>
gst_exempt
boolean or null
cost_gross
number <double>
cost
number <double>
gst
number <double>
total
number <double>
description
string or null
issued
string or null <date-time>
payment_due
string or null <date-time>
payment_terms
string or null
retention_value
number or null <double>
comments
string or null
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 null <int32> [ items <int32 > ]
required
object (JobOverview)
required
object (ClientOverview)
number
required
string
sequence_number
required
integer <int32>
object or null (UserOverview)
object or null
created
string <date-time>
modified
string <date-time>

Response samples

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

Update an invoice

path Parameters
id
required
integer <int32>
Request Body schema: application/json
required
job_id
required
integer or null <int32>
user_id
required
integer or null <int32>
type
required
any or null (NullableOfInvoiceTypeKey)
Enum: "GENERAL" "CLAIM" null
status
required
any or null (NullableOfInvoiceStatusKey)
Enum: "DRAFT" "SUBMITTED" "APPROVED" "PARTIALLY_PAID" "FULLY_PAID" "VOIDED" null
issued
required
string or null <date-time>
payment_due
required
string or null <date-time>
payment_terms
required
string or null
hidden_quote_section_ids
required
Array of integers or null <int32> [ items <int32 > ]
comments
required
string or null
required
Array of objects or null (UpdateInvoiceRequestItem)

Responses

Response Schema: application/json
id
integer <int32>
gst_exempt
boolean or null
cost_gross
number <double>
cost
number <double>
gst
number <double>
total
number <double>
description
string or null
issued
string or null <date-time>
payment_due
string or null <date-time>
payment_terms
string or null
retention_value
number or null <double>
comments
string or null
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 null <int32> [ items <int32 > ]
required
object (JobOverview)
required
object (ClientOverview)
number
required
string
sequence_number
required
integer <int32>
object or null (UserOverview)
object or null
created
string <date-time>
modified
string <date-time>

Request samples

Content type
application/json
{
  • "job_id": 0,
  • "user_id": 0,
  • "type": "GENERAL",
  • "status": "DRAFT",
  • "issued": "2019-08-24T14:15:22Z",
  • "payment_due": "2019-08-24T14:15:22Z",
  • "payment_terms": "string",
  • "hidden_quote_section_ids": [
    ],
  • "comments": "string",
  • "items": [
    ]
}

Response samples

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

Jobs

Return a single job by id

path Parameters
id
required
integer <int32>

Responses

Response Schema: application/json
id
integer <int32>
name
required
string
required
object (ClientOverview)
status
required
any (JobStatusKey)
Enum: "NEW" "CANCELLED" "IN_PROGRESS" "AWAITING_COMPLETION" "COMPLETE"
address
string or null
suburb
string or null
postcode
string or null
state
string or null
country
string or null
commissioned
string <date-time>
start
string or null <date-time>
due
string or null <date-time>
object or null (JobFinancial)
object or null (QuoteOverview)
number
required
string
object or null (UserOverview)
security_type
required
any (JobSecurityTypeKey)
Enum: "NONE" "RETENTION" "GUARANTEE"
retention_initial_withholding_rate
number <double>
retention_total_withholding_rate
number <double>
created
string <date-time>
modified
string <date-time>

Response samples

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

Returns a list of all jobs

query Parameters
Filters
string
Sorts
string
Page
integer <int32>
PageSize
integer <int32>

Responses

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

Response samples

Content type
application/json
[
  • {
    }
]

Return the files for the specified job

path Parameters
id
required
integer <int32>
query Parameters
path
required
string
Filters
string
Sorts
string
Page
integer <int32>
PageSize
integer <int32>

Responses

Response Schema: application/json
Array
id
required
string
name
required
string
type
required
any (FileItemTypeKey)
Enum: "FOLDER" "FILE"
size
integer or null <int64>
modified
string or null <date-time>

Response samples

Content type
application/json
[
  • {
    }
]

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

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

path Parameters
id
required
integer <int32>
query Parameters
invoice_number
integer <int32>

Responses

Response Schema: application/json
Array
section_id
integer or null <int32>
section_name
string
total_charge
number <double>
total_invoiced
number <double>
children_hidden
boolean

Response samples

Content type
application/json
[
  • {
    }
]

Return a file for the specified job

path Parameters
id
required
integer <int32>
query Parameters
path
required
string

Responses

Request to upload a file for the specified job

path Parameters
id
required
integer <int32>
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

path Parameters
id
required
integer <int32>

Responses

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

Response samples

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

Returns a list of all purchase orders

query Parameters
job_id
integer <int32>
Filters
string
Sorts
string
Page
integer <int32>
PageSize
integer <int32>

Responses

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

Response samples

Content type
application/json
[
  • {
    }
]

Quotes

Return a single quote by id

path Parameters
id
required
integer <int32>

Responses

Response Schema: application/json
id
integer <int32>
name
required
string
cost
number <double>
labour_cost
number <double>
materials_cost
number <double>
quotes_cost
number <double>
charge
number <double>
labour_charge
number <double>
materials_charge
number <double>
quotes_charge
number <double>
object or null (ClientOverview2)
object or null (JobOverview2)
status
any (QuoteStatusKey)
Enum: "NEW" "VOIDED" "IN_PROGRESS" "PENDING" "WON" "LOST"
object or null (QuoteItemOverview)
address
string or null
suburb
string or null
postcode
string or null
state
string or null
country
string or null
due
string <date-time>
number
string or null
object or null (QuoteRevisionOverview)
object or null (UserOverview)
created
string <date-time>
modified
string <date-time>

Response samples

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

Returns a list of all quotes

query Parameters
Filters
string
Sorts
string
Page
integer <int32>
PageSize
integer <int32>

Responses

Response Schema: application/json
Array
id
integer <int32>
name
required
string
cost
number <double>
labour_cost
number <double>
materials_cost
number <double>
quotes_cost
number <double>
charge
number <double>
labour_charge
number <double>
materials_charge
number <double>
quotes_charge
number <double>
object or null (ClientOverview2)
object or null (JobOverview2)
status
any (QuoteStatusKey)
Enum: "NEW" "VOIDED" "IN_PROGRESS" "PENDING" "WON" "LOST"
object or null (QuoteItemOverview)
address
string or null
suburb
string or null
postcode
string or null
state
string or null
country
string or null
due
string <date-time>
number
string or null
object or null (QuoteRevisionOverview)
object or null (UserOverview)
created
string <date-time>
modified
string <date-time>

Response samples

Content type
application/json
[
  • {
    }
]

Return the files for the specified quote

path Parameters
id
required
integer <int32>
query Parameters
path
required
string
Filters
string
Sorts
string
Page
integer <int32>
PageSize
integer <int32>

Responses

Response Schema: application/json
Array
id
required
string
name
required
string
type
required
any (FileItemTypeKey)
Enum: "FOLDER" "FILE"
size
integer or null <int64>
modified
string or null <date-time>

Response samples

Content type
application/json
[
  • {
    }
]

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

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

path Parameters
id
required
integer <int32>
query Parameters
Filters
string
Sorts
string
Page
integer <int32>
PageSize
integer <int32>

Responses

Response Schema: application/json
Array
id
integer <int32>
name
required
string
item_type
required
string
number
string or null
quantity
number <double>
unit_cost
number <double>
cost
number <double>
charge
number <double>
override_margins
boolean or null
labour_margin
number or null <double>
materials_margin
number or null <double>
quotes_margin
number or null <double>
unit_id
integer or null <int32>
description
string or null
notes
string or null
sort
integer <int32>
parent_id
integer or null <int32>
source_id
integer or null <int32>

Response samples

Content type
application/json
[
  • {
    }
]

Return a list of quote revisions for the specified quote

path Parameters
id
required
integer <int32>
query Parameters
Filters
string
Sorts
string
Page
integer <int32>
PageSize
integer <int32>

Responses

Response Schema: application/json
Array
id
integer <int32>
name
required
string
charge
number <double>
gst
number <double>
charge_gst
boolean or null
total
number <double>
number
integer <int32>
created
string <date-time>
modified
string <date-time>

Response samples

Content type
application/json
[
  • {
    }
]

Return a file for the specified quote

path Parameters
id
required
integer <int32>
query Parameters
path
required
string

Responses

Request to upload a file for the specified quote

path Parameters
id
required
integer <int32>
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

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

path Parameters
id
required
integer <int32>

Responses

Response Schema: application/json
id
integer <int32>
name
required
string
address
string or null
suburb
string or null
postcode
string or null
state
string or null
country
string or null
gst_exempt
boolean or null
phone
string or null
alternate_phone1
string or null
alternate_phone2
string or null
email
string or null
abn
string or null
acn
string or null
object or null (UserOverview)
object or null
created
string <date-time>
modified
string <date-time>

Response samples

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

Returns a list of all suppliers

query Parameters
Filters
string
Sorts
string
Page
integer <int32>
PageSize
integer <int32>

Responses

Response Schema: application/json
Array
id
integer <int32>
name
required
string
address
string or null
suburb
string or null
postcode
string or null
state
string or null
country
string or null
gst_exempt
boolean or null
phone
string or null
alternate_phone1
string or null
alternate_phone2
string or null
email
string or null
abn
string or null
acn
string or null
object or null (UserOverview)
object or null
created
string <date-time>
modified
string <date-time>

Response samples

Content type
application/json
[
  • {
    }
]

Time Entries

Create a time entry

Request Body schema: application/json
required
employee_id
required
integer or null <int32>
job_id
required
integer or null <int32>
quote_item_id
required
integer or null <int32>
labour_id
required
integer or null <int32>
description
required
string or null
date
required
string or null <date>
start
required
string or null <time>
end
required
string or null <time>
quantity
required
number or null <double>

Responses

Response Schema: application/json
id
integer <int32>
required
object (EmployeeOverview)
object or null (JobOverview2)
object or null (QuoteItemOverview)
object or null (LibraryItemOverview)
date
string <date>
start
string or null <time>
end
string or null <time>
quantity
number <double>
description
string or null
created
string <date-time>
modified
string <date-time>

Request samples

Content type
application/json
{
  • "employee_id": 0,
  • "job_id": 0,
  • "quote_item_id": 0,
  • "labour_id": 0,
  • "description": "string",
  • "date": "2019-08-24",
  • "start": "14:15:22Z",
  • "end": "14:15:22Z",
  • "quantity": 0.1
}

Response samples

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

Returns a list of all time entries

query Parameters
Filters
string
Sorts
string
Page
integer <int32>
PageSize
integer <int32>

Responses

Response Schema: application/json
Array
id
integer <int32>
required
object (EmployeeOverview)
object or null (JobOverview2)
object or null (QuoteItemOverview)
object or null (LibraryItemOverview)
date
string <date>
start
string or null <time>
end
string or null <time>
quantity
number <double>
description
string or null
created
string <date-time>
modified
string <date-time>

Response samples

Content type
application/json
[
  • {
    }
]

Update time entries in a pay week

Request Body schema: application/json
required
employee_id
required
integer or null <int32>
required
Array of objects or null (UpdateTimeEntriesRequestEntry)

Responses

Response Schema: application/json
Array
id
integer <int32>
required
object (EmployeeOverview)
object or null (JobOverview2)
object or null (QuoteItemOverview)
object or null (LibraryItemOverview)
date
string <date>
start
string or null <time>
end
string or null <time>
quantity
number <double>
description
string or null
created
string <date-time>
modified
string <date-time>

Request samples

Content type
application/json
{
  • "employee_id": 0,
  • "entries": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Update a time entry

path Parameters
id
required
integer <int32>
Request Body schema: application/json
required
employee_id
required
integer or null <int32>
job_id
required
integer or null <int32>
quote_item_id
required
integer or null <int32>
labour_id
required
integer or null <int32>
description
required
string or null
date
required
string or null <date>
start
required
string or null <time>
end
required
string or null <time>
quantity
required
number or null <double>

Responses

Response Schema: application/json
id
integer <int32>
required
object (EmployeeOverview)
object or null (JobOverview2)
object or null (QuoteItemOverview)
object or null (LibraryItemOverview)
date
string <date>
start
string or null <time>
end
string or null <time>
quantity
number <double>
description
string or null
created
string <date-time>
modified
string <date-time>

Request samples

Content type
application/json
{
  • "employee_id": 0,
  • "job_id": 0,
  • "quote_item_id": 0,
  • "labour_id": 0,
  • "description": "string",
  • "date": "2019-08-24",
  • "start": "14:15:22Z",
  • "end": "14:15:22Z",
  • "quantity": 0.1
}

Response samples

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

Variations

Return a single variation by id

path Parameters
id
required
integer <int32>

Responses

Response Schema: application/json
id
integer <int32>
name
required
string
cost
number <double>
labour_cost
number <double>
materials_cost
number <double>
quotes_cost
number <double>
charge
number <double>
labour_charge
number <double>
materials_charge
number <double>
quotes_charge
number <double>
object or null (QuoteOverview)
status
any (QuoteVariationStatusKey)
Enum: "PENDING" "APPROVED" "DECLINED"
object or null (QuoteItemOverview)
number
string or null
object or null (VariationRevisionOverview)
object or null (UserOverview)
created
string <date-time>
modified
string <date-time>

Response samples

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

Returns a list of all variations

query Parameters
Filters
string
Sorts
string
Page
integer <int32>
PageSize
integer <int32>

Responses

Response Schema: application/json
Array
id
integer <int32>
name
required
string
cost
number <double>
labour_cost
number <double>
materials_cost
number <double>
quotes_cost
number <double>
charge
number <double>
labour_charge
number <double>
materials_charge
number <double>
quotes_charge
number <double>
object or null (QuoteOverview)
status
any (QuoteVariationStatusKey)
Enum: "PENDING" "APPROVED" "DECLINED"
object or null (QuoteItemOverview)
number
string or null
object or null (VariationRevisionOverview)
object or null (UserOverview)
created
string <date-time>
modified
string <date-time>

Response samples

Content type
application/json
[
  • {
    }
]