adjustments_get_list
Retrieve a list of adjustments from ServiceTitan using filters like IDs, dates, adjustment types, and custom fields. Supports pagination and sorting for efficient data management.
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 |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"active": {
"description": "What kind of items should be returned (only active items will be returned by default)\nValues: [True, Any, False]",
"type": [
"string",
"null"
]
},
"adjustmentTypes": {
"description": "Filter by a collection of adjustment types",
"type": [
"string",
"null"
]
},
"batchId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Format - int64. BatchId filter"
},
"businessUnitIds": {
"description": "Filter by a collection of business unit Ids",
"type": [
"string",
"null"
]
},
"createdBefore": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"description": "Format - date-time (as date-time in RFC3339). Return items created before certain date/time (in UTC)"
},
"createdOnOrAfter": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"description": "Format - date-time (as date-time in RFC3339). Return items created on or after certain date/time (in UTC)"
},
"customFields.Fields": {
"description": "Collection of custom field pairs (name, value) to filter by",
"type": [
"string",
"null"
]
},
"customFields.Operator": {
"description": "Can be \"Or\" or \"And\"\nValues: [And, Or]",
"type": [
"string",
"null"
]
},
"dateBefore": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"description": "Format - date-time (as date-time in RFC3339). Return adjustments with date before certain date/time"
},
"dateOnOrAfter": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"description": "Format - date-time (as date-time in RFC3339). Return adjustments with date on or after certain date/time"
},
"externalDataApplicationGuid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"description": "Format - guid. If this guid is provided, external data corresponding to\nthis application guid will be returned."
},
"externalDataKey": {
"description": "Performs lookup by external data key, 'externalDataValues' must also be provided.",
"type": [
"string",
"null"
]
},
"externalDataValues": {
"description": "Performs lookup by external data values (maximum 50), 'externalDataKey' must also be provided.",
"type": [
"string",
"null"
]
},
"ids": {
"description": "Perform lookup by multiple IDs (maximum 50)",
"type": [
"string",
"null"
]
},
"includeTotal": {
"description": "Whether total count should be returned",
"type": [
"boolean",
"null"
]
},
"inventoryLocationIds": {
"description": "Filter by a collection of inventory location Ids",
"type": [
"string",
"null"
]
},
"invoiceIds": {
"description": "Filter by a collection of invoice Ids",
"type": [
"string",
"null"
]
},
"modifiedBefore": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"description": "Format - date-time (as date-time in RFC3339). Return items modified before certain date/time (in UTC)"
},
"modifiedOnOrAfter": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"description": "Format - date-time (as date-time in RFC3339). Return items modified on or after certain date/time (in UTC)"
},
"number": {
"description": "Number filter",
"type": [
"string",
"null"
]
},
"page": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Format - int32. The logical number of page to return, starting from 1"
},
"pageSize": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Format - int32. How many records to return (50 by default)"
},
"referenceNumber": {
"description": "Reference number filter",
"type": [
"string",
"null"
]
},
"sort": {
"description": "Applies sorting by the specified field:\n\"?sort=+FieldName\" for ascending order,\n\"?sort=-FieldName\" for descending order.\n\nAvailable fields are: Id, ModifiedOn, CreatedOn.",
"type": [
"string",
"null"
]
},
"syncStatuses": {
"description": "Filter by a collection of sync statues",
"type": [
"string",
"null"
]
},
"tenant": {
"description": "Format - int64. Tenant ID",
"type": "integer"
}
},
"required": [
"tenant"
],
"type": "object"
}