journal_entries_get_list
Retrieve a list of journal entries from ServiceTitan based on filters like IDs, dates, statuses, or custom fields. Supports sorting, pagination, and filtering by transactions, customers, vendors, or business units.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| businessUnitIds | No | Comma-delimited list of business unit IDs, maximum 50 items | |
| createdBefore | No | Return items created before certain date/time (in UTC) | |
| createdOnOrAfter | No | Return items created on or after certain date/time (in UTC) | |
| customField | No | Filter by custom fields associated with journal entries. Example: ?customField.fieldName1=value1&customField.fieldName2=value2. A field with null value, and a non-existent field are treated equally. Maximum 5 custom fields are supported in one request. | |
| customerName | No | Contains a transaction for a customer with name containing | |
| exportedBy | No | Comma-delimited list of user IDs, maximum 50 items | |
| exportedFrom | No | Exported on or after certain date/time (in UTC) | |
| exportedTo | No | Exported on or before certain date/time (in UTC) | |
| ids | No | Comma-delimited list of journal entry IDs, maximum 50 items | |
| includeTotal | No | Whether total count should be returned | |
| inventoryLocationName | No | Contains a transaction for an inventory location with name containing | |
| locationName | No | Contains a transaction for a customer location with name containing | |
| modifiedBefore | No | Return items modified before certain date/time (in UTC) | |
| modifiedOnOrAfter | No | Return items modified on or after certain date/time (in UTC) | |
| name | No | Name contains | |
| numberFrom | No | Number is greater or equal than | |
| numberTo | No | Number is less or equal to | |
| page | No | The logical number of page to return, starting from 1 | |
| pageSize | No | How many records to return (50 by default). Maximum value is 500. | |
| postedFrom | No | Posted on or after certain date/time (in UTC) | |
| postedTo | No | Posted on or before certain date/time (in UTC) | |
| refNumber | No | Contains a transaction with reference number containing | |
| serviceAgreementIds | No | Comma-delimited list of service agreement IDs, maximum 50 items | |
| sort | No | Applies sorting by the specified field and direction. Options: Id, Number, Name, Status, CreatedOn, ExportedOn, ExportedBy, PostDate. Use "+" for ascending order, and "-" for descending order. Example: "?sort=-Number" will sort by number in descending order. | |
| statuses | No | Array of statuses | |
| syncStatuses | No | Array of sync statuses | |
| tenant | Yes | Tenant ID | |
| transactionPostedFrom | No | Contains a transaction posted on or after certain date/time (in UTC) | |
| transactionPostedTo | No | Contains a transaction posted on or before certain date/time (in UTC) | |
| transactionTypes | No | List of transaction types. A journal entry will be returned if it contains at least one transaction of this type. | |
| vendorName | No | Contains a transaction for a vendor with name containing |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"businessUnitIds": {
"description": "Comma-delimited list of business unit IDs, maximum 50 items",
"type": "string"
},
"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"
},
"customField": {
"additionalProperties": {
"type": "string"
},
"description": "Filter by custom fields associated with journal entries. Example: ?customField.fieldName1=value1&customField.fieldName2=value2. A field with null value, and a non-existent field are treated equally. Maximum 5 custom fields are supported in one request.",
"type": "object"
},
"customerName": {
"description": "Contains a transaction for a customer with name containing",
"maxLength": 255,
"type": "string"
},
"exportedBy": {
"description": "Comma-delimited list of user IDs, maximum 50 items",
"type": "string"
},
"exportedFrom": {
"description": "Exported on or after certain date/time (in UTC)",
"format": "date-time",
"type": "string"
},
"exportedTo": {
"description": "Exported on or before certain date/time (in UTC)",
"format": "date-time",
"type": "string"
},
"ids": {
"description": "Comma-delimited list of journal entry IDs, maximum 50 items",
"type": "string"
},
"includeTotal": {
"description": "Whether total count should be returned",
"type": "boolean"
},
"inventoryLocationName": {
"description": "Contains a transaction for an inventory location with name containing",
"maxLength": 255,
"type": "string"
},
"locationName": {
"description": "Contains a transaction for a customer location with name containing",
"maxLength": 255,
"type": "string"
},
"modifiedBefore": {
"description": "Return items modified before certain date/time (in UTC)",
"format": "date-time",
"type": "string"
},
"modifiedOnOrAfter": {
"description": "Return items modified on or after certain date/time (in UTC)",
"format": "date-time",
"type": "string"
},
"name": {
"description": "Name contains",
"maxLength": 255,
"type": "string"
},
"numberFrom": {
"description": "Number is greater or equal than",
"type": "integer"
},
"numberTo": {
"description": "Number is less or equal to",
"type": "integer"
},
"page": {
"description": "The logical number of page to return, starting from 1",
"type": "integer"
},
"pageSize": {
"description": "How many records to return (50 by default). Maximum value is 500.",
"type": "integer"
},
"postedFrom": {
"description": "Posted on or after certain date/time (in UTC)",
"format": "date-time",
"type": "string"
},
"postedTo": {
"description": "Posted on or before certain date/time (in UTC)",
"format": "date-time",
"type": "string"
},
"refNumber": {
"description": "Contains a transaction with reference number containing",
"maxLength": 255,
"type": "string"
},
"serviceAgreementIds": {
"description": "Comma-delimited list of service agreement IDs, maximum 50 items",
"type": "string"
},
"sort": {
"description": "Applies sorting by the specified field and direction. Options: Id, Number, Name, Status, CreatedOn, ExportedOn, ExportedBy, PostDate. Use \"+\" for ascending order, and \"-\" for descending order. Example: \"?sort=-Number\" will sort by number in descending order.",
"type": "string"
},
"statuses": {
"description": "Array of statuses",
"items": {
"type": "string"
},
"maxItems": 50,
"type": "array"
},
"syncStatuses": {
"description": "Array of sync statuses",
"items": {
"type": "string"
},
"maxItems": 50,
"type": "array"
},
"tenant": {
"description": "Tenant ID",
"type": "integer"
},
"transactionPostedFrom": {
"description": "Contains a transaction posted on or after certain date/time (in UTC)",
"format": "date-time",
"type": "string"
},
"transactionPostedTo": {
"description": "Contains a transaction posted on or before certain date/time (in UTC)",
"format": "date-time",
"type": "string"
},
"transactionTypes": {
"description": "List of transaction types. A journal entry will be returned if it contains at least one transaction of this type.",
"items": {
"type": "string"
},
"maxItems": 50,
"type": "array"
},
"vendorName": {
"description": "Contains a transaction for a vendor with name containing",
"maxLength": 255,
"type": "string"
}
},
"required": [
"tenant"
],
"type": "object"
}