Calcular o balanço de uma zona de medição
RegistosGET /topology/balance/dma/{id}
Read-only. Inflow comes from the DMA's inflow device, outflow is authorised consumption (billed plus unbilled metered) plus metered export. Check status before trusting the loss figure.
Parâmetros
idID of the district metered area (DMA) to balance; it must belong to the caller's tenant, and the window comes from the required from and to parameters (RFC 3339 instants or YYYY-MM-DD dates read as midnight UTC, at most 366 days apart).
fromRFC 3339 instant or date
toRFC 3339 instant or date; at most 366 days after from
Devolve
200 Balance
Mostrar atributos
dma_iddma_codenode_idperiod_startperiod_endinflow_volume_litersexport_volume_litersoutflow_volume_litersAuthorised consumption plus export
storage_delta_litersauthorised_consumption_litersbilled_consumption_litersunbilled_metered_consumption_litersestimated_consumption_litersunaccounted_loss_litersnon_revenue_water_litersloss_basis_pointstolerance_basis_pointsphysically_validmass_conservedstatusum de
computed,partial_data,insufficient_datainflowMostrar atributos filhos
sourceum de
measurements,meter_consumption,nonedevice_idsample_countfirst_observed_atlast_observed_atcomplete
exportMostrar atributos filhos
sourceum de
measurements,meter_consumption,nonedevice_idsample_countfirst_observed_atlast_observed_atcomplete
storageMostrar atributos filhos
sourceum de
measurements,meter_consumption,nonedevice_idsample_countfirst_observed_atlast_observed_atcomplete
consumptionMostrar atributos filhos
attributionum de
dma_taps,service_area,nonemeter_countbilled_recordsunbilled_recordsproratedskipped_records
warnings
Permissões network:read · Funções: admin, analyst, field_reader, field_supervisor, operations, owner, viewer
curl -X GET "$BUSINESS_API/topology/balance/dma/{id}" \
-H "Authorization: Bearer sk_test_..."
# Sem comando CLI equivalente; use cURL ou HTTP directo.
const res = await fetch("$BUSINESS_API/topology/balance/dma/{id}", {
method: "GET",
headers: {
Authorization: "Bearer sk_test_..."
}
});
const data = await res.json();
import requests
res = requests.get(
"$BUSINESS_API/topology/balance/dma/{id}",
headers={
"Authorization": "Bearer sk_test_..."
}
)
data = res.json()
req, _ := http.NewRequest("GET", "$BUSINESS_API/topology/balance/dma/{id}", nil)
req.Header.Set("Authorization", "Bearer sk_test_...")
resp, err := http.DefaultClient.Do(req)
{
"dma_id": "dma_2gE3tiwbLQQnDGcrVkstPO8Bjkg",
"dma_code": "DMA-2026-000142",
"node_id": "nod_26enLAulDEgfZ0IlNWY59ugfRs0",
"period_start": "2026-11-19T09:30:00Z",
"period_end": "2026-11-19T09:30:00Z",
"inflow_volume_liters": 1342,
"export_volume_liters": 1342,
"outflow_volume_liters": 1342,
"storage_delta_liters": 1,
"authorised_consumption_liters": 1342,
"billed_consumption_liters": 1342,
"unbilled_metered_consumption_liters": 1342,
"estimated_consumption_liters": 1342,
"unaccounted_loss_liters": 1,
"non_revenue_water_liters": 1,
"loss_basis_points": 1,
"tolerance_basis_points": 1,
"physically_valid": true,
"mass_conserved": true,
"status": "computed",
"inflow": {
"source": "measurements",
"device_id": "dev_2E2J9iiRr2o7PWMrj8wJrQyb9sK",
"sample_count": 1,
"first_observed_at": "2026-11-19T09:30:00Z",
"last_observed_at": "2026-11-19T09:30:00Z",
"complete": true
},
"export": {
"source": "measurements",
"device_id": "dev_2E2J9iiRr2o7PWMrj8wJrQyb9sK",
"sample_count": 1,
"first_observed_at": "2026-11-19T09:30:00Z",
"last_observed_at": "2026-11-19T09:30:00Z",
"complete": true
},
"storage": {
"source": "measurements",
"device_id": "dev_2E2J9iiRr2o7PWMrj8wJrQyb9sK",
"sample_count": 1,
"first_observed_at": "2026-11-19T09:30:00Z",
"last_observed_at": "2026-11-19T09:30:00Z",
"complete": true
},
"consumption": {
"attribution": "dma_taps",
"meter_count": 1,
"billed_records": 1,
"unbilled_records": 1,
"prorated": true,
"skipped_records": 1
},
"warnings": [
"warning"
]
}