Invoices

The Invoice object represents an itemized record of goods and/or services sold to a customer or bought from a vendor.

Represents a Bill when the Invoice type is ACCOUNTS_PAYABLE. References an Invoice when the Invoice type is ACCOUNTS_RECEIVABLE.

Properties
idUUID
remote_idString
The third-party API ID of the matching object.
created_atDateTime (ISO 8601)
The datetime that this object was created by Merge.
modified_atDateTime (ISO 8601)
The datetime that this object was modified by Merge.
typeEnum
Whether the invoice is an accounts receivable or accounts payable. If type is ACCOUNTS_PAYABLE, the invoice is a bill. If type is ACCOUNTS_RECEIVABLE, it is an invoice. Possible values include: ACCOUNTS_RECEIVABLE, ACCOUNTS_PAYABLE. 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.
contactUUID
The invoice's contact.
numberString
The invoice's number.
issue_dateDateTime (ISO 8601)
The invoice's issue date.
due_dateDateTime (ISO 8601)
The invoice's due date.
paid_on_dateDateTime (ISO 8601)
The invoice's paid date.
memoString
The invoice's private note.
companyUUID
The company the invoice belongs to.
employeeUUID
The employee this overall transaction relates to.
currencyEnum
The invoice'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
The invoice's exchange rate.
payment_termUUID
The payment term that applies to this transaction.
total_discountNumber
The total discounts applied to the total cost.
sub_totalNumber
The total amount being paid before taxes.
statusEnum
The status of the invoice. Possible values include: PAID, DRAFT, SUBMITTED, PARTIALLY_PAID, OPEN, VOID. 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.
total_tax_amountNumber
The total amount being paid in taxes.
total_amountNumber
The invoice's total amount.
balanceNumber
The invoice's remaining balance.
remote_updated_atDateTime (ISO 8601)
When the third party's invoice entry was updated.
tracking_categoriesArray
accounting_periodUUID
The accounting period that the Invoice was generated in.
purchase_ordersArray
paymentsArray
Array of Payment object IDs.
applied_paymentsArray
A list of the Payment Applied to Lines common models related to a given Invoice, Credit Note, or Journal Entry.
line_itemsInvoiceLineItem[]
The InvoiceLineItem object
The InvoiceLineItem object represents an itemized record of goods and/or services sold to a customer.
Properties
idUUID
remote_idString
The third-party API ID of the matching object.
created_atDateTime (ISO 8601)
The datetime that this object was created by Merge.
modified_atDateTime (ISO 8601)
The datetime that this object was modified by Merge.
descriptionString
The line item's description.
unit_priceNumber
The line item's unit price.
quantityNumber
The line item's quantity.
total_amountNumber
The line item's total amount.
employeeUUID
The employee this overall transaction relates to.
projectUUID
contactUUID
The invoice's contact.
currencyEnum
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. To receive all enum values in the original format, use the show_enum_origins query parameter. Learn more.
exchange_rateString
The line item's exchange rate.
itemUUID
accountUUID
tax_rateUUID
The tax rate that applies to this line item.
tracking_categoriesArray
The invoice line item's associated tracking categories.
companyUUID
The company the invoice belongs to.
remote_was_deletedBoolean
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
remote_fieldsRemoteField[]
applied_credit_notesCreditNoteApplyLineForInvoice[]
CreditNoteApplyLines applied to the Invoice.
The CreditNoteApplyLineForInvoice object
The CreditNoteApplyLine is attached to the CreditNote model.
Properties
remote_idString
The third-party API ID of the matching object.
created_atDateTime (ISO 8601)
The datetime that this object was created by Merge.
modified_atDateTime (ISO 8601)
The datetime that this object was modified by Merge.
credit_noteUUID
applied_dateDateTime (ISO 8601)
Date that the credit note is applied to the invoice.
applied_amountString
The amount of the Credit Note applied to the invoice.
remote_was_deletedBoolean
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.
applied_vendor_creditsVendorCreditApplyLineForInvoice[]
VendorCreditApplyLines applied to the Invoice.
The VendorCreditApplyLineForInvoice object
The VendorCreditApplyLine object is used to represent a applied vendor credit.
Properties
remote_idString
The third-party API ID of the matching object.
created_atDateTime (ISO 8601)
The datetime that this object was created by Merge.
modified_atDateTime (ISO 8601)
The datetime that this object was modified by Merge.
vendor_creditUUID
applied_dateDateTime (ISO 8601)
Date that the vendor credit is applied to the invoice.
applied_amountString
The amount of the VendorCredit applied to the invoice.
remote_was_deletedBoolean
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.
inclusive_of_taxBoolean
If the transaction is inclusive or exclusive of tax. True if inclusive, False if exclusive.
remote_was_deletedBoolean
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
remote_dataRemoteData[]
The RemoteData object
The RemoteData object is used to represent the full data pulled from the third-party API for an object.
Properties
pathString
The third-party API path that is being called.
dataAny
The data returned from the third-party for this object in its original, unnormalized format.
remote_fieldsRemoteField[]
GET
/invoices

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

