PT EN

Balanço hídrico

URL base: $BUSINESS_API

O objecto

scopestring · opcional

um de system, dma

dma_idstring · opcional
period_startstring (date-time) · opcional
period_endstring (date-time) · opcional
statusstring · opcional

um de computed, partial_data, insufficient_data

system_input_litersinteger · opcional
billed_authorized_litersinteger · opcional
unbilled_authorized_litersinteger · opcional
authorized_consumption_litersinteger · opcional
water_losses_litersinteger · opcional
apparent_losses_litersinteger · opcional · anulável
real_losses_litersinteger · opcional · anulável
loss_splitstring · opcional

um de computed_from_assumption, insufficient_data

apparent_loss_assumption_bpinteger · opcional
non_revenue_water_litersinteger · opcional
non_revenue_water_bpinteger · opcional
dmas_totalinteger · opcional
dmas_computedinteger · opcional
dmasarray of IWAWaterBalance · opcional
warningsarray of string · opcional
O objecto
{
  "scope": "system",
  "dma_id": "dma_2gE3tiwbLQQnDGcrVkstPO8Bjkg",
  "period_start": "2026-11-19T09:30:00Z",
  "period_end": "2026-11-19T09:30:00Z",
  "status": "computed",
  "system_input_liters": 1,
  "billed_authorized_liters": 1,
  "unbilled_authorized_liters": 1,
  "authorized_consumption_liters": 1342,
  "water_losses_liters": 1,
  "apparent_losses_liters": 1,
  "real_losses_liters": 1,
  "loss_split": "computed_from_assumption",
  "apparent_loss_assumption_bp": 1,
  "non_revenue_water_liters": 1,
  "non_revenue_water_bp": 1,
  "dmas_total": 125000,
  "dmas_computed": 1,
  "dmas": [],
  "warnings": [
    "warning"
  ]
}

Obter o balanço hídrico do sistema

Registos

GET /water-balance

Computes the IWA water balance for the whole network over a window by balancing every DMA and adding up those with enough data; the response includes the per-DMA detail, system input, billed and unbilled authorised consumption, water losses and non-revenue water. DMAs with insufficient data are excluded from the totals with a warning, and the status is computed, partial_data or insufficient_data accordingly. Water losses are split into apparent and real only when apparent_loss_bp is given. Read-only; requires network read access.

Parâmetros

fromstring · consulta · obrigatório

Required start of the window as an RFC 3339 timestamp; the window must end after it and span at most 366 days.

tostring · consulta · obrigatório

Required end of the window as an RFC 3339 timestamp, later than from.

apparent_loss_bpinteger · consulta · opcional

Optional assumed apparent losses as basis points of authorised consumption, an integer from 0 to 10000 (100 = 1%); when omitted, losses are not split into apparent and real.

Devolve

200 OK

Mostrar atributos
scopestring · opcional

um de system, dma

dma_idstring · opcional
period_startstring (date-time) · opcional
period_endstring (date-time) · opcional
statusstring · opcional

um de computed, partial_data, insufficient_data

system_input_litersinteger · opcional
billed_authorized_litersinteger · opcional
unbilled_authorized_litersinteger · opcional
authorized_consumption_litersinteger · opcional
water_losses_litersinteger · opcional
apparent_losses_litersinteger · opcional · anulável
real_losses_litersinteger · opcional · anulável
loss_splitstring · opcional

um de computed_from_assumption, insufficient_data

apparent_loss_assumption_bpinteger · opcional
non_revenue_water_litersinteger · opcional
non_revenue_water_bpinteger · opcional
dmas_totalinteger · opcional
dmas_computedinteger · opcional
dmasarray of IWAWaterBalance · opcional
warningsarray of string · opcional

Erros 400 · 403

Permissões network:read · Funções: admin, analyst, field_reader, field_supervisor, operations, owner, viewer

curl -X GET "$BUSINESS_API/water-balance" \
  -H "Authorization: Bearer sk_test_..."
Resposta 200
{
  "scope": "system",
  "dma_id": "dma_2gE3tiwbLQQnDGcrVkstPO8Bjkg",
  "period_start": "2026-11-19T09:30:00Z",
  "period_end": "2026-11-19T09:30:00Z",
  "status": "computed",
  "system_input_liters": 1,
  "billed_authorized_liters": 1,
  "unbilled_authorized_liters": 1,
  "authorized_consumption_liters": 1342,
  "water_losses_liters": 1,
  "apparent_losses_liters": 1,
  "real_losses_liters": 1,
  "loss_split": "computed_from_assumption",
  "apparent_loss_assumption_bp": 1,
  "non_revenue_water_liters": 1,
  "non_revenue_water_bp": 1,
  "dmas_total": 125000,
  "dmas_computed": 1,
  "dmas": [],
  "warnings": [
    "warning"
  ]
}