Payments

The Payment object represents general payments made towards a specific transaction.

The Payment object

Properties


idString
Required

remote_idString
Optional
The third-party API ID of the matching object.

remote_dataRemoteData[]
Optional

transaction_dateString
Optional
The payment's transaction date.

contactString
Optional
The supplier, or customer involved in the payment.

accountString
Optional
The supplier’s or customer’s account in which the payment is made.

currencyEnum
Optional
The payment'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_rateString
Optional
The payment's exchange rate.

companyString
Optional
The company the payment belongs to.

total_amountNumber
Optional
The total amount of money being paid to the supplier, or customer, after taxes.

remote_updated_atString
Optional
When the third party's payment entry was updated.

remote_was_deletedBoolean
Required
Indicates whether or not this object has been deleted by third party webhooks.

field_mappingsObject
Optional

The Payment object
JSON
{
"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"
}
}
}

GET

/payments

Returns a list of Payment objects.


Header Parameters


AuthorizationString
Required
Token-based authentication with required prefix "Bearer"

X-Account-TokenString
Required
Token identifying the end user.

Query & Path Parameters


account_idString
Optional
If provided, will only return payments for this account.

company_idString
Optional
If provided, will only return payments for this company.

contact_idString
Optional
If provided, will only return payments for this contact.

created_afterString
Optional
If provided, will only return objects created after this datetime.

created_beforeString
Optional
If provided, will only return objects created before this datetime.

cursorString
Optional
The pagination cursor value.

expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

include_deleted_dataBoolean
Optional
Whether to include data that was marked as deleted by third party webhooks.

include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.

modified_afterString
Optional
If provided, will only return objects modified after this datetime.

modified_beforeString
Optional
If provided, will only return objects modified before this datetime.

page_sizeInteger
Optional
Number of results to return per page.

remote_idString
Optional
The API provider's ID for the given object.

Response
JSON
{
"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"
}
}
}
]
}
Field support by platform

FreshBooks

FreshBooks

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


contactString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

remote_updated_atString

total_amountNumber

transaction_dateString

Microsoft Dynamics 365 Business Central

Microsoft Dynamics 365 Business Central

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


companyString

contactString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

remote_updated_atString

total_amountNumber

transaction_dateString

Moneybird

Moneybird

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

contactString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

remote_updated_atString

total_amountNumber

transaction_dateString

NetSuite

NetSuite

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


companyString

contactString

currencyEnum

exchange_rateString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

total_amountNumber

transaction_dateString

QuickBooks Online

QuickBooks Online

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

contactString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

remote_updated_atString

total_amountNumber

transaction_dateString

Sage Business Cloud Accounting

Sage Business Cloud Accounting

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

contactString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

remote_updated_atString

total_amountNumber

transaction_dateString

Sage Intacct

Sage Intacct

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


contactString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

total_amountNumber

transaction_dateString

Xero

Xero

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

contactString

currencyEnum

exchange_rateString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

remote_updated_atString

total_amountNumber

transaction_dateString

Zoho Books

Zoho Books

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


contactString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

total_amountNumber

transaction_dateString
Hint: Use the /linked-accounts endpoint to pull platform support information.
POST

/payments

Creates a Payment object with the given values.


Header Parameters


AuthorizationString
Required
Token-based authentication with required prefix "Bearer"

X-Account-TokenString
Required
Token identifying the end user.

Query & Path Parameters


is_debug_modeBoolean
Optional
Whether to include debug fields (such as log file links) in the response.

run_asyncBoolean
Optional
Whether or not third-party updates should be run asynchronously.

Body Parameters


modelObject
Required
Find available fields below under “Model Parameters”.

Model Parameters


transaction_dateString
Optional
The payment's transaction date.

contactString
Optional
The supplier, or customer involved in the payment. Must pass in a valid Merge ID, which can be obtained from the id field in the Contact table.

accountString
Optional
The supplier’s or customer’s account in which the payment is made. Must pass in a valid Merge ID, which can be obtained from the id field in the Account table.

currencyEnum
Optional
The payment's currency. Must pass in one of the following choices: 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.

