GET
List journal entries (organization)
Organization space Accounting module For: Accountant · Permission: journal_entries.list Conditions
  • The accounting module must be included in the plan of the organization.
  • In the organization space the caller needs an accounting access grant on the book named in the URL.
  • The book must be set up for accounting (it must have at least one journal).
  • Only entries of the selected book are listed.
  • When both from and to are sent, to must not be before from.
Part of Record and correct entries.

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 (a 27-character KSUID): the organization itself or one of its companies. The caller must hold an accounting access grant on it.

Query Parameters

per_page
integer | null

Number of items per page.

Required range: 1 <= x <= 100
cursor
string | null

Position in the list. Pass the meta.next_cursor or meta.prev_cursor value of the previous page; leave it out to get the first page.

sort_by
enum<string> | null

Field the list is sorted by.

Available options:
accounting_date,
created_at
sort_order
enum<string> | null

asc for ascending order, desc for descending order.

Available options:
asc,
desc
fiscal_period_id
string | null

Only entries posted in this fiscal period (27-character KSUID).

journal_id
string | null

Only entries posted in this journal (27-character KSUID).

account
string | null

Identifier of an accounting account: only entries having at least one line on this account.

source_type
string | null

Only entries generated from this kind of source record (for example reversal, opening_balances or recurring_entry); manual entries have no source.

source_id
string | null

Only entries whose source record has this identifier. Usually combined with source_type.

status
enum<string> | null

Only entries with this status: posted (in force), reversed (cancelled by a reversal entry) or refunded.

Available options:
posted,
reversed,
refunded
from
string<date-time> | null

Start of the date range: only entries with an accounting date on or after this date (ISO 8601).

to
string<date-time> | null

End of the date range: only entries with an accounting date on or before this date (ISO 8601). Must not be before from.

response
enum<string>
default:resource

Response mode. Default resource; none answers 204 No Content.

Available options:
resource
fields
string

Comma-separated JSON keys of the root resource (id is always rendered). Available: id, owner_type, journal_id, fiscal_period_id, accounting_date, reference, description, source_type, source_id, source_event, metadata, currency_code, currency_exponent, status, reversal_of_entry_id, refund_of_entry_id, posted_at, created_at, updated_at, attachments_count.

include
string

Comma-separated include paths, each optionally followed by its fields in parentheses: units(id,sku),units.uomUnit(id,name). Max depth 6, max 40 paths. Available: lines, lines.account, attachments.

Response

Resource.

data
JournalEntryResource · object[]
required

Items of this page.

meta
object
required

Pagination details.