Invoices
The Invoice object represents an itemized record of goods and/or services sold to a customer.
Properties
idString
Required
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.
contactString
Optional
The invoice's contact.
numberString
Optional
The invoice's number.
issue_dateString
Optional
The invoice's issue date.
due_dateString
Optional
The invoice's due date.
paid_on_dateString
Optional
The invoice's paid date.
memoString
Optional
The invoice's private note.
companyString
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_atString
Optional
When the third party's invoice entry was updated.
tracking_categoriesArray
Required
paymentsArray
Required
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.
JSON
{
  "remote_id": "8765432",
  "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",
  "created_at": "2021-09-15T00:00:00Z",
  "modified_at": "2021-10-16T00:00:00Z",
Show advanced fields
}
Properties
remote_idString
Optional
The third-party API ID of the matching object.
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.
itemString
Optional
accountString
Optional
tracking_categoryString
Optional
tracking_categoriesArray
Required
companyString
Optional
The company the line item belongs to.
idString
Required
created_atString
Required
modified_atString
Required
This is the datetime that this object was last updated by Merge
field_mappingsObject
Optional
remote_was_deletedBoolean
Required
accounting_periodString
Optional
The accounting period that the Invoice was generated in.
purchase_ordersArray
Required
remote_idString
Optional
The third-party API ID of the matching object.
created_atString
Required
modified_atString
Required
This is the datetime that this object was last updated by Merge
field_mappingsObject
Optional
remote_dataRemoteData[]
Optional
The Invoice object
JSON
{
  "id": "9871b4a9-f5d2-4f3b-a66b-dfedbed42c46",
  "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,
  "status": "DRAFT",
  "total_tax_amount": 5,
  "total_amount": 105,
  "balance": 105,
  "remote_updated_at": "2020-04-01T00:00:00Z",
  "tracking_categories": [
    "7dc5ca17-d311-44cd-9ce0-333080367a18",
    "6aa0700c-48e1-4c4a-8162-02e6a582df05",
    "8c933d61-8f5b-4360-ac0c-c9dc87bee763"
  ],
  "payments": [
    "b26fd49a-cbae-470a-a8f8-bcbc119e0390"
  ],
  "line_items": [
    {
      "id": "022a2bef-57e5-4def-8ed2-7c41bd9a5ed8",
      "remote_id": "8765432",
      "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",
      "remote_data": [
        {
          "path": "/actions",
          "data": [
            "Varies by platform"
          ]
        }
      ]
    }
  ],
  "remote_was_deleted": true,
  "accounting_period": "7dc5ca17-d311-44cd-9ce0-333080367a18",
  "purchase_orders": [
    "e7378d8f-3992-4c2a-8417-ebdc4f2bfeb7",
    "dd70ca2f-b120-46fa-889a-9604037f45fd",
    "889b281d-739c-4759-95b8-0aedb3947131"
  ],
  "remote_id": "990110",
  "created_at": "2021-09-15T00:00:00Z",
  "modified_at": "2021-10-16T00:00:00Z",
Show advanced fields
}
GET
/invoices

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

US
EU

Returns a list of Invoice objects.