exchange_rateString
Optional
The payment's exchange rate.

companyString
Optional
The company the payment belongs to. Must pass in a valid Merge ID, which can be obtained from the id field in the Company table.

total_amountNumber
Optional
The total amount of money being paid to the supplier, or customer, after taxes.

integration_paramsObject
Optional

linked_account_paramsObject
Optional

POST v1/payments
JSON
{
"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
}
}
Response
JSON
{
"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
}
}
]
}
Field support by platform

QuickBooks Online

QuickBooks Online

Merge supports Passthrough Requests to this platform's API

Supported POST Body Parameters


accountString
Required

contactString
Required

remote_idString
Optional

remote_updated_atString
Optional

total_amountNumber
Required

transaction_dateString
Required
Hint: Use the /linked-accounts endpoint to pull platform support information.
GET

/payments/{id}

Returns a Payment object with the given id.


Header Parameters


AuthorizationString
Required
Token-based authentication with required prefix "Bearer"

X-Account-TokenString
Required
Token identifying the end user.

Query & Path Parameters


expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

idString
Required

include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
Response
JSON
{
"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"
}
}
}
Field support by platform

FreshBooks

FreshBooks

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


contactString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

remote_updated_atString

total_amountNumber

transaction_dateString

Microsoft Dynamics 365 Business Central

Microsoft Dynamics 365 Business Central

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


companyString

contactString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

remote_updated_atString

total_amountNumber

transaction_dateString

Moneybird

Moneybird

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

contactString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

remote_updated_atString

total_amountNumber

transaction_dateString

NetSuite

NetSuite

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


companyString

contactString

currencyEnum

exchange_rateString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

total_amountNumber

transaction_dateString

QuickBooks Online

QuickBooks Online

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

contactString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

remote_updated_atString

total_amountNumber

transaction_dateString

Sage Business Cloud Accounting

Sage Business Cloud Accounting

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

contactString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

remote_updated_atString

total_amountNumber

transaction_dateString

Sage Intacct

Sage Intacct

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


contactString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

total_amountNumber

transaction_dateString

Xero

Xero

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

contactString

currencyEnum

exchange_rateString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

remote_updated_atString

total_amountNumber

transaction_dateString

Zoho Books

Zoho Books

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


contactString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

total_amountNumber

transaction_dateString
Hint: Use the /linked-accounts endpoint to pull platform support information.
GET

/payments/meta/post

Returns metadata for Payment POSTs.


Header Parameters


AuthorizationString
Required
Token-based authentication with required prefix "Bearer"

X-Account-TokenString
Required
Token identifying the end user.
Response
JSON
{
"request_schema": {},
"status": {
"linked_account_status": "string",
"can_make_request": true
},
"has_conditional_params": true,
"has_required_linked_account_params": true
}
Field support by platform

FreshBooks

FreshBooks

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


contactString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

remote_updated_atString

total_amountNumber

transaction_dateString

Microsoft Dynamics 365 Business Central

Microsoft Dynamics 365 Business Central

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


companyString

contactString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

remote_updated_atString

total_amountNumber

transaction_dateString

Moneybird

Moneybird

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

contactString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

remote_updated_atString

total_amountNumber

transaction_dateString

NetSuite

NetSuite

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


companyString

contactString

currencyEnum

exchange_rateString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

total_amountNumber

transaction_dateString

QuickBooks Online

QuickBooks Online

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

contactString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

remote_updated_atString

total_amountNumber

transaction_dateString

Sage Business Cloud Accounting

Sage Business Cloud Accounting

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

contactString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

remote_updated_atString

total_amountNumber

transaction_dateString

Sage Intacct

Sage Intacct

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


contactString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

total_amountNumber

transaction_dateString

Xero

Xero

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

contactString

currencyEnum

exchange_rateString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

remote_updated_atString

total_amountNumber

transaction_dateString

Zoho Books

Zoho Books

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


contactString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

total_amountNumber

transaction_dateString
Hint: Use the /linked-accounts endpoint to pull platform support information.