Payments
ThePayment
object represents general payments made towards a specific transaction.The Payment object
Properties
id
Stringremote_id
Stringremote_data
RemoteData[]transaction_date
Stringcontact
Stringaccount
Stringcurrency
EnumXUA
, 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
Stringcompany
Stringtotal_amount
Numberremote_updated_at
Stringremote_was_deleted
Booleanfield_mappings
Object{"id": "b26fd49a-cbae-470a-a8f8-bcbc119e0390","remote_id": "987300","remote_data": [{"path": "/actions","data": ["Varies by platform"]}],"transaction_date": "2020-03-31T00:00:00Z","contact": "5b3c1341-a20f-4e51-b72c-f3830a16c97b","account": "d6e687d6-0c36-48a1-8114-35324b5cb38f","currency": "FKP","exchange_rate": "2.9","company": "595c8f97-2ac4-45b7-b000-41bdf43240b5","total_amount": 50,"remote_updated_at": "2020-03-31T00:00:00Z","remote_was_deleted": true,"field_mappings": {"organization_defined_targets": {"custom_key": "custom_value"},"linked_account_defined_targets": {"custom_key": "custom_value"}}}
/payments
Returns a list of Payment
objects.
Header Parameters
Authorization
StringX-Account-Token
StringQuery & Path Parameters
account_id
Stringcompany_id
Stringcontact_id
Stringcreated_after
Stringcreated_before
Stringcursor
Stringexpand
Stringinclude_deleted_data
Booleaninclude_remote_data
Booleanmodified_after
Stringmodified_before
Stringpage_size
Integerremote_id
String{"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw","previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ","results": [{"id": "b26fd49a-cbae-470a-a8f8-bcbc119e0390","remote_id": "987300","remote_data": [{"path": "/actions","data": ["Varies by platform"]}],"transaction_date": "2020-03-31T00:00:00Z","contact": "5b3c1341-a20f-4e51-b72c-f3830a16c97b","account": "d6e687d6-0c36-48a1-8114-35324b5cb38f","currency": "FKP","exchange_rate": "2.9","company": "595c8f97-2ac4-45b7-b000-41bdf43240b5","total_amount": 50,"remote_updated_at": "2020-03-31T00:00:00Z","remote_was_deleted": true,"field_mappings": {"organization_defined_targets": {"custom_key": "custom_value"},"linked_account_defined_targets": {"custom_key": "custom_value"}}}]}

FreshBooks
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
contact
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringtotal_amount
Numbertransaction_date
String
Microsoft Dynamics 365 Business Central
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
company
Stringcontact
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringtotal_amount
Numbertransaction_date
String
Moneybird
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringcontact
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringtotal_amount
Numbertransaction_date
String
NetSuite
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
company
Stringcontact
Stringcurrency
Enumexchange_rate
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringtotal_amount
Numbertransaction_date
String
QuickBooks Online
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringcontact
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringtotal_amount
Numbertransaction_date
String
Sage Business Cloud Accounting
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringcontact
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringtotal_amount
Numbertransaction_date
String
Sage Intacct
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
contact
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringtotal_amount
Numbertransaction_date
String
Xero
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringcontact
Stringcurrency
Enumexchange_rate
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringtotal_amount
Numbertransaction_date
String
Zoho Books
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
contact
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringtotal_amount
Numbertransaction_date
String/payments
Creates a Payment
object with the given values.
Header Parameters
Authorization
StringX-Account-Token
StringQuery & Path Parameters
is_debug_mode
Booleanrun_async
BooleanBody Parameters
model
ObjectModel Parameters
transaction_date
Stringcontact
Stringid
field in the Contact table.account
Stringid
field in the Account table.currency
EnumXUA
, 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_rate
Stringcompany
Stringid
field in the Company table.total_amount
Numberintegration_params
Objectlinked_account_params
Object{"model": {"transaction_date": "2020-03-31T00:00:00Z","contact": "5b3c1341-a20f-4e51-b72c-f3830a16c97b","account": "d6e687d6-0c36-48a1-8114-35324b5cb38f","currency": "FKP","exchange_rate": "2.9","company": "595c8f97-2ac4-45b7-b000-41bdf43240b5","total_amount": 50}}
{"model": {"id": "b26fd49a-cbae-470a-a8f8-bcbc119e0390","remote_id": "987300","remote_data": [{"path": "/actions","data": ["Varies by platform"]}],"transaction_date": "2020-03-31T00:00:00Z","contact": "5b3c1341-a20f-4e51-b72c-f3830a16c97b","account": "d6e687d6-0c36-48a1-8114-35324b5cb38f","currency": "FKP","exchange_rate": "2.9","company": "595c8f97-2ac4-45b7-b000-41bdf43240b5","total_amount": 50,"remote_updated_at": "2020-03-31T00:00:00Z","remote_was_deleted": true,"field_mappings": {"organization_defined_targets": {"custom_key": "custom_value"},"linked_account_defined_targets": {"custom_key": "custom_value"}}},"warnings": [{"source": {"pointer": "/age"},"title": "Unrecognized Field","detail": "An unrecognized field, age, was passed in with request data.","problem_type": "UNRECOGNIZED_FIELD"}],"errors": [{"source": {"pointer": "/model/custom_fields"},"title": "Missing Required Field","detail": "custom_fields is a required field on model.","problem_type": "MISSING_REQUIRED_FIELD"}],"logs": [{"log_id": "99433219-8017-4acd-bb3c-ceb23d663832","dashboard_view": "https://app.merge.dev/logs/99433219-8017-4acd-bb3c-ceb23d663832","log_summary": {"url": "https://harvest.greenhouse.io/v1/candidates/","method": "POST","status_code": 200}}]}

