PT EN

Pedidos de vistoria

URL base: $CONSUMER_API

O objecto

idstring · obrigatório
tenant_idstring · obrigatório
account_idstring · obrigatório
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.

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.

identity_idstring · obrigatório
requester_namestring · opcional

Who filed it, which can differ from the account holder.

reasonstring · obrigatório
idempotency_keystring · opcional
kindstring · opcional

um de consumer, field_reread

reading_idstring · opcional
statusstring · obrigatório

um de open, scheduled, completed, cancelled

scheduled_atstring · opcional · anulável
resolutionstring · opcional
resolved_bystring · opcional
resolved_atstring · opcional · anulável
created_atstring (date-time) · obrigatório
updated_atstring (date-time) · obrigatório
O objecto
{
  "id": "met_22OXlyuNjQGrXkQbdCkn18WvtcE",
  "tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
  "account_id": "act_2JFioNDgIfvkgflk8RtcqhBaARP",
  "account_number": "ACC-2026-000142",
  "account_holder_name": "Ana Matsinhe",
  "meter_id": "mtr_21F02THKOD7uMpvUalZKsBv64nN",
  "meter_serial": "meter serial",
  "meter_holder_name": "Ana Matsinhe",
  "identity_id": "ide_2W4tFuAzbOoV5aORlgwJHqwRdkg",
  "requester_name": "Ana Matsinhe",
  "reason": "Leitura confirmada no local.",
  "idempotency_key": "idempotency key",
  "kind": "consumer",
  "reading_id": "rdg_2o0xXwujnSgR9QIvVEWblWSv7u0",
  "status": "open",
  "scheduled_at": "2026-11-19T09:30:00Z",
  "resolution": "resolution",
  "resolved_by": "resolved by",
  "resolved_at": "2026-11-19T09:30:00Z",
  "created_at": "2026-11-19T09:30:00Z",
  "updated_at": "2026-11-19T09:30:00Z"
}

Listar pedidos de vistoria

Registos

GET /meter-inspection-requests

Pages the meter inspection requests that consumers raised on one linked account. account_id is required (400 without it) and the caller needs read access to the account, otherwise 403. Pagination uses limit and after.

Parâmetros

tenant_idstring · consulta · obrigatório

Tenant (utility workspace) that owns the account; when omitted it is worked out from the caller's account memberships.

account_idstring · consulta · obrigatório

Required identifier of the linked account whose inspection requests are listed.

limitinteger · consulta · opcional

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

afterstring · consulta · opcional

Opaque cursor returned by the previous page.

Devolve

200 Consumer inspection requests in the selected linked account

Mostrar atributos
dataarray of MeterInspectionRequest · obrigatório
Mostrar atributos filhos
idstring · obrigatório
tenant_idstring · obrigatório
account_idstring · obrigatório
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.

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.

identity_idstring · obrigatório
requester_namestring · opcional

Who filed it, which can differ from the account holder.

reasonstring · obrigatório
idempotency_keystring · opcional
kindstring · opcional

um de consumer, field_reread

reading_idstring · opcional
statusstring · obrigatório

um de open, scheduled, completed, cancelled

scheduled_atstring · opcional · anulável
resolutionstring · opcional
resolved_bystring · opcional
resolved_atstring · opcional · anulável
created_atstring (date-time) · obrigatório
updated_atstring (date-time) · obrigatório
has_moreboolean · obrigatório
next_cursorstring · opcional
curl -X GET "$CONSUMER_API/meter-inspection-requests" \
  -H "Authorization: Bearer sk_test_..."
