Payments
The Payment object represents general payments made towards a specific transaction.
Properties
idUUID
Required
remote_idString
Optional
The third-party API ID of the matching object.
created_atDateTime (ISO 8601)
Required
The datetime that this object was created by Merge.
modified_atDateTime (ISO 8601)
Required
The datetime that this object was modified by Merge.
transaction_dateDateTime (ISO 8601)
Optional
The payment's transaction date.
contactUUID
Optional
The supplier, or customer involved in the payment.
accountUUID
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. In cases where there is no clear mapping, the original value passed through will be returned. To receive all enum values in the original format, use the show_enum_origins query parameter. Learn more.
exchange_rateString
Optional
The payment's exchange rate.
companyUUID
Optional
The company the payment belongs to.
total_amountNumber
Optional
The total amount of money being paid to the supplier, or customer, after taxes.
typeEnum
Optional
The type of the invoice. Possible values include: ACCOUNTS_PAYABLE, ACCOUNTS_RECEIVABLE. In cases where there is no clear mapping, the original value passed through will be returned. To receive all enum values in the original format, use the show_enum_origins query parameter. Learn more.
tracking_categoriesArray
Required
accounting_periodUUID
Optional
The accounting period that the Payment was generated in.
applied_to_linesPaymentLineItem[]
Required
A list of “Payment Applied to Lines” objects.
The PaymentLineItem object
The PaymentLineItem object is an applied-to-line on a Payment that can either be a Invoice, CreditNote, or JournalEntry.
Properties
idUUID
Required
remote_idString
Optional
The third-party API ID of the matching object.
created_atDateTime (ISO 8601)
Required
The datetime that this object was created by Merge.
modified_atDateTime (ISO 8601)
Required
The datetime that this object was modified by Merge.
applied_amountString
Optional
The amount being applied to the transaction.
applied_dateDateTime (ISO 8601)
Optional
The date the payment portion is applied.
related_object_idUUID
Required
The Merge ID of the transaction the payment portion is being applied to.
related_object_typeString
Required
The type of transaction the payment portion is being applied to. Possible values include: INVOICE, JOURNAL_ENTRY, or CREDIT_NOTE.
remote_updated_atDateTime (ISO 8601)
Optional
When the third party's payment entry was updated.
remote_was_deletedBoolean
Required
Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.
field_mappingsObject
Optional
remote_dataRemoteData[]
Optional
remote_fieldsRemoteField[]
Required
GET
/payments

https://api.merge.dev/api/accounting/v1/payments

US
EU
APAC

Returns a list of Payment objects.


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_afterDateTime (ISO 8601)
Optional
If provided, will only return objects created after this datetime.
created_beforeDateTime (ISO 8601)
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
Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.
include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
include_remote_fieldsBoolean
Optional
Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
include_shell_dataBoolean
Optional
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
modified_afterDateTime (ISO 8601)
Optional
If provided, only objects synced by Merge after this date time will be returned.
modified_beforeDateTime (ISO 8601)
Optional
If provided, only objects synced by Merge before this date time will be returned.
page_sizeInteger
Optional
Number of results to return per page.
remote_idString
Optional
The API provider's ID for the given object.
transaction_date_afterDateTime (ISO 8601)
Optional
If provided, will only return objects created after this datetime.
transaction_date_beforeDateTime (ISO 8601)
Optional
If provided, will only return objects created before this datetime.
Field support by integration
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
FreshBooks
FreshBooks
Microsoft Dynamics 365 Business Central
Microsoft Dynamics 365 Business Central
Moneybird
Moneybird
NetSuite
NetSuite
QuickBooks Online
QuickBooks Online
Sage Business Cloud Accounting
Sage Business Cloud Accounting
Sage Intacct
Sage Intacct
Xero
Xero
Zoho Books
Zoho Books
POST
/payments

https://api.merge.dev/api/accounting/v1/payments

US
EU
APAC

Creates a Payment object with the given values.


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
View app-specific writable fields under “Field support by platform” in this section.
transaction_dateDateTime (ISO 8601)
The payment's transaction date.
contactUUID
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 object.
accountUUID
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 object.
currencyEnum
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
The payment's exchange rate.
companyUUID
The company the payment belongs to. Must pass in a valid Merge ID, which can be obtained from the id field in the CompanyInfo object.
total_amountNumber
The total amount of money being paid to the supplier, or customer, after taxes.
typeEnum
The type of the invoice. Must pass in one of the following choices: ACCOUNTS_PAYABLE, ACCOUNTS_RECEIVABLE.
tracking_categoriesArray
accounting_periodUUID
The accounting period that the Payment was generated in. Must pass in a valid Merge ID, which can be obtained from the id field in the AccountingPeriod object.
applied_to_linesArray
A list of “Payment Applied to Lines” objects.
integration_paramsObject
linked_account_paramsObject
remote_fieldsArray
Field support by integration
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
FreshBooks
FreshBooks
NetSuite
NetSuite
QuickBooks Online
QuickBooks Online
Sage Intacct
Sage Intacct
Xero
Xero
To include the correct model fields when making POST requests, use the GET /payments/meta/post endpoint. Learn more in our /meta guide.
GET
/payments/{id}

