paymentterms_getlist
Retrieve a filtered list of payment terms within ServiceTitan by tenant ID, creation/modification dates, IDs, or sorting criteria to manage and analyze payment data efficiently.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| createdBefore | No | Return items created before certain date/time (in UTC) | |
| createdOnOrAfter | No | Return items created on or after certain date/time (in UTC) | |
| ids | No | Perform lookup by multiple IDs (maximum 50) | |
| includeTotal | No | Whether total count should be returned | |
| modifiedBefore | No | ||
| modifiedOnOrAfter | No | ||
| page | No | The logical number of page to return, starting from 1 | |
| pageSize | No | How many records to return (50 by default) | |
| sort | No | Applies sorting by the specified field: "?sort=+FieldName" for ascending order, "?sort=-FieldName" for descending order. Available fields are: Id, Name, CreatedOn. | |
| tenant | Yes | Tenant ID |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"createdBefore": {
"description": "Return items created before certain date/time (in UTC)",
"format": "date-time",
"type": "string"
},
"createdOnOrAfter": {
"description": "Return items created on or after certain date/time (in UTC)",
"format": "date-time",
"type": "string"
},
"ids": {
"description": "Perform lookup by multiple IDs (maximum 50)",
"type": "string"
},
"includeTotal": {
"description": "Whether total count should be returned",
"type": "boolean"
},
"modifiedBefore": {
"format": "date-time",
"type": "string"
},
"modifiedOnOrAfter": {
"format": "date-time",
"type": "string"
},
"page": {
"description": "The logical number of page to return, starting from 1",
"type": "integer"
},
"pageSize": {
"description": "How many records to return (50 by default)",
"type": "integer"
},
"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, Name, CreatedOn.",
"type": "string"
},
"tenant": {
"description": "Tenant ID",
"type": "integer"
}
},
"required": [
"tenant"
],
"type": "object"
}