Transactions
The Transaction common model includes records of all types of transactions that do not appear in other common models. The type of transaction can be identified through the type field. More specifically, it will contain all types of transactions outside of:
- Credit Notes
- Expenses
- Invoices
- Journal Entries
- Payments
- Purchase Orders
- Vendor Credits
Properties
idUUIDRequired
remote_idStringOptional
The third-party API ID of the matching object.
created_atDateTime (ISO 8601)Required
The datetime that this object was created by Merge.
modified_atDateTime (ISO 8601)Required
The datetime that this object was modified by Merge.
transaction_typeStringOptional
The type of transaction, which can by any transaction object not already included in Merge’s common model.
numberStringOptional
The transaction's number used for identifying purposes.
transaction_dateDateTime (ISO 8601)Optional
The date upon which the transaction occurred.
accountUUIDOptional
The transaction's account.
contactUUIDOptional
The contact to whom the transaction relates to.
inclusive_of_taxBooleanOptional
If the transaction is inclusive or exclusive of tax.
True if inclusive, False if exclusive.total_amountStringOptional
The total amount being paid after taxes.
currencyEnumOptional
The transaction'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_rateStringOptional
The transaction's exchange rate.
companyUUIDOptional
The company the transaction belongs to.
tracking_categoriesArrayRequired
line_itemsTransactionLineItem[]Required
The TransactionLineItem object
The
TransactionLineItem object is used to represent a transaction's line items.Properties
idUUIDRequired
remote_idStringOptional
The third-party API ID of the matching object.
created_atDateTime (ISO 8601)Required
The datetime that this object was created by Merge.
modified_atDateTime (ISO 8601)Required
The datetime that this object was modified by Merge.
memoStringOptional
An internal note used by the business to clarify purpose of the transaction.
unit_priceStringOptional
The line item's unit price.
quantityStringOptional
The line item's quantity.
itemUUIDOptional
accountUUIDOptional
The line item's account.
tracking_categoryUUIDDeprecatedOptional
The line's associated tracking category.
The tracking_category field on the TransactionLineItem object is deprecated
tracking_categoriesArrayRequired
The transaction line item's associated tracking categories.
total_line_amountStringOptional
The line item's total.
tax_rateUUIDOptional
The tax rate that applies to this line item.
currencyEnumOptional
The 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.exchange_rateStringOptional
The line item's exchange rate.
companyUUIDOptional
The company the line belongs to.
remote_was_deletedBooleanRequired
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_was_deletedBooleanRequired
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.
accounting_periodUUIDOptional
The accounting period that the Transaction was generated in.
field_mappingsObjectOptional
remote_dataRemoteData[]Optional
GET
/transactions
https://api.merge.dev/api/accounting/v1/transactions
US
EU
APAC
Returns a list of Transaction objects.
Query & Path Parameters
company_idStringOptional
If provided, will only return accounting transactions 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.
cursorStringOptional
The pagination cursor value.
expandStringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
include_deleted_dataBooleanOptional
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_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
include_shell_dataBooleanOptional
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_sizeIntegerOptional
Number of results to return per page.
remote_idStringOptional
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
See all supported fieldsUse the /linked-accounts endpoint to pull platform support information
FreshBooks
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
currencyEnuminclusive_of_taxBooleannumberStringremote_dataRemoteData[]pathstringdatastringremote_idStringtotal_amountStringtransaction_dateDateTime (ISO 8601)transaction_typeString
Microsoft Dynamics 365 Business Central
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
companyUUIDcontactUUIDcurrencyEnumline_itemsTransactionLineItem[]idstringremote_idstringcreated_atstringmodified_atstringmemostringunit_pricestringquantitystringitemstringaccountstringtracking_categorystringtracking_categoriesarraytotal_line_amountstringtax_ratestringcurrencystringexchange_ratestringcompanystringremote_was_deletedbooleannumberStringremote_dataRemoteData[]pathstringdatastringremote_idStringtotal_amountStringtracking_categoriesArraytransaction_dateDateTime (ISO 8601)transaction_typeString
NetSuite
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
accountUUIDaccounting_periodUUIDcompanyUUIDcontactUUIDcurrencyEnumexchange_rateStringinclusive_of_taxBooleanline_itemsTransactionLineItem[]idstringremote_idstringcreated_atstringmodified_atstringmemostringunit_pricestringquantitystringitemstringaccountstringtracking_categorystringtracking_categoriesarraytotal_line_amountstringtax_ratestringcurrencystringexchange_ratestringcompanystringremote_was_deletedbooleannumberStringremote_dataRemoteData[]pathstringdatastringremote_idStringtotal_amountStringtracking_categoriesArraytransaction_dateDateTime (ISO 8601)transaction_typeString
QuickBooks Online
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
accountUUIDcontactUUIDcurrencyEnumexchange_rateStringline_itemsTransactionLineItem[]idstringremote_idstringcreated_atstringmodified_atstringmemostringunit_pricestringquantitystringitemstringaccountstringtracking_categorystringtracking_categoriesarraytotal_line_amountstringtax_ratestringcurrencystringexchange_ratestringcompanystringremote_was_deletedbooleannumberStringremote_dataRemoteData[]pathstringdatastringremote_idStringtotal_amountStringtracking_categoriesArraytransaction_dateDateTime (ISO 8601)transaction_typeString
Sage Intacct
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
companyUUIDcontactUUIDcurrencyEnumexchange_rateStringline_itemsTransactionLineItem[]idstringremote_idstringcreated_atstringmodified_atstringmemostringunit_pricestringquantitystringitemstringaccountstringtracking_categorystringtracking_categoriesarraytotal_line_amountstringtax_ratestringcurrencystringexchange_ratestringcompanystringremote_was_deletedbooleannumberStringremote_dataRemoteData[]pathstringdatastringremote_idStringtotal_amountStringtracking_categoriesArraytransaction_dateDateTime (ISO 8601)transaction_typeString
Xero
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
exchange_rateStringline_itemsTransactionLineItem[]idstringremote_idstringcreated_atstringmodified_atstringmemostringunit_pricestringquantitystringitemstringaccountstringtracking_categorystringtracking_categoriesarraytotal_line_amountstringtax_ratestringcurrencystringexchange_ratestringcompanystringremote_was_deletedbooleanremote_dataRemoteData[]pathstringdatastringremote_idStringtotal_amountStringtransaction_dateDateTime (ISO 8601)transaction_typeStringGET
/transactions/{id}
https://api.merge.dev/api/accounting/v1/transactions/{id}
US
EU
APAC
Returns a Transaction object with the given id.
Query & Path Parameters
expandStringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
idUUIDRequired
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
Field support by integration
See all supported fieldsUse the /linked-accounts endpoint to pull platform support information
FreshBooks
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
currencyEnuminclusive_of_taxBooleannumberStringremote_dataRemoteData[]pathstringdatastringremote_idStringtotal_amountStringtransaction_dateDateTime (ISO 8601)transaction_typeStringMicrosoft Dynamics 365 Business Central
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
companyUUIDcontactUUIDcurrencyEnumline_itemsTransactionLineItem[]idstringremote_idstringcreated_atstringmodified_atstringmemostringunit_pricestringquantitystringitemstringaccountstringtracking_categorystringtracking_categoriesarraytotal_line_amountstringtax_ratestringcurrencystringexchange_ratestringcompanystringremote_was_deletedbooleannumberStringremote_dataRemoteData[]pathstringdatastringremote_idStringtotal_amountStringtracking_categoriesArraytransaction_dateDateTime (ISO 8601)transaction_typeStringNetSuite
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
accountUUIDaccounting_periodUUIDcompanyUUIDcontactUUIDcurrencyEnumexchange_rateStringinclusive_of_taxBooleanline_itemsTransactionLineItem[]idstringremote_idstringcreated_atstringmodified_atstringmemostringunit_pricestringquantitystringitemstringaccountstringtracking_categorystringtracking_categoriesarraytotal_line_amountstringtax_ratestringcurrencystringexchange_ratestringcompanystringremote_was_deletedbooleannumberStringremote_dataRemoteData[]pathstringdatastringremote_idStringtotal_amountStringtracking_categoriesArraytransaction_dateDateTime (ISO 8601)transaction_typeStringQuickBooks Online
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
accountUUIDcontactUUIDcurrencyEnumexchange_rateStringline_itemsTransactionLineItem[]idstringremote_idstringcreated_atstringmodified_atstringmemostringunit_pricestringquantitystringitemstringaccountstringtracking_categorystringtracking_categoriesarraytotal_line_amountstringtax_ratestringcurrencystringexchange_ratestringcompanystringremote_was_deletedbooleannumberStringremote_dataRemoteData[]pathstringdatastringremote_idStringtotal_amountStringtracking_categoriesArraytransaction_dateDateTime (ISO 8601)transaction_typeStringSage Intacct
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
companyUUIDcontactUUIDcurrencyEnumexchange_rateStringline_itemsTransactionLineItem[]idstringremote_idstringcreated_atstringmodified_atstringmemostringunit_pricestringquantitystringitemstringaccountstringtracking_categorystringtracking_categoriesarraytotal_line_amountstringtax_ratestringcurrencystringexchange_ratestringcompanystringremote_was_deletedbooleannumberStringremote_dataRemoteData[]pathstringdatastringremote_idStringtotal_amountStringtracking_categoriesArraytransaction_dateDateTime (ISO 8601)transaction_typeStringXero
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
exchange_rateStringline_itemsTransactionLineItem[]idstringremote_idstringcreated_atstringmodified_atstringmemostringunit_pricestringquantitystringitemstringaccountstringtracking_categorystringtracking_categoriesarraytotal_line_amountstringtax_ratestringcurrencystringexchange_ratestringcompanystringremote_was_deletedbooleanremote_dataRemoteData[]pathstringdatastringremote_idStringtotal_amountStringtransaction_dateDateTime (ISO 8601)transaction_typeString