Journal Entries

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.

Properties
idUUID
remote_idString
The third-party API ID of the matching object.
created_atDateTime (ISO 8601)
The datetime that this object was created by Merge.
modified_atDateTime (ISO 8601)
The datetime that this object was modified by Merge.
transaction_dateDateTime (ISO 8601)
The journal entry's transaction date.
paymentsArray
Array of Payment object IDs.
applied_paymentsArray
A list of the Payment Applied to Lines common models related to a given Invoice, Credit Note, or Journal Entry.
memoString
The journal entry's private note.
currencyEnum
The journal's currency. Possible values include: XUA, AFN, AFA, ALL, ALK, DZD, ADP, AOA, AOK, AON, AOR, ARA, ARS, ARM, ARP, ARL, AMD, AWG, AUD, ATS, AZN, AZM, BSD, BHD, BDT, BBD, BYN, BYB, BYR, BEF, BEC, BEL, BZD, BMD, BTN, BOB, BOL, BOV, BOP, BAM, BAD, BAN, BWP, BRC, BRZ, BRE, BRR, BRN, BRB, BRL, GBP, BND, BGL, BGN, BGO, BGM, BUK, BIF, XPF, KHR, CAD, CVE, KYD, XAF, CLE, CLP, CLF, CNX, CNY, CNH, COP, COU, KMF, CDF, CRC, HRD, HRK, CUC, CUP, CYP, CZK, CSK, DKK, DJF, DOP, NLG, XCD, DDM, ECS, ECV, EGP, GQE, ERN, EEK, ETB, EUR, XBA, XEU, XBB, XBC, XBD, FKP, FJD, FIM, FRF, XFO, XFU, GMD, GEK, GEL, DEM, GHS, GHC, GIP, XAU, GRD, GTQ, GWP, GNF, GNS, GYD, HTG, HNL, HKD, HUF, IMP, ISK, ISJ, INR, IDR, IRR, IQD, IEP, ILS, ILP, ILR, ITL, JMD, JPY, JOD, KZT, KES, KWD, KGS, LAK, LVL, LVR, LBP, LSL, LRD, LYD, LTL, LTT, LUL, LUC, LUF, MOP, MKD, MKN, MGA, MGF, MWK, MYR, MVR, MVP, MLF, MTL, MTP, MRU, MRO, MUR, MXV, MXN, MXP, MDC, MDL, MCF, MNT, MAD, MAF, MZE, MZN, MZM, MMK, NAD, NPR, ANG, TWD, NZD, NIO, NIC, NGN, KPW, NOK, OMR, PKR, XPD, PAB, PGK, PYG, PEI, PEN, PES, PHP, XPT, PLN, PLZ, PTE, GWE, QAR, XRE, RHD, RON, ROL, RUB, RUR, RWF, SVC, WST, SAR, RSD, CSD, SCR, SLL, XAG, SGD, SKK, SIT, SBD, SOS, ZAR, ZAL, KRH, KRW, KRO, SSP, SUR, ESP, ESA, ESB, XDR, LKR, SHP, XSU, SDD, SDG, SDP, SRD, SRG, SZL, SEK, CHF, SYP, STN, STD, TVD, TJR, TJS, TZS, XTS, THB, XXX, TPE, TOP, TTD, TND, TRY, TRL, TMT, TMM, USD, USN, USS, UGX, UGS, UAH, UAK, AED, UYW, UYU, UYP, UYI, UZS, VUV, VES, VEB, VEF, VND, VNN, CHE, CHW, XOF, YDD, YER, YUN, YUD, YUM, YUR, ZWN, ZRN, ZRZ, ZMW, ZMK, ZWD, ZWR, ZWL. In cases where there is no clear mapping, the original value passed through will be returned. To receive all enum values in the original format, use the show_enum_origins query parameter. Learn more.
exchange_rateString
The journal entry's exchange rate.
companyUUID
The company the journal entry belongs to.
inclusive_of_taxBoolean
If the transaction is inclusive or exclusive of tax. True if inclusive, False if exclusive.
linesJournalLine[]
The JournalLine object
The JournalLine object is used to represent a journal entry's line items.
Properties
idUUID
remote_idString
The third-party API ID of the matching object.
created_atDateTime (ISO 8601)
The datetime that this object was created by Merge.
modified_atDateTime (ISO 8601)
The datetime that this object was modified by Merge.
accountUUID
net_amountNumber
The value of the line item including taxes and other fees.
tracking_categoriesArray
The journal line item's associated tracking categories.
currencyEnum
The journal line item's currency. Possible values include: XUA, AFN, AFA, ALL, ALK, DZD, ADP, AOA, AOK, AON, AOR, ARA, ARS, ARM, ARP, ARL, AMD, AWG, AUD, ATS, AZN, AZM, BSD, BHD, BDT, BBD, BYN, BYB, BYR, BEF, BEC, BEL, BZD, BMD, BTN, BOB, BOL, BOV, BOP, BAM, BAD, BAN, BWP, BRC, BRZ, BRE, BRR, BRN, BRB, BRL, GBP, BND, BGL, BGN, BGO, BGM, BUK, BIF, XPF, KHR, CAD, CVE, KYD, XAF, CLE, CLP, CLF, CNX, CNY, CNH, COP, COU, KMF, CDF, CRC, HRD, HRK, CUC, CUP, CYP, CZK, CSK, DKK, DJF, DOP, NLG, XCD, DDM, ECS, ECV, EGP, GQE, ERN, EEK, ETB, EUR, XBA, XEU, XBB, XBC, XBD, FKP, FJD, FIM, FRF, XFO, XFU, GMD, GEK, GEL, DEM, GHS, GHC, GIP, XAU, GRD, GTQ, GWP, GNF, GNS, GYD, HTG, HNL, HKD, HUF, IMP, ISK, ISJ, INR, IDR, IRR, IQD, IEP, ILS, ILP, ILR, ITL, JMD, JPY, JOD, KZT, KES, KWD, KGS, LAK, LVL, LVR, LBP, LSL, LRD, LYD, LTL, LTT, LUL, LUC, LUF, MOP, MKD, MKN, MGA, MGF, MWK, MYR, MVR, MVP, MLF, MTL, MTP, MRU, MRO, MUR, MXV, MXN, MXP, MDC, MDL, MCF, MNT, MAD, MAF, MZE, MZN, MZM, MMK, NAD, NPR, ANG, TWD, NZD, NIO, NIC, NGN, KPW, NOK, OMR, PKR, XPD, PAB, PGK, PYG, PEI, PEN, PES, PHP, XPT, PLN, PLZ, PTE, GWE, QAR, XRE, RHD, RON, ROL, RUB, RUR, RWF, SVC, WST, SAR, RSD, CSD, SCR, SLL, XAG, SGD, SKK, SIT, SBD, SOS, ZAR, ZAL, KRH, KRW, KRO, SSP, SUR, ESP, ESA, ESB, XDR, LKR, SHP, XSU, SDD, SDG, SDP, SRD, SRG, SZL, SEK, CHF, SYP, STN, STD, TVD, TJR, TJS, TZS, XTS, THB, XXX, TPE, TOP, TTD, TND, TRY, TRL, TMT, TMM, USD, USN, USS, UGX, UGS, UAH, UAK, AED, UYW, UYU, UYP, UYI, UZS, VUV, VES, VEB, VEF, VND, VNN, CHE, CHW, XOF, YDD, YER, YUN, YUD, YUM, YUR, ZWN, ZRN, ZRZ, ZMW, ZMK, ZWD, ZWR, ZWL. In cases where there is no clear mapping, the original value passed through will be returned. To receive all enum values in the original format, use the show_enum_origins query parameter. Learn more.
companyUUID
The company the journal entry belongs to.
employeeUUID
contactUUID
tax_rateUUID
The tax rate that applies to this line item.
descriptionString
The line's description.
exchange_rateString
The journal line item's exchange rate.
remote_was_deletedBoolean
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.
remote_fieldsRemoteField[]
journal_numberString
Reference number for identifying journal entries.
tracking_categoriesArray
remote_was_deletedBoolean
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
The journal's posting status. Possible values include: UNPOSTED, POSTED. In cases where there is no clear mapping, the original value passed through will be returned. To receive all enum values in the original format, use the show_enum_origins query parameter. Learn more.
accounting_periodUUID
The accounting period that the JournalEntry was generated in.
remote_created_atDateTime (ISO 8601)
When the third party's journal entry was created.
remote_updated_atDateTime (ISO 8601)
When the third party's journal entry was updated.
field_mappingsObject
remote_dataRemoteData[]
The RemoteData object
The RemoteData object is used to represent the full data pulled from the third-party API for an object.
Properties
pathString
The third-party API path that is being called.
dataAny
The data returned from the third-party for this object in its original, unnormalized format.
remote_fieldsRemoteField[]
GET
/journal-entries

