PT EN

Instalações de contadores

URL base: $BUSINESS_API

O objecto

idstring · obrigatório
tenant_idstring · obrigatório
connection_idstring · obrigatório
connection_holder_namestring · opcional

Display name of the customer who holds the referenced connection. Omitted when unknown.

meter_idstring · obrigatório
meter_serialstring · opcional

Serial number of the referenced meter. Omitted when unknown.

meter_holder_namestring · opcional

Display name of the customer who holds the account the meter is installed on. Omitted when unknown.

account_idstring · opcional
account_numberstring · opcional

Number of the referenced account, e.g. CTA-000044. Omitted when unknown.

account_holder_namestring · opcional

Display name of the customer who holds the referenced account. Omitted when unknown.

installed_atstring (date-time) · obrigatório
initial_readingstring · obrigatório
removed_atstring · opcional · anulável
final_readingstring · opcional
exchange_reasonstring · opcional
installed_bystring · obrigatório
security_seal_numberstring · opcional
replaced_installation_idstring · opcional
idempotency_keystring · opcional
created_atstring (date-time) · obrigatório
updated_atstring (date-time) · obrigatório
O objecto
{
  "id": "met_2yk9v6SNluyXngonlgs1hccPdGU",
  "tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
  "connection_id": "con_2wuJTWy9FOCTPGA3noGbHegbLaU",
  "connection_holder_name": "Ana Matsinhe",
  "meter_id": "mtr_21F02THKOD7uMpvUalZKsBv64nN",
  "meter_serial": "meter serial",
  "meter_holder_name": "Ana Matsinhe",
  "account_id": "act_2JFioNDgIfvkgflk8RtcqhBaARP",
  "account_number": "ACC-2026-000142",
  "account_holder_name": "Ana Matsinhe",
  "installed_at": "2026-11-19T09:30:00Z",
  "initial_reading": "initial reading",
  "removed_at": "2026-11-19T09:30:00Z",
  "final_reading": "final reading",
  "exchange_reason": "exchange reason",
  "installed_by": "installed by",
  "security_seal_number": "SEC-2026-000142",
  "replaced_installation_id": "rep_2rLgATXYm9pMiLbYyNLwCPHAGTv",
  "idempotency_key": "idempotency key",
  "created_at": "2026-11-19T09:30:00Z",
  "updated_at": "2026-11-19T09:30:00Z"
}

Listar instalações de contadores

Registos

GET /meter-installations

Returns installation records (meter, connection, account, installation time, initial reading and seal number) across the tenant, with cursor pagination. With no filter every installation is returned. Requires the business:meters:read permission.

Parâmetros

connection_idstring · consulta · opcional

Returns only installations on this connection.

meter_idstring · consulta · opcional

Returns only installations of this meter.

openboolean · consulta · opcional

When true or 1, returns only installations that are still in place (the meter has not been removed); any other value returns open and closed installations.

limitinteger · consulta · opcional

Maximum resources to return (default 20, maximum 100).

afterstring · consulta · opcional

Opaque cursor returned by the previous page.

Devolve

200 Installations, newest first

Mostrar atributos
dataarray of MeterInstallation · obrigatório
Mostrar atributos filhos
idstring · obrigatório
tenant_idstring · obrigatório
connection_idstring · obrigatório
connection_holder_namestring · opcional

Display name of the customer who holds the referenced connection. Omitted when unknown.

meter_idstring · obrigatório
meter_serialstring · opcional

Serial number of the referenced meter. Omitted when unknown.

meter_holder_namestring · opcional

Display name of the customer who holds the account the meter is installed on. Omitted when unknown.

account_idstring · opcional
account_numberstring · opcional

Number of the referenced account, e.g. CTA-000044. Omitted when unknown.

account_holder_namestring · opcional

Display name of the customer who holds the referenced account. Omitted when unknown.

installed_atstring (date-time) · obrigatório
initial_readingstring · obrigatório
removed_atstring · opcional · anulável
final_readingstring · opcional
exchange_reasonstring · opcional
installed_bystring · obrigatório
security_seal_numberstring · opcional
replaced_installation_idstring · opcional
idempotency_keystring · opcional
created_atstring (date-time) · obrigatório
updated_atstring (date-time) · obrigatório
has_moreboolean · obrigatório
next_cursorstring · opcional

Erros 400 · 403

Permissões business:meters:read · Funções: admin, analyst, billing_clerk, customer_service, field_reader, field_supervisor, operations, owner, viewer

curl -X GET "$BUSINESS_API/meter-installations" \
  -H "Authorization: Bearer sk_test_..."
Resposta 200
{
  "data": [
    {
      "id": "met_2yk9v6SNluyXngonlgs1hccPdGU",
      "tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
      "connection_id": "con_2wuJTWy9FOCTPGA3noGbHegbLaU",
      "connection_holder_name": "Ana Matsinhe",
      "meter_id": "mtr_21F02THKOD7uMpvUalZKsBv64nN",
      "meter_serial": "meter serial",
      "meter_holder_name": "Ana Matsinhe",
      "account_id": "act_2JFioNDgIfvkgflk8RtcqhBaARP",
      "account_number": "ACC-2026-000142",
      "account_holder_name": "Ana Matsinhe",
      "installed_at": "2026-11-19T09:30:00Z",
      "initial_reading": "initial reading",
      "removed_at": "2026-11-19T09:30:00Z",
      "final_reading": "final reading",
      "exchange_reason": "exchange reason",
      "installed_by": "installed by",
      "security_seal_number": "SEC-2026-000142",
      "replaced_installation_id": "rep_2rLgATXYm9pMiLbYyNLwCPHAGTv",
      "idempotency_key": "idempotency key",
      "created_at": "2026-11-19T09:30:00Z",
      "updated_at": "2026-11-19T09:30:00Z"
    }
  ],
  "has_more": true,
  "next_cursor": "next cursor"
}