v1

latestOpenAPI 3.1.02026-07-24120106.5 KB

List Terminal Invoices

get/billing/terminal/invoices

Query parameters

customerIdstring

Filter by unique identifier of the customer.

terminalIdstring

Filter by unique identifier of the terminalId.

externalInvoiceIdstring

Filter by unique identifier of the externalInvoiceId from integrator's system.

statusstring

Filter by invoice status. Supported values are PAID, PENDING_TERMINAL_PAYMENT, PROCESSING, FAILED, REFUNDED, PARTIALLY_REFUNDED.

fromstring

Start date for range of invoices to view. Filter by date defined in the invoice date.

untilstring

Apply a limit to the number of objects to be returned. Supported limit range is 1 to 100. Defaults to 10.

limitstring

To paginate a large result set, use the 'limit' argument to limit the number of results returned per page up to a maximum of 100 records. For example, limit = 10 shows results 1-10. The default returned result would be 100.

cursorstring

An cursor for use in pagination. Specify the number of objects to skip to fetch the next page of objects. For example, limit=10 and cursor=10 will show results for record 11 - 20.

sortBystring

Sort the result based on the provided parameter if exist

Headers

merchantstring required

Merchant ID

Response

200

Example response

{
  "data": [
    {
      "id": "c184ef50-cc0a-4139-ac1f-2d86b1a520e9",
      "documentNumber": "IN0000000000000072",
      "date": "2025-04-07",
      "dueDate": "2025-04-07",
      "status": "FAILED",
      "memo": "this is a test invoice for FRS 9 August 2023",
      "items": [
        {
          "description": "this is a test invoice for FRS ",
          "amount": {
            "currency": "AUD",
            "value": 1000
          },
          "tax": {
            "rate": 10
          },
          "id": "892d6e55-7e86-4f81-b5eb-43c6a29253d3",
          "type": "on_demand_payment",
          "discounted": {
            "currency": "AUD"
          }
        }
      ],
      "amount": {
        "currency": "AUD",
        "value": 1000
      },
      "amountWithoutDiscount": {
        "currency": "AUD",
        "value": 1000
      },
      "totalDiscounted": {
        "currency": "AUD"
      },
      "totalRefunded": {
        "currency": "AUD"
      },
      "totalTax": {
        "currency": "AUD",
        "value": 90.91
      },
      "processingModel": "IN_PERSON_PAYMENT",
      "createdOn": "2025-04-07T07:04:22.931",
      "failedPaymentReason": {
        "code": "declined",
        "description": "This transaction was declined by the bank."
      },
      "paymentProviderResponse": {
        "description": "DECLINED"
      },
      "channel": "MOBILE_POINT_OF_SALE",
      "terminalId": "195a48b4-735f-4697-8702-102b1facaad8",
      "invoiceCategory": "ONE_OFF",
      "invoiceSubCategory": "TERMINAL",
      "manualRetryPossible": true
    }
  ],
  "paging": {
    "totalCount": 2
  }
}