adjustments_get_list
Retrieve a filtered list of adjustments from ServiceTitan using criteria like date ranges, IDs, or custom fields, with options for sorting and pagination.
Input Schema
Name | Required | Description | Default |
---|---|---|---|
active | No | What kind of items should be returned (only active items will be returned by default) Values: [True, Any, False] | |
adjustmentTypes | No | Filter by a collection of adjustment types | |
batchId | No | Format - int64. BatchId filter | |
businessUnitIds | No | Filter by a collection of business unit Ids | |
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) | |
customFields.Fields | No | Collection of custom field pairs (name, value) to filter by | |
customFields.Operator | No | Can be "Or" or "And" Values: [And, Or] | |
dateBefore | No | Format - date-time (as date-time in RFC3339). Return adjustments with date before certain date/time | |
dateOnOrAfter | No | Format - date-time (as date-time in RFC3339). Return adjustments with date on or after certain date/time | |
externalDataApplicationGuid | No | Format - guid. If this guid is provided, external data corresponding to this application guid will be returned. | |
externalDataKey | No | Performs lookup by external data key, 'externalDataValues' must also be provided. | |
externalDataValues | No | Performs lookup by external data values (maximum 50), 'externalDataKey' must also be provided. | |
ids | No | Perform lookup by multiple IDs (maximum 50) | |
includeTotal | No | Whether total count should be returned | |
inventoryLocationIds | No | Filter by a collection of inventory location Ids | |
invoiceIds | No | Filter by a collection of invoice Ids | |
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 | Number filter | |
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) | |
referenceNumber | No | Reference number filter | |
sort | No | Applies sorting by the specified field: "?sort=+FieldName" for ascending order, "?sort=-FieldName" for descending order. Available fields are: Id, ModifiedOn, CreatedOn. | |
syncStatuses | No | Filter by a collection of sync statues | |
tenant | Yes | Format - int64. Tenant ID |