Receivables

Base URL: $BUSINESS_API

The object

invoice_idstring · required
invoice_numberstring · required
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.

balance_centsinteger · required
total_centsinteger · required
currencystring · required
statusstring · required

one of open, partially_paid

due_datestring (date-time) · required
issued_atstring (date-time) · required
days_overdueinteger · required
ageing_bucketstring · required

one of current, 1_30, 31_60, 61_90, over_90

The object
{
  "invoice_id": "inv_2jnourvAGxXMMd5IyFbwc1LqUX1",
  "invoice_number": "INV-2026-000142",
  "customer_id": "cus_2UuXtOGTHWKlvkoF5so5Joi3Hck",
  "customer_name": "Ana Matsinhe",
  "account_id": "act_2JFioNDgIfvkgflk8RtcqhBaARP",
  "account_number": "ACC-2026-000142",
  "account_holder_name": "Ana Matsinhe",
  "balance_cents": 125000,
  "total_cents": 125000,
  "currency": "MZN",
  "status": "open",
  "due_date": "2026-11-19T09:30:00Z",
  "issued_at": "2026-11-19T09:30:00Z",
  "days_overdue": 125000,
  "ageing_bucket": "current"
}

List utility receivables

Logs

GET /receivables

Returns the tenant's open receivables, one row per invoice that is open or partially paid and still has a balance, a page at a time (limit and after). Each row has the balance and total in cents, due date, the whole days overdue as of now and an ageing bucket: current, 1_30, 31_60, 61_90 or over_90. Requires the invoices: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 Receivables in the authenticated utility tenant

Show attributes
dataarray of Receivable · required
Show child attributes
invoice_idstring · required
invoice_numberstring · required
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.

balance_centsinteger · required
total_centsinteger · required
currencystring · required
statusstring · required

one of open, partially_paid

due_datestring (date-time) · required
issued_atstring (date-time) · required
days_overdueinteger · required
ageing_bucketstring · required

one of current, 1_30, 31_60, 61_90, over_90

has_moreboolean · optional
next_cursorstring · optional
total_countinteger · optional

Errors 401 · 403

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

curl -X GET "$BUSINESS_API/receivables" \
  -H "Authorization: Bearer sk_test_..."
Response 200
{
  "data": [
    {
      "invoice_id": "inv_2jnourvAGxXMMd5IyFbwc1LqUX1",
      "invoice_number": "INV-2026-000142",
      "customer_id": "cus_2UuXtOGTHWKlvkoF5so5Joi3Hck",
      "customer_name": "Ana Matsinhe",
      "account_id": "act_2JFioNDgIfvkgflk8RtcqhBaARP",
      "account_number": "ACC-2026-000142",
      "account_holder_name": "Ana Matsinhe",
      "balance_cents": 125000,
      "total_cents": 125000,
      "currency": "MZN",
      "status": "open",
      "due_date": "2026-11-19T09:30:00Z",
      "issued_at": "2026-11-19T09:30:00Z",
      "days_overdue": 125000,
      "ageing_bucket": "current"
    }
  ],
  "has_more": true,
  "next_cursor": "next cursor",
  "total_count": 125000
}