Receipts

Base URL: $BUSINESS_API

The object

receipt_numberstring · required

Receipt number, unique within the tenant.

tenant_idstring · required
payment_idstring · required

Payment the receipt was issued for.

invoice_idstring · required

Invoice the payment was applied to.

customer_idstring · required
customer_namestring · optional

Display name of the referenced customer. Omitted when unknown.

account_idstring · required
account_numberstring · optional

Number of the referenced account, e.g. CTA-000044. Omitted when unknown.

account_holder_namestring · optional

Display name of the customer who holds the referenced account. Omitted when unknown.

amount_centsinteger (int64) · required

Amount received, in minor units.

currencystring · required
issued_atstring (date-time) · required
The object
{
  "receipt_number": "REC-2026-000142",
  "tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
  "payment_id": "pay_2eUBfC8BJA6JLIoHrQwtN0GL1mW",
  "invoice_id": "inv_2jnourvAGxXMMd5IyFbwc1LqUX1",
  "customer_id": "cus_2UuXtOGTHWKlvkoF5so5Joi3Hck",
  "customer_name": "Ana Matsinhe",
  "account_id": "act_2JFioNDgIfvkgflk8RtcqhBaARP",
  "account_number": "ACC-2026-000142",
  "account_holder_name": "Ana Matsinhe",
  "amount_cents": 125000,
  "currency": "MZN",
  "issued_at": "2026-11-19T09:30:00Z"
}

List receipts issued for recorded payments

Logs

GET /receipts

Returns a cursor-paginated page of payment receipts issued in the tenant, each with its receipt number, payment, invoice, customer, account, amount in cents and issue time. You can narrow it with account_id or invoice_id and page with limit and after. Requires the payments:read permission.

Parameters

limitinteger · query · optional

Maximum resources to return (default 20, maximum 100).

afterstring · query · optional

Opaque cursor returned by the previous page.

Returns

200 Receipts in the authenticated utility tenant

Permissions payments:read · Roles: admin, analyst, billing_clerk, customer_service, finance, owner, viewer

curl -X GET "$BUSINESS_API/receipts" \
  -H "Authorization: Bearer sk_test_..."
Response 200

Receipts in the authenticated utility tenant

Download a payment receipt as a PDF recibo

Logs

GET /receipts/{number}/pdf

Renders the receipt with this number as a PDF and returns it inline with Content-Type application/pdf. The document shows the tenant as issuer, the customer and account, the amount, the payment method and reference, and the paid invoice number when there is one. A receipt that does not exist in the tenant returns 404.

Parameters

numberstring · path · required

Receipt number

layoutstring · query · optional · default a4

Page format. mobile is one narrow column sized to its content, for reading on a phone. An unknown value renders A4.

one of a4, mobile

Returns

200 PDF document

Errors 403 · 404

Permissions payments:read · Roles: admin, analyst, billing_clerk, customer_service, finance, owner, viewer

curl -X GET "$BUSINESS_API/receipts/{number}/pdf" \
  -H "Authorization: Bearer sk_test_..."
Response 200

PDF document

Get a payment receipt by its number

Logs

GET /receipts/{number}

Returns the receipt issued for a recorded payment: receipt number, the payment and invoice it covers, customer and account (with the holder's display name), amount in minor units, currency and issue time. Use GET $BUSINESS_API/receipts/{number}/pdf for the printable document. Requires payments:read; a number that does not exist in the caller's tenant returns 404.

Parameters

numberstring · path · required

Receipt number as printed on the receipt, unique within the tenant.

Returns

200 Receipt

Show attributes
receipt_numberstring · required

Receipt number, unique within the tenant.

tenant_idstring · required
payment_idstring · required

Payment the receipt was issued for.

invoice_idstring · required

Invoice the payment was applied to.

customer_idstring · required
customer_namestring · optional

Display name of the referenced customer. Omitted when unknown.

account_idstring · required
account_numberstring · optional

Number of the referenced account, e.g. CTA-000044. Omitted when unknown.

account_holder_namestring · optional

Display name of the customer who holds the referenced account. Omitted when unknown.

amount_centsinteger (int64) · required

Amount received, in minor units.

currencystring · required
issued_atstring (date-time) · required

Errors 400 · 401 · 403 · 404

Permissions payments:read · Roles: admin, analyst, billing_clerk, customer_service, finance, owner, viewer

curl -X GET "$BUSINESS_API/receipts/{number}" \
  -H "Authorization: Bearer sk_test_..."
Response 200
{
  "receipt_number": "REC-2026-000142",
  "tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
  "payment_id": "pay_2eUBfC8BJA6JLIoHrQwtN0GL1mW",
  "invoice_id": "inv_2jnourvAGxXMMd5IyFbwc1LqUX1",
  "customer_id": "cus_2UuXtOGTHWKlvkoF5so5Joi3Hck",
  "customer_name": "Ana Matsinhe",
  "account_id": "act_2JFioNDgIfvkgflk8RtcqhBaARP",
  "account_number": "ACC-2026-000142",
  "account_holder_name": "Ana Matsinhe",
  "amount_cents": 125000,
  "currency": "MZN",
  "issued_at": "2026-11-19T09:30:00Z"
}