PT EN

Contestações de leituras

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.

reading_idstring · obrigatório
identity_idstring · obrigatório
requester_namestring · opcional

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

reasonstring · obrigatório
idempotency_keystring · opcional
statusstring · obrigatório

um de open, in_review, resolved, rejected

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": "rea_2ZFwubFQelpiuLny0PJuoljESL5",
  "tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
  "account_id": "act_2JFioNDgIfvkgflk8RtcqhBaARP",
  "account_number": "ACC-2026-000142",
  "account_holder_name": "Ana Matsinhe",
  "reading_id": "rdg_2o0xXwujnSgR9QIvVEWblWSv7u0",
  "identity_id": "ide_2W4tFuAzbOoV5aORlgwJHqwRdkg",
  "requester_name": "Ana Matsinhe",
  "reason": "Leitura confirmada no local.",
  "idempotency_key": "idempotency key",
  "status": "open",
  "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 contestações de leituras

Registos

GET /reading-disputes

List disputes for a reading linked to the authenticated consumer

Pages the disputes raised on meter readings of 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 reading disputes are listed.

reading_idstring · consulta · opcional

Returns only disputes about this meter reading.

limitinteger · consulta · opcional

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

afterstring · consulta · opcional

Opaque cursor returned by the previous page.

Devolve

200 Disputes in the selected linked account

Mostrar atributos
dataarray of ReadingDispute · 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.

reading_idstring · obrigatório
identity_idstring · obrigatório
requester_namestring · opcional

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

reasonstring · obrigatório
idempotency_keystring · opcional
statusstring · obrigatório

um de open, in_review, resolved, rejected

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/reading-disputes" \
  -H "Authorization: Bearer sk_test_..."
Resposta 200
{
  "data": [
    {
      "id": "rea_2ZFwubFQelpiuLny0PJuoljESL5",
      "tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
      "account_id": "act_2JFioNDgIfvkgflk8RtcqhBaARP",
      "account_number": "ACC-2026-000142",
      "account_holder_name": "Ana Matsinhe",
      "reading_id": "rdg_2o0xXwujnSgR9QIvVEWblWSv7u0",
      "identity_id": "ide_2W4tFuAzbOoV5aORlgwJHqwRdkg",
      "requester_name": "Ana Matsinhe",
      "reason": "Leitura confirmada no local.",
      "idempotency_key": "idempotency key",
      "status": "open",
      "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"
}

Contestar uma leitura

Registos

POST /reading-disputes

Disputes a meter reading on a linked account, for example when the recorded value looks wrong. account_id, reading_id, a reason of up to 500 characters and an idempotency_key of up to 160 characters are required, and the reading must belong to the account (403 otherwise). Resending the same key with the same content returns the existing dispute, while the same key with different content returns 409; the dispute is created open for staff review and the call answers 202.

Corpo application/json

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

Devolve

202 Consumer reading dispute 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.

reading_idstring · obrigatório
identity_idstring · obrigatório
requester_namestring · opcional

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

reasonstring · obrigatório
idempotency_keystring · opcional
statusstring · obrigatório

um de open, in_review, resolved, rejected

resolutionstring · opcional
resolved_bystring · opcional
resolved_atstring · opcional · anulável
created_atstring (date-time) · obrigatório
updated_atstring (date-time) · obrigatório
curl -X POST "$CONSUMER_API/reading-disputes" \
  -H "Authorization: Bearer sk_test_..." \
  -H "Content-Type: application/json" \
  -d '{
  "tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
  "account_id": "act_2JFioNDgIfvkgflk8RtcqhBaARP",
  "reading_id": "rdg_2o0xXwujnSgR9QIvVEWblWSv7u0",
  "reason": "Leitura confirmada no local.",
  "idempotency_key": "idempotency key"
}'
Resposta 202
{
  "id": "rea_2ZFwubFQelpiuLny0PJuoljESL5",
  "tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
  "account_id": "act_2JFioNDgIfvkgflk8RtcqhBaARP",
  "account_number": "ACC-2026-000142",
  "account_holder_name": "Ana Matsinhe",
  "reading_id": "rdg_2o0xXwujnSgR9QIvVEWblWSv7u0",
  "identity_id": "ide_2W4tFuAzbOoV5aORlgwJHqwRdkg",
  "requester_name": "Ana Matsinhe",
  "reason": "Leitura confirmada no local.",
  "idempotency_key": "idempotency key",
  "status": "open",
  "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"
}