---
title: "List Terminal Invoices"
method: GET
path: "/billing/terminal/invoices"
---

# List Terminal Invoices

`GET /billing/terminal/invoices`

## Request

- Base URL: `https://api-sandbox.ezypay.com/v2`
- URL: `https://api-sandbox.ezypay.com/v2/billing/terminal/invoices`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://identity-sandbox.ezypay.com/token`

## Query parameters

- `customerId` string
- `terminalId` string
- `externalInvoiceId` string
- `status` string
- `from` string
- `until` string
- `limit` string
- `cursor` string
- `sortBy` string

## Headers

- `merchant` string, required

## Response `200`

200

- object
  - `data` object[]
    - `id` string
    - `creditNoteId` unknown
    - `documentNumber` string
    - `date` string
    - `dueDate` string
    - `scheduledPaymentDate` unknown
    - `status` string
    - `memo` string
    - `items` object[]
      - `description` string
      - `amount` object
        - `currency` string
        - `value` integer
        - `type` unknown
      - `tax` object
        - `rate` integer
      - `id` string
      - `type` string
      - `discounted` object
        - `currency` string
        - `value` integer
        - `type` unknown
      - `accountingCode` unknown
      - `reference` unknown
    - `amount` object
      - `currency` string
      - `value` integer
      - `type` unknown
    - `amountWithoutDiscount` object
      - `currency` string
      - `value` integer
      - `type` unknown
    - `totalDiscounted` object
      - `currency` string
      - `value` integer
      - `type` unknown
    - `totalRefunded` object
      - `currency` string
      - `value` integer
      - `type` unknown
    - `totalTax` object
      - `currency` string
      - `value` number
      - `type` unknown
    - `customerId` unknown
    - `subscriptionId` unknown
    - `checkoutId` unknown
    - `subscriptionName` unknown
    - `paymentMethodToken` unknown
    - `paymentMethodData` unknown
    - `autoPayment` boolean
    - `processingModel` string
    - `transactionSource` unknown
    - `createdOn` string
    - `failedPaymentReason` object
      - `code` string
      - `description` string
    - `paymentProviderResponse` object
      - `code` unknown
      - `description` string
    - `payNowUrl` unknown
    - `channel` string
    - `checkoutResult` unknown
    - `customerFirstName` unknown
    - `customerLastName` unknown
    - `terminalId` string
    - `invoiceCategory` string
    - `invoiceSubCategory` string
    - `manualRetryPossible` boolean
    - `paymentMethodInvalid` boolean
  - `paging` object
    - `nextUrl` unknown
    - `nextCursor` integer
    - `limit` integer
    - `totalCount` integer

## Other responses

- `400`: 400

---

[API](https://skmtc.dev/ezypay/apis/vault.md) - [All operations](https://skmtc.dev/ezypay/apis/vault/llms.txt) - [OpenAPI document](https://skmtc.dev/ezypay/apis/vault/revisions/924be4030f56?raw)