> ## Documentation Index
> Fetch the complete documentation index at: https://www.bloxs.io/llms.txt
> Use this file to discover all available pages before exploring further.
# Get journals filtered and paged
> Get a paged list of existing journals, optionally filtered to the given parameters.
## OpenAPI
````json POST /api/v1/finance/journals/filter
{
"openapi": "3.0.4",
"info": {
"title": "Invoices V1",
"description": "Welcome to BETA version of the new Invoices API - intended for client public testing before the launch of the final version. During this BETA phase, we'll be improving the API based on specific client's feedbacks.",
"version": "v1"
},
"security": [
{}
],
"tags": [
{
"name": "Budgets"
},
{
"name": "Compactions"
},
{
"name": "ConceptPurchaseInvoices"
},
{
"name": "JournalPosts"
},
{
"name": "Journals"
},
{
"name": "LedgerAccounts"
},
{
"name": "Metadata"
},
{
"name": "PaymentReminders"
},
{
"name": "PurchaseInvoices"
},
{
"name": "PurchaseOrders"
},
{
"name": "SalesInvoices"
},
{
"name": "SalesInvoiceServices"
}
],
"paths": {
"/api/v1/finance/journals/filter": {
"post": {
"tags": [
"Journals"
],
"summary": "Get journals filtered and paged",
"description": "Get a paged list of existing journals, optionally filtered to the given parameters.",
"operationId": "GetJournalsFilteredPaged",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JournalSearchRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JournalSearchResult"
}
}
}
}
},
"x-d360-narrative-url": "Get Journals Filtered and Paged (POST)
This endpoint returns a paged list of existing journals, the categories used to group journal posts, such as a sales journal, purchase journal, or bank journal.
Developers call it to look up the available journals by code or name, for example when validating or mapping the journalCode used when creating a journal post.
Results can be filtered, sorted, and paged, and an empty filter returns the full list of journals 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 journals. |
filter.code | String | No | Filters on the journal code. Matches the code field returned in the response. |
filter.name | String | No | Filters on the journal 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). |
journals | Array | No | List of journals matching the |