Header Parameters
AuthorizationString
Required
Token-based authentication with required prefix "Bearer"
X-Account-TokenString
Required
Token identifying the end user.
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_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.
issue_date_afterString
Optional
If provided, will only return objects created after this datetime.
issue_date_beforeString
Optional
If provided, will only return objects created before this datetime.
modified_afterString
Optional
If provided, only objects synced by Merge after this date time will be returned.
modified_beforeString
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
Which fields should be returned in non-normalized form.
typeString
Optional
If provided, will only return Invoices with this type
Response
JSON
{
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
  "previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
  "results": [
    {
      "id": "9871b4a9-f5d2-4f3b-a66b-dfedbed42c46",
      "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,
      "status": "DRAFT",
      "total_tax_amount": 5,
      "total_amount": 105,
      "balance": 105,
      "remote_updated_at": "2020-04-01T00:00:00Z",
      "tracking_categories": [
        "7dc5ca17-d311-44cd-9ce0-333080367a18",
        "6aa0700c-48e1-4c4a-8162-02e6a582df05",
        "8c933d61-8f5b-4360-ac0c-c9dc87bee763"
      ],
      "payments": [
        "b26fd49a-cbae-470a-a8f8-bcbc119e0390"
      ],
      "line_items": [
        {
          "id": "022a2bef-57e5-4def-8ed2-7c41bd9a5ed8",
          "remote_id": "8765432",
          "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",
          "remote_data": [
            {
              "path": "/actions",
              "data": [
                "Varies by platform"
              ]
            }
          ]
        }
      ],
      "remote_was_deleted": true,
      "accounting_period": "7dc5ca17-d311-44cd-9ce0-333080367a18",
      "purchase_orders": [
        "e7378d8f-3992-4c2a-8417-ebdc4f2bfeb7",
        "dd70ca2f-b120-46fa-889a-9604037f45fd",
        "889b281d-739c-4759-95b8-0aedb3947131"
      ],
      "remote_id": "990110",
      "created_at": "2021-09-15T00:00:00Z",
      "modified_at": "2021-10-16T00:00:00Z",
Show advanced fields
    }
  ]
}
Field support by platform
Clear Books
Clear Books

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

line_itemsInvoiceLineItem[]
descriptionstring
unit_pricenumber
quantitynumber
balanceNumber
currencyEnum
due_dateString
issue_dateString
numberString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
remote_updated_atString
total_amountNumber
total_tax_amountNumber
typeEnum
FreeAgent
FreeAgent

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

line_itemsInvoiceLineItem[]
remote_idstring
descriptionstring
unit_pricenumber
quantitynumber
total_amountnumber
accountstring
balanceNumber
contactString
currencyEnum
due_dateString
issue_dateString
memoString
numberString
paid_on_dateString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
remote_updated_atString
total_amountNumber
typeEnum
FreshBooks
FreshBooks

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

line_itemsInvoiceLineItem[]
remote_idstring
descriptionstring
unit_pricenumber
quantitynumber
total_amountnumber
currencystring
balanceNumber
contactString
currencyEnum
due_dateString
issue_dateString
numberString
paid_on_dateString
paymentsArray
remote_dataRemoteData[]
pathstring
datastring
remote_idString
remote_updated_atString
statusEnum
sub_totalNumber
total_amountNumber
total_discountNumber
total_tax_amountNumber
typeEnum
Microsoft Dynamics 365 Business Central
Microsoft Dynamics 365 Business Central

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

line_itemsInvoiceLineItem[]
remote_idstring
descriptionstring
unit_pricenumber
quantitynumber
total_amountnumber
itemstring
accountstring
tracking_categoriesarray
contactString
currencyEnum
due_dateString
issue_dateString
numberString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
remote_updated_atString
statusEnum
total_amountNumber
total_discountNumber
total_tax_amountNumber
tracking_categoriesArray
typeEnum
Moneybird
Moneybird

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

line_itemsInvoiceLineItem[]
remote_idstring
descriptionstring
unit_pricenumber
quantitynumber
total_amountnumber
itemstring
accountstring
balanceNumber
contactString
currencyEnum
due_dateString
issue_dateString
paid_on_dateString
paymentsArray
remote_dataRemoteData[]
pathstring
datastring
remote_idString
remote_updated_atString
total_amountNumber
total_discountNumber
typeEnum
NetSuite
NetSuite

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

line_itemsInvoiceLineItem[]
remote_idstring
descriptionstring
unit_pricenumber
quantitynumber
total_amountnumber
currencystring
exchange_ratestring
itemstring
accountstring
tracking_categoriesarray
accounting_periodString
balanceNumber
companyString
contactString
currencyEnum
due_dateString
exchange_rateString
issue_dateString
memoString
numberString
purchase_ordersArray
remote_dataRemoteData[]
pathstring
datastring
remote_idString
remote_updated_atString
statusEnum
sub_totalNumber
total_amountNumber
tracking_categoriesArray
typeEnum
QuickBooks Online
QuickBooks Online

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

