Transactions
TheTransaction
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_type
StringOptional
The type of transaction, which can by any transaction object not already included in Merge’s common model.
remote_data
RemoteData[]Optional
number
StringOptional
The transaction's number used for identifying purposes.
transaction_date
StringOptional
The date upon which the transaction occurred.
account
StringOptional
The transaction's account.
contact
StringOptional
The contact to whom the transaction relates to.
total_amount
StringOptional
The total amount being paid after taxes.
currency
EnumOptional
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_rate
StringOptional
The transaction's exchange rate.
company
StringOptional
The company the transaction belongs to.
line_items
TransactionLineItem[]Required
The TransactionLineItem object
The
TransactionLineItem
object is used to represent a transaction's line items.JSON
{"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"}
Properties
tracking_categories
ArrayRequired
The line's associated tracking categories.
memo
StringOptional
An internal note used by the business to clarify purpose of the transaction.
unit_price
StringOptional
The line item's unit price.
quantity
StringOptional
The line item's quantity.
item
StringOptional
account
StringOptional
The line item's account.
tracking_category
StringOptional
The line's associated tracking category.
total_line_amount
StringOptional
The line item's total.
tax_rate
StringOptional
The line item's tax rate.
currency
EnumOptional
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_rate
StringOptional
The line item's exchange rate.
company
StringOptional
The company the line belongs to.
remote_was_deleted
BooleanRequired
Indicates whether or not this object has been deleted by third party webhooks.
id
StringRequired
remote_id
StringOptional
The third-party API ID of the matching object.
field_mappings
ObjectOptional
The Transaction object
JSON
{"transaction_type": "estimate","remote_data": [{"path": "/actions","data": ["Varies by platform"]}],"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","line_items": [{"memo": "Pickleball paddles","unit_price": 25,"quantity": 10,"item": "0958cbc6-6040-430a-848e-aafacbadf4ae","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": 260,"tax_rate": "a12e7c20-1922-9df7-s75n-edfeewnn7384"},{"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","field_mappings": {"organization_defined_targets": {"custom_key": "custom_value"},"linked_account_defined_targets": {"custom_key": "custom_value"}}}
GET
/transactions
Returns a list of Transaction
objects.
Header Parameters
Authorization
StringRequired
Token-based authentication with required prefix "Bearer"
X-Account-Token
StringRequired
Token identifying the end user.
Query & Path Parameters
company_id
StringOptional
If provided, will only return accounting transactions for this company.
created_after
StringOptional
If provided, will only return objects created after this datetime.
created_before
StringOptional
If provided, will only return objects created before this datetime.
cursor
StringOptional
The pagination cursor value.
expand
StringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
include_deleted_data
BooleanOptional
Whether to include data that was marked as deleted by third party webhooks.
include_remote_data
BooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
modified_after
StringOptional
If provided, will only return objects modified after this datetime.
modified_before
StringOptional
If provided, will only return objects modified before this datetime.
page_size
IntegerOptional
Number of results to return per page.
remote_id
StringOptional
The API provider's ID for the given object.
Response
JSON
{"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw","previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ","results": [{"transaction_type": "estimate","remote_data": [{"path": "/actions","data": ["Varies by platform"]}],"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","line_items": [{"memo": "Pickleball paddles","unit_price": 25,"quantity": 10,"item": "0958cbc6-6040-430a-848e-aafacbadf4ae","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": 260,"tax_rate": "a12e7c20-1922-9df7-s75n-edfeewnn7384"},{"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","field_mappings": {"organization_defined_targets": {"custom_key": "custom_value"},"linked_account_defined_targets": {"custom_key": "custom_value"}}}]}
Field support by platform

Microsoft Dynamics 365 Business Central
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
company
Stringcontact
Stringcurrency
Enumnumber
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringtotal_amount
Stringtransaction_date
Stringtransaction_type
String
NetSuite
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringcompany
Stringcontact
Stringcurrency
Enumexchange_rate
Stringnumber
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringtotal_amount
Stringtransaction_date
Stringtransaction_type
String
QuickBooks Online
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
contact
Stringcurrency
Enumexchange_rate
Stringnumber
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringtotal_amount
Stringtransaction_date
Stringtransaction_type
StringHint: Use the /linked-accounts endpoint to pull platform support information.
GET
/transactions/{id}
Returns a Transaction
object with the given id
.
Header Parameters
Authorization
StringRequired
Token-based authentication with required prefix "Bearer"
X-Account-Token
StringRequired
Token identifying the end user.
Query & Path Parameters
expand
StringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
id
StringRequired
include_remote_data
BooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
Response
JSON
{"transaction_type": "estimate","remote_data": [{"path": "/actions","data": ["Varies by platform"]}],"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","line_items": [{"memo": "Pickleball paddles","unit_price": 25,"quantity": 10,"item": "0958cbc6-6040-430a-848e-aafacbadf4ae","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": 260,"tax_rate": "a12e7c20-1922-9df7-s75n-edfeewnn7384"},{"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","field_mappings": {"organization_defined_targets": {"custom_key": "custom_value"},"linked_account_defined_targets": {"custom_key": "custom_value"}}}
Field support by platform

Microsoft Dynamics 365 Business Central
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
company
Stringcontact
Stringcurrency
Enumnumber
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringtotal_amount
Stringtransaction_date
Stringtransaction_type
String
NetSuite
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringcompany
Stringcontact
Stringcurrency
Enumexchange_rate
Stringnumber
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringtotal_amount
Stringtransaction_date
Stringtransaction_type
String
QuickBooks Online
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
contact
Stringcurrency
Enumexchange_rate
Stringnumber
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringtotal_amount
Stringtransaction_date
Stringtransaction_type
StringHint: Use the /linked-accounts endpoint to pull platform support information.