Obter o resumo
RegistosGET /overview
Billed, collected, volume, readings, receivables ageing, collection and read rate, open work, series
Requires business:overview:read. Each returned data group is filtered by its own domain read scope; overview access alone does not grant access to billing, payment, reading, consumption, operations, or support totals.
Parâmetros
periodMonth as YYYY-MM; defaults to the current month
Devolve
200 Overview
Mostrar atributos
periodcurrencybilled_centscollected_centsvolume_m3readings_countcollection_ratePercentage of the period's billed amount collected through payments applied to invoices billed in that period, capped at 100. Payments against earlier invoices are in arrears_collected_cents and do not raise this rate.
collected_current_period_centsPart of collected_cents applied to invoices billed in the period
arrears_collected_centsPart of collected_cents applied to invoices billed in earlier periods, or to no invoice
collections_by_hourCollections for the utility's local today and yesterday, independent of the requested period
Mostrar atributos filhos
timezonetodayMostrar atributos filhos
datetotal_centshoursAll 24 local hours in order
Mostrar atributos filhos
hourcollected_centspayments
yesterdayMostrar atributos filhos
datetotal_centshoursAll 24 local hours in order
Mostrar atributos filhos
hourcollected_centspayments
read_rateopen_workMostrar atributos filhos
incidentsticketswork_orders
receivables_by_ageingMostrar atributos filhos
balance_centsbucketinvoices
seriesMostrar atributos filhos
billed_centsMostrar atributos filhos
datevalue
collected_centsMostrar atributos filhos
datevalue
volume_m3Mostrar atributos filhos
datevalue
readingsMostrar atributos filhos
datevalue
Permissões business:overview:read · Funções: admin, analyst, field_supervisor, finance, operations, owner, viewer
curl -X GET "$BUSINESS_API/overview" \
-H "Authorization: Bearer sk_test_..."
# Sem comando CLI equivalente; use cURL ou HTTP directo.
const res = await fetch("$BUSINESS_API/overview", {
method: "GET",
headers: {
Authorization: "Bearer sk_test_..."
}
});
const data = await res.json();
import requests
res = requests.get(
"$BUSINESS_API/overview",
headers={
"Authorization": "Bearer sk_test_..."
}
)
data = res.json()
req, _ := http.NewRequest("GET", "$BUSINESS_API/overview", nil)
req.Header.Set("Authorization", "Bearer sk_test_...")
resp, err := http.DefaultClient.Do(req)
{
"period": {},
"currency": "MZN",
"billed_cents": 1,
"collected_cents": 1,
"volume_m3": 13.42,
"readings_count": 1342,
"collection_rate": 1,
"collected_current_period_cents": 1,
"arrears_collected_cents": 1,
"collections_by_hour": {
"timezone": "Africa/Maputo",
"today": {
"date": "2026-11-19",
"total_cents": 125000,
"hours": [
{
"hour": 0,
"collected_cents": 1,
"payments": 1
}
]
},
"yesterday": {
"date": "2026-11-19",
"total_cents": 125000,
"hours": [
{
"hour": 0,
"collected_cents": 1,
"payments": 1
}
]
}
},
"read_rate": 1,
"open_work": {
"incidents": 1,
"tickets": 1,
"work_orders": 1
},
"receivables_by_ageing": [
{
"balance_cents": 125000,
"bucket": "bucket",
"invoices": 1
}
],
"series": {
"billed_cents": [
{
"date": "2026-11-19",
"value": 13.42
}
],
"collected_cents": [
{
"date": "2026-11-19",
"value": 13.42
}
],
"volume_m3": [
{
"date": "2026-11-19",
"value": 13.42
}
],
"readings": [
{
"date": "2026-11-19",
"value": 13.42
}
]
}
}