line_itemsInvoiceLineItem[]
remote_idstring
descriptionstring
unit_pricenumber
quantitynumber
total_amountnumber
itemstring
accountstring
tracking_categoriesarray
balanceNumber
contactString
currencyEnum
due_dateString
exchange_rateString
issue_dateString
memoString
numberString
paymentsArray
remote_dataRemoteData[]
pathstring
datastring
remote_idString
remote_updated_atString
statusEnum
total_amountNumber
total_tax_amountNumber
tracking_categoriesArray
typeEnum
Sage Business Cloud Accounting
Sage Business Cloud Accounting

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

line_itemsInvoiceLineItem[]
remote_idstring
descriptionstring
unit_pricenumber
quantitynumber
total_amountnumber
itemstring
balanceNumber
contactString
currencyEnum
due_dateString
exchange_rateString
issue_dateString
numberString
paid_on_dateString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
remote_updated_atString
sub_totalNumber
total_amountNumber
total_discountNumber
total_tax_amountNumber
typeEnum
Sage Intacct
Sage Intacct

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

line_itemsInvoiceLineItem[]
remote_idstring
descriptionstring
total_amountnumber
currencystring
exchange_ratestring
itemstring
accountstring
tracking_categoriesarray
balanceNumber
companyString
contactString
currencyEnum
due_dateString
exchange_rateString
issue_dateString
memoString
numberString
paid_on_dateString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
remote_updated_atString
statusEnum
total_amountNumber
typeEnum
Wave Financial
Wave Financial

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

line_itemsInvoiceLineItem[]
descriptionstring
unit_pricenumber
quantitynumber
total_amountnumber
itemstring
accountstring
balanceNumber
contactString
currencyEnum
due_dateString
issue_dateString
memoString
numberString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
remote_updated_atString
sub_totalNumber
total_amountNumber
total_discountNumber
total_tax_amountNumber
typeEnum
Workday
Workday

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

line_itemsInvoiceLineItem[]
remote_idstring
unit_pricenumber
quantitynumber
total_amountnumber
itemstring
companystring
balanceNumber
companyString
contactString
currencyEnum
due_dateString
exchange_rateString
issue_dateString
memoString
numberString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
total_amountNumber
total_tax_amountNumber
typeEnum
Xero
Xero

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

line_itemsInvoiceLineItem[]
remote_idstring
descriptionstring
unit_pricenumber
quantitynumber
total_amountnumber
itemstring
accountstring
tracking_categoriesarray
balanceNumber
contactString
currencyEnum
due_dateString
exchange_rateString
issue_dateString
memoString
numberString
paid_on_dateString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
remote_updated_atString
statusEnum
sub_totalNumber
total_amountNumber
total_discountNumber
total_tax_amountNumber
typeEnum
Zoho Books
Zoho Books

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

line_itemsInvoiceLineItem[]
remote_idstring
descriptionstring
unit_pricenumber
quantitynumber
total_amountnumber
itemstring
accountstring
companystring
balanceNumber
companyString
contactString
currencyEnum
due_dateString
issue_dateString
memoString
numberString
paid_on_dateString
paymentsArray
remote_dataRemoteData[]
pathstring
datastring
remote_idString
remote_updated_atString
statusEnum
sub_totalNumber
total_amountNumber
total_discountNumber
total_tax_amountNumber
typeEnum
Not seeing a platform that you're looking for? Submit a request for it here.
Hint: Use the /linked-accounts endpoint to pull platform support information.
POST
/invoices

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

US
EU

