Journal Entries

GET /accounting/journal-entries

Group: Accounting › Journal Entries · Operation ID: journalEntries

Returns a list of journal entries, each as a header without its lines. To read an entry with its lines, use GET accounting/journal-entries/:id or POST accounting/journal-entries/search.

Open in the interactive reference

Parameters

Name	In	Type	Required	Description
`Api-Version`	header	`"v1"`	yes	The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version `v1`.

Query surface

id — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
status — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
type — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
postingDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
bookName — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
lastModifiedDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
Orderable: id, status, type, postingDate, bookName, lastModifiedDate
Selectable: id, name, status, type, approvalStatus, postingDate, reversalDate, reversalReason, reversalDescription, description, url, bookName, lastModifiedDate

Response

200 Success

Under data, an array of journalEntriesRow:

Field	Type	Required	Description
`id`	string	no	The unique identifier for the journal entry.
`name`	string or null	no	The display name of the journal entry.
`status`	string	no	The posting status of the journal entry. Possible values: 'posted', 'unposted', 'voided'.
`type`	string or null	no	How the entry originated, for example 'manual', 'invoice', 'revaluation' or 'reversal'. A system-assigned value.
`approvalStatus`	string or null	no	The approval status of the journal entry. Possible values: 'draft', 'pendingApproval', 'revise', 'approved', 'rejected'. Absent on entries that never entered the approval workflow.
`postingDate`	string (date)	no	The date the entry posts to the general ledger. Format YYYY-MM-DD.
`reversalDate`	string (date) or null	no	The reversal date recorded on the entry. Format YYYY-MM-DD. Set only on a reversed entry or a reversal entry.
`reversalReason`	string or null	no	The reason recorded for the reversal. Possible values: 'accrualReversal', 'revaluationReversal', 'estimate', 'rebook', 'reversingSFD', 'other'.
`reversalDescription`	string or null	no	The description recorded on the reversal.
`description`	string or null	no	A free-form description of the journal entry.
`url`	string or null	no	A link to the source document this entry comes from.
`bookName`	string or null	no	The name of the accounting book this entry posts to. See name on GET accounting/books/:id.
`lastModifiedDate`	string (date-time)	no	The date and time the journal entry last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.

Statuses

400 — Invalid request or business failure
401 — Missing or invalid access token
403 — Not authorized
404 — Not found
429 — Too many requests
500 — Internal server error