US
EU
APAC

Returns a list of Invoice objects.


Query & path parameters
company_idString
Optional
If provided, will only return invoices for this company.
contact_idString
Optional
If provided, will only return invoices 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).
issue_date_afterDateTime (ISO 8601)
Optional
If provided, will only return objects created after this datetime.
issue_date_beforeDateTime (ISO 8601)
Optional
If provided, will only return objects created before this datetime.
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.
numberString
Optional
If provided, will only return Invoices with this number.
page_sizeInteger
Optional
Number of results to return per page. The maximum limit is 100.
remote_fieldsString
Optional
Deprecated. Use show_enum_origins.
remote_idString
Optional
The API provider's ID for the given object.
show_enum_originsString
Optional
A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. Learn more
statusString
Optional
If provided, will only return Invoices with this status.
typeString
Optional
If provided, will only return Invoices with this type.
Field support by integration
Use the /linked-accounts endpoint to pull platform support information
Clear Books
Clear Books
FreeAgent
FreeAgent
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
Wave Financial
Wave Financial
Workday
Workday
Xero
Xero
Zoho Books
Zoho Books
POST
/invoices
Beta

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

US
EU
APAC

Creates an Invoice object with the given values. Including a PurchaseOrder id in the purchase_orders property will generate an Accounts Payable Invoice from the specified Purchase Order(s). To run asynchronously, see our guide.


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.
typeEnum
Whether the invoice is an accounts receivable or accounts payable. If type is ACCOUNTS_PAYABLE, the invoice is a bill. If type is ACCOUNTS_RECEIVABLE, it is an invoice. Must pass in one of the following choices: ACCOUNTS_RECEIVABLE, ACCOUNTS_PAYABLE.
contactUUID
The invoice's contact. Must pass in a valid Merge ID, which can be obtained from the id field in the Contact object.
numberString
The invoice's number.
issue_dateDateTime (ISO 8601)
The invoice's issue date.
due_dateDateTime (ISO 8601)
The invoice's due date.
paid_on_dateDateTime (ISO 8601)
The invoice's paid date.
employeeUUID
The employee this overall transaction relates to. Must pass in a valid Merge ID, which can be obtained from the id field in the Employee object.
memoString
The invoice's private note.
statusEnum
The status of the invoice. Must pass in one of the following choices: PAID, DRAFT, SUBMITTED, PARTIALLY_PAID, OPEN, VOID.
companyUUID
The company the invoice belongs to. Must pass in a valid Merge ID, which can be obtained from the id field in the CompanyInfo object.
currencyEnum
The invoice'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 invoice's exchange rate.
total_discountNumber
The total discounts applied to the total cost.
sub_totalNumber
The total amount being paid before taxes.
payment_termUUID
The payment term that applies to this transaction. Must pass in a valid Merge ID, which can be obtained from the id field in the PaymentTerm object.
total_tax_amountNumber
The total amount being paid in taxes.
inclusive_of_taxBoolean
If the transaction is inclusive or exclusive of tax. True if inclusive, False if exclusive.
total_amountNumber
The invoice's total amount.
balanceNumber
The invoice's remaining balance.
paymentsArray
Array of Payment object IDs.
tracking_categoriesArray
line_itemsArray
purchase_ordersArray
integration_paramsObject
linked_account_paramsObject
remote_fieldsArray
Field support by integration
Use the /linked-accounts endpoint to pull platform support information
Clear Books
Clear Books
FreshBooks
FreshBooks
Microsoft Dynamics 365 Business Central
Microsoft Dynamics 365 Business Central
NetSuite
NetSuite
QuickBooks Online
QuickBooks Online
Sage Intacct
Sage Intacct
Xero
Xero
Zoho Books
Zoho Books
To include the correct model fields when making POST requests, use the GET /invoices/meta/post endpoint. Learn more in our /meta guide.
GET
/invoices/{id}

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

