v1

latestOpenAPI 3.0.32026-07-268955212.1 KB
journal-entries

Get journal entries

Get journal entries for the company. Use the query parameters to filter and navigate through the results. Scope: journal-entries:read

get/companies/{companyId}/journal-entries

Query parameters

pageinteger

Page number

pageSizeinteger

Number of items per page

querystring

Optional query to filter the data set with supported fields listed below and available operations.

FieldType
titlestring
journalEntryNumberstring
datedate
reversingJournalEntryIdstring
reversedByJournalEntryIdstring
tagIdstring uuid

[Preview] Filter journal entries by tag. Returns only journal entries that have the specified tag applied, either at the journal entry level or at the line item level.

Requires the Tags feature to be enabled in the company's price plan.

Response

Journal entries found

totalItemsinteger
totalPagesinteger
currentPageinteger

Example response

{
  "totalItems": 1,
  "totalPages": 1,
  "currentPage": 1,
  "items": [
    {
      "id": "a419cf69-db6f-4de9-992c-b1a60942a443",
      "title": "invoice 1234",
      "journalEntryNumber": "V342",
      "date": "2024-10-10",
      "items": [
        {
          "id": 1,
          "debit": 200,
          "credit": 0,
          "account": 1930,
          "tags": []
        },
        {
          "id": 2,
          "debit": 0,
          "credit": 40,
          "account": 3011,
          "tags": []
        },
        {
          "id": 3,
          "debit": 0,
          "credit": 160,
          "account": 2611,
          "tags": []
        }
      ],
      "tags": []
    }
  ]
}
All 89 operations