https://api.merge.dev/api/accounting/v1/journal-entries

US
EU
APAC

Returns a list of JournalEntry objects.


Query & path parameters
company_idString
Optional
If provided, will only return journal entries for this company.
created_afterDateTime (ISO 8601)
Optional
If provided, will only return objects created after this datetime.
created_beforeDateTime (ISO 8601)
Optional
If provided, will only return objects created before this datetime.
cursorString
Optional
The pagination cursor value.
expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
include_deleted_dataBoolean
Optional
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.
include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
include_remote_fieldsBoolean
Optional
Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
include_shell_dataBoolean
Optional
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
modified_afterDateTime (ISO 8601)
Optional
If provided, only objects synced by Merge after this date time will be returned.
modified_beforeDateTime (ISO 8601)
Optional
If provided, only objects synced by Merge before this date time will be returned.
page_sizeInteger
Optional
Number of results to return per page.
remote_idString
Optional
The API provider's ID for the given object.
transaction_date_afterDateTime (ISO 8601)
Optional
If provided, will only return objects created after this datetime.
transaction_date_beforeDateTime (ISO 8601)
Optional
If provided, will only return objects created before this datetime.
Field support by integration
Use the /linked-accounts endpoint to pull platform support information
FreeAgent
FreeAgent
FreshBooks
FreshBooks
Microsoft Dynamics 365 Business Central
Microsoft Dynamics 365 Business Central
NetSuite
NetSuite
QuickBooks Desktop
QuickBooks Desktop
QuickBooks Online
QuickBooks Online
Sage Business Cloud Accounting
Sage Business Cloud Accounting
Sage Intacct
Sage Intacct
Workday
Workday
Xero
Xero
Zoho Books
Zoho Books
POST
/journal-entries

