Common ModelsJournal Entries

The JournalEntry object

A JournalEntry is a record of a transaction or event that is entered into a company’s accounting system.

The JournalEntry common model contains records that are automatically created as a result of a certain type of transaction, like an Invoice, and records that are manually created against a company’s ledger.

The lines of a given JournalEntry object should always sum to 0. A positive net_amount means the line represents a debit and a negative net_amount represents a credit.

idstringOptionalRead-onlyformat: "uuid"
remote_idstring or nullOptional

The third-party API ID of the matching object.

created_atdatetimeOptionalRead-only
The datetime that this object was created by Merge.
modified_atdatetimeOptionalRead-only
The datetime that this object was modified by Merge.
transaction_datedatetime or nullOptional
The journal entry's transaction date.
paymentslist of stringsOptional

Array of Payment object IDs.

applied_paymentslist of stringsOptional
A list of the Payment Applied to Lines common models related to a given Invoice, Credit Note, or Journal Entry.
memostring or nullOptional
The journal entry's private note.
currencyenum or nullOptional
The journal's currency. The currency code in ISO 4217 format.
exchange_ratestring or nullOptionalformat: "decimal"
The journal entry's exchange rate.
companystring or nullOptionalformat: "uuid"
The company the journal entry belongs to.
inclusive_of_taxboolean or nullOptional

If the transaction is inclusive or exclusive of tax. True if inclusive, False if exclusive.

lineslist of objectsOptionalRead-only
journal_numberstring or nullOptional<=70 characters
Reference number for identifying journal entries.
tracking_categorieslist of stringsOptional
remote_was_deletedbooleanOptionalRead-only

Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.

posting_statusenum or nullOptional

The journal’s posting status.

  • UNPOSTED - UNPOSTED
  • POSTED - POSTED
Allowed values:
accounting_periodstring or nullOptionalformat: "uuid"
The accounting period that the JournalEntry was generated in.
remote_created_atdatetime or nullOptional
When the third party's journal entry was created.
remote_updated_atdatetime or nullOptional
When the third party's journal entry was updated.
field_mappingsobject or nullOptionalRead-only
remote_datalist of objects or nullOptionalRead-only
remote_fieldslist of objectsOptionalRead-only