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
transaction_type
StringOptional
The type of transaction, which can by any transaction object not already included in Merge’s common model.
number
StringOptional
The transaction's number used for identifying purposes.
transaction_date
DateTime (ISO 8601)Optional
The date upon which the transaction occurred.
account
UUIDOptional
The transaction's account.
contact
UUIDOptional
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
. In cases where there is no clear mapping, the original value passed through will be returned.exchange_rate
StringOptional
The transaction's exchange rate.
company
UUIDOptional
The company the transaction belongs to.
tracking_categories
ArrayRequired
line_items
TransactionLineItem[]Required
The TransactionLineItem object
The
TransactionLineItem
object is used to represent a transaction's line items.Properties
tracking_categories
ArrayRequired
The line's associated tracking categories.
remote_id
StringOptional
The third-party API ID of the matching object.
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
UUIDOptional
account
UUIDOptional
The line item's account.
tracking_category
UUIDOptional
The line's associated tracking category.
total_line_amount
StringOptional
The line item's total.
tax_rate
UUIDOptional
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
. In cases where there is no clear mapping, the original value passed through will be returned.exchange_rate
StringOptional
The line item's exchange rate.
company
UUIDOptional
The company the line belongs to.
remote_was_deleted
BooleanRequired
Indicates whether or not this object has been deleted in the third party platform.
id
UUIDRequired
created_at
DateTime (ISO 8601)Required
modified_at
DateTime (ISO 8601)Required
This is the datetime that this object was last updated by Merge
remote_was_deleted
BooleanRequired
Indicates whether or not this object has been deleted in the third party platform.
accounting_period
UUIDOptional
The accounting period that the Transaction was generated in.
id
UUIDRequired
remote_id
StringOptional
The third-party API ID of the matching object.
created_at
DateTime (ISO 8601)Required
modified_at
DateTime (ISO 8601)Required
This is the datetime that this object was last updated by Merge
field_mappings
ObjectOptional
remote_data
RemoteData[]Optional
GET
/transactions
https://api.merge.dev/api/accounting/v1/transactions
US
EU
Returns a list of Transaction
objects.
Query & Path Parameters
company_id
StringOptional
If provided, will only return accounting transactions for this company.
created_after
DateTime (ISO 8601)Optional
If provided, will only return objects created after this datetime.
created_before
DateTime (ISO 8601)Optional
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
DateTime (ISO 8601)Optional
If provided, only objects synced by Merge after this date time will be returned.
modified_before
DateTime (ISO 8601)Optional
If provided, only objects synced by Merge before this date time will be returned.
page_size
IntegerOptional
Number of results to return per page.
remote_id
StringOptional
The API provider's ID for the given object.
transaction_date_after
DateTime (ISO 8601)Optional
If provided, will only return objects created after this datetime.
transaction_date_before
DateTime (ISO 8601)Optional
If provided, will only return objects created before this datetime.
Field support by integration
See all supported fields
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
company
UUIDcontact
UUIDcurrency
Enumline_items
TransactionLineItem[]remote_id
stringmemo
stringunit_price
stringquantity
stringitem
stringaccount
stringtracking_category
stringtracking_categories
arraytotal_line_amount
stringtax_rate
stringcurrency
stringexchange_rate
stringcompany
stringremote_was_deleted
booleanid
stringcreated_at
stringmodified_at
stringnumber
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringtotal_amount
Stringtracking_categories
Arraytransaction_date
DateTime (ISO 8601)transaction_type
String
NetSuite
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
account
UUIDaccounting_period
UUIDcompany
UUIDcontact
UUIDcurrency
Enumexchange_rate
Stringline_items
TransactionLineItem[]remote_id
stringmemo
stringunit_price
stringquantity
stringitem
stringaccount
stringtracking_category
stringtracking_categories
arraytotal_line_amount
stringtax_rate
stringcurrency
stringexchange_rate
stringcompany
stringremote_was_deleted
booleanid
stringcreated_at
stringmodified_at
stringnumber
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringtotal_amount
Stringtracking_categories
Arraytransaction_date
DateTime (ISO 8601)transaction_type
String
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
account
UUIDcontact
UUIDcurrency
Enumexchange_rate
Stringline_items
TransactionLineItem[]remote_id
stringmemo
stringunit_price
stringquantity
stringitem
stringaccount
stringtracking_category
stringtracking_categories
arraytotal_line_amount
stringtax_rate
stringcurrency
stringexchange_rate
stringcompany
stringremote_was_deleted
booleanid
stringcreated_at
stringmodified_at
stringnumber
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringtotal_amount
Stringtracking_categories
Arraytransaction_date
DateTime (ISO 8601)transaction_type
String
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
company
UUIDcontact
UUIDcurrency
Enumexchange_rate
Stringline_items
TransactionLineItem[]remote_id
stringmemo
stringunit_price
stringquantity
stringitem
stringaccount
stringtracking_category
stringtracking_categories
arraytotal_line_amount
stringtax_rate
stringcurrency
stringexchange_rate
stringcompany
stringremote_was_deleted
booleanid
stringcreated_at
stringmodified_at
stringnumber
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringtotal_amount
Stringtransaction_date
DateTime (ISO 8601)transaction_type
String
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_rate
Stringline_items
TransactionLineItem[]remote_id
stringmemo
stringunit_price
stringquantity
stringitem
stringaccount
stringtracking_category
stringtracking_categories
arraytotal_line_amount
stringtax_rate
stringcurrency
stringexchange_rate
stringcompany
stringremote_was_deleted
booleanid
stringcreated_at
stringmodified_at
stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringtotal_amount
Stringtransaction_date
DateTime (ISO 8601)transaction_type
StringGET
/transactions/{id}
https://api.merge.dev/api/accounting/v1/transactions/{id}
US
EU
Returns a Transaction
object with the given id
.
Query & Path Parameters
expand
StringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
id
UUIDRequired
include_remote_data
BooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
Field support by integration
See all supported fields
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
company
UUIDcontact
UUIDcurrency
Enumline_items
TransactionLineItem[]remote_id
stringmemo
stringunit_price
stringquantity
stringitem
stringaccount
stringtracking_category
stringtracking_categories
arraytotal_line_amount
stringtax_rate
stringcurrency
stringexchange_rate
stringcompany
stringremote_was_deleted
booleanid
stringcreated_at
stringmodified_at
stringnumber
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringtotal_amount
Stringtracking_categories
Arraytransaction_date
DateTime (ISO 8601)transaction_type
String
NetSuite
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
account
UUIDaccounting_period
UUIDcompany
UUIDcontact
UUIDcurrency
Enumexchange_rate
Stringline_items
TransactionLineItem[]remote_id
stringmemo
stringunit_price
stringquantity
stringitem
stringaccount
stringtracking_category
stringtracking_categories
arraytotal_line_amount
stringtax_rate
stringcurrency
stringexchange_rate
stringcompany
stringremote_was_deleted
booleanid
stringcreated_at
stringmodified_at
stringnumber
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringtotal_amount
Stringtracking_categories
Arraytransaction_date
DateTime (ISO 8601)transaction_type
String
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
account
UUIDcontact
UUIDcurrency
Enumexchange_rate
Stringline_items
TransactionLineItem[]remote_id
stringmemo
stringunit_price
stringquantity
stringitem
stringaccount
stringtracking_category
stringtracking_categories
arraytotal_line_amount
stringtax_rate
stringcurrency
stringexchange_rate
stringcompany
stringremote_was_deleted
booleanid
stringcreated_at
stringmodified_at
stringnumber
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringtotal_amount
Stringtracking_categories
Arraytransaction_date
DateTime (ISO 8601)transaction_type
String
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
company
UUIDcontact
UUIDcurrency
Enumexchange_rate
Stringline_items
TransactionLineItem[]remote_id
stringmemo
stringunit_price
stringquantity
stringitem
stringaccount
stringtracking_category
stringtracking_categories
arraytotal_line_amount
stringtax_rate
stringcurrency
stringexchange_rate
stringcompany
stringremote_was_deleted
booleanid
stringcreated_at
stringmodified_at
stringnumber
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringtotal_amount
Stringtransaction_date
DateTime (ISO 8601)transaction_type
String
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_rate
Stringline_items
TransactionLineItem[]remote_id
stringmemo
stringunit_price
stringquantity
stringitem
stringaccount
stringtracking_category
stringtracking_categories
arraytotal_line_amount
stringtax_rate
stringcurrency
stringexchange_rate
stringcompany
stringremote_was_deleted
booleanid
stringcreated_at
stringmodified_at
stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringtotal_amount
Stringtransaction_date
DateTime (ISO 8601)transaction_type
String