GET All Journals

Production

GET

/journals{format}

Returns a paginated list of journal entries. Results are ordered by date (newest first) by default and can be narrowed with the filter parameters below. Non-owner staff see only the journals they are permitted to view.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Query Params

Header Params

Responses

🟢200OK

application/json

Bodyapplication/json

🟠401Unauthorized

🟠403Forbidden

Request Example

Shell

JavaScript

Java

Swift

curl --location '/journals.json?sort=date&direction=desc' \
--header 'Accept: application/json' \
--header 'apikey: ' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json'

Response Example

200 - Example 1

{
    "result": "successful",
    "code": 200,
    "data": [
        {
            "Journal": {
                "id": 0,
                "number": "string",
                "date": "2026-05-10",
                "description": "string",
                "alter_description": "string",
                "entity_type": "string",
                "entity_id": "string",
                "draft": 0,
                "is_automatic": 0,
                "staff_id": 0,
                "total_debit": 0,
                "total_credit": 0,
                "currency_code": "USD",
                "currency_rate": 0,
                "created": "2019-08-24T14:15:22.123Z",
                "modified": "2019-08-24T14:15:22.123Z",
                "JournalTransaction": [
                    {
                        "id": 0,
                        "journal_id": "string",
                        "journal_account_id": "string",
                        "debit": 0,
                        "credit": 0,
                        "currency_debit": 0,
                        "currency_credit": 0,
                        "description": "string"
                    }
                ]
            }
        }
    ],
    "pagination": {
        "prev": null,
        "next": "/api2/journals/?page=2",
        "page": 1,
        "page_count": 5,
        "total_results": 98
    }
}

Edit Journals

GET Single Journal