PT EN

Recibos

URL base: $BUSINESS_API

O objecto

receipt_numberstring · obrigatório

Receipt number, unique within the tenant.

tenant_idstring · obrigatório
payment_idstring · obrigatório

Payment the receipt was issued for.

invoice_idstring · obrigatório

Invoice the payment was applied to.

customer_idstring · obrigatório
customer_namestring · opcional

Display name of the referenced customer. Omitted when unknown.

account_idstring · obrigatório
account_numberstring · opcional

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

account_holder_namestring · opcional

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

amount_centsinteger (int64) · obrigatório

Amount received, in minor units.

currencystring · obrigatório
issued_atstring (date-time) · obrigatório
O objecto
{
  "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"
}

Listar recibos

Registos

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.

Parâmetros

limitinteger · consulta · opcional

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

afterstring · consulta · opcional

Opaque cursor returned by the previous page.

Devolve

200 Receipts in the authenticated utility tenant

Permissões payments:read · Funções: admin, analyst, billing_clerk, customer_service, finance, owner, viewer

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

Receipts in the authenticated utility tenant

Descarregar um recibo em PDF

Registos

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.

Parâmetros

numberstring · caminho · obrigatório

Receipt number

layoutstring · consulta · opcional · predefinição a4

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

um de a4, mobile

Devolve

200 PDF document

Erros 403 · 404

Permissões payments:read · Funções: admin, analyst, billing_clerk, customer_service, finance, owner, viewer

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

PDF document

Obter um recibo

Registos

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.

Parâmetros

numberstring · caminho · obrigatório

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

Devolve

200 Receipt

Mostrar atributos
receipt_numberstring · obrigatório

Receipt number, unique within the tenant.

tenant_idstring · obrigatório
payment_idstring · obrigatório

Payment the receipt was issued for.

invoice_idstring · obrigatório

Invoice the payment was applied to.

customer_idstring · obrigatório
customer_namestring · opcional

Display name of the referenced customer. Omitted when unknown.

account_idstring · obrigatório
account_numberstring · opcional

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

account_holder_namestring · opcional

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

amount_centsinteger (int64) · obrigatório

Amount received, in minor units.

currencystring · obrigatório
issued_atstring (date-time) · obrigatório

Erros 400 · 401 · 403 · 404

Permissões payments:read · Funções: admin, analyst, billing_clerk, customer_service, finance, owner, viewer

curl -X GET "$BUSINESS_API/receipts/{number}" \
  -H "Authorization: Bearer sk_test_..."
Resposta 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"
}