​
Endpoint

GET /api/invoices 
[
    {
        "invoiceId": 388815,
        "customerId": null,
        "merchantInvoiceRefId": "1234-5678-9101",
        "binNumber": "444433",
        "last4Digit": "1111",
        "invoiceStatus": "Paid",
        "subtotal": 150.0000,
        "tax": 0.0000,
        "total": 150.0000,
        "billingDate": "12-15-2024",
        "merchantLegalName": "Test Merchant",
        "merchantCustomerRefId": null,
        "customerFirstName": null,
        "customerLastName": null
    },
.... Additional array values
  ]

​
Request Parameters

All parameters are optional and can be used to filter or paginate the list of invoices.
ParameterTypeDescriptionDefault
start_dateStringFilter invoices issued on or after this date (ISO 8601 format: YYYY-MM-DD).None
end_dateStringFilter invoices issued on or before this date (ISO 8601 format: YYYY-MM-DD).None
statusStringFilter by invoice status (open, paid, voided, draft).None
pageIntegerPage number to retrieve (1-based indexing).1
page_sizeIntegerNumber of invoices per page (max: 100).25

​
Example Request

StartDate and EndDate filter values are based on BillingDate in UTC. The result is sorted by invoice billing date in descending order and secondary invoiceId ascending order. Example order:
  1. 12-13-2024 12347
  2. 12-11-2024 12345
  3. 12-11-2024 12346
Pages are limited to 100 items per page. An example call with filters would be 
{{Api Root}}/api/Invoices?startDate=01-05-2024&endDate=12-12-2024&page=2&pageSize=10

​
Response

The API returns a JSON array of invoice objects.

​
Response Fields

FieldTypeDescription
idStringUnique identifier for the invoice.
amountNumberTotal invoice amount (in cents, e.g., 15075 = $150.75).
currencyStringCurrency code (e.g., USD).
statusStringCurrent status of the invoice (open, paid, voided, draft).
issue_dateStringDate the invoice was issued (ISO 8601).
due_dateStringDate the invoice is due (ISO 8601).
created_atStringDate the invoice was created (ISO 8601).
updated_atStringDate the invoice was last updated (ISO 8601).
To get more information about the invoices including invoiceAttempts[] check the documentation for Get Details of Invoice Attempts
Invoice Attempts & Details