Listar valores a receber
RegistosGET /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.
Parâmetros
limitMaximum resources to return (default 20, maximum 100).
afterOpaque cursor returned by the previous page.
Devolve
200 Receivables in the authenticated utility tenant
Mostrar atributos
dataMostrar atributos filhos
invoice_idinvoice_numbercustomer_idcustomer_nameDisplay name of the referenced customer. Omitted when unknown.
account_idaccount_numberNumber of the referenced account, e.g. CTA-000044. Omitted when unknown.
account_holder_nameDisplay name of the customer who holds the referenced account. Omitted when unknown.
balance_centstotal_centscurrencystatusum de
open,partially_paiddue_dateissued_atdays_overdueageing_bucketum de
current,1_30,31_60,61_90,over_90
has_morenext_cursortotal_count
Permissões invoices:read · Funções: admin, analyst, billing_clerk, customer_service, finance, owner, viewer
curl -X GET "$BUSINESS_API/receivables" \
-H "Authorization: Bearer sk_test_..."
# Sem comando CLI equivalente; use cURL ou HTTP directo.
const res = await fetch("$BUSINESS_API/receivables", {
method: "GET",
headers: {
Authorization: "Bearer sk_test_..."
}
});
const data = await res.json();
import requests
res = requests.get(
"$BUSINESS_API/receivables",
headers={
"Authorization": "Bearer sk_test_..."
}
)
data = res.json()
req, _ := http.NewRequest("GET", "$BUSINESS_API/receivables", nil)
req.Header.Set("Authorization", "Bearer sk_test_...")
resp, err := http.DefaultClient.Do(req)
{
"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
}