Overview

Base URL: $BUSINESS_API

The object

periodobject · optional
currencystring · optional
billed_centsinteger (int64) · optional
collected_centsinteger (int64) · optional
volume_m3number · optional
readings_countinteger · optional
collection_ratenumber · optional

Percentage 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_centsinteger (int64) · optional

Part of collected_cents applied to invoices billed in the period

arrears_collected_centsinteger (int64) · optional

Part of collected_cents applied to invoices billed in earlier periods, or to no invoice

collections_by_hourobject · optional

Collections for the utility's local today and yesterday, independent of the requested period

Show child attributes
timezonestring · optional
todayobject · optional
Show child attributes
datestring (date) · optional
total_centsinteger (int64) · optional
hoursarray of object · optional

All 24 local hours in order

Show child attributes
hourinteger · optional
collected_centsinteger (int64) · optional
paymentsinteger · optional
yesterdayobject · optional
Show child attributes
datestring (date) · optional
total_centsinteger (int64) · optional
hoursarray of object · optional

All 24 local hours in order

Show child attributes
hourinteger · optional
collected_centsinteger (int64) · optional
paymentsinteger · optional
read_ratenumber · optional
open_workobject · optional
Show child attributes
incidentsinteger · optional
ticketsinteger · optional
work_ordersinteger · optional
receivables_by_ageingarray of object · optional
Show child attributes
balance_centsinteger · optional
bucketstring · optional
invoicesinteger · optional
seriesobject · optional
Show child attributes
billed_centsarray of SeriesPoint · optional
Show child attributes
datestring (date) · optional
valuenumber · optional
collected_centsarray of SeriesPoint · optional
Show child attributes
datestring (date) · optional
valuenumber · optional
volume_m3array of SeriesPoint · optional
Show child attributes
datestring (date) · optional
valuenumber · optional
readingsarray of SeriesPoint · optional
Show child attributes
datestring (date) · optional
valuenumber · optional
Endpoints
The object
{
  "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
      }
    ]
  }
}

Get business overview

Logs

GET /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.

Parameters

periodstring · query · optional

Month as YYYY-MM; defaults to the current month

Returns

200 Overview

Show attributes
periodobject · optional
currencystring · optional
billed_centsinteger (int64) · optional
collected_centsinteger (int64) · optional
volume_m3number · optional
readings_countinteger · optional
collection_ratenumber · optional

Percentage 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_centsinteger (int64) · optional

Part of collected_cents applied to invoices billed in the period

arrears_collected_centsinteger (int64) · optional

Part of collected_cents applied to invoices billed in earlier periods, or to no invoice

collections_by_hourobject · optional

Collections for the utility's local today and yesterday, independent of the requested period

Show child attributes
timezonestring · optional
todayobject · optional
Show child attributes
datestring (date) · optional
total_centsinteger (int64) · optional
hoursarray of object · optional

All 24 local hours in order

Show child attributes
hourinteger · optional
collected_centsinteger (int64) · optional
paymentsinteger · optional
yesterdayobject · optional
Show child attributes
datestring (date) · optional
total_centsinteger (int64) · optional
hoursarray of object · optional

All 24 local hours in order

Show child attributes
hourinteger · optional
collected_centsinteger (int64) · optional
paymentsinteger · optional
read_ratenumber · optional
open_workobject · optional
Show child attributes
incidentsinteger · optional
ticketsinteger · optional
work_ordersinteger · optional
receivables_by_ageingarray of object · optional
Show child attributes
balance_centsinteger · optional
bucketstring · optional
invoicesinteger · optional
seriesobject · optional
Show child attributes
billed_centsarray of SeriesPoint · optional
Show child attributes
datestring (date) · optional
valuenumber · optional
collected_centsarray of SeriesPoint · optional
Show child attributes
datestring (date) · optional
valuenumber · optional
volume_m3array of SeriesPoint · optional
Show child attributes
datestring (date) · optional
valuenumber · optional
readingsarray of SeriesPoint · optional
Show child attributes
datestring (date) · optional
valuenumber · optional

Permissions business:overview:read · Roles: admin, analyst, field_supervisor, finance, operations, owner, viewer

curl -X GET "$BUSINESS_API/overview" \
  -H "Authorization: Bearer sk_test_..."
Response 200
{
  "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
      }
    ]
  }
}