um de mobile_reader, customer_self_reading, ami_interval, office_estimate
plausibility_statusstring · opcional
um de passed, flagged_high, flagged_negative, flagged_zero, verified_manual
photo_evidencestring · opcional
is_billedboolean · opcional
idstring · obrigatório
tenant_idstring · obrigatório
meter_idstring · obrigatório
meter_holder_namestring · opcional
Display name of the customer who holds the account the meter is installed on. Omitted when unknown.
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.
route_idstring · opcional
cycle_idstring · opcional
assignment_idstring · opcional
valuestring · obrigatório
unitstring · obrigatório
measured_atstring (date-time) · obrigatório
received_atstring (date-time) · obrigatório
methodstring · obrigatório
um de manual, consumer, remote, imported, estimated
submitted_bystring · obrigatório
source_idstring · opcional
external_idstring · opcional
client_reading_idstring · obrigatório
idempotency_keystring · obrigatório
statusstring · obrigatório
um de submitted, validating, accepted, review_required, rejected, superseded
evidence_idsarray of string · opcional
estimate_reasonstring · opcional
review_reasonstring · opcional
review_reason_codestring · opcional
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.
Parâmetros
limitinteger · consulta · opcional
Maximum resources to return (default 20, maximum 100).
afterstring · consulta · opcional
Opaque cursor returned by the previous page.
Devolve
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.
Parâmetros
limitinteger · consulta · opcional
Maximum resources to return (default 20, maximum 100).
afterstring · consulta · opcional
Opaque cursor returned by the previous page.
meter_idstring · consulta · opcional
Returns only readings taken on this meter ID.
account_idstring · consulta · opcional
Returns only readings recorded for this account ID.
route_idstring · consulta · opcional
Returns only readings taken while working this reading route ID.
cycle_idstring · consulta · opcional
Returns only readings that belong to this reading cycle ID.
statusstring · consulta · opcional
Returns only readings in this status: submitted, validating, accepted, review_required, rejected or superseded; any other value returns 400.
um de submitted, validating, accepted, review_required, rejected, superseded
methodstring · consulta · opcional
Returns only readings captured this way: manual, consumer, remote, imported or estimated; any other value returns 400.
um de 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.
Corpo application/json
meter_idstring · obrigatório
assignment_idstring · opcional
Optional in-progress assignment that authorizes this field reading and supplies route/cycle provenance.
valuestring · obrigatório
unitstring · obrigatório
measured_atstring (date-time) · obrigatório
client_reading_idstring · obrigatório
idempotency_keystring · obrigatório
evidence_idsarray of string · opcional
estimate_reasonstring · opcional
Devolve
202Reading recorded for validation or review
Mostrar atributos
meter_serialstring · opcional
The meter's serial number; present on consumer reading listings
connection_idstring · opcional
connection_holder_namestring · opcional
Display name of the customer who holds the referenced connection. Omitted when unknown.
previous_valuestring · opcional
raw_consumptionstring · opcional
Advance since previous_value in the meter unit; a plausible decrease is treated as a rollover.
um de mobile_reader, customer_self_reading, ami_interval, office_estimate
plausibility_statusstring · opcional
um de passed, flagged_high, flagged_negative, flagged_zero, verified_manual
photo_evidencestring · opcional
is_billedboolean · opcional
idstring · obrigatório
tenant_idstring · obrigatório
meter_idstring · obrigatório
meter_holder_namestring · opcional
Display name of the customer who holds the account the meter is installed on. Omitted when unknown.
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.
route_idstring · opcional
cycle_idstring · opcional
assignment_idstring · opcional
valuestring · obrigatório
unitstring · obrigatório
measured_atstring (date-time) · obrigatório
received_atstring (date-time) · obrigatório
methodstring · obrigatório
um de manual, consumer, remote, imported, estimated
submitted_bystring · obrigatório
source_idstring · opcional
external_idstring · opcional
client_reading_idstring · obrigatório
idempotency_keystring · obrigatório
statusstring · obrigatório
um de submitted, validating, accepted, review_required, rejected, superseded
evidence_idsarray of string · opcional
estimate_reasonstring · opcional
review_reasonstring · opcional
review_reason_codestring · opcional
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.
Parâmetros
idstring · caminho · obrigatório
ID of the meter reading to return.
Devolve
200Reading details
Mostrar atributos
meter_serialstring · opcional
The meter's serial number; present on consumer reading listings
connection_idstring · opcional
connection_holder_namestring · opcional
Display name of the customer who holds the referenced connection. Omitted when unknown.
previous_valuestring · opcional
raw_consumptionstring · opcional
Advance since previous_value in the meter unit; a plausible decrease is treated as a rollover.
um de mobile_reader, customer_self_reading, ami_interval, office_estimate
plausibility_statusstring · opcional
um de passed, flagged_high, flagged_negative, flagged_zero, verified_manual
photo_evidencestring · opcional
is_billedboolean · opcional
idstring · obrigatório
tenant_idstring · obrigatório
meter_idstring · obrigatório
meter_holder_namestring · opcional
Display name of the customer who holds the account the meter is installed on. Omitted when unknown.
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.
route_idstring · opcional
cycle_idstring · opcional
assignment_idstring · opcional
valuestring · obrigatório
unitstring · obrigatório
measured_atstring (date-time) · obrigatório
received_atstring (date-time) · obrigatório
methodstring · obrigatório
um de manual, consumer, remote, imported, estimated
submitted_bystring · obrigatório
source_idstring · opcional
external_idstring · opcional
client_reading_idstring · obrigatório
idempotency_keystring · obrigatório
statusstring · obrigatório
um de submitted, validating, accepted, review_required, rejected, superseded
evidence_idsarray of string · opcional
estimate_reasonstring · opcional
review_reasonstring · opcional
review_reason_codestring · opcional
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.
Parâmetros
idstring · caminho · obrigatório
ID of the meter reading to accept.
Devolve
200Accepted reading
Mostrar atributos
meter_serialstring · opcional
The meter's serial number; present on consumer reading listings
connection_idstring · opcional
connection_holder_namestring · opcional
Display name of the customer who holds the referenced connection. Omitted when unknown.
previous_valuestring · opcional
raw_consumptionstring · opcional
Advance since previous_value in the meter unit; a plausible decrease is treated as a rollover.
um de mobile_reader, customer_self_reading, ami_interval, office_estimate
plausibility_statusstring · opcional
um de passed, flagged_high, flagged_negative, flagged_zero, verified_manual
photo_evidencestring · opcional
is_billedboolean · opcional
idstring · obrigatório
tenant_idstring · obrigatório
meter_idstring · obrigatório
meter_holder_namestring · opcional
Display name of the customer who holds the account the meter is installed on. Omitted when unknown.
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.
route_idstring · opcional
cycle_idstring · opcional
assignment_idstring · opcional
valuestring · obrigatório
unitstring · obrigatório
measured_atstring (date-time) · obrigatório
received_atstring (date-time) · obrigatório
methodstring · obrigatório
um de manual, consumer, remote, imported, estimated
submitted_bystring · obrigatório
source_idstring · opcional
external_idstring · opcional
client_reading_idstring · obrigatório
idempotency_keystring · obrigatório
statusstring · obrigatório
um de submitted, validating, accepted, review_required, rejected, superseded
evidence_idsarray of string · opcional
estimate_reasonstring · opcional
review_reasonstring · opcional
review_reason_codestring · opcional
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.
Parâmetros
idstring · caminho · obrigatório
ID of the meter reading to reject.
Corpo application/json
reasonstring · obrigatório
Devolve
200Rejected reading
Mostrar atributos
meter_serialstring · opcional
The meter's serial number; present on consumer reading listings
connection_idstring · opcional
connection_holder_namestring · opcional
Display name of the customer who holds the referenced connection. Omitted when unknown.
previous_valuestring · opcional
raw_consumptionstring · opcional
Advance since previous_value in the meter unit; a plausible decrease is treated as a rollover.
um de mobile_reader, customer_self_reading, ami_interval, office_estimate
plausibility_statusstring · opcional
um de passed, flagged_high, flagged_negative, flagged_zero, verified_manual
photo_evidencestring · opcional
is_billedboolean · opcional
idstring · obrigatório
tenant_idstring · obrigatório
meter_idstring · obrigatório
meter_holder_namestring · opcional
Display name of the customer who holds the account the meter is installed on. Omitted when unknown.
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.
route_idstring · opcional
cycle_idstring · opcional
assignment_idstring · opcional
valuestring · obrigatório
unitstring · obrigatório
measured_atstring (date-time) · obrigatório
received_atstring (date-time) · obrigatório
methodstring · obrigatório
um de manual, consumer, remote, imported, estimated
submitted_bystring · obrigatório
source_idstring · opcional
external_idstring · opcional
client_reading_idstring · obrigatório
idempotency_keystring · obrigatório
statusstring · obrigatório
um de submitted, validating, accepted, review_required, rejected, superseded
evidence_idsarray of string · opcional
estimate_reasonstring · opcional
review_reasonstring · opcional
review_reason_codestring · opcional
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."
}'
# Sem comando CLI equivalente; use cURL ou HTTP directo.
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)
um de mobile_reader, customer_self_reading, ami_interval, office_estimate
plausibility_statusstring · opcional
um de passed, flagged_high, flagged_negative, flagged_zero, verified_manual
photo_evidencestring · opcional
is_billedboolean · opcional
idstring · obrigatório
tenant_idstring · obrigatório
meter_idstring · obrigatório
meter_holder_namestring · opcional
Display name of the customer who holds the account the meter is installed on. Omitted when unknown.
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.
route_idstring · opcional
cycle_idstring · opcional
assignment_idstring · opcional
valuestring · obrigatório
unitstring · obrigatório
measured_atstring (date-time) · obrigatório
received_atstring (date-time) · obrigatório
methodstring · obrigatório
um de manual, consumer, remote, imported, estimated
submitted_bystring · obrigatório
source_idstring · opcional
external_idstring · opcional
client_reading_idstring · obrigatório
idempotency_keystring · obrigatório
statusstring · obrigatório
um de submitted, validating, accepted, review_required, rejected, superseded
evidence_idsarray of string · opcional
estimate_reasonstring · opcional
review_reasonstring · opcional
review_reason_codestring · opcional
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.