invoices list
GET {{baseUrl}}/invoices
Returns a list of Invoice objects.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
contact_id | string | If provided, will only return invoices for this contact. | |
created_after | string | If provided, will only return objects created after this datetime. | |
created_before | string | If provided, will only return objects created before this datetime. | |
cursor | string | The pagination cursor value. | |
expand | string | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | |
include_deleted_data | boolean | Whether to include data that was deleted in the third-party service. | |
include_remote_data | boolean | Whether to include the original data Merge fetched from the third-party to produce these models. | |
modified_after | string | If provided, will only return objects modified after this datetime. | |
modified_before | string | If provided, will only return objects modified before this datetime. | |
page_size | number | Number of results to return per page. | |
remote_id | string | The API provider's ID for the given object. | |
type | string | If provided, will only return Invoices with this type | |
issue_date_after | string | ||
issue_date_before | string | ||
company_id | string | If provided, will only return invoices for this company. | |
contact_id | string | If provided, will only return invoices for this contact. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
X-Account-Token | string | (Required) Token identifying the end user. | |
Accept | string |
RESPONSES
status: OK
{"next":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw","previous":"cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ","results":[{"id":"9871b4a9-f5d2-4f3b-a66b-dfedbed42c46","remote_id":"990110","type":"ACCOUNTS_PAYABLE","contact":"022a2bef-57e5-4def-8ed2-7c41bd9a5ed8","number":"AIQ12546","issue_date":"2020-03-31T00:00:00Z","due_date":"2020-04-15T00:00:00Z","paid_on_date":"2020-04-01T00:00:00Z","memo":"Weekly Payment","currency":"YDD","total_discount":78442369.9429541,"sub_total":100,"total_tax_amount":5,"total_amount":105,"balance":105,"remote_updated_at":"2020-04-01T00:00:00Z","payments":["b26fd49a-cbae-470a-a8f8-bcbc119e0390"],"line_items":[{"remote_id":"8765432","description":"Pickleball lessons","unit_price":50,"quantity":2,"total_amount":100,"item":"5b3c1341-a20f-4e51-b72c-f3830a16c97b","remote_data":[{"path":"/actions","data":["Varies by platform"]}]}]},{"id":"9871b4a9-f5d2-4f3b-a66b-dfedbed42c46","remote_id":"990110","type":"ACCOUNTS_PAYABLE","contact":"022a2bef-57e5-4def-8ed2-7c41bd9a5ed8","number":"AIQ12546","issue_date":"2020-03-31T00:00:00Z","due_date":"2020-04-15T00:00:00Z","paid_on_date":"2020-04-01T00:00:00Z","memo":"Weekly Payment","currency":"ADP","total_discount":-67929777.547254,"sub_total":100,"total_tax_amount":5,"total_amount":105,"balance":105,"remote_updated_at":"2020-04-01T00:00:00Z","payments":["b26fd49a-cbae-470a-a8f8-bcbc119e0390"],"line_items":[{"remote_id":"8765432","description":"Pickleball lessons","unit_price":50,"quantity":2,"total_amount":100,"item":"5b3c1341-a20f-4e51-b72c-f3830a16c97b","remote_data":[{"path":"/actions","data":["Varies by platform"]}]}]}]}