Search for invoices with search criteria and retrieve a paged list of invoices.
Valid filters are:
Pagination has the defaults as specified in its schema, but 'pagination' is an optional search request attribute! Filters can have three items that apply to pagination (Supported by /invoice/list and factored in for compatibility):
NOTE: The following pattern in the request body/shape constitutes a request for "the default Pagination settings" and will cause 'limit' filters to be IGNORED because you are providing explicit Pagination: { "pagination": "" }
Filters:
Valid parameters of /invoice/list Examples: Include voided invoices:
"filters": [
{
"type": "boolean",
"field": "includevoided",
"value": "true"
}
]
Multiple, specific invoices:
"filters": [
{
"type": "list",
"field": "invoiceids",
"value": "A1A1A1A1A1A1A1A1,B2B2B2B2B2B2B2B2,C3C3C3C3C3C3C3C3"
}
]
Weak pagination via limit and offset:
"filters": [
{
"type": "integer",
"field": "limit",
"value": "10"
},
{
"type": "integer",
"field": "offset",
"value": "10"
},
{
"type": "boolean",
"field": "includevoided",
"value": "true"
}
]
Better pagination:
"filters": [
{
"type": "boolean",
"field": "includevoided",
"value": "true"
}
],
"pagination": {
"TotalItems": 20,
"ItemsPerPage": 10,
"PageNumber": 2
}
Search for invoices
An invoice list response
API key is missing or invalid
Request is completely forbidden. API not provided or method and or endpoint not supported
404 Not found
429 too many requests response
Service Error
unexpected error response
{- "asyncResult": true,
- "filters": [
- {
- "field": "string",
- "type": "integer",
- "value": "string"
}
], - "pagination": {
- "ItemsPerPage": 20,
- "PageNumber": 1,
- "SortColumn": "",
- "SortDirection": "asc",
- "TotalItems": 20,
- "TotalPages": 1
}, - "resultToken": "string",
- "searchStart": 0,
- "timeout": 19
}
{- "code": "Success",
- "message": "string",
- "continuation": {
- "search_start": 999999999
}, - "invoice_list": [
- {
- "amount": -999999999.99,
- "attachmentCount": 6,
- "authorizedAt": "2020-07-21 17:32:28Z",
- "baseAmt": -999999999.99,
- "comments": "string",
- "company": {
- "id": "string",
- "logoUrl": "string",
- "name": "string",
- "phone": "string",
- "publicId": 999999999,
- "type": ""
}, - "convFee": -999999999.99,
- "convFeeDisable": true,
- "createdAt": "2020-07-21 17:32:28Z",
- "customFields": { },
- "customer": {
- "city": "string",
- "companyId": "string",
- "contactEmail": "string",
- "contactPhone": "string",
- "customerCompanyId": "string",
- "id": "string",
- "name": "string",
- "nickname": "string",
- "publicId": 999999999,
- "state": "AL"
}, - "customerId": "string",
- "deletedAt": "2020-07-21 17:32:28Z",
- "deletionReason": "",
- "department": {
- "id": "string",
- "locationId": "string",
- "name": "string"
}, - "depositStatus": "",
- "description": "string",
- "files": [
- {
- "fileId": "string",
- "fileName": "string",
- "invoiceFileId": "string",
- "invoiceId": "string",
- "type": ""
}
], - "id": "string",
- "initialType": "",
- "invoiceNumber": 999999999,
- "lineItems": [
- {
- "cost": -999999999.99,
- "description": "string",
- "isTaxable": true,
- "product": {
- "accountingProducts": [
- {
- "externalId": null,
- "featureType": null
}
], - "cost": -999999999.99,
- "generalLedger": "string",
- "id": "string",
- "isTaxable": true,
- "locationId": "string",
- "name": "string",
- "parentId": "string",
- "parentPath": "string",
- "selectType": "",
- "type": "service",
- "weight": 999999999
}, - "productId": "string",
- "qty": -999999999.99,
- "type": "service"
}
], - "location": {
- "city": "string",
- "companyId": "string",
- "customFields": [
- {
- "deletedAt": "2020-07-21 17:32:28Z",
- "id": "string",
- "isRequired": true,
- "isShownInList": true,
- "name": "string",
- "options": { },
- "title": "string",
- "type": ""
}
], - "id": "string",
- "name": "string",
- "state": "AL",
- "timezone": "US/Hawaii"
}, - "payerEmail": "string",
- "payerName": "string",
- "payerPhone": "string",
- "paymentError": "",
- "publicId": 999999999,
- "receipt": {
- "url": "string"
}, - "sentAt": "2020-07-21 17:32:28Z",
- "shift": {
- "id": "string",
- "locationId": "string",
- "name": "string"
}, - "status": "",
- "subtype": "string",
- "temporaryCustomerName": "string",
- "timezone": "US/Hawaii",
- "token": "string",
- "type": "",
- "updatedAt": "2020-07-21 17:32:28Z",
- "user": {
- "avatarUrl": "string",
- "email": "string",
- "first": "string",
- "id": "string",
- "isVerified": true,
- "last": "string",
- "phone": "string"
}, - "userId": "string",
- "workOrderId": "string",
- "workflowStatus": ""
}
], - "pagination": {
- "ItemsPerPage": 20,
- "PageNumber": 1,
- "SortColumn": "",
- "SortDirection": "asc",
- "TotalItems": 20,
- "TotalPages": 1
}, - "parameters": { },
- "result_token": "string",
- "stats": { }
}