GET
Download journal entries file (organization)
Organization space Accounting module For: Accountant · Permission: journal_entries.export Conditions
  • The accounting module must be part of the organization’s plan.
  • In the organization space, the caller must have access to the book.
  • The book must have accounting set up.
  • fiscal_year_id is required and must be a fiscal year of the book.
  • journal_id, when sent, must be a journal of the book.
  • to, when sent, must not be before from.
Part of Export and share accounting files.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

book
string
required

Identifier of the accounting book in the organization space: the organization itself or one of its companies, among the books the caller has access to.

Query Parameters

fiscal_year_id
string
required

Identifier of the fiscal year to export (27-character KSUID string). Required; it must be a fiscal year of the selected book.

journal_id
string | null

Restricts the file to one journal of the selected book (27-character KSUID string). All journals when omitted.

from
string<date> | null

First accounting date to include, in YYYY-MM-DD. Clamped to the start of the fiscal year; the fiscal year start when omitted.

to
string<date> | null

Last accounting date to include, in YYYY-MM-DD; must not be before from. Clamped to the end of the fiscal year; the fiscal year end when omitted.

Response

The response is of type string.