Payment allocations

Base URL: $BUSINESS_API

The object

idstring · required
tenant_idstring · required
payment_idstring · required
invoice_idstring · required
invoice_numberstring · optional

The invoice's display number

invoice_statusstring · optional

The invoice's current status, read when the response is written; omitted when the invoice cannot be read

amount_centsinteger (int64) · required
currencystring · required
account_idstring · optional
account_numberstring · optional
account_holder_namestring · optional
customer_idstring · optional
customer_namestring · optional
created_atstring (date-time) · required
reversed_atstring (date-time) · optional
The object
{
  "id": "pay_2F9MkvJqchhA2HP0mRBY6Lry6lf",
  "tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
  "payment_id": "pay_2eUBfC8BJA6JLIoHrQwtN0GL1mW",
  "invoice_id": "inv_2jnourvAGxXMMd5IyFbwc1LqUX1",
  "invoice_number": "INV-2026-000142",
  "invoice_status": "invoice status",
  "amount_cents": 125000,
  "currency": "MZN",
  "account_id": "act_2JFioNDgIfvkgflk8RtcqhBaARP",
  "account_number": "ACC-2026-000142",
  "account_holder_name": "Ana Matsinhe",
  "customer_id": "cus_2UuXtOGTHWKlvkoF5so5Joi3Hck",
  "customer_name": "Ana Matsinhe",
  "created_at": "2026-11-19T09:30:00Z",
  "reversed_at": "2026-11-19T09:30:00Z"
}

List allocations of confirmed payments to invoices

Logs

GET /payment-allocations

Each allocation carries the target invoice's number and current status (invoice_status), read in one batched lookup per response, so clients can filter allocations by invoice state without paging the invoice list.

Parameters

limitinteger · query · optional

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

afterstring · query · optional

Opaque cursor returned by the previous page.

payment_idstring · query · optional

Optional payment ID; when set, only the allocations of that payment are returned.

invoice_idstring · query · optional

Optional invoice ID; when set, only the allocations applied to that invoice are returned.

Returns

200 Payment allocations in the authenticated utility tenant

Show attributes
dataarray of PaymentAllocation · required
Show child attributes
idstring · required
tenant_idstring · required
payment_idstring · required
invoice_idstring · required
invoice_numberstring · optional

The invoice's display number

invoice_statusstring · optional

The invoice's current status, read when the response is written; omitted when the invoice cannot be read

amount_centsinteger (int64) · required
currencystring · required
account_idstring · optional
account_numberstring · optional
account_holder_namestring · optional
customer_idstring · optional
customer_namestring · optional
created_atstring (date-time) · required
reversed_atstring (date-time) · optional
has_moreboolean · required
next_cursorstring · optional

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

curl -X GET "$BUSINESS_API/payment-allocations" \
  -H "Authorization: Bearer sk_test_..."
Response 200
{
  "data": [
    {
      "id": "pay_2F9MkvJqchhA2HP0mRBY6Lry6lf",
      "tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
      "payment_id": "pay_2eUBfC8BJA6JLIoHrQwtN0GL1mW",
      "invoice_id": "inv_2jnourvAGxXMMd5IyFbwc1LqUX1",
      "invoice_number": "INV-2026-000142",
      "invoice_status": "invoice status",
      "amount_cents": 125000,
      "currency": "MZN",
      "account_id": "act_2JFioNDgIfvkgflk8RtcqhBaARP",
      "account_number": "ACC-2026-000142",
      "account_holder_name": "Ana Matsinhe",
      "customer_id": "cus_2UuXtOGTHWKlvkoF5so5Joi3Hck",
      "customer_name": "Ana Matsinhe",
      "created_at": "2026-11-19T09:30:00Z",
      "reversed_at": "2026-11-19T09:30:00Z"
    }
  ],
  "has_more": true,
  "next_cursor": "next cursor"
}