Obter o resumo da carteira
RegistosGET /portfolio-overview
Overview totals across the caller's account and its sub-accounts
Builds the business overview for one month for the caller's own account and for every descendant account in its organization tree where the caller holds business:overview:read directly or through an inherited membership; owning the parent alone does not open the children. Each account is returned with its own overview, and billed, collected, volume and reading totals and daily series are summed across them. As in the single-account overview, each data group of each account is shown only when the caller holds that domain's read scope on that account (invoices:read, payments:read, collections:read, business:readings:read, business:consumptions:read, operations:read, support:read). Requires business:overview:read on the caller's tenant. A period that is not YYYY-MM returns 400, and accounts that report in different currencies return 409.
Parâmetros
periodMonth to report as YYYY-MM, in UTC; defaults to the current month.
Devolve
200 Portfolio overview
Mostrar atributos
root_account_idThe caller's tenant, at the root of the portfolio.
periodReporting month.
Mostrar atributos filhos
labelstartend
currencyCurrency shared by every account in the portfolio.
accountsThe root account first, then each readable descendant account.
Mostrar atributos filhos
account_idaccount_numberNumber of the referenced account. Omitted when unknown.
account_holder_nameDisplay name of the account holder. Omitted when unknown.
overviewDomain totals and series are returned only when the caller has the corresponding domain read scope. Receivables require invoices:read or collections:read; collection_rate requires both invoices:read and payments:read. Portfolio overviews apply these checks separately to each account.
Mostrar atributos filhos
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
timezonetodayyesterday
read_rateopen_workMostrar atributos filhos
incidentsticketswork_orders
receivables_by_ageingMostrar atributos filhos
balance_centsbucketinvoices
seriesMostrar atributos filhos
billed_centscollected_centsvolume_m3readings
billed_centsSum of billed_cents across the accounts.
collected_centsSum of collected_cents across the accounts.
volume_m3Sum of volume_m3 across the accounts.
readings_countSum of readings_count across the accounts.
seriesDaily series summed across the accounts, oldest first.
Mostrar 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/portfolio-overview" \
-H "Authorization: Bearer sk_test_..."
# Sem comando CLI equivalente; use cURL ou HTTP directo.
const res = await fetch("$BUSINESS_API/portfolio-overview", {
method: "GET",
headers: {
Authorization: "Bearer sk_test_..."
}
});
const data = await res.json();
import requests
res = requests.get(
"$BUSINESS_API/portfolio-overview",
headers={
"Authorization": "Bearer sk_test_..."
}
)
data = res.json()
req, _ := http.NewRequest("GET", "$BUSINESS_API/portfolio-overview", nil)
req.Header.Set("Authorization", "Bearer sk_test_...")
resp, err := http.DefaultClient.Do(req)
{
"root_account_id": "roo_202ZxesHbMupdaSf3oITN8C1tiu",
"period": {
"label": "2026-10",
"start": "2026-11-19T09:30:00Z",
"end": "2026-11-19T09:30:00Z"
},
"currency": "MZN",
"accounts": [
{
"account_id": "act_2JFioNDgIfvkgflk8RtcqhBaARP",
"account_number": "ACC-2026-000142",
"account_holder_name": "Ana Matsinhe",
"overview": {
"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": []
},
"yesterday": {
"date": "2026-11-19",
"total_cents": 125000,
"hours": []
}
},
"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": [
{}
],
"collected_cents": [
{}
],
"volume_m3": [
{}
],
"readings": [
{}
]
}
}
}
],
"billed_cents": 1,
"collected_cents": 1,
"volume_m3": 13.42,
"readings_count": 1342,
"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
}
]
}
}