RIrillet
Journal Entries

Lists all journal entries

Changed on

Returns GL journal entries with rich filtering (subsidiary, account, date range, reconciliation state). Use entry ids with retrieve-a-journal-entry before attempting updates or deletes.

get/journal-entries

Request

Query parameters

limitinteger

Maximum number of rows to return in the page.

cursorstring

If defined, a cursor to retrieve the next page.

Example:iLQvkEj3sh3UiweC

Pagination cursor to navigate through the full response.

subsidiary_idstring uuid

Subsidiary to be used when filtering data

book_idstring uuid

Book ID to filter journal entries by. Primary books return primary entries only; adjustment-overlay books return primary and adjustment entries.

updated.gtstring date-time
Example:2023-01-01T00:00:00Z

Filter journal entries updated after this timestamp

date.gtestring date
Example:2023-12-01

Filter journal entries with a posting date on or after this date (inclusive)

date.ltestring date
Example:2023-12-31

Filter journal entries with a posting date on or before this date (inclusive)

account_idsstring[]

Filter journal entries that have at least one line item posting to any of these account ids (comma-separated)

sort_by'created' | 'updated'

the field the journal entries should be sorted by descending (either created or updated)

Response

OK

Example response

{
  "journal_entries": [
    {
      "currency": "USD",
      "items": [
        {
          "amount": {
            "amount": "1.01",
            "currency": "USD"
          },
          "original_transaction_amount": {
            "amount": "1.01",
            "currency": "USD"
          },
          "account_code": "11112"
        }
      ],
      "exchange_rate": {
        "base": "USD",
        "target": "USD"
      }
    }
  ],
  "pagination": {
    "next_cursor": "iLQvkEj3sh3UiweC"
  }
}

Changes

  • c393d0102005Revision changes
    • info

      added the new optional query request parameter book_id

    • info

      added the required property // to the response with the status