Invoices
The Invoice object represents an itemized record of goods and/or services sold to a customer.
If type = accounts_payable Invoice is a bill, if type = accounts_receivable it's an invoice.
The Invoice object
Properties
remote_dataRemoteData[]Optional
typeEnumOptional
Whether the invoice is an accounts receivable or accounts payable. Accounts payable invoices are commonly referred to as Bills. Possible values include:
ACCOUNTS_RECEIVABLE, ACCOUNTS_PAYABLE, or - in cases where there is no clear mapping - the original value passed through.contactStringOptional
The invoice's contact.
numberStringOptional
The invoice's number.
issue_dateStringOptional
The invoice's issue date.
due_dateStringOptional
The invoice's due date.
paid_on_dateStringOptional
The invoice's paid date.
memoStringOptional
The invoice's private note.
companyStringOptional
The company the invoice belongs to.
currencyEnumOptional
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, or - in cases where there is no clear mapping - the original value passed through.exchange_rateStringOptional
The invoice's exchange rate.
total_discountNumberOptional
The total discounts applied to the total cost.
sub_totalNumberOptional
The total amount being paid before taxes.
total_tax_amountNumberOptional
The total amount being paid in taxes.
total_amountNumberOptional
The invoice's total amount.
balanceNumberOptional
The invoice's remaining balance.
remote_updated_atStringOptional
When the third party's invoice entry was updated.
paymentsArrayRequired
Array of
Payment object IDs.line_itemsInvoiceLineItem[]Required
The InvoiceLineItem object
The
InvoiceLineItem object represents an itemized record of goods and/or services sold to a customer. If type = accounts_payable, invoice is a bill, if type = accounts_receivable it's an invoice.JSON
{"description": "Pickleball lessons","unit_price": 50,"quantity": 1,"total_amount": 50,"currency": "USD","exchange_rate": "2.9","item": "5b3c1341-a20f-4e51-b72c-f3830a16c97b","account": "cd0f32d4-a493-11ec-b909-0242ac120002","tracking_category": "b38c59b0-a9d7-4740-b1ee-5436c6751e3d","tracking_categories": ["b38c59b0-a9d7-4740-b1ee-5436c6751e3d","9b840d2-686a-465a-8a8e-7b028498f8e4","a47e11b6-c73b-4a0c-be31-130fc48177fa"],"company": "595c8f97-2ac4-45b7-b000-41bdf43240b5","id": "022a2bef-57e5-4def-8ed2-7c41bd9a5ed8","remote_id": "8765432","field_mappings": {"organization_defined_targets": {"custom_key": "custom_value"},"linked_account_defined_targets": {"custom_key": "custom_value"}}}
Properties
descriptionStringOptional
The line item's description.
unit_priceNumberOptional
The line item's unit price.
quantityNumberOptional
The line item's quantity.
total_amountNumberOptional
The line item's total amount.
currencyEnumOptional
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, or - in cases where there is no clear mapping - the original value passed through.exchange_rateStringOptional
The line item's exchange rate.
itemStringOptional
accountStringOptional
tracking_categoryStringOptional
tracking_categoriesArrayRequired
companyStringOptional
The company the line item belongs to.
idStringRequired
remote_idStringOptional
The third-party API ID of the matching object.
field_mappingsObjectOptional
remote_was_deletedBooleanRequired
idStringRequired
remote_idStringOptional
The third-party API ID of the matching object.
field_mappingsObjectOptional
The Invoice object
JSON
{"remote_data": [{"path": "/actions","data": ["Varies by platform"]}],"type": "ACCOUNTS_RECEIVABLE","contact": "022a2bef-57e5-4def-8ed2-7c41bd9a5ed8","number": "AIQ12546","issue_date": "2020-03-31T00:00:00Z","due_date": "2020-04-15T00:00:00Z","paid_on_date": "2020-04-01T00:00:00Z","memo": "Weekly Payment","company": "595c8f97-2ac4-45b7-b000-41bdf43240b5","currency": "USD","exchange_rate": "2.9","total_discount": 0,"sub_total": 100,"total_tax_amount": 5,"total_amount": 105,"balance": 105,"remote_updated_at": "2020-04-01T00:00:00Z","payments": ["b26fd49a-cbae-470a-a8f8-bcbc119e0390"],"line_items": [{"id": "022a2bef-57e5-4def-8ed2-7c41bd9a5ed8","remote_id": "8765432","description": "Pickleball lessons","unit_price": 50,"quantity": 2,"total_amount": 100,"item": "5b3c1341-a20f-4e51-b72c-f3830a16c97b","account": "cd0f32d4-a493-11ec-b909-0242ac120002","remote_data": [{"path": "/actions","data": ["Varies by platform"]}]}],"remote_was_deleted": true,"id": "9871b4a9-f5d2-4f3b-a66b-dfedbed42c46","remote_id": "990110","field_mappings": {"organization_defined_targets": {"custom_key": "custom_value"},"linked_account_defined_targets": {"custom_key": "custom_value"}}}
GET
/invoices
Returns a list of Invoice objects.
Header Parameters
AuthorizationStringRequired
Token-based authentication with required prefix "Bearer"
X-Account-TokenStringRequired
Token identifying the end user.
Query & Path Parameters
company_idStringOptional
If provided, will only return invoices for this company.
contact_idStringOptional
If provided, will only return invoices for this contact.
created_afterStringOptional
If provided, will only return objects created after this datetime.
created_beforeStringOptional
If provided, will only return objects created before this datetime.
cursorStringOptional
The pagination cursor value.
expandStringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
include_deleted_dataBooleanOptional
Whether to include data that was marked as deleted by third party webhooks.
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
modified_afterStringOptional
If provided, will only return objects modified after this datetime.
modified_beforeStringOptional
If provided, will only return objects modified before this datetime.
page_sizeIntegerOptional
Number of results to return per page.
remote_fieldsStringOptional
Deprecated. Use show_enum_origins.
remote_idStringOptional
The API provider's ID for the given object.
show_enum_originsStringOptional
Which fields should be returned in non-normalized form.
typeStringOptional
If provided, will only return Invoices with this type
Response
JSON
{"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw","previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ","results": [{"remote_data": [{"path": "/actions","data": ["Varies by platform"]}],"type": "ACCOUNTS_RECEIVABLE","contact": "022a2bef-57e5-4def-8ed2-7c41bd9a5ed8","number": "AIQ12546","issue_date": "2020-03-31T00:00:00Z","due_date": "2020-04-15T00:00:00Z","paid_on_date": "2020-04-01T00:00:00Z","memo": "Weekly Payment","company": "595c8f97-2ac4-45b7-b000-41bdf43240b5","currency": "USD","exchange_rate": "2.9","total_discount": 0,"sub_total": 100,"total_tax_amount": 5,"total_amount": 105,"balance": 105,"remote_updated_at": "2020-04-01T00:00:00Z","payments": ["b26fd49a-cbae-470a-a8f8-bcbc119e0390"],"line_items": [{"id": "022a2bef-57e5-4def-8ed2-7c41bd9a5ed8","remote_id": "8765432","description": "Pickleball lessons","unit_price": 50,"quantity": 2,"total_amount": 100,"item": "5b3c1341-a20f-4e51-b72c-f3830a16c97b","account": "cd0f32d4-a493-11ec-b909-0242ac120002","remote_data": [{"path": "/actions","data": ["Varies by platform"]}]}],"remote_was_deleted": true,"id": "9871b4a9-f5d2-4f3b-a66b-dfedbed42c46","remote_id": "990110","field_mappings": {"organization_defined_targets": {"custom_key": "custom_value"},"linked_account_defined_targets": {"custom_key": "custom_value"}}}]}
Field support by platform
Clear Books
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
line_itemsInvoiceLineItem[]descriptionstringunit_pricenumberquantitynumberbalanceNumbercurrencyEnumdue_dateStringissue_dateStringnumberStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringtotal_amountNumbertotal_tax_amountNumbertypeEnum
FreeAgent
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
line_itemsInvoiceLineItem[]descriptionstringunit_pricenumberquantitynumbertotal_amountnumberaccountstringremote_idstringbalanceNumbercontactStringcurrencyEnumdue_dateStringissue_dateStringmemoStringnumberStringpaid_on_dateStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringtotal_amountNumbertypeEnum
FreshBooks
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
line_itemsInvoiceLineItem[]descriptionstringunit_pricenumberquantitynumbertotal_amountnumberremote_idstringbalanceNumbercontactStringcurrencyEnumdue_dateStringissue_dateStringnumberStringpaid_on_dateStringremote_dataRemoteData[]pathstringdataobjectremote_idStringtotal_amountNumbertotal_discountNumber
Microsoft Dynamics 365 Business Central
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
line_itemsInvoiceLineItem[]descriptionstringunit_pricenumberquantitynumbertotal_amountnumberitemstringaccountstringremote_idstringcontactStringcurrencyEnumdue_dateStringissue_dateStringnumberStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringtotal_amountNumbertotal_discountNumbertotal_tax_amountNumbertypeEnum
Moneybird
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
line_itemsInvoiceLineItem[]descriptionstringunit_pricenumberquantitynumbertotal_amountnumberitemstringaccountstringremote_idstringbalanceNumbercontactStringcurrencyEnumdue_dateStringissue_dateStringpaid_on_dateStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringtotal_amountNumbertotal_discountNumbertypeEnum
NetSuite
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
line_itemsInvoiceLineItem[]descriptionstringunit_pricenumberquantitynumbertotal_amountnumberexchange_ratestringitemstringaccountstringtracking_categorystringtracking_categoriesarrayremote_idstringbalanceNumbercompanyStringcontactStringcurrencyEnumdue_dateStringexchange_rateStringissue_dateStringmemoStringnumberStringpaid_on_dateStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringsub_totalNumbertotal_amountNumbertypeEnum
QuickBooks Online
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
line_itemsInvoiceLineItem[]descriptionstringunit_pricenumberquantitynumbertotal_amountnumberitemstringaccountstringtracking_categorystringremote_idstringbalanceNumbercontactStringcurrencyEnumdue_dateStringexchange_rateStringissue_dateStringmemoStringnumberStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringtotal_amountNumbertotal_tax_amountNumbertypeEnum
Sage Business Cloud Accounting
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
line_itemsInvoiceLineItem[]descriptionstringunit_pricenumberquantitynumbertotal_amountnumberitemstringremote_idstringbalanceNumbercontactStringcurrencyEnumdue_dateStringissue_dateStringnumberStringpaid_on_dateStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringsub_totalNumbertotal_amountNumbertotal_discountNumbertotal_tax_amountNumbertypeEnum
Sage Intacct
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
line_itemsInvoiceLineItem[]descriptionstringtotal_amountnumberitemstringaccountstringtracking_categorystringremote_idstringbalanceNumbercontactStringcurrencyEnumdue_dateStringissue_dateStringmemoStringnumberStringpaid_on_dateStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringtotal_amountNumbertypeEnum
Wave Financial
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
line_itemsInvoiceLineItem[]descriptionstringunit_pricenumberquantitynumbertotal_amountnumberitemstringaccountstringbalanceNumbercontactStringcurrencyEnumdue_dateStringissue_dateStringmemoStringnumberStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringsub_totalNumbertotal_amountNumbertotal_discountNumbertotal_tax_amountNumbertypeEnum
Xero
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
line_itemsInvoiceLineItem[]descriptionstringunit_pricenumberquantitynumbertotal_amountnumberitemstringaccountstringtracking_categorystringremote_idstringbalanceNumbercontactStringcurrencyEnumdue_dateStringissue_dateStringnumberStringpaid_on_dateStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringsub_totalNumbertotal_amountNumbertotal_discountNumbertotal_tax_amountNumbertypeEnum
Zoho Books
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
line_itemsInvoiceLineItem[]descriptionstringunit_pricenumberquantitynumbertotal_amountnumberitemstringaccountstringremote_idstringbalanceNumbercontactStringcurrencyEnumdue_dateStringissue_dateStringmemoStringnumberStringpaid_on_dateStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringsub_totalNumbertotal_amountNumbertotal_discountNumbertotal_tax_amountNumbertypeEnumHint: Use the /linked-accounts endpoint to pull platform support information.
POST
/invoices
Creates an Invoice object with the given values.
Header Parameters
AuthorizationStringRequired
Token-based authentication with required prefix "Bearer"
X-Account-TokenStringRequired
Token identifying the end user.
Query & Path Parameters
is_debug_modeBooleanOptional
Whether to include debug fields (such as log file links) in the response.
run_asyncBooleanOptional
Whether or not third-party updates should be run asynchronously.
Body Parameters
modelObjectRequired
Find available fields below under “Model Parameters”.
Model Parameters
typeEnumOptional
Whether the invoice is an accounts receivable or accounts payable. Accounts payable invoices are commonly referred to as Bills. Must pass in one of the following choices:
ACCOUNTS_RECEIVABLE, ACCOUNTS_PAYABLE.contactStringOptional
The invoice's contact. Must pass in a valid Merge ID, which can be obtained from the
id field in the Contact table.numberStringOptional
The invoice's number.
issue_dateStringOptional
The invoice's issue date.
due_dateStringOptional
The invoice's due date.
paid_on_dateStringOptional
The invoice's paid date.
memoStringOptional
The invoice's private note.
companyStringOptional
The company the invoice belongs to. Must pass in a valid Merge ID, which can be obtained from the
id field in the CompanyInfo table.currencyEnumOptional
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_rateStringOptional
The invoice's exchange rate.
total_discountNumberOptional
The total discounts applied to the total cost.
sub_totalNumberOptional
The total amount being paid before taxes.
total_tax_amountNumberOptional
The total amount being paid in taxes.
total_amountNumberOptional
The invoice's total amount.
balanceNumberOptional
The invoice's remaining balance.
paymentsArrayRequired
Array of
Payment object IDs.line_itemsArrayRequired
integration_paramsObjectOptional
linked_account_paramsObjectOptional
POST v1/invoices
JSON
{"model": {"type": "ACCOUNTS_RECEIVABLE","contact": "022a2bef-57e5-4def-8ed2-7c41bd9a5ed8","number": "AIQ12546","issue_date": "2020-03-31T00:00:00Z","due_date": "2020-04-15T00:00:00Z","paid_on_date": "2020-04-01T00:00:00Z","memo": "Weekly Payment","company": "595c8f97-2ac4-45b7-b000-41bdf43240b5","currency": "USD","exchange_rate": "2.9","total_discount": 0,"sub_total": 100,"total_tax_amount": 5,"total_amount": 105,"balance": 105,"payments": ["b26fd49a-cbae-470a-a8f8-bcbc119e0390"],"line_items": [{"id": "022a2bef-57e5-4def-8ed2-7c41bd9a5ed8","remote_id": "8765432","description": "Pickleball lessons","unit_price": 50,"quantity": 2,"total_amount": 100,"item": "5b3c1341-a20f-4e51-b72c-f3830a16c97b","account": "cd0f32d4-a493-11ec-b909-0242ac120002","remote_data": [{"path": "/actions","data": ["Varies by platform"]}]}]}}
Response
JSON
{"model": {"remote_data": [{"path": "/actions","data": ["Varies by platform"]}],"type": "ACCOUNTS_RECEIVABLE","contact": "022a2bef-57e5-4def-8ed2-7c41bd9a5ed8","number": "AIQ12546","issue_date": "2020-03-31T00:00:00Z","due_date": "2020-04-15T00:00:00Z","paid_on_date": "2020-04-01T00:00:00Z","memo": "Weekly Payment","company": "595c8f97-2ac4-45b7-b000-41bdf43240b5","currency": "USD","exchange_rate": "2.9","total_discount": 0,"sub_total": 100,"total_tax_amount": 5,"total_amount": 105,"balance": 105,"remote_updated_at": "2020-04-01T00:00:00Z","payments": ["b26fd49a-cbae-470a-a8f8-bcbc119e0390"],"line_items": [{"id": "022a2bef-57e5-4def-8ed2-7c41bd9a5ed8","remote_id": "8765432","description": "Pickleball lessons","unit_price": 50,"quantity": 2,"total_amount": 100,"item": "5b3c1341-a20f-4e51-b72c-f3830a16c97b","account": "cd0f32d4-a493-11ec-b909-0242ac120002","remote_data": [{"path": "/actions","data": ["Varies by platform"]}]}],"remote_was_deleted": true,"id": "9871b4a9-f5d2-4f3b-a66b-dfedbed42c46","remote_id": "990110","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
Microsoft Dynamics 365 Business Central
Merge supports Passthrough Requests to this platform's API
Supported POST Body Parameters
contactStringRequired
currencyEnumOptional
due_dateStringOptional
issue_dateStringOptional
numberStringOptional
remote_idStringOptional
remote_updated_atStringOptional
total_amountNumberOptional
total_discountNumberOptional
total_tax_amountNumberOptional
typeEnumRequired
Additional POST Parameters
integration_paramsObjectRequired
company_idStringRequired
NetSuite
Merge supports Passthrough Requests to this platform's API
Supported POST Body Parameters
balanceNumberOptional
contactStringOptional
currencyEnumOptional
due_dateStringOptional
issue_dateStringOptional
memoStringOptional
numberStringOptional
paid_on_dateStringOptional
remote_idStringOptional
remote_updated_atStringOptional
sub_totalNumberOptional
total_amountNumberOptional
total_discountNumberOptional
total_tax_amountNumberOptional
typeEnumOptional
Additional POST Parameters
companyStringRequired
QuickBooks Online
Merge supports Passthrough Requests to this platform's API
Supported POST Body Parameters
balanceNumberOptional
contactStringRequired
currencyEnumOptional
due_dateStringOptional
issue_dateStringOptional
numberStringOptional
paid_on_dateStringOptional
remote_idStringOptional
remote_updated_atStringOptional
total_amountNumberOptional
typeEnumOptional
Additional POST Parameters
line_itemsStringRequired
Xero
Merge supports Passthrough Requests to this platform's API
Supported POST Body Parameters
balanceNumberOptional
contactStringRequired
currencyEnumOptional
due_dateStringOptional
exchange_rateStringOptional
issue_dateStringOptional
numberStringOptional
remote_idStringOptional
remote_updated_atStringOptional
sub_totalNumberOptional
total_amountNumberOptional
total_tax_amountNumberOptional
typeEnumRequired
Additional POST Parameters
line_itemsObjectRequired
accountStringRequired
FreeAgent
FreshBooks
Sage Intacct
Hint: Use the /linked-accounts endpoint to pull platform support information.
GET
/invoices/{id}
Returns an Invoice object with the given id.
Header Parameters
AuthorizationStringRequired
Token-based authentication with required prefix "Bearer"
X-Account-TokenStringRequired
Token identifying the end user.
Query & Path Parameters
expandStringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
idStringRequired
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
remote_fieldsStringOptional
Deprecated. Use show_enum_origins.
show_enum_originsStringOptional
Which fields should be returned in non-normalized form.
Response
JSON
{"remote_data": [{"path": "/actions","data": ["Varies by platform"]}],"type": "ACCOUNTS_RECEIVABLE","contact": "022a2bef-57e5-4def-8ed2-7c41bd9a5ed8","number": "AIQ12546","issue_date": "2020-03-31T00:00:00Z","due_date": "2020-04-15T00:00:00Z","paid_on_date": "2020-04-01T00:00:00Z","memo": "Weekly Payment","company": "595c8f97-2ac4-45b7-b000-41bdf43240b5","currency": "USD","exchange_rate": "2.9","total_discount": 0,"sub_total": 100,"total_tax_amount": 5,"total_amount": 105,"balance": 105,"remote_updated_at": "2020-04-01T00:00:00Z","payments": ["b26fd49a-cbae-470a-a8f8-bcbc119e0390"],"line_items": [{"id": "022a2bef-57e5-4def-8ed2-7c41bd9a5ed8","remote_id": "8765432","description": "Pickleball lessons","unit_price": 50,"quantity": 2,"total_amount": 100,"item": "5b3c1341-a20f-4e51-b72c-f3830a16c97b","account": "cd0f32d4-a493-11ec-b909-0242ac120002","remote_data": [{"path": "/actions","data": ["Varies by platform"]}]}],"remote_was_deleted": true,"id": "9871b4a9-f5d2-4f3b-a66b-dfedbed42c46","remote_id": "990110","field_mappings": {"organization_defined_targets": {"custom_key": "custom_value"},"linked_account_defined_targets": {"custom_key": "custom_value"}}}
Field support by platform
Clear Books
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
line_itemsInvoiceLineItem[]descriptionstringunit_pricenumberquantitynumberbalanceNumbercurrencyEnumdue_dateStringissue_dateStringnumberStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringtotal_amountNumbertotal_tax_amountNumbertypeEnumFreeAgent
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
line_itemsInvoiceLineItem[]descriptionstringunit_pricenumberquantitynumbertotal_amountnumberaccountstringremote_idstringbalanceNumbercontactStringcurrencyEnumdue_dateStringissue_dateStringmemoStringnumberStringpaid_on_dateStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringtotal_amountNumbertypeEnumFreshBooks
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
line_itemsInvoiceLineItem[]descriptionstringunit_pricenumberquantitynumbertotal_amountnumberremote_idstringbalanceNumbercontactStringcurrencyEnumdue_dateStringissue_dateStringnumberStringpaid_on_dateStringremote_dataRemoteData[]pathstringdataobjectremote_idStringtotal_amountNumbertotal_discountNumberMicrosoft Dynamics 365 Business Central
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
line_itemsInvoiceLineItem[]descriptionstringunit_pricenumberquantitynumbertotal_amountnumberitemstring