Invoices

The Invoice object is used to represent a company's invoices.

The Invoice object

Properties


idString
Optional

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

remote_dataRemoteData[]
Optional

typeEnum
Optional
The invoice's type. Possible values include: ACCOUNTS_RECEIVABLE, ACCOUNTS_PAYABLE, or - in cases where there is no clear mapping - the original value passed through.

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.

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, or - in cases where there is no clear mapping - the original value passed through.

total_discountNumber
Optional
The invoice's total discount.

sub_totalNumber
Optional
The invoice's sub-total.

total_tax_amountNumber
Optional
The invoice's total tax amount.

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.

paymentsArray
Optional
Array of Payment object IDs.

line_itemsArray
Optional

The Invoice object

{
  "id": "9871b4a9-f5d2-4f3b-a66b-dfedbed42c46",
  "remote_id": "990110",
  "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",
  "currency": "USD",
  "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",
      "remote_data": [
        {
          "path": "/actions",
          "data": [
            "Varies by platform"
          ]
        }
      ]
    }
  ]
}

GET

/invoices

Returns a list of Invoice objects.


Query & Path Parameters


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.

include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.

modified_afterString
Optional
If provided, will only return objects modified after this datetime.

modified_beforeString
Optional
If provided, will only return objects modified before this datetime.

page_sizeInteger
Optional
Number of results to return per page.

remote_idString
Optional
The API provider's ID for the given object.

Response

{
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
  "previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
  "results": [
    {
      "id": "9871b4a9-f5d2-4f3b-a66b-dfedbed42c46",
      "remote_id": "990110",
      "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",
      "currency": "USD",
      "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",
          "remote_data": [
            {
              "path": "/actions",
              "data": [
                "Varies by platform"
              ]
            }
          ]
        }
      ]
    }
  ]
}
Field support by platform

Quickbooks Online

Quickbooks Online

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


paid_on_dateString

due_dateString

remote_updated_atString

typeEnum

contactString

remote_idString

numberString

balanceNumber

issue_dateString

total_tax_amountNumber

Sage Business Cloud Accounting

Sage Business Cloud Accounting

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


paid_on_dateString

due_dateString

remote_updated_atString

typeEnum

remote_dataRemoteData[]

total_amountNumber

contactString

remote_idString

numberString

balanceNumber

sub_totalNumber

currencyEnum

total_discountNumber

issue_dateString

total_tax_amountNumber
GET

/invoices/{id}

Returns an Invoice object with the given id.


Query & Path Parameters


idString
Required

include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.

Response

{
  "id": "9871b4a9-f5d2-4f3b-a66b-dfedbed42c46",
  "remote_id": "990110",
  "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",
  "currency": "USD",
  "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",
      "remote_data": [
        {
          "path": "/actions",
          "data": [
            "Varies by platform"
          ]
        }
      ]
    }
  ]
}
Field support by platform

Quickbooks Online

Quickbooks Online

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


paid_on_dateString

due_dateString

remote_updated_atString

typeEnum

contactString

remote_idString

numberString

balanceNumber

issue_dateString

total_tax_amountNumber

Sage Business Cloud Accounting

Sage Business Cloud Accounting

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


paid_on_dateString

due_dateString

remote_updated_atString

typeEnum

remote_dataRemoteData[]

total_amountNumber

contactString

remote_idString

numberString

balanceNumber

sub_totalNumber

currencyEnum

total_discountNumber

issue_dateString

total_tax_amountNumber