PT EN

Leituras estimadas

URL base: $BUSINESS_API

O objecto

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.

raw_consumption_microlitresinteger (int64) · opcional
has_rolloverboolean · opcional
sourcestring · opcional

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.

rejection_reasonstring · opcional
reviewed_bystring · opcional
reviewed_atstring · opcional · anulável
supersedes_idstring · opcional
superseded_by_idstring · opcional
correction_reasonstring · opcional
created_atstring (date-time) · obrigatório
O objecto
{
  "meter_serial": "meter serial",
  "connection_id": "con_2wuJTWy9FOCTPGA3noGbHegbLaU",
  "connection_holder_name": "Ana Matsinhe",
  "previous_value": "previous value",
  "raw_consumption": "raw consumption",
  "raw_consumption_microlitres": 1342,
  "has_rollover": true,
  "source": "mobile_reader",
  "plausibility_status": "passed",
  "photo_evidence": "photo evidence",
  "is_billed": true,
  "id": "rdg_2o0xXwujnSgR9QIvVEWblWSv7u0",
  "tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
  "meter_id": "mtr_21F02THKOD7uMpvUalZKsBv64nN",
  "meter_holder_name": "Ana Matsinhe",
  "account_id": "act_2JFioNDgIfvkgflk8RtcqhBaARP",
  "account_number": "ACC-2026-000142",
  "account_holder_name": "Ana Matsinhe",
  "route_id": "rte_2Tzu6NZioJBSiX9CSX5qObtq4Zt",
  "cycle_id": "cyc_2o6Z32az1oKF1ykfNkmdxACDLcy",
  "assignment_id": "ass_2bVAYnXSmDHuMvxsMpR2Q93SOVR",
  "value": "value",
  "unit": "unit",
  "measured_at": "2026-11-19T09:30:00Z",
  "received_at": "2026-11-19T09:30:00Z",
  "method": "manual",
  "submitted_by": "submitted by",
  "source_id": "sou_2fjWEpPCsLRCQBV64hz26xd8MF9",
  "external_id": "ext_29hSSzf2mTlOMhPS6LZmabb6s5h",
  "client_reading_id": "cli_20odFUijr6eh1g69pygb9smdNCU",
  "idempotency_key": "idempotency key",
  "status": "submitted",
  "evidence_ids": [
    "evi_2N98GhhgsvHGkNNqQ3LICnXai7r"
  ],
  "estimate_reason": "estimate reason",
  "review_reason": "review reason",
  "review_reason_code": "REV-2026-000142",
  "rejection_reason": "rejection reason",
  "reviewed_by": "reviewed by",
  "reviewed_at": "2026-11-19T09:30:00Z",
  "supersedes_id": "sup_2ZzC0N30W7dG4lhc0j9MWD38E9H",
  "superseded_by_id": "sup_2CCzv2SV1C8FhKeH3QOr5AY7LOi",
  "correction_reason": "correction reason",
  "created_at": "2026-11-19T09:30:00Z"
}

Registar uma leitura estimada

Registos

POST /reading-estimates

Estimates remain marked as estimates and require the same validation and acceptance process as observations.

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

202 Estimated reading submitted 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.

raw_consumption_microlitresinteger (int64) · opcional
has_rolloverboolean · opcional
sourcestring · opcional

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.

rejection_reasonstring · opcional
reviewed_bystring · opcional
reviewed_atstring · opcional · anulável
supersedes_idstring · opcional
superseded_by_idstring · opcional
correction_reasonstring · opcional
created_atstring (date-time) · obrigatório

Permissões business:readings:estimate · Funções: admin, operations, owner

curl -X POST "$BUSINESS_API/reading-estimates" \
  -H "Authorization: Bearer sk_test_..." \
  -H "Content-Type: application/json" \
  -d '{
  "meter_id": "mtr_21F02THKOD7uMpvUalZKsBv64nN",
  "assignment_id": "ass_2bVAYnXSmDHuMvxsMpR2Q93SOVR",
  "value": "value",
  "unit": "unit",
  "measured_at": "2026-11-19T09:30:00Z",
  "client_reading_id": "cli_20odFUijr6eh1g69pygb9smdNCU",
  "idempotency_key": "idempotency key",
  "evidence_ids": [
    "evi_2N98GhhgsvHGkNNqQ3LICnXai7r"
  ],
  "estimate_reason": "estimate reason"
}'
Resposta 202
{
  "meter_serial": "meter serial",
  "connection_id": "con_2wuJTWy9FOCTPGA3noGbHegbLaU",
  "connection_holder_name": "Ana Matsinhe",
  "previous_value": "previous value",
  "raw_consumption": "raw consumption",
  "raw_consumption_microlitres": 1342,
  "has_rollover": true,
  "source": "mobile_reader",
  "plausibility_status": "passed",
  "photo_evidence": "photo evidence",
  "is_billed": true,
  "id": "rdg_2o0xXwujnSgR9QIvVEWblWSv7u0",
  "tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
  "meter_id": "mtr_21F02THKOD7uMpvUalZKsBv64nN",
  "meter_holder_name": "Ana Matsinhe",
  "account_id": "act_2JFioNDgIfvkgflk8RtcqhBaARP",
  "account_number": "ACC-2026-000142",
  "account_holder_name": "Ana Matsinhe",
  "route_id": "rte_2Tzu6NZioJBSiX9CSX5qObtq4Zt",
  "cycle_id": "cyc_2o6Z32az1oKF1ykfNkmdxACDLcy",
  "assignment_id": "ass_2bVAYnXSmDHuMvxsMpR2Q93SOVR",
  "value": "value",
  "unit": "unit",
  "measured_at": "2026-11-19T09:30:00Z",
  "received_at": "2026-11-19T09:30:00Z",
  "method": "manual",
  "submitted_by": "submitted by",
  "source_id": "sou_2fjWEpPCsLRCQBV64hz26xd8MF9",
  "external_id": "ext_29hSSzf2mTlOMhPS6LZmabb6s5h",
  "client_reading_id": "cli_20odFUijr6eh1g69pygb9smdNCU",
  "idempotency_key": "idempotency key",
  "status": "submitted",
  "evidence_ids": [
    "evi_2N98GhhgsvHGkNNqQ3LICnXai7r"
  ],
  "estimate_reason": "estimate reason",
  "review_reason": "review reason",
  "review_reason_code": "REV-2026-000142",
  "rejection_reason": "rejection reason",
  "reviewed_by": "reviewed by",
  "reviewed_at": "2026-11-19T09:30:00Z",
  "supersedes_id": "sup_2ZzC0N30W7dG4lhc0j9MWD38E9H",
  "superseded_by_id": "sup_2CCzv2SV1C8FhKeH3QOr5AY7LOi",
  "correction_reason": "correction reason",
  "created_at": "2026-11-19T09:30:00Z"
}