US
EU
APAC

Returns an Invoice 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.
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).
remote_fieldsString
Optional
Deprecated. Use show_enum_origins.
show_enum_originsString
Optional
A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. Learn more
Field support by integration
Use the /linked-accounts endpoint to pull platform support information
Clear Books
Clear Books
FreeAgent
FreeAgent
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
Wave Financial
Wave Financial
Workday
Workday
Xero
Xero
Zoho Books
Zoho Books
PATCH
/invoices/{id}
Beta

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

US
EU
APAC

Updates an Invoice 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.
typeEnum
Whether the invoice is an accounts receivable or accounts payable. If type is ACCOUNTS_PAYABLE, the invoice is a bill. If type is ACCOUNTS_RECEIVABLE, it is an invoice. Must pass in one of the following choices: ACCOUNTS_RECEIVABLE, ACCOUNTS_PAYABLE.
contactUUID
The invoice's contact. Must pass in a valid Merge ID, which can be obtained from the id field in the Contact object.
numberString
The invoice's number.
issue_dateDateTime (ISO 8601)
The invoice's issue date.
due_dateDateTime (ISO 8601)
The invoice's due date.
paid_on_dateDateTime (ISO 8601)
The invoice's paid date.
employeeUUID
The employee this overall transaction relates to. Must pass in a valid Merge ID, which can be obtained from the id field in the Employee object.
memoString
The invoice's private note.
statusEnum
The status of the invoice. Must pass in one of the following choices: PAID, DRAFT, SUBMITTED, PARTIALLY_PAID, OPEN, VOID.
companyUUID
The company the invoice belongs to. Must pass in a valid Merge ID, which can be obtained from the id field in the CompanyInfo object.
currencyEnum
The invoice'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 invoice's exchange rate.
total_discountNumber
The total discounts applied to the total cost.
sub_totalNumber
The total amount being paid before taxes.
payment_termUUID
The payment term that applies to this transaction. Must pass in a valid Merge ID, which can be obtained from the id field in the PaymentTerm object.
total_tax_amountNumber
The total amount being paid in taxes.
inclusive_of_taxBoolean
If the transaction is inclusive or exclusive of tax. True if inclusive, False if exclusive.
total_amountNumber
The invoice's total amount.
balanceNumber
The invoice's remaining balance.
paymentsArray
Array of Payment object IDs.
tracking_categoriesArray
line_itemsArray
purchase_ordersArray
integration_paramsObject
linked_account_paramsObject
remote_fieldsArray
Field support by integration
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
/invoices/line-items/remote-field-classes
Beta

https://api.merge.dev/api/accounting/v1/invoices/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
is_customBoolean
Optional
If provided, will only return remote fields classes with this is_custom value
page_sizeInteger
Optional
Number of results to return per page. The maximum limit is 100.
GET
/invoices/meta/patch/{id}

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

US
EU
APAC

Returns metadata for Invoice PATCHs.


Query & path parameters
idUUID
Required
Field support by integration
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
/invoices/meta/post

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

US
EU
APAC

Returns metadata for Invoice POSTs.


Field support by integration
Use the /linked-accounts endpoint to pull platform support information
Clear Books
Clear Books
FreshBooks
FreshBooks
Microsoft Dynamics 365 Business Central
Microsoft Dynamics 365 Business Central
NetSuite
NetSuite
QuickBooks Online
QuickBooks Online
Sage Intacct
Sage Intacct
Xero
Xero
Zoho Books
Zoho Books
GET
/invoices/remote-field-classes
Beta

https://api.merge.dev/api/accounting/v1/invoices/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
is_customBoolean
Optional
If provided, will only return remote fields classes with this is_custom value
page_sizeInteger
Optional
Number of results to return per page. The maximum limit is 100.
Previous
Income Statements
Next Up
Items