Transactions
The Transaction includes different types of transactions. The Transactions object does not cover expenses, credit notes, vendor credit, invoices, purchase orders, and journal entries. See the “transaction_type” field for more information.The Transaction object
Properties
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_dateStringOptional
The date upon which the transaction occurred.
accountStringOptional
The transaction's account.
contactStringOptional
The contact to whom the transaction relates to.
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, or - in cases where there is no clear mapping - the original value passed through.exchange_rateStringOptional
The transaction's exchange rate.
companyStringOptional
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.JSON
{"remote_id": "121222","memo": "Pickleball paddles","unit_price": "25.0","quantity": "10.0","item": "0958cbc6-6040-430a-848e-aafacbadf4ae","account": "2b38c085-2620-4269-b5ec-75dd9095ed2c","tracking_category": "f1214c24-2702-4617-b74b-3ddecfc0d384","tracking_categories": ["f1214c24-2702-4617-b74b-3ddecfc0d384","9b840d2-686a-465a-8a8e-7b028498f8e4","a47e11b6-c73b-4a0c-be31-130fc48177fa"],"total_line_amount": 260,"tax_rate": "a12e7c20-1922-9df7-s75n-edfeewnn7384","currency": "USD","exchange_rate": "2.9","company": "595c8f97-2ac4-45b7-b000-41bdf43240b5","modified_at": "2021-10-16T00:00:00Z"}
Properties
tracking_categoriesArrayRequired
The line's associated tracking categories.
remote_idStringOptional
The third-party API ID of the matching object.
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.
itemStringOptional
accountStringOptional
The line item's account.
tracking_categoryStringOptional
The line's associated tracking category.
total_line_amountStringOptional
The line item's total.
tax_rateStringOptional
The line item's tax rate.
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, or - in cases where there is no clear mapping - the original value passed through.exchange_rateStringOptional
The line item's exchange rate.
companyStringOptional
The company the line belongs to.
modified_atStringRequired
This is the datetime that this object was last updated by Merge
remote_was_deletedBooleanRequired
Indicates whether or not this object has been deleted by third party webhooks.
idStringRequired
remote_idStringOptional
The third-party API ID of the matching object.
field_mappingsObjectOptional
modified_atStringRequired
This is the datetime that this object was last updated by Merge
remote_dataRemoteData[]Optional
The Transaction object
JSON
{"transaction_type": "estimate","number": "122","transaction_date": "2020-03-31T00:00:00Z0","account": "3e442c5d-8f51-4103-b5c9-dcee39c30a08","contact": "2c22ce34-5c6e-4fc7-a594-7f26bb4cf78b","total_amount": 260,"currency": "USD","exchange_rate": "2.9","company": "595c8f97-2ac4-45b7-b000-41bdf43240b5","tracking_categories": ["b38c59b0-a9d7-4740-b1ee-5436c6751e3d","9b840d2-686a-465a-8a8e-7b028498f8e4","a47e11b6-c73b-4a0c-be31-130fc48177fa"],"line_items": [{"remote_id": "121222","memo": "Pickleball paddles","unit_price": "25.0","quantity": "10.0","item": "0958cbc6-6040-430a-848e-aafacbadf4ae","account": "2b38c085-2620-4269-b5ec-75dd9095ed2c","tracking_category": "f1214c24-2702-4617-b74b-3ddecfc0d384","tracking_categories": ["f1214c24-2702-4617-b74b-3ddecfc0d384","9b840d2-686a-465a-8a8e-7b028498f8e4","a47e11b6-c73b-4a0c-be31-130fc48177fa"],"total_line_amount": 260,"tax_rate": "a12e7c20-1922-9df7-s75n-edfeewnn7384","currency": "USD","exchange_rate": "2.9","company": "595c8f97-2ac4-45b7-b000-41bdf43240b5"},{"memo": "Pickleball Balls","unit_price": 1,"quantity": 10,"item": "249c9faa-3045-4a31-953b-8f22d3613301","account": "3e442c5d-8f51-4103-b5c9-dcee39c30a08","tracking_category": "f1214c24-2702-4617-b74b-3ddecfc0d384","tracking_categories": ["f1214c24-2702-4617-b74b-3ddecfc0d384","9b840d2-686a-465a-8a8e-7b028498f8e4","a47e11b6-c73b-4a0c-be31-130fc48177fa"],"total_line_amount": 20,"tax_rate": "a12e7c20-1922-9df7-s75n-edfeewnn7384"}],"remote_was_deleted": true,"id": "0048ea5b-911e-4dff-9364-92070dea62ff","remote_id": "239741",Show advanced fields}
GET
/transactions
Returns a list of Transaction objects.
Header Parameters
AuthorizationStringRequired
Token-based authentication with required prefix "Bearer"
X-Account-TokenStringRequired
Token identifying the end user.
Query & Path Parameters
company_idStringOptional
If provided, will only return accounting transactions for this company.
created_afterStringOptional
If provided, will only return objects created after this datetime.
created_beforeStringOptional
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
Whether to include data that was marked as deleted by third party webhooks.
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
modified_afterStringOptional
If provided, only objects synced by Merge after this date time will be returned.
modified_beforeStringOptional
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_afterStringOptional
If provided, will only return objects created after this datetime.
transaction_date_beforeStringOptional
If provided, will only return objects created before this datetime.
Response
JSON
{"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw","previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ","results": [{"transaction_type": "estimate","number": "122","transaction_date": "2020-03-31T00:00:00Z0","account": "3e442c5d-8f51-4103-b5c9-dcee39c30a08","contact": "2c22ce34-5c6e-4fc7-a594-7f26bb4cf78b","total_amount": 260,"currency": "USD","exchange_rate": "2.9","company": "595c8f97-2ac4-45b7-b000-41bdf43240b5","tracking_categories": ["b38c59b0-a9d7-4740-b1ee-5436c6751e3d","9b840d2-686a-465a-8a8e-7b028498f8e4","a47e11b6-c73b-4a0c-be31-130fc48177fa"],"line_items": [{"remote_id": "121222","memo": "Pickleball paddles","unit_price": "25.0","quantity": "10.0","item": "0958cbc6-6040-430a-848e-aafacbadf4ae","account": "2b38c085-2620-4269-b5ec-75dd9095ed2c","tracking_category": "f1214c24-2702-4617-b74b-3ddecfc0d384","tracking_categories": ["f1214c24-2702-4617-b74b-3ddecfc0d384","9b840d2-686a-465a-8a8e-7b028498f8e4","a47e11b6-c73b-4a0c-be31-130fc48177fa"],"total_line_amount": 260,"tax_rate": "a12e7c20-1922-9df7-s75n-edfeewnn7384","currency": "USD","exchange_rate": "2.9","company": "595c8f97-2ac4-45b7-b000-41bdf43240b5"},{"memo": "Pickleball Balls","unit_price": 1,"quantity": 10,"item": "249c9faa-3045-4a31-953b-8f22d3613301","account": "3e442c5d-8f51-4103-b5c9-dcee39c30a08","tracking_category": "f1214c24-2702-4617-b74b-3ddecfc0d384","tracking_categories": ["f1214c24-2702-4617-b74b-3ddecfc0d384","9b840d2-686a-465a-8a8e-7b028498f8e4","a47e11b6-c73b-4a0c-be31-130fc48177fa"],"total_line_amount": 20,"tax_rate": "a12e7c20-1922-9df7-s75n-edfeewnn7384"}],"remote_was_deleted": true,"id": "0048ea5b-911e-4dff-9364-92070dea62ff","remote_id": "239741",Show advanced fields}]}
Field support by platform
Microsoft Dynamics 365 Business Central
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
companyStringcontactStringcurrencyEnumline_itemsTransactionLineItem[]remote_idstringmemostringunit_pricestringquantitystringitemstringaccountstringtracking_categorystringtracking_categoriesarraytotal_line_amountstringtax_ratestringcurrencystringexchange_ratestringcompanystringmodified_atstringnumberStringremote_dataRemoteData[]pathstringdataobjectremote_idStringtotal_amountStringtracking_categoriesArraytransaction_dateStringtransaction_typeString
NetSuite
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
accountStringcompanyStringcontactStringcurrencyEnumexchange_rateStringline_itemsTransactionLineItem[]remote_idstringmemostringunit_pricestringquantitystringitemstringaccountstringtracking_categorystringtracking_categoriesarraytotal_line_amountstringtax_ratestringcurrencystringexchange_ratestringcompanystringmodified_atstringnumberStringremote_dataRemoteData[]pathstringdataobjectremote_idStringtotal_amountStringtracking_categoriesArraytransaction_dateStringtransaction_typeString
QuickBooks Online
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
accountStringcontactStringcurrencyEnumexchange_rateStringline_itemsTransactionLineItem[]remote_idstringmemostringunit_pricestringquantitystringitemstringaccountstringtracking_categorystringtracking_categoriesarraytotal_line_amountstringtax_ratestringcurrencystringexchange_ratestringcompanystringmodified_atstringnumberStringremote_dataRemoteData[]pathstringdataobjectremote_idStringtotal_amountStringtracking_categoriesArraytransaction_dateStringtransaction_typeStringHint: Use the /linked-accounts endpoint to pull platform support information.
GET
/transactions/{id}
Returns a Transaction object with the given id.
Header Parameters
AuthorizationStringRequired
Token-based authentication with required prefix "Bearer"
X-Account-TokenStringRequired
Token identifying the end user.
Query & Path Parameters
expandStringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
idStringRequired
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
Response
JSON
{"transaction_type": "estimate","number": "122","transaction_date": "2020-03-31T00:00:00Z0","account": "3e442c5d-8f51-4103-b5c9-dcee39c30a08","contact": "2c22ce34-5c6e-4fc7-a594-7f26bb4cf78b","total_amount": 260,"currency": "USD","exchange_rate": "2.9","company": "595c8f97-2ac4-45b7-b000-41bdf43240b5","tracking_categories": ["b38c59b0-a9d7-4740-b1ee-5436c6751e3d","9b840d2-686a-465a-8a8e-7b028498f8e4","a47e11b6-c73b-4a0c-be31-130fc48177fa"],"line_items": [{"remote_id": "121222","memo": "Pickleball paddles","unit_price": "25.0","quantity": "10.0","item": "0958cbc6-6040-430a-848e-aafacbadf4ae","account": "2b38c085-2620-4269-b5ec-75dd9095ed2c","tracking_category": "f1214c24-2702-4617-b74b-3ddecfc0d384","tracking_categories": ["f1214c24-2702-4617-b74b-3ddecfc0d384","9b840d2-686a-465a-8a8e-7b028498f8e4","a47e11b6-c73b-4a0c-be31-130fc48177fa"],"total_line_amount": 260,"tax_rate": "a12e7c20-1922-9df7-s75n-edfeewnn7384","currency": "USD","exchange_rate": "2.9","company": "595c8f97-2ac4-45b7-b000-41bdf43240b5"},{"memo": "Pickleball Balls","unit_price": 1,"quantity": 10,"item": "249c9faa-3045-4a31-953b-8f22d3613301","account": "3e442c5d-8f51-4103-b5c9-dcee39c30a08","tracking_category": "f1214c24-2702-4617-b74b-3ddecfc0d384","tracking_categories": ["f1214c24-2702-4617-b74b-3ddecfc0d384","9b840d2-686a-465a-8a8e-7b028498f8e4","a47e11b6-c73b-4a0c-be31-130fc48177fa"],"total_line_amount": 20,"tax_rate": "a12e7c20-1922-9df7-s75n-edfeewnn7384"}],"remote_was_deleted": true,"id": "0048ea5b-911e-4dff-9364-92070dea62ff","remote_id": "239741",Show advanced fields}
Field support by platform
Microsoft Dynamics 365 Business Central
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
companyStringcontactStringcurrencyEnumline_itemsTransactionLineItem[]remote_idstringmemostringunit_pricestringquantitystringitemstringaccountstringtracking_categorystringtracking_categoriesarraytotal_line_amountstringtax_ratestringcurrencystringexchange_ratestringcompanystringmodified_atstringnumberStringremote_dataRemoteData[]pathstringdataobjectremote_idStringtotal_amountStringtracking_categoriesArraytransaction_dateStringtransaction_typeStringNetSuite
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
accountStringcompanyStringcontactStringcurrencyEnumexchange_rateStringline_itemsTransactionLineItem[]remote_idstringmemostringunit_pricestringquantitystringitemstringaccountstringtracking_categorystringtracking_categoriesarraytotal_line_amountstringtax_ratestringcurrencystringexchange_ratestringcompanystringmodified_atstringnumberStringremote_dataRemoteData[]pathstringdataobjectremote_idStringtotal_amountStringtracking_categoriesArraytransaction_dateStringtransaction_typeStringQuickBooks Online
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
accountStringcontactStringcurrencyEnumexchange_rateStringline_itemsTransactionLineItem[]remote_idstringmemostringunit_pricestringquantitystringitemstringaccountstringtracking_categorystringtracking_categoriesarraytotal_line_amountstringtax_ratestringcurrencystringexchange_ratestringcompanystringmodified_atstringnumberStringremote_dataRemoteData[]pathstringdataobjectremote_idStringtotal_amountStringtracking_categoriesArraytransaction_dateStringtransaction_typeStringHint: Use the /linked-accounts endpoint to pull platform support information.