https://api.merge.dev/api/accounting/v1/journal-entries

US
EU
APAC

Creates a JournalEntry object with the given values. To run asynchronously, see our guide.


Query & path parameters
is_debug_modeBoolean
Optional
Whether to include debug fields (such as log file links) in the response.
run_asyncBoolean
Optional
Whether or not third-party updates should be run asynchronously.
Body parameters
modelObject
Required
Find available fields below under “Model Parameters”.
Model parameters
View app-specific writable fields under “Field support by platform” in this section.
transaction_dateDateTime (ISO 8601)
The journal entry's transaction date.
paymentsArray
Array of Payment object IDs.
memoString
The journal entry's private note.
currencyEnum
The journal's currency. Must pass in one of the following choices: XUA, AFN, AFA, ALL, ALK, DZD, ADP, AOA, AOK, AON, AOR, ARA, ARS, ARM, ARP, ARL, AMD, AWG, AUD, ATS, AZN, AZM, BSD, BHD, BDT, BBD, BYN, BYB, BYR, BEF, BEC, BEL, BZD, BMD, BTN, BOB, BOL, BOV, BOP, BAM, BAD, BAN, BWP, BRC, BRZ, BRE, BRR, BRN, BRB, BRL, GBP, BND, BGL, BGN, BGO, BGM, BUK, BIF, XPF, KHR, CAD, CVE, KYD, XAF, CLE, CLP, CLF, CNX, CNY, CNH, COP, COU, KMF, CDF, CRC, HRD, HRK, CUC, CUP, CYP, CZK, CSK, DKK, DJF, DOP, NLG, XCD, DDM, ECS, ECV, EGP, GQE, ERN, EEK, ETB, EUR, XBA, XEU, XBB, XBC, XBD, FKP, FJD, FIM, FRF, XFO, XFU, GMD, GEK, GEL, DEM, GHS, GHC, GIP, XAU, GRD, GTQ, GWP, GNF, GNS, GYD, HTG, HNL, HKD, HUF, IMP, ISK, ISJ, INR, IDR, IRR, IQD, IEP, ILS, ILP, ILR, ITL, JMD, JPY, JOD, KZT, KES, KWD, KGS, LAK, LVL, LVR, LBP, LSL, LRD, LYD, LTL, LTT, LUL, LUC, LUF, MOP, MKD, MKN, MGA, MGF, MWK, MYR, MVR, MVP, MLF, MTL, MTP, MRU, MRO, MUR, MXV, MXN, MXP, MDC, MDL, MCF, MNT, MAD, MAF, MZE, MZN, MZM, MMK, NAD, NPR, ANG, TWD, NZD, NIO, NIC, NGN, KPW, NOK, OMR, PKR, XPD, PAB, PGK, PYG, PEI, PEN, PES, PHP, XPT, PLN, PLZ, PTE, GWE, QAR, XRE, RHD, RON, ROL, RUB, RUR, RWF, SVC, WST, SAR, RSD, CSD, SCR, SLL, XAG, SGD, SKK, SIT, SBD, SOS, ZAR, ZAL, KRH, KRW, KRO, SSP, SUR, ESP, ESA, ESB, XDR, LKR, SHP, XSU, SDD, SDG, SDP, SRD, SRG, SZL, SEK, CHF, SYP, STN, STD, TVD, TJR, TJS, TZS, XTS, THB, XXX, TPE, TOP, TTD, TND, TRY, TRL, TMT, TMM, USD, USN, USS, UGX, UGS, UAH, UAK, AED, UYW, UYU, UYP, UYI, UZS, VUV, VES, VEB, VEF, VND, VNN, CHE, CHW, XOF, YDD, YER, YUN, YUD, YUM, YUR, ZWN, ZRN, ZRZ, ZMW, ZMK, ZWD, ZWR, ZWL.
exchange_rateString
The journal entry's exchange rate.
companyUUID
The company the journal entry belongs to. Must pass in a valid Merge ID, which can be obtained from the id field in the CompanyInfo object.
tracking_categoriesArray
inclusive_of_taxBoolean
If the transaction is inclusive or exclusive of tax. True if inclusive, False if exclusive.
linesArray
journal_numberString
Reference number for identifying journal entries.
posting_statusEnum
The journal's posting status. Must pass in one of the following choices: UNPOSTED, POSTED.
integration_paramsObject
linked_account_paramsObject
remote_fieldsArray
Field support by integration
Use the /linked-accounts endpoint to pull platform support information
Microsoft Dynamics 365 Business Central
Microsoft Dynamics 365 Business Central
NetSuite
NetSuite
QuickBooks Desktop
QuickBooks Desktop
QuickBooks Online
QuickBooks Online
Sage Intacct
Sage Intacct
Xero
Xero
To include the correct model fields when making POST requests, use the GET /journal-entries/meta/post endpoint. Learn more in our /meta guide.
GET
/journal-entries/{id}

