Get Journal Entry

GET /accounting/journal-entries/{id}

Group: Accounting › Journal Entries · Operation ID: getJournalEntry

Returns the journal entry with the given identifier, including its lines.

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.
id path string yes The unique identifier for the journal entry to return.

Response

200 Success

Under data (getJournalEntryOutput):

Field Type Required Description
id string yes The unique identifier for the journal entry.
approvalStatus string no The approval status of the journal entry. Possible values: 'draft', 'pendingApproval', 'revise', 'approved', 'rejected'. Absent on entries that never entered the approval workflow.
bookId string no The accounting book this entry posts to. See id on GET accounting/books/:id.
description string no A free-form description of the journal entry.
name string no The display name of the journal entry.
postingDate string (date) yes The date the entry posts to the general ledger. Format YYYY-MM-DD.
reversalDate string (date) no The reversal date recorded on the entry. Format YYYY-MM-DD. Set only on a reversed entry or a reversal entry.
reversalDescription string no The description recorded on the reversal.
reversalReason string no The reason recorded for the reversal. Possible values: 'accrualReversal', 'revaluationReversal', 'estimate', 'rebook', 'reversingSFD', 'other'.
status string yes The posting status of the journal entry. Possible values: 'posted', 'unposted', 'voided'.
type string no How the entry originated, for example 'manual', 'invoice', 'revaluation' or 'reversal'. A system-assigned value.
url string no A link to the source document this entry comes from.
lastModifiedDate string (date-time) yes The date and time the journal entry last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.
lines array of object yes The debit and credit lines of the entry.
lines[].id string yes The unique identifier for the line.
lines[].accountId string yes The general ledger account this line posts to. See id on GET accounting/accounts/:id.
lines[].credit string (decimal) no The credit amount for this line, in its transactionalCurrency. A line has either a debit or a credit, not both.
lines[].debit string (decimal) no The debit amount for this line, in its transactionalCurrency. A line has either a debit or a credit, not both.
lines[].description string no A free-form description of the line.
lines[].entityId string yes The legal entity this line posts to. See id on GET base/entities.
lines[].intercompanyPartnerId string no The intercompany counterparty for this line. Set on intercompany lines.
lines[].exchangeRate string (decimal) no The exchange rate used to convert the line's transactional amount to its functional amount.
lines[].functionalCredit string (decimal) no The credit amount for this line, in the functional currency.
lines[].functionalCurrency string no The functional currency of the posting entity. Format ISO 4217, for example 'USD'.
lines[].functionalDebit string (decimal) no The debit amount for this line, in the functional currency.
lines[].journalEntryId string no The journal entry this line belongs to. See id on GET accounting/journal-entries/:id.
lines[].lineNumber number no The line's sequential number within the entry.
lines[].lineType string no The classification of the line, for example 'standard', 'tax', 'offset' or 'fxRoundingDifference'. A system-assigned value. Absent when the line has no classification.
lines[].postingPeriodId string no The accounting period this line posts to. See id on GET accounting/accounting-periods/:id.
lines[].revaluation boolean no Whether a currency-revaluation process created this line.
lines[].sourceTransaction string no The identifier of the source transaction that generated this line, for example an invoice or payment number.
lines[].transactionalCurrency string no The currency of the line's transactional amounts. Format ISO 4217, for example 'USD'.
lines[].transactionDate string (date) no The date of the underlying transaction. Format YYYY-MM-DD. It can differ from the posting date.
lines[].reportingTags array of object no The reporting tags assigned to this line. Set them with create or update.
lines[].reportingTags[].dimensionCode string yes The reporting dimension this tag is for. Possible values: 'department', 'businessUnit', 'team', 'location', 'region', 'employee', 'vendor', 'customer', 'valueCenter', 'custom'.
lines[].reportingTags[].modelId string yes The dimension record this tag points to, on the model that dimensionCode names.
lines[].reportingTags[].customDimensionId string no The custom dimension this tag belongs to. Present only for a custom-dimension tag. See id on GET base/custom-dimensions.
lines[].reportingTags[].isActive boolean yes Whether the referenced dimension record is currently active. A historical entry can have tags that point at records since made inactive.

Errors

Code Status
NOT_FOUND 400

Statuses