Listar ciclos de facturação
RegistosGET /billing-runs
Returns the tenant's billing runs with cursor pagination (limit defaults to 20, at most 100), optionally filtered by status. Each run shows its period, service area, status, issued, skipped and estimated invoice counts, total amount and exception count. Requires billing_runs:read.
Parâmetros
limitMaximum resources to return (default 20, maximum 100).
afterOpaque cursor returned by the previous page.
Devolve
200 Billing runs
Mostrar atributos
dataMostrar atributos filhos
idtenant_idservice_area_idschedule_idperiod_startperiod_endtotal_invoicestotal_amount_centsstatusum de
pending,running,completed,failedissued_invoicesInvoices issued by the most recent execution of this run.
issued_amount_centsTotal of the invoices issued by the most recent execution of this run; total_amount_cents covers every execution.
skipped_accountsestimated_invoicesexception_counterror_messagecreated_atcompleted_at
has_morenext_cursortotal_count
Permissões billing_runs:read · Funções: admin, analyst, billing_clerk, customer_service, finance, owner, viewer
curl -X GET "$BUSINESS_API/billing-runs" \
-H "Authorization: Bearer sk_test_..."
# Sem comando CLI equivalente; use cURL ou HTTP directo.
const res = await fetch("$BUSINESS_API/billing-runs", {
method: "GET",
headers: {
Authorization: "Bearer sk_test_..."
}
});
const data = await res.json();
import requests
res = requests.get(
"$BUSINESS_API/billing-runs",
headers={
"Authorization": "Bearer sk_test_..."
}
)
data = res.json()
req, _ := http.NewRequest("GET", "$BUSINESS_API/billing-runs", nil)
req.Header.Set("Authorization", "Bearer sk_test_...")
resp, err := http.DefaultClient.Do(req)
{
"data": [
{
"id": "brn_2fnCKRfkezDig1bGCBlcUfDW45V",
"tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
"service_area_id": "ser_23fmkpfkC17kSVJ2spjyiBbOED9",
"schedule_id": "sch_277GSDJgyxdmMHr4kPVUg5dswJl",
"period_start": "2026-11-19T09:30:00Z",
"period_end": "2026-11-19T09:30:00Z",
"total_invoices": 125000,
"total_amount_cents": 125000,
"status": "pending",
"issued_invoices": 1,
"issued_amount_cents": 125000,
"skipped_accounts": 1,
"estimated_invoices": 1,
"exception_count": 1,
"error_message": "error message",
"created_at": "2026-11-19T09:30:00Z",
"completed_at": "2026-11-19T09:30:00Z"
}
],
"has_more": true,
"next_cursor": "next cursor",
"total_count": 125000
}