https://api.merge.dev/api/accounting/v1/journal-entries/{id}

US
EU
APAC

Returns a JournalEntry object with the given id.


Query & path parameters
expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
idUUID
Required
include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
include_remote_fieldsBoolean
Optional
Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
include_shell_dataBoolean
Optional
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
Field support by integration
Use the /linked-accounts endpoint to pull platform support information
FreeAgent
FreeAgent
FreshBooks
FreshBooks
Microsoft Dynamics 365 Business Central
Microsoft Dynamics 365 Business Central
NetSuite
NetSuite
QuickBooks Desktop
QuickBooks Desktop
QuickBooks Online
QuickBooks Online
Sage Business Cloud Accounting
Sage Business Cloud Accounting
Sage Intacct
Sage Intacct
Workday
Workday
Xero
Xero
Zoho Books
Zoho Books
GET
/journal-entries/lines/remote-field-classes
Beta

https://api.merge.dev/api/accounting/v1/journal-entries/lines/remote-field-classes

US
EU
APAC

Returns a list of RemoteFieldClass objects.


Query & path parameters
cursorString
Optional
The pagination cursor value.
include_deleted_dataBoolean
Optional
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.
include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
include_shell_dataBoolean
Optional
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
is_common_model_fieldBoolean
Optional
If provided, will only return remote field classes with this is_common_model_field value
is_customBoolean
Optional
If provided, will only return remote fields classes with this is_custom value
page_sizeInteger
Optional
Number of results to return per page.
GET
/journal-entries/meta/post

https://api.merge.dev/api/accounting/v1/journal-entries/meta/post

US
EU
APAC

Returns metadata for JournalEntry POSTs.


Field support by integration
Use the /linked-accounts endpoint to pull platform support information
Microsoft Dynamics 365 Business Central
Microsoft Dynamics 365 Business Central
NetSuite
NetSuite
QuickBooks Desktop
QuickBooks Desktop
QuickBooks Online
QuickBooks Online
Sage Intacct
Sage Intacct
Xero
Xero
GET
/journal-entries/remote-field-classes
Beta

https://api.merge.dev/api/accounting/v1/journal-entries/remote-field-classes

US
EU
APAC

Returns a list of RemoteFieldClass objects.


Query & path parameters
cursorString
Optional
The pagination cursor value.
include_deleted_dataBoolean
Optional
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.
include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
include_shell_dataBoolean
Optional
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
is_common_model_fieldBoolean
Optional
If provided, will only return remote field classes with this is_common_model_field value
is_customBoolean
Optional
If provided, will only return remote fields classes with this is_custom value
page_sizeInteger
Optional
Number of results to return per page.
Previous
Items
Next Up
Payment Methods