QuickBooks Online
Merge supports Passthrough Requests to this platform's API
Supported POST Body Parameters
account
Stringcontact
Stringremote_id
Stringremote_updated_at
Stringtotal_amount
Numbertransaction_date
String/payments/{id}
Returns a Payment
object with the given id
.
Header Parameters
Authorization
StringX-Account-Token
StringQuery & Path Parameters
expand
Stringid
Stringinclude_remote_data
Boolean{"id": "b26fd49a-cbae-470a-a8f8-bcbc119e0390","remote_id": "987300","remote_data": [{"path": "/actions","data": ["Varies by platform"]}],"transaction_date": "2020-03-31T00:00:00Z","contact": "5b3c1341-a20f-4e51-b72c-f3830a16c97b","account": "d6e687d6-0c36-48a1-8114-35324b5cb38f","currency": "FKP","exchange_rate": "2.9","company": "595c8f97-2ac4-45b7-b000-41bdf43240b5","total_amount": 50,"remote_updated_at": "2020-03-31T00:00:00Z","remote_was_deleted": true,"field_mappings": {"organization_defined_targets": {"custom_key": "custom_value"},"linked_account_defined_targets": {"custom_key": "custom_value"}}}

FreshBooks
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
contact
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringtotal_amount
Numbertransaction_date
String
Microsoft Dynamics 365 Business Central
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
company
Stringcontact
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringtotal_amount
Numbertransaction_date
String
Moneybird
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringcontact
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringtotal_amount
Numbertransaction_date
String
NetSuite
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
company
Stringcontact
Stringcurrency
Enumexchange_rate
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringtotal_amount
Numbertransaction_date
String
QuickBooks Online
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringcontact
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringtotal_amount
Numbertransaction_date
String
Sage Business Cloud Accounting
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringcontact
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringtotal_amount
Numbertransaction_date
String
Sage Intacct
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
contact
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringtotal_amount
Numbertransaction_date
String
Xero
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringcontact
Stringcurrency
Enumexchange_rate
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringtotal_amount
Numbertransaction_date
String
Zoho Books
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
contact
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringtotal_amount
Numbertransaction_date
String/payments/meta/post
Returns metadata for Payment
POSTs.
Header Parameters
Authorization
StringX-Account-Token
String{"request_schema": {},"status": {"linked_account_status": "string","can_make_request": true},"has_conditional_params": true,"has_required_linked_account_params": true}

FreshBooks
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
contact
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringtotal_amount
Numbertransaction_date
String
Microsoft Dynamics 365 Business Central
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
company
Stringcontact
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringtotal_amount
Numbertransaction_date
String
Moneybird
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringcontact
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringtotal_amount
Numbertransaction_date
String
NetSuite
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
company
Stringcontact
Stringcurrency
Enumexchange_rate
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringtotal_amount
Numbertransaction_date
String
QuickBooks Online
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringcontact
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringtotal_amount
Numbertransaction_date
String
Sage Business Cloud Accounting
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringcontact
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringtotal_amount
Numbertransaction_date
String
Sage Intacct
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
contact
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringtotal_amount
Numbertransaction_date
String
Xero
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringcontact
Stringcurrency
Enumexchange_rate
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringtotal_amount
Numbertransaction_date
String
Zoho Books
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
contact
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringtotal_amount
Numbertransaction_date
String