https://api.merge.dev/api/accounting/v1/payments/{id}

US
EU
APAC

Returns a Payment object with the given id.


Query & Path Parameters
expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
idUUID
Required
include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
include_remote_fieldsBoolean
Optional
Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
Field support by integration
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
FreshBooks
FreshBooks
Microsoft Dynamics 365 Business Central
Microsoft Dynamics 365 Business Central
Moneybird
Moneybird
NetSuite
NetSuite
QuickBooks Online
QuickBooks Online
Sage Business Cloud Accounting
Sage Business Cloud Accounting
Sage Intacct
Sage Intacct
Xero
Xero
Zoho Books
Zoho Books
PATCH
/payments/{id}
Beta

https://api.merge.dev/api/accounting/v1/payments/{id}

US
EU
APAC

Updates a Payment object with the given id.


Query & Path Parameters
idUUID
Required
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
View app-specific writable fields under “Field support by platform” in this section.
transaction_dateDateTime (ISO 8601)
The payment's transaction date.
contactUUID
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 object.
accountUUID
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 object.
currencyEnum
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
The payment's exchange rate.
companyUUID
The company the payment belongs to. Must pass in a valid Merge ID, which can be obtained from the id field in the Company object.
total_amountNumber
The total amount of money being paid to the supplier, or customer, after taxes.
typeEnum
The type of the invoice. Must pass in one of the following choices: ACCOUNTS_PAYABLE, ACCOUNTS_RECEIVABLE.
tracking_categoriesArray
accounting_periodUUID
The accounting period that the Payment was generated in. Must pass in a valid Merge ID, which can be obtained from the id field in the Accounting_period object.
applied_to_linesArray
A list of “Payment Applied to Lines” objects.
integration_paramsObject
linked_account_paramsObject
remote_fieldsArray
Field support by integration
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
FreshBooks
FreshBooks
NetSuite
NetSuite
QuickBooks Online
QuickBooks Online
Not seeing an integration that you're looking for? Submit a request for it.
GET
/payments/line-items/remote-field-classes
Beta

https://api.merge.dev/api/accounting/v1/payments/line-items/remote-field-classes

US
EU
APAC

Returns a list of RemoteFieldClass objects.


Query & Path Parameters
cursorString
Optional
The pagination cursor value.
include_deleted_dataBoolean
Optional
Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.
include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
include_shell_dataBoolean
Optional
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
is_common_model_fieldBoolean
Optional
If provided, will only return remote field classes with this is_common_model_field value
page_sizeInteger
Optional
Number of results to return per page.
GET
/payments/meta/patch/{id}

https://api.merge.dev/api/accounting/v1/payments/meta/patch/{id}

US
EU
APAC

Returns metadata for Payment PATCHs.


Query & Path Parameters
idUUID
Required
Field support by integration
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
FreshBooks
FreshBooks
NetSuite
NetSuite
QuickBooks Online
QuickBooks Online
Not seeing an integration that you're looking for? Submit a request for it.
GET
/payments/meta/post

https://api.merge.dev/api/accounting/v1/payments/meta/post

US
EU
APAC

Returns metadata for Payment POSTs.


Field support by integration
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
FreshBooks
FreshBooks
NetSuite
NetSuite
QuickBooks Online
QuickBooks Online
Sage Intacct
Sage Intacct
Xero
Xero
GET
/payments/remote-field-classes
Beta

https://api.merge.dev/api/accounting/v1/payments/remote-field-classes

US
EU
APAC

Returns a list of RemoteFieldClass objects.


Query & Path Parameters
cursorString
Optional
The pagination cursor value.
include_deleted_dataBoolean
Optional
Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.
include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
include_shell_dataBoolean
Optional
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
is_common_model_fieldBoolean
Optional
If provided, will only return remote field classes with this is_common_model_field value
page_sizeInteger
Optional
Number of results to return per page.
Previous
Journal Entries
Next Up
Phone Numbers