one of mobile_reader, customer_self_reading, ami_interval, office_estimate
plausibility_statusstring · optional
one of passed, flagged_high, flagged_negative, flagged_zero, verified_manual
photo_evidencestring · optional
is_billedboolean · optional
idstring · required
tenant_idstring · required
meter_idstring · required
meter_holder_namestring · optional
Display name of the customer who holds the account the meter is installed on. Omitted when unknown.
account_idstring · required
account_numberstring · optional
Number of the referenced account, e.g. CTA-000044. Omitted when unknown.
account_holder_namestring · optional
Display name of the customer who holds the referenced account. Omitted when unknown.
route_idstring · optional
cycle_idstring · optional
assignment_idstring · optional
valuestring · required
unitstring · required
measured_atstring (date-time) · required
received_atstring (date-time) · required
methodstring · required
one of manual, consumer, remote, imported, estimated
submitted_bystring · required
source_idstring · optional
external_idstring · optional
client_reading_idstring · required
idempotency_keystring · required
statusstring · required
one of submitted, validating, accepted, review_required, rejected, superseded
evidence_idsarray of string · optional
estimate_reasonstring · optional
review_reasonstring · optional
review_reason_codestring · optional
Stable code of the plausibility check that sent the reading to review (reading_review.below_reset_baseline, reading_review.earlier_than_latest, reading_review.earlier_or_lower, reading_review.zero_with_recent_usage, reading_review.above_three_month_average); clients word it and fall back to review_reason.
Readings awaiting plausibility review with three-month context
Returns the review queue: readings in review_required status that the plausibility check flagged as high, negative or zero consumption, a page at a time (limit default 20, maximum 100, and after). Each item adds up to 12 accepted readings of the same meter from the previous three months, their average consumption and the high-consumption threshold derived from it. Requires business:readings:read.
Parameters
limitinteger · query · optional
Maximum resources to return (default 20, maximum 100).
afterstring · query · optional
Opaque cursor returned by the previous page.
Returns
200Flagged readings with average, threshold and recent accepted readings
Returns a cursor-paginated page of meter readings in the tenant, with value, unit, method, status, plausibility result and the route, cycle and assignment they came from. Filters combine, and limit (default 20, maximum 100) and after page the results. Requires business:readings:read.
Parameters
limitinteger · query · optional
Maximum resources to return (default 20, maximum 100).
afterstring · query · optional
Opaque cursor returned by the previous page.
meter_idstring · query · optional
Returns only readings taken on this meter ID.
account_idstring · query · optional
Returns only readings recorded for this account ID.
route_idstring · query · optional
Returns only readings taken while working this reading route ID.
cycle_idstring · query · optional
Returns only readings that belong to this reading cycle ID.
statusstring · query · optional
Returns only readings in this status: submitted, validating, accepted, review_required, rejected or superseded; any other value returns 400.
one of submitted, validating, accepted, review_required, rejected, superseded
methodstring · query · optional
Returns only readings captured this way: manual, consumer, remote, imported or estimated; any other value returns 400.
one of manual, consumer, remote, imported, estimated
Records a reading taken by staff and returns 202 with the reading, whose status is submitted or review_required depending on the plausibility check; a manual reading also logs a field visit. meter_id, client_reading_id, idempotency_key, measured_at, value and the meter's unit are required, the meter must be active, and measured_at cannot be before installation or more than 5 minutes in the future. Retrying with the same idempotency_key and identical data returns the original reading, while different data returns 409. Sending a readings array instead records up to 500 readings and returns 207 with a per-item result.
Body application/json
meter_idstring · required
assignment_idstring · optional
Optional in-progress assignment that authorizes this field reading and supplies route/cycle provenance.
valuestring · required
unitstring · required
measured_atstring (date-time) · required
client_reading_idstring · required
idempotency_keystring · required
evidence_idsarray of string · optional
estimate_reasonstring · optional
Returns
202Reading recorded for validation or review
Show attributes
meter_serialstring · optional
The meter's serial number; present on consumer reading listings
connection_idstring · optional
connection_holder_namestring · optional
Display name of the customer who holds the referenced connection. Omitted when unknown.
previous_valuestring · optional
raw_consumptionstring · optional
Advance since previous_value in the meter unit; a plausible decrease is treated as a rollover.
one of mobile_reader, customer_self_reading, ami_interval, office_estimate
plausibility_statusstring · optional
one of passed, flagged_high, flagged_negative, flagged_zero, verified_manual
photo_evidencestring · optional
is_billedboolean · optional
idstring · required
tenant_idstring · required
meter_idstring · required
meter_holder_namestring · optional
Display name of the customer who holds the account the meter is installed on. Omitted when unknown.
account_idstring · required
account_numberstring · optional
Number of the referenced account, e.g. CTA-000044. Omitted when unknown.
account_holder_namestring · optional
Display name of the customer who holds the referenced account. Omitted when unknown.
route_idstring · optional
cycle_idstring · optional
assignment_idstring · optional
valuestring · required
unitstring · required
measured_atstring (date-time) · required
received_atstring (date-time) · required
methodstring · required
one of manual, consumer, remote, imported, estimated
submitted_bystring · required
source_idstring · optional
external_idstring · optional
client_reading_idstring · required
idempotency_keystring · required
statusstring · required
one of submitted, validating, accepted, review_required, rejected, superseded
evidence_idsarray of string · optional
estimate_reasonstring · optional
review_reasonstring · optional
review_reason_codestring · optional
Stable code of the plausibility check that sent the reading to review (reading_review.below_reset_baseline, reading_review.earlier_than_latest, reading_review.earlier_or_lower, reading_review.zero_with_recent_usage, reading_review.above_three_month_average); clients word it and fall back to review_reason.
Returns one meter reading with its value, unit, method, status, plausibility result, evidence and review details. A reading that does not exist in the tenant returns 404. Requires business:readings:read.
Parameters
idstring · path · required
ID of the meter reading to return.
Returns
200Reading details
Show attributes
meter_serialstring · optional
The meter's serial number; present on consumer reading listings
connection_idstring · optional
connection_holder_namestring · optional
Display name of the customer who holds the referenced connection. Omitted when unknown.
previous_valuestring · optional
raw_consumptionstring · optional
Advance since previous_value in the meter unit; a plausible decrease is treated as a rollover.
one of mobile_reader, customer_self_reading, ami_interval, office_estimate
plausibility_statusstring · optional
one of passed, flagged_high, flagged_negative, flagged_zero, verified_manual
photo_evidencestring · optional
is_billedboolean · optional
idstring · required
tenant_idstring · required
meter_idstring · required
meter_holder_namestring · optional
Display name of the customer who holds the account the meter is installed on. Omitted when unknown.
account_idstring · required
account_numberstring · optional
Number of the referenced account, e.g. CTA-000044. Omitted when unknown.
account_holder_namestring · optional
Display name of the customer who holds the referenced account. Omitted when unknown.
route_idstring · optional
cycle_idstring · optional
assignment_idstring · optional
valuestring · required
unitstring · required
measured_atstring (date-time) · required
received_atstring (date-time) · required
methodstring · required
one of manual, consumer, remote, imported, estimated
submitted_bystring · required
source_idstring · optional
external_idstring · optional
client_reading_idstring · required
idempotency_keystring · required
statusstring · required
one of submitted, validating, accepted, review_required, rejected, superseded
evidence_idsarray of string · optional
estimate_reasonstring · optional
review_reasonstring · optional
review_reason_codestring · optional
Stable code of the plausibility check that sent the reading to review (reading_review.below_reset_baseline, reading_review.earlier_than_latest, reading_review.earlier_or_lower, reading_review.zero_with_recent_usage, reading_review.above_three_month_average); clients word it and fall back to review_reason.
Accepts a reading so it can be used for consumption and billing, records the reviewer and the status change, and returns the updated reading. Only readings in submitted or review_required status can be accepted; any other status returns 409. Requires business:readings:review.
Parameters
idstring · path · required
ID of the meter reading to accept.
Returns
200Accepted reading
Show attributes
meter_serialstring · optional
The meter's serial number; present on consumer reading listings
connection_idstring · optional
connection_holder_namestring · optional
Display name of the customer who holds the referenced connection. Omitted when unknown.
previous_valuestring · optional
raw_consumptionstring · optional
Advance since previous_value in the meter unit; a plausible decrease is treated as a rollover.
one of mobile_reader, customer_self_reading, ami_interval, office_estimate
plausibility_statusstring · optional
one of passed, flagged_high, flagged_negative, flagged_zero, verified_manual
photo_evidencestring · optional
is_billedboolean · optional
idstring · required
tenant_idstring · required
meter_idstring · required
meter_holder_namestring · optional
Display name of the customer who holds the account the meter is installed on. Omitted when unknown.
account_idstring · required
account_numberstring · optional
Number of the referenced account, e.g. CTA-000044. Omitted when unknown.
account_holder_namestring · optional
Display name of the customer who holds the referenced account. Omitted when unknown.
route_idstring · optional
cycle_idstring · optional
assignment_idstring · optional
valuestring · required
unitstring · required
measured_atstring (date-time) · required
received_atstring (date-time) · required
methodstring · required
one of manual, consumer, remote, imported, estimated
submitted_bystring · required
source_idstring · optional
external_idstring · optional
client_reading_idstring · required
idempotency_keystring · required
statusstring · required
one of submitted, validating, accepted, review_required, rejected, superseded
evidence_idsarray of string · optional
estimate_reasonstring · optional
review_reasonstring · optional
review_reason_codestring · optional
Stable code of the plausibility check that sent the reading to review (reading_review.below_reset_baseline, reading_review.earlier_than_latest, reading_review.earlier_or_lower, reading_review.zero_with_recent_usage, reading_review.above_three_month_average); clients word it and fall back to review_reason.
Rejects a reading so it is not used for consumption or billing, records the reviewer, the reason and the status change, and returns the updated reading. A reason of 1 to 500 characters is required (400 otherwise). Only readings in submitted or review_required status can be rejected; any other status returns 409. Requires business:readings:review.
Parameters
idstring · path · required
ID of the meter reading to reject.
Body application/json
reasonstring · required
Returns
200Rejected reading
Show attributes
meter_serialstring · optional
The meter's serial number; present on consumer reading listings
connection_idstring · optional
connection_holder_namestring · optional
Display name of the customer who holds the referenced connection. Omitted when unknown.
previous_valuestring · optional
raw_consumptionstring · optional
Advance since previous_value in the meter unit; a plausible decrease is treated as a rollover.
one of mobile_reader, customer_self_reading, ami_interval, office_estimate
plausibility_statusstring · optional
one of passed, flagged_high, flagged_negative, flagged_zero, verified_manual
photo_evidencestring · optional
is_billedboolean · optional
idstring · required
tenant_idstring · required
meter_idstring · required
meter_holder_namestring · optional
Display name of the customer who holds the account the meter is installed on. Omitted when unknown.
account_idstring · required
account_numberstring · optional
Number of the referenced account, e.g. CTA-000044. Omitted when unknown.
account_holder_namestring · optional
Display name of the customer who holds the referenced account. Omitted when unknown.
route_idstring · optional
cycle_idstring · optional
assignment_idstring · optional
valuestring · required
unitstring · required
measured_atstring (date-time) · required
received_atstring (date-time) · required
methodstring · required
one of manual, consumer, remote, imported, estimated
submitted_bystring · required
source_idstring · optional
external_idstring · optional
client_reading_idstring · required
idempotency_keystring · required
statusstring · required
one of submitted, validating, accepted, review_required, rejected, superseded
evidence_idsarray of string · optional
estimate_reasonstring · optional
review_reasonstring · optional
review_reason_codestring · optional
Stable code of the plausibility check that sent the reading to review (reading_review.below_reset_baseline, reading_review.earlier_than_latest, reading_review.earlier_or_lower, reading_review.zero_with_recent_usage, reading_review.above_three_month_average); clients word it and fall back to review_reason.
curl -X POST "$BUSINESS_API/readings/{id}/reject"\
-H "Authorization: Bearer sk_test_..."\
-H "Content-Type: application/json"\
-d '{
"reason": "Leitura confirmada no local."
}'
# No matching CLI command; use cURL or direct HTTP.
constres=awaitfetch("$BUSINESS_API/readings/{id}/reject",{method:"POST",headers:{Authorization:"Bearer sk_test_...","Content-Type":"application/json"},body:JSON.stringify({"reason":"Leitura confirmada no local."})});constdata=awaitres.json();
importrequestsres=requests.post("$BUSINESS_API/readings/{id}/reject",headers={"Authorization":"Bearer sk_test_..."},json={"reason":"Leitura confirmada no local."})data=res.json()
body:=strings.NewReader(`{
"reason": "Leitura confirmada no local."
}`)req,_:=http.NewRequest("POST","$BUSINESS_API/readings/{id}/reject",body)req.Header.Set("Authorization","Bearer sk_test_...")req.Header.Set("Content-Type","application/json")resp,err:=http.DefaultClient.Do(req)
one of mobile_reader, customer_self_reading, ami_interval, office_estimate
plausibility_statusstring · optional
one of passed, flagged_high, flagged_negative, flagged_zero, verified_manual
photo_evidencestring · optional
is_billedboolean · optional
idstring · required
tenant_idstring · required
meter_idstring · required
meter_holder_namestring · optional
Display name of the customer who holds the account the meter is installed on. Omitted when unknown.
account_idstring · required
account_numberstring · optional
Number of the referenced account, e.g. CTA-000044. Omitted when unknown.
account_holder_namestring · optional
Display name of the customer who holds the referenced account. Omitted when unknown.
route_idstring · optional
cycle_idstring · optional
assignment_idstring · optional
valuestring · required
unitstring · required
measured_atstring (date-time) · required
received_atstring (date-time) · required
methodstring · required
one of manual, consumer, remote, imported, estimated
submitted_bystring · required
source_idstring · optional
external_idstring · optional
client_reading_idstring · required
idempotency_keystring · required
statusstring · required
one of submitted, validating, accepted, review_required, rejected, superseded
evidence_idsarray of string · optional
estimate_reasonstring · optional
review_reasonstring · optional
review_reason_codestring · optional
Stable code of the plausibility check that sent the reading to review (reading_review.below_reset_baseline, reading_review.earlier_than_latest, reading_review.earlier_or_lower, reading_review.zero_with_recent_usage, reading_review.above_three_month_average); clients word it and fall back to review_reason.