Reading disputes

Base URL: $BUSINESS_API

List consumer disputes in the utility tenant

Logs

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.

Parameters

limitinteger · query · optional

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

afterstring · query · optional

Opaque cursor returned by the previous page.

account_idstring · query · optional

Returns only disputes raised on this account ID.

reading_idstring · query · optional

Returns only disputes raised against this meter reading ID.

statusstring · query · optional

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

one of open, in_review, resolved, rejected

Returns

200 Tenant-scoped consumer reading disputes

Permissions business:reading-disputes:read · Roles: admin, analyst, customer_service, field_supervisor, operations, owner

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

Tenant-scoped consumer reading disputes

Review, resolve, or reject a consumer reading dispute

Logs

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.

Parameters

idstring · path · required

ID of the reading dispute to update.

Body application/json

statusstring · required

one of in_review, resolved, rejected

resolutionstring · optional

Returns

204 Dispute state updated

Permissions business:reading-disputes:manage · Roles: 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"
}'
Response 204

Dispute state updated