ZAzahlo
Billing

Retrieve an invoice

Retrieve an invoice. Use the response status and request ID to decide whether to retry, reconcile, or ask the customer for action.

get/api/v1/invoices/{id}

Request

  • Base URL
    https://merchant.zahlo.eu
  • Auth
    API key in header x-api-key

Path parameters

idstring required

The resource identifier returned by the merchant API.

Response

Successful response

idstring required
object'invoice' required
livemodeboolean required
createdAtstring date-time required
kind'invoice' | 'receipt' required

receipt until you set an invoice VAT rate.

status'paid' required
numberstring required

Sequential per merchant.

customerIdstring nullable
subscriptionIdstring nullable
paymentIdstring required
currencystring required
amountSubtotalMinorinteger required
amountDiscountMinorinteger required
amountPaidMinorinteger required

Tax-inclusive total.

customerTaxIdsstring[] required
periodStartstring date-time nullable

Service period of a subscription invoice.

periodEndstring date-time nullable
paidAtstring date-time required
hostedInvoiceUrlstring uri required
invoicePdfUrlstring uri required

Changes

No recorded changes to this operation across all 1 revision of this API.