PT EN

Contestações de leituras

URL base: $BUSINESS_API

Listar contestações de leituras

Registos

GET /reading-disputes

Returns a cursor-paginated page of the disputes customers have raised against meter readings, with the account, reading, reason, who filed it and any resolution. Use limit (default 20, maximum 100) and after to page. Requires the business:reading-disputes:read permission.

Parâmetros

limitinteger · consulta · opcional

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

afterstring · consulta · opcional

Opaque cursor returned by the previous page.

account_idstring · consulta · opcional

Returns only disputes raised on this account ID.

reading_idstring · consulta · opcional

Returns only disputes raised against this meter reading ID.

statusstring · consulta · opcional

Returns only disputes in this status: open, in_review, resolved or rejected; any other value returns 400.

um de open, in_review, resolved, rejected

Devolve

200 Tenant-scoped consumer reading disputes

Permissões business:reading-disputes:read · Funções: admin, analyst, customer_service, field_supervisor, operations, owner

curl -X GET "$BUSINESS_API/reading-disputes" \
  -H "Authorization: Bearer sk_test_..."
Resposta 200

Tenant-scoped consumer reading disputes

Analisar uma contestação de leitura

Registos

PATCH /reading-disputes/{id}/status

Moves a reading dispute forward and returns 204 with no body. An open dispute can go to in_review, and an open or in_review dispute can be closed as resolved or rejected; closing requires a non-empty resolution text, which is stored with the reviewer and the time. Any other move, including reopening a closed dispute, returns 409, and an unknown status returns 400. Requires business:reading-disputes:manage.

Parâmetros

idstring · caminho · obrigatório

ID of the reading dispute to update.

Corpo application/json

statusstring · obrigatório

um de in_review, resolved, rejected

resolutionstring · opcional

Devolve

204 Dispute state updated

Permissões business:reading-disputes:manage · Funções: admin, customer_service, field_supervisor, operations, owner

curl -X PATCH "$BUSINESS_API/reading-disputes/{id}/status" \
  -H "Authorization: Bearer sk_test_..." \
  -H "Content-Type: application/json" \
  -d '{
  "status": "in_review",
  "resolution": "resolution"
}'
Resposta 204

Dispute state updated