invoices_getlist
Retrieve and filter invoices from ServiceTitan based on criteria such as ID, date ranges, status, and assigned entities for efficient invoice management.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| adjustmentToId | No | Format - int64. When searching for adjustment invoices, this field will search for invoices that are adjustments to the specified invoice ID. | |
| assignedToIds | No | AssignedTo IDs associated with invoices. | |
| balanceFilter.Balance | No | Format - decimal. | |
| balanceFilter.Comparer | No | Values: [Equals, NotEquals, Greater, Less] | |
| batchId | No | Format - int64. Batch ID associated with invoices. | |
| batchNumber | No | Format - int32. Batch number associated with invoices. | |
| businessUnitId | No | Format - int64. Business unit ID associated with invoices. | |
| createdBefore | No | Format - date-time (as date-time in RFC3339). Return items created before certain date/time (in UTC) | |
| createdOnOrAfter | No | Format - date-time (as date-time in RFC3339). Return items created on or after certain date/time (in UTC) | |
| customField.Fields | No | Dictionary of name-value pairs | |
| customField.Operator | No | Operator to be used between the name-value pairs. Can be "Or" or "And", default is "And".\ Values: [And, Or] | |
| customerId | No | Format - int64. Customer ID associated with invoices. | |
| dueDateBefore | No | Format - date-time (as date-time in RFC3339). Retrieve all invoices with a due date before the input value | |
| dueDateOnOrAfter | No | Format - date-time (as date-time in RFC3339). Retrieve all invoices with a due date on after or equal the input value | |
| ids | No | Comma-delimited list of invoice IDs. | |
| includeTotal | No | Whether total count should be returned | |
| invoicedOnBefore | No | Format - date-time (as date-time in RFC3339). | |
| invoicedOnOrAfter | No | Format - date-time (as date-time in RFC3339). | |
| jobId | No | Format - int64. Job ID associated with invoices. This will be null if the invoice is not linked to a job. | |
| jobNumber | No | Job number associated with invoices. This will be null if the invoice is not linked to a job. | |
| modifiedBefore | No | Format - date-time (as date-time in RFC3339). Return items modified before certain date/time (in UTC) | |
| modifiedOnOrAfter | No | Format - date-time (as date-time in RFC3339). Return items modified on or after certain date/time (in UTC) | |
| number | No | Reference number associated with invoices. | |
| orderBy | No | Field on which you want to order the returned list of invoices. | |
| orderByDirection | No | Order direction of the retuned list of invoices. Values of "desc" or "descending" will order the list in descending order, otherwise the list will be ordered in ascending order. | |
| page | No | Format - int32. The logical number of page to return, starting from 1 | |
| pageSize | No | Format - int32. How many records to return (50 by default) | |
| reviewStatuses | No | Review statuses associated with invoices. | |
| sort | No | Applies sorting by the specified field: "?sort=+FieldName" for ascending order, "?sort=-FieldName" for descending order.' | |
| statuses | No | Transaction status, which can be one of: Pending, Posted, Exported. By default, all transaction statuses are included. If you want to filter by more than one status, add a new "statuses" query parameter for each status you want to include. For example: &statuses=Pending&statuses=Posted | |
| tenant | Yes | Format - int64. Tenant ID | |
| totalGreater | No | Format - decimal. Retrieve all invoices with a total greater than or equal to the input value. | |
| totalLess | No | Format - decimal. Retrieve all invoices with a total less than or equal to the input value. |