GlAccounts_GetList
Retrieve a list of GL accounts by specifying filters like IDs, names, types, activity status, or creation/modification dates. Supports pagination and sorting for efficient account management within ServiceTitan.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| active | No | Specify if only active accounts, only inactive accounts, or both, should be retrieved. By default, only active accounts will be retrieved. Values: [True, Any, False] | |
| 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) | |
| description | No | A substring that must be contained in the account description | |
| ids | No | Comma-delimited list of account IDs, maximum 50 items | |
| includeTotal | No | Whether total count should be returned | |
| isIntacctBankAccount | No | Set to true to retrieve Intacct bank accounts only | |
| isIntacctGroup | No | Set to true to retrieve Intacct group accounts only | |
| 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) | |
| names | No | Comma-delimited list of account names, maximum 50 items | |
| numbers | No | Comma-delimited list of account numbers, maximum 50 items | |
| 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) | |
| sort | No | Applies sorting by specified fields | |
| source | No | Account source Values: [Undefined, AccountingSystem, ManuallyCreated, PublicApi] | |
| subtypes | No | Comma-delimited list of account subtypes, maximum 50 items | |
| tenant | Yes | Format - int64. Tenant ID | |
| types | No | Comma-delimited list of account types, maximum 50 items |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"active": {
"description": "Specify if only active accounts, only inactive accounts, or both, should be retrieved.\nBy default, only active accounts will be retrieved.\nValues: [True, Any, False]",
"type": [
"string",
"null"
]
},
"createdBefore": {
"description": "Format - date-time (as date-time in RFC3339). Return items created before certain date/time (in UTC)",
"type": [
"string",
"null"
]
},
"createdOnOrAfter": {
"description": "Format - date-time (as date-time in RFC3339). Return items created on or after certain date/time (in UTC)",
"type": [
"string",
"null"
]
},
"description": {
"anyOf": [
{
"maxLength": 255,
"type": "string"
},
{
"type": "null"
}
],
"description": "A substring that must be contained in the account description"
},
"ids": {
"description": "Comma-delimited list of account IDs, maximum 50 items",
"type": [
"string",
"null"
]
},
"includeTotal": {
"description": "Whether total count should be returned",
"type": [
"boolean",
"null"
]
},
"isIntacctBankAccount": {
"description": "Set to true to retrieve Intacct bank accounts only",
"type": [
"boolean",
"null"
]
},
"isIntacctGroup": {
"description": "Set to true to retrieve Intacct group accounts only",
"type": [
"boolean",
"null"
]
},
"modifiedBefore": {
"description": "Format - date-time (as date-time in RFC3339). Return items modified before certain date/time (in UTC)",
"type": [
"string",
"null"
]
},
"modifiedOnOrAfter": {
"description": "Format - date-time (as date-time in RFC3339). Return items modified on or after certain date/time (in UTC)",
"type": [
"string",
"null"
]
},
"names": {
"description": "Comma-delimited list of account names, maximum 50 items",
"type": [
"string",
"null"
]
},
"numbers": {
"description": "Comma-delimited list of account numbers, maximum 50 items",
"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)"
},
"sort": {
"description": "Applies sorting by specified fields",
"type": [
"string",
"null"
]
},
"source": {
"description": "Account source\nValues: [Undefined, AccountingSystem, ManuallyCreated, PublicApi]",
"type": [
"string",
"null"
]
},
"subtypes": {
"description": "Comma-delimited list of account subtypes, maximum 50 items",
"type": [
"string",
"null"
]
},
"tenant": {
"description": "Format - int64. Tenant ID",
"type": "integer"
},
"types": {
"description": "Comma-delimited list of account types, maximum 50 items",
"type": [
"string",
"null"
]
}
},
"required": [
"tenant"
],
"type": "object"
}