Invoices
The Invoice object represents an itemized record of goods and/or services sold to a customer.
Properties

idUUID
Required

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

created_atDateTime (ISO 8601)
Required

modified_atDateTime (ISO 8601)
Required
This is the datetime that this object was last updated by Merge

typeEnum
Optional
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.

contactUUID
Optional
The invoice's contact.

numberString
Optional
The invoice's number.

issue_dateDateTime (ISO 8601)
Optional
The invoice's issue date.

due_dateDateTime (ISO 8601)
Optional
The invoice's due date.

paid_on_dateDateTime (ISO 8601)
Optional
The invoice's paid date.

memoString
Optional
The invoice's private note.

companyUUID
Optional
The company the invoice belongs to.

currencyEnum
Optional
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.

exchange_rateString
Optional
The invoice's exchange rate.

total_discountNumber
Optional
The total discounts applied to the total cost.

sub_totalNumber
Optional
The total amount being paid before taxes.

statusEnum
Optional
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.

total_tax_amountNumber
Optional
The total amount being paid in taxes.

total_amountNumber
Optional
The invoice's total amount.

balanceNumber
Optional
The invoice's remaining balance.

remote_updated_atDateTime (ISO 8601)
Optional
When the third party's invoice entry was updated.

tracking_categoriesArray
Required

paymentsArray
Required
Array of Payment object IDs.

applied_paymentsArray
Required
A list of the Payment Applied to Lines common models related to a given Invoice, Credit Note, or Journal Entry.

line_itemsInvoiceLineItem[]
Required
The InvoiceLineItem object
The InvoiceLineItem object represents an itemized record of goods and/or services sold to a customer.
Properties

idUUID
Required

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

created_atDateTime (ISO 8601)
Required

modified_atDateTime (ISO 8601)
Required
This is the datetime that this object was last updated by Merge

descriptionString
Optional
The line item's description.

unit_priceNumber
Optional
The line item's unit price.

quantityNumber
Optional
The line item's quantity.

total_amountNumber
Optional
The line item's total amount.

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

itemUUID
Optional

accountUUID
Optional

tracking_categoryUUID
Optional

tracking_categoriesArray
Required

companyUUID
Optional
The company the line item belongs to.

remote_was_deletedBoolean
Required
Indicates whether or not this object has been deleted in the third party platform.

field_mappingsObject
Optional

remote_was_deletedBoolean
Required

accounting_periodUUID
Optional
The accounting period that the Invoice was generated in.

purchase_ordersArray
Required

field_mappingsObject
Optional

remote_dataRemoteData[]
Optional


GET
/invoices

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

US
EU

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
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.

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.

page_sizeInteger
Optional
Number of results to return per page.

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 you'd like returned as original values, rather than normalized to Merge's standard enum values. Learn more

typeString
Optional
If provided, will only return Invoices with this type

Field support by integration
See all supported fields
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

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

US
EU

Creates an Invoice 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.

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.

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.

total_tax_amountNumber
The total amount being paid in taxes.

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

Field support by integration
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
Microsoft Dynamics 365 Business Central
Microsoft Dynamics 365 Business Central
NetSuite
NetSuite
QuickBooks Online
QuickBooks Online
Sage Intacct
Sage Intacct
Xero
Xero
FreeAgent
FreeAgent
Coming soon
FreshBooks
FreshBooks
Coming soon
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

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.

remote_fieldsString
Optional
Deprecated. Use show_enum_origins.

show_enum_originsString
Optional
A comma separated list of enum field names you'd like returned as original values, rather than normalized to Merge's standard enum values. Learn more

Field support by integration
See all supported fields
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