---
title: "Create A Terminal Invoice"
method: POST
path: "/billing/terminal/invoices"
---

# Create A Terminal Invoice

`POST /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`

## Headers

- `merchant` string, required

## Request body

- object
  - `terminalId` string, required
  - `memo` string: Description of the invoice item. Max of 100 characters.
  - `items` object[], required: Details of the individual items that are included in the invoice.
    - `description` string: Description of the invoice Item.
    - `accountingCode` string: Specify an accounting code to categorise revenue collected from the invoice item. Max of 50 characters.
    - `amount` object
      - `currency` string, required: Three letter ISO 4217 currency code for the amount.
      - `value` number, double, required: The value of the amount. Must be positive value greater than zero.
      - `type` string: The type of the amount value. Supported values are: `percentage`, `fixed_amount`
    - `tax` object
      - `rate` number, double: Rate of the specified tax in percentage. Supported values are from 0 to 99.99.
    - `reference` string: Additional reference for invoice
  - `autoPayment` boolean: Determines if auto payment processing occurs for invoices generated from the subscription. Supported value are: `true` - Default value. Invoices generated will automatically proceed to payment processing. `false` - Invoices are generated but will not automatically proceed to payment processing.
  - `externalInvoiceId` string: An invoice id from integrator's system that works as a correlation id with the invoice from Ezypay's system, which helps to identify the invoice. It should be unique per merchant
  - `customerId` string: Identifier of the customer the invoice is billed to.

## Response `200`

200

- 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
  - `payNowUrl` unknown
  - `channel` string
  - `checkoutResult` unknown
  - `customerFirstName` unknown
  - `customerLastName` unknown
  - `terminalId` string
  - `invoiceCategory` string
  - `invoiceSubCategory` string

## Other responses

- `400`: 400

## Changes

- **2026-11-03** `924be4030f56`: 1 breaking, 2 warning
  - added the new required `header` request parameter `merchant`
  - deleted the `header` request parameter `authorization`
  - deleted the `header` request parameter `merchantId`

[Operation history](https://skmtc.dev/ezypay/apis/vault/changes/billing/terminal/invoices/post.md)

---

[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)