payments_get_list
Retrieve and filter payment records from ServiceTitan by criteria such as date, customer ID, invoice status, and transaction type for efficient payment management.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| appliedToInvoiceIds | No | ||
| appliedToReferenceNumber | No | ||
| batchId | No | Format - int64. | |
| batchNumber | No | Format - int32. | |
| businessUnitIds | No | ||
| 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. | |
| ids | No | Perform lookup by multiple IDs (maximum 50) | |
| includeTotal | No | Whether total count should be returned | |
| 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) | |
| 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) | |
| paidOnAfter | No | Format - date-time (as date-time in RFC3339). | |
| paidOnBefore | No | Format - date-time (as date-time in RFC3339). | |
| sort | No | Applies sorting by the specified field: "?sort=+FieldName" for ascending order, "?sort=-FieldName" for descending order. | |
| statuses | No | ||
| tenant | Yes | Format - int64. Tenant ID | |
| totalGreater | No | Format - decimal. | |
| totalLess | No | Format - decimal. | |
| transactionType | No | Values: [Undefined, JournalEntry, ReceivePayment] |