Get a paged list of existing ledger accounts, optionally filtered to the given parameters.
Get Ledger Accounts Filtered and Paged (POST)
This endpoint returns a paged list of existing ledger accounts, the accounts that make up the chart of accounts used to categorize financial transactions across journal posts, budgets, and invoice lines.
Developers call it to search the chart of accounts by code or name, to retrieve accounts for reconciliation or mapping purposes, or to populate account selection lists in an integration.
Results can be filtered, sorted, and paged, and an empty filter returns the full account list according to the given paging settings.
Request Fields
Field | Type | Required | Description |
|---|---|---|---|
paging | Object | No | Paging settings for the result set. Omit to use default paging behavior. |
paging.pageSize | Integer | No | Number of records to return per page. Minimum 1, maximum 1000. |
paging.pageNumber | Integer | No | Page number to retrieve, starting at 1. Maximum 9999. |
sorting | Object | No | Sorting settings for the result set. |
sorting.columnName | String | No | Name of the field to sort by. |
sorting.order | Integer (enum) | No | Sort direction. Allowed values: 0 (Ascending), 1 (Descending). |
filter | Object | No | Filter criteria. Omit or leave fields empty to match all ledger accounts. |
filter.code | String | No | Filters on the ledger account code. Matches the code field returned in the response. |
filter.name | String | No | Filters on the ledger account name. |
filter.lastModified.from | String (date-time) | No | Lower bound of the last modified date range, ISO 8601, UTC. |
filter.lastModified.to | String (date-time) | No | Upper bound of the last modified date range, ISO 8601, UTC. |
Response Fields
Field | Type | Required | Description |
|---|---|---|---|
paging | Object | No | Echoes the paging settings applied to this result set. |
paging.pageSize | Integer | No | Number of records returned per page. |
paging.pageNumber | Integer | No | Page number of this result set. |
sorting | Object | No | Echoes the sorting settings applied to this result set. |
sorting.columnName | String | No | Name of the field the results are sorted by. |
sorting.order | Integer (enum) | No | Sort direction applied. Allowed values: 0 (Ascending), 1 (Descending). |
ledgerAccounts | Array | No | List of ledger accounts matching the filter, for the requested page. |
ledgerAccounts[].code | String | No | Ledger account code. Maximum length 12 characters. Used to reference this account from journal posts, budget lines, and invoice lines. |
ledgerAccounts[].name | String | No | Ledger account name. Maximum length 256 characters. |
ledgerAccounts[].lastModified | String (date-time) | No | Date and time the ledger account was last modified, ISO 8601, UTC. |
Ascending = 0 Descending = 1
OK
Ascending = 0 Descending = 1