Creates an Invoice 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
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.
contactString
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_dateString
The invoice's issue date.
due_dateString
The invoice's due date.
paid_on_dateString
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.
companyString
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
integration_paramsObject
linked_account_paramsObject
POST v1/invoices
JSON
{
  "model": {
    "contact": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "number": "string",
    "issue_date": "2023-09-28T03:29:00.375Z",
    "due_date": "2023-09-28T03:29:00.375Z",
    "paid_on_date": "2023-09-28T03:29:00.375Z",
    "memo": "string",
    "company": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "exchange_rate": "string",
    "total_discount": 0,
    "sub_total": 0,
    "total_tax_amount": 0,
    "total_amount": 0,
    "balance": 0,
    "payments": [
      "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    ],
    "tracking_categories": [
      "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    ],
    "line_items": [
      {
        "remote_id": "8765432",
        "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"
      }
    ]
  }
}
Response
JSON
{
  "model": {
    "id": "9871b4a9-f5d2-4f3b-a66b-dfedbed42c46",
    "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,
    "status": "DRAFT",
    "total_tax_amount": 5,
    "total_amount": 105,
    "balance": 105,
    "remote_updated_at": "2020-04-01T00:00:00Z",
    "tracking_categories": [
      "7dc5ca17-d311-44cd-9ce0-333080367a18",
      "6aa0700c-48e1-4c4a-8162-02e6a582df05",
      "8c933d61-8f5b-4360-ac0c-c9dc87bee763"
    ],
    "payments": [
      "b26fd49a-cbae-470a-a8f8-bcbc119e0390"
    ],
    "line_items": [
      {
        "id": "022a2bef-57e5-4def-8ed2-7c41bd9a5ed8",
        "remote_id": "8765432",
        "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",
        "remote_data": [
          {
            "path": "/actions",
            "data": [
              "Varies by platform"
            ]
          }
        ]
      }
    ],
    "remote_was_deleted": true,
    "accounting_period": "7dc5ca17-d311-44cd-9ce0-333080367a18",
    "purchase_orders": [
      "e7378d8f-3992-4c2a-8417-ebdc4f2bfeb7",
      "dd70ca2f-b120-46fa-889a-9604037f45fd",
      "889b281d-739c-4759-95b8-0aedb3947131"
    ],
    "remote_id": "990110",
    "created_at": "2021-09-15T00:00:00Z",
    "modified_at": "2021-10-16T00:00:00Z",
Show advanced fields
  }
}
Field support by platform
Microsoft Dynamics 365 Business Central
Microsoft Dynamics 365 Business Central

Merge supports Passthrough Requests to this platform's API

Supported POST Model Parameters

companyString
Optional
contactString
Required
currencyEnum
Optional
due_dateString
Optional
issue_dateString
Optional
line_itemsInvoiceLineItem[]
remote_idstring
descriptionstring
unit_pricenumber
quantitynumber
total_amountnumber
currencystring
exchange_ratestring
itemstring
accountstring
tracking_categorystring
tracking_categoriesarray
companystring
idstring
created_atstring
modified_atstring
field_mappingsobject
numberString
Optional
remote_idString
Optional
remote_updated_atString
Optional
total_amountNumber
Optional
total_discountNumber
Optional
total_tax_amountNumber
Optional
typeEnum
Required
NetSuite
NetSuite

Merge supports Passthrough Requests to this platform's API

Supported POST Model Parameters

balanceNumber
Optional
companyString
Required
contactString
Required
currencyEnum
Optional
due_dateString
Optional
exchange_rateString
Optional
issue_dateString
Optional
line_itemsInvoiceLineItem[]
remote_idstring
descriptionstring
unit_pricenumber
quantitynumber
total_amountnumber
currencystring
exchange_ratestring
itemstring
accountstring
tracking_categorystring
tracking_categoriesarray
companystring
idstring
created_atstring
modified_atstring
field_mappingsobject
memoString
Optional
numberString
Optional
remote_idString
Optional
remote_updated_atString
Optional
statusEnum
Optional
sub_totalNumber
Optional
total_amountNumber
Optional
total_discountNumber
Optional
total_tax_amountNumber
Optional
typeEnum
Required
QuickBooks Online
QuickBooks Online

Merge supports Passthrough Requests to this platform's API

Supported POST Model Parameters

balanceNumber
Optional
contactString
Required
currencyEnum
Optional
due_dateString
Optional
exchange_rateString
Optional
issue_dateString
Optional
line_itemsInvoiceLineItem[]
remote_idstring