Resposta 200
{
  "data": [
    {
      "id": "met_22OXlyuNjQGrXkQbdCkn18WvtcE",
      "tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
      "account_id": "act_2JFioNDgIfvkgflk8RtcqhBaARP",
      "account_number": "ACC-2026-000142",
      "account_holder_name": "Ana Matsinhe",
      "meter_id": "mtr_21F02THKOD7uMpvUalZKsBv64nN",
      "meter_serial": "meter serial",
      "meter_holder_name": "Ana Matsinhe",
      "identity_id": "ide_2W4tFuAzbOoV5aORlgwJHqwRdkg",
      "requester_name": "Ana Matsinhe",
      "reason": "Leitura confirmada no local.",
      "idempotency_key": "idempotency key",
      "kind": "consumer",
      "reading_id": "rdg_2o0xXwujnSgR9QIvVEWblWSv7u0",
      "status": "open",
      "scheduled_at": "2026-11-19T09:30:00Z",
      "resolution": "resolution",
      "resolved_by": "resolved by",
      "resolved_at": "2026-11-19T09:30:00Z",
      "created_at": "2026-11-19T09:30:00Z",
      "updated_at": "2026-11-19T09:30:00Z"
    }
  ],
  "has_more": true,
  "next_cursor": "next cursor"
}

Pedir uma vistoria ao contador

Registos

POST /meter-inspection-requests

Request a meter inspection for an explicitly authorized account

Asks the utility to inspect a meter on a linked account, for example when the caller suspects it is faulty. account_id, meter_id, a reason of up to 500 characters and an idempotency_key of up to 160 characters are required; the caller needs the ticket create permission and the meter must belong to the account (403 otherwise). Resending the same key with the same content returns the existing request, while the same key with different content returns 409; the request is created open and the call answers 202.

Corpo application/json

tenant_idstring · obrigatório
account_idstring · obrigatório
meter_idstring · obrigatório
reasonstring · obrigatório
idempotency_keystring · obrigatório

Devolve

202 Inspection request submitted

Mostrar atributos
idstring · obrigatório
tenant_idstring · obrigatório
account_idstring · obrigatório
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.

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.

identity_idstring · obrigatório
requester_namestring · opcional

Who filed it, which can differ from the account holder.

reasonstring · obrigatório
idempotency_keystring · opcional
kindstring · opcional

um de consumer, field_reread

reading_idstring · opcional
statusstring · obrigatório

um de open, scheduled, completed, cancelled

scheduled_atstring · opcional · anulável
resolutionstring · opcional
resolved_bystring · opcional
resolved_atstring · opcional · anulável
created_atstring (date-time) · obrigatório
updated_atstring (date-time) · obrigatório

Erros 400 · 403 · 404 · 409

curl -X POST "$CONSUMER_API/meter-inspection-requests" \
  -H "Authorization: Bearer sk_test_..." \
  -H "Content-Type: application/json" \
  -d '{
  "tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
  "account_id": "act_2JFioNDgIfvkgflk8RtcqhBaARP",
  "meter_id": "mtr_21F02THKOD7uMpvUalZKsBv64nN",
  "reason": "Leitura confirmada no local.",
  "idempotency_key": "idempotency key"
}'
Resposta 202
{
  "id": "met_22OXlyuNjQGrXkQbdCkn18WvtcE",
  "tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
  "account_id": "act_2JFioNDgIfvkgflk8RtcqhBaARP",
  "account_number": "ACC-2026-000142",
  "account_holder_name": "Ana Matsinhe",
  "meter_id": "mtr_21F02THKOD7uMpvUalZKsBv64nN",
  "meter_serial": "meter serial",
  "meter_holder_name": "Ana Matsinhe",
  "identity_id": "ide_2W4tFuAzbOoV5aORlgwJHqwRdkg",
  "requester_name": "Ana Matsinhe",
  "reason": "Leitura confirmada no local.",
  "idempotency_key": "idempotency key",
  "kind": "consumer",
  "reading_id": "rdg_2o0xXwujnSgR9QIvVEWblWSv7u0",
  "status": "open",
  "scheduled_at": "2026-11-19T09:30:00Z",
  "resolution": "resolution",
  "resolved_by": "resolved by",
  "resolved_at": "2026-11-19T09:30:00Z",
  "created_at": "2026-11-19T09:30:00Z",
  "updated_at": "2026-11-19T09:30:00Z"
}