Get a paged list of existing ledger accounts, optionally filtered to the given parameters.
Description
This endpoint retrieves a paged list of existing ledger account codes and names from the financial accounting administration, filtered to the given parameters.
Use Case
The user wants to call the GET ledger account operation, however does not know which code to use for the specific ledger account. By using the filter operation and leaving 'code' and 'name' empty the user can retrieve the list of available codes.
Request fields
The request contains the following fields:
| Field | Description |
|---|---|
| pageSize | The maximum number of pages to be returned per request. The default number is 100 and the maximum is 1.000. If more results are returned than specified in the PageSize, the remaining pages are dropped based on the reference (number). |
| pageNumber | This allows the requesting party to specify which of the pages they want to receive. |
| columnName | The data field based on which sorting is applied. For example, if the results are sorted based on compaction code, columnName will contain the value 'compaction code'. |
| order | Based on this value, the property defined in 'columnName' is either sorted ascending (a-z) or descending (z-a). |
| code | Ledger account code. |
| name | Ledger account name. |
| lastModified.from | The last modified date. This defines the lower border of the range. |
| lastModified.to | The last modified date. This defines the upper border of the range. |
Response fields
The 200 response contains the fields in the table below. Please note that the response can contain multiple instances of ledger accounts. For the GET operation it gives a up-to-date insight in the data that is currently registered in Bloxs.
| Field | Description |
|---|---|
| pageSize | The maximum number of pages to be returned per request. The default number is 100 and the maximum is 1.000. If more results are returned than specified in the PageSize, the remaining pages are dropped based on the reference (number). |
| pageNumber | This allows the requesting party to specify which of the pages they want to receive. |
| columnName | The data field based on which sorting is applied. For example, if the results are sorted based on compaction code, columnName will contain the value 'compaction code'. |
| order | Based on this value, the property defined in 'columnName' is either sorted ascending (a-z) or descending (z-a). |
| code | Ledger account code. |
| name | Ledger account name. |
| lastModified | The last modified date. |
Please enter a valid token
OK