v1

latestOpenAPI 3.0.02026-07-2671142187.3 KB

Invoice

Get invoices

get/invoices

Query parameters

pageinteger

Page number for paginated results. Defaults to the first page if omitted.

dateStartstring date-time

Filter invoices created on or after this date or date-time. Format: YYYY-MM-DD or YYYY-MM-DD HH:MM:SS. If time is omitted, 00:00:00 is assumed. If dateEnd is provided, it must not be earlier than dateStart.

dateEndstring date-time

Filter invoices created on or before this date or date-time. Format: YYYY-MM-DD or YYYY-MM-DD HH:MM:SS. If time is omitted, 23:59:59 is assumed. If dateStart is provided, dateEnd must not be earlier than dateStart.

invoiceNumberstring

Filter invoices by the exact invoice number. Matches exactly (case-insensitive). If no match exists, no invoices are returned.

customerIdstring

Filter invoices by customer ID.

Filter invoices by status.

Filter invoices by type.

currency'CAD' | 'USD'

Filter invoices by currency code.

withConvenienceFee0 | 1

Include the convenience fee for each invoice. If 1, the convenience fee is included in the response. If 0 or omitted, the convenience fee is set to 0.

withOrderFields0 | 1

Include custom field values for each invoice. If 1, the orderFields array for each invoice is populated. If 0 or omitted, orderFields is always an empty array.

convenienceFeeEnabled0 | 1

Filter invoices by whether the convenience fee is enabled. If 1, return all invoices with the convenience fee enabled. If 0, return all invoices with the convenience fee disabled. If omitted, no filter is applied.

Response

Successful

invoiceIdinteger

Unique ID of the invoice.

invoiceNumberstring

Invoice number. Generated if not provided during creation.

tokenstring

A system generated unique token to reference the invoice with. can be used to view the invoice online.

typestring

The type of the invoice. Possible values include: ESTIMATE, INVOICE, QUOTE, ORDER, PURCHASE_ORDER, STATEMENT, REGISTRATION, CREDIT.

statusstring

The current status of the invoice. Possible values include: CANCELLED, DUE, PAID, SHIPPED, COMPLETED, REFUNDED, APP, IN_PROGRESS, OVERDUE, FOR_APPROVAL, APPROVED.

currencystring

The three-letter ISO 4217 currency code for this invoice. Possible values include: CAD, USD.

customerIdinteger

ID of the customer associated with this invoice. Will be 0 if no customer is associated with the invoice.

dateCreatedstring date-time

The date and time when the invoice was created.

dateUpdatedstring date-time

The date and time when the invoice was last updated.

datePaidstring date-time

The date and time when the invoice was paid, if applicable.

dateIssuedstring date-time

The date and time when the invoice was issued.

amountnumber float

The total amount of the invoice.

amountPaidnumber float

The total amount that has been paid towards this invoice.

amountDuenumber float

The remaining balance due for this invoice.

tipAmountnumber float

The tip amount applied to this invoice.

depositAmountnumber float

The deposit for items on the invoice, e.g bottle fees.

convenienceFeenumber float

The total convenience fee applied to this invoice.

convenienceFeeEnabledboolean

Indicates whether a convenience fee was enabled for this invoice.

surchargingFeenumber float

The total surcharging fee applied to this invoice.

notesstring

Notes visible to the customer at the bottom of the invoice.

Example response

[
  {
    "invoiceId": 28658838,
    "invoiceNumber": "INV1000",
    "token": "4e71b0b71b032e8bd95097",
    "type": "INVOICE",
    "status": "DUE",
    "currency": "CAD",
    "customerId": 15301549,
    "billingAddress": {
      "name": "John Smith/Helcim",
      "street1": "123 Street",
      "city": "Calgary",
      "province": "AB",
      "country": "CAN",
      "postalCode": "H0H0H0",
      "phone": "1234567890",
      "email": "john@example.com"
    },
    "shipping": {
      "amount": 10.99,
      "details": "Canada Post 1-day shipping",
      "address": {
        "name": "John Smith/Helcim",
        "street1": "123 Street",
        "city": "Calgary",
        "province": "AB",
        "country": "CAN",
        "postalCode": "H0H0H0",
        "phone": "1234567890",
        "email": "john@example.com"
      }
    },
    "pickup": {
      "date": "2022-01-25 13:55:55",
      "name": "Jane Smith"
    },
    "tax": {
      "amount": 5.99,
      "details": "GST 5%"
    },
    "discount": {
      "amount": 10.99,
      "details": "DISC100"
    },
    "dateCreated": "2025-06-20 13:05:03",
    "dateUpdated": "2025-06-20 13:05:03",
    "datePaid": "0000-00-00 00:00:00",
    "dateIssued": "2025-06-20 13:05:03",
    "amount": 127.48,
    "amountDue": 127.48,
    "tipAmount": 0.99,
    "orderFields": [
      {
        "displayName": "Table Number",
        "value": "44B"
      }
    ],
    "notes": "No vegetables please"
  }
]