The Journal Entry object
Beta API Versions
API versions labelled as Beta are not subject to our standard versioning policy. As such, they may undergo small breaking changes until they are transitioned to the stable version. We encourage you to exercise caution when using Beta API versions and take the necessary steps to ensure a smooth integration into your applications
From the Journal Entries endpoint, you can retrieve a list of all entries made in a company's general ledger or chart of accounts. The journal line items for each journal entry should balance.
| Field | Type | Description |
|---|---|---|
| id sortable, filterable | string | Identifier for the journal entry, unique for the business in the accounting service. |
| postedDate sortable, filterable | string See Date | Date on which the journal entry was posted to the accounting service, and had an impact on the general ledger. This may be different from the creation date. |
| createdDate sortable, filterable | string See Date | Date on which the journal entry was created in the accounting service. |
| currency | string | ISO-4217 currency code of the journal entry. |
| currencyRate | decimal | Rate to convert the total amount of the transaction into the base currency for the business at the time of the transaction. |
| lines | array | An array of journal entry line items. |
| totalCredit sortable, filterable | decimal | Total amount of credit line items. |
| totalDebit sortable, filterable | decimal | Total amount of debit line items. |
| memo | string | Any additional information or business notes about the journal entry. |
| journalRef | Reference Types | Reference to the type of journal the journal entry is linked to. Relevant journal in accounting integrations that use multi-book accounting (multiple journals). |
| sourceModifiedDate sortable, filterable | string See Date | The date on which this record was last modified in the accounting service. |
Lines
| Field | Type | Description |
|---|---|---|
| id sortable, filterable | string | The Id of the line item. |
| description | string | Description of the line item. |
| credit sortable, filterable | decimal | The credit amount associated with the journal entry line item. A line item can have a debit or credit amount. |
| debit sortable, filterable | decimal | The debit amount associated with the journal entry line item. A line item can have a debit or credit amount. |
| taxAmount sortable, filterable | decimal | Line item tax amount. |
| accountRef | Reference Types | Reference to the account the line item is linked to. |
| taxRateRef | Reference Types | Reference to the tax rate to which the line item is linked to. |
| entityRef | Reference Types | Reference to the Vendor/Customer when the account referenced is an Account Receivable or Account Payable. |
| taxRateRef | Reference Types | Reference to the tax rate the line item is linked to. |
| trackingCategoryRef | Reference Types | Reference to the tracking categories associated with this line item, e.g. classes or departments. |
How to - User Guide
Step-by-step guide on utilizing this endpoint.