Returns the tenant's meters with cursor pagination. The optional q parameter searches meters and also matches meters of accounts whose holder matches the text. An unknown status value returns 400. Requires the business:meters:read permission.
Parameters
limitinteger · query · optional
Maximum resources to return (default 20, maximum 100).
afterstring · query · optional
Opaque cursor returned by the previous page.
qstring · query · optional
Resource-specific text search.
account_idstring · query · optional
Returns only meters assigned to this customer account.
statusstring · query · optional
Operational status: active, inactive or retired; any other value returns 400.
one of active, inactive, retired
device_statusstring · query · optional
Physical device state: in_warehouse, installed, in_testing or scrapped.
one of in_warehouse, installed, in_testing, scrapped
Returns
200Meters in the authenticated utility tenant
Show attributes
dataarray of Meter · required
Show child attributes
meter_rolestring · optional
one of standard, master, submeter
parent_meter_idstring · optional
master_billing_modestring · optional
one of gross, net_of_submeters, monitor_only
idstring · required
tenant_idstring · required
account_idstring · optional
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.
serial_numberstring · required
unitstring · required
precisioninteger · required
manufacturerstring · optional
modelstring · optional
meter_typestring · optional
one of mechanical, ultrasonic, electromagnetic, smart, prepaid
diameter_mminteger · optional
unit_of_measurestring · optional
dial_digitsinteger · optional
dial_decimalsinteger · optional
pulse_multiplierstring · optional
maximum_readingstring · optional
device_statusstring · required
one of in_warehouse, installed, in_testing, scrapped
rollover_valuestring · optional
Optional meter modulus used to calculate a reviewed rollover consumption.
Registers a meter with its serial number (stored upper case), unit, precision (0 to 9) and optional device details, and returns it with 201. A meter registered as in_warehouse or in_testing may have no account and starts inactive; otherwise account_id must name an active account and the meter starts active and installed. Returns 400 for invalid fields or an installed_at in the future, and 404 when the account does not exist. Requires the business:meters:create permission.
Body application/json
manufacturerstring · optional
modelstring · optional
meter_typestring · optional
diameter_mminteger · optional
dial_digitsinteger · optional
Integer dial digits; derives maximum_reading (99999 for five digits).
dial_decimalsinteger · optional
pulse_multiplierstring · optional
maximum_readingstring · optional
Largest dial value; rollover modulus is this plus one smallest dial unit.
device_statusstring · optional
A warehouse or testing meter needs no account.
one of in_warehouse, in_testing, installed
account_idstring · required
serial_numberstring · required
unitstring · required
precisioninteger · required
rollover_valuestring · optional
installed_atstring (date-time) · optional
Returns
201Meter registered
Show attributes
meter_rolestring · optional
one of standard, master, submeter
parent_meter_idstring · optional
master_billing_modestring · optional
one of gross, net_of_submeters, monitor_only
idstring · required
tenant_idstring · required
account_idstring · optional
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.
serial_numberstring · required
unitstring · required
precisioninteger · required
manufacturerstring · optional
modelstring · optional
meter_typestring · optional
one of mechanical, ultrasonic, electromagnetic, smart, prepaid
diameter_mminteger · optional
unit_of_measurestring · optional
dial_digitsinteger · optional
dial_decimalsinteger · optional
pulse_multiplierstring · optional
maximum_readingstring · optional
device_statusstring · required
one of in_warehouse, installed, in_testing, scrapped
rollover_valuestring · optional
Optional meter modulus used to calculate a reviewed rollover consumption.
Install a meter on a connection, writing the installation, start reading and bi-temporal binding atomically
Installs a meter on a connection in one transaction: it records the installation, binds the meter to the connection from installed_at, marks the meter active and installed, records an accepted initial reading, and emits a meter.installed event. idempotency_key is required; repeating it with the same meter and connection returns the existing installation, and with different values returns 409. Returns 409 when the connection or the meter already has an open installation or the meter is scrapped, and 400 when no active account can be resolved. Requires the business:meters:manage permission.
Body application/json
connection_idstring · required
meter_idstring · required
account_idstring · optional
installed_atstring (date-time) · optional
initial_readingstring · required
security_seal_numberstring · optional
idempotency_keystring · required
location_idstring · optional
Store or van the meter is taken from; inventory refuses the installation when its serial is elsewhere.
Returns
201Installation recorded
Show attributes
idstring · required
tenant_idstring · required
connection_idstring · required
connection_holder_namestring · optional
Display name of the customer who holds the referenced connection. Omitted when unknown.
meter_idstring · required
meter_serialstring · optional
Serial number of the referenced meter. Omitted when unknown.
meter_holder_namestring · optional
Display name of the customer who holds the account the meter is installed on. Omitted when unknown.
account_idstring · optional
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.
Closes the old installation, opens the new one, records final and start readings, flips both devices and supersedes the bi-temporal binding in one transaction. Idempotent on idempotency_key.
Body application/json
connection_idstring · required
old_meter_idstring · required
new_meter_idstring · required
exchanged_atstring (date-time) · optional
final_readingstring · required
start_readingstring · required
exchange_reasonstring · required
security_seal_numberstring · optional
old_meter_statusstring · optional
one of in_testing, in_warehouse, scrapped
idempotency_keystring · required
new_meter_location_idstring · optional
Store or van the new meter is taken from.
return_location_idstring · optional
Where an old meter returned in_warehouse goes; the default warehouse when empty.
Returns
201Exchange recorded
Show attributes
closed_installationobject · optional
Show child attributes
idstring · required
tenant_idstring · required
connection_idstring · required
connection_holder_namestring · optional
Display name of the customer who holds the referenced connection. Omitted when unknown.
meter_idstring · required
meter_serialstring · optional
Serial number of the referenced meter. Omitted when unknown.
meter_holder_namestring · optional
Display name of the customer who holds the account the meter is installed on. Omitted when unknown.
account_idstring · optional
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.
installed_atstring (date-time) · required
initial_readingstring · required
removed_atstring · optional · nullable
final_readingstring · optional
exchange_reasonstring · optional
installed_bystring · required
security_seal_numberstring · optional
replaced_installation_idstring · optional
idempotency_keystring · optional
created_atstring (date-time) · required
updated_atstring (date-time) · required
new_installationobject · optional
Show child attributes
idstring · required
tenant_idstring · required
connection_idstring · required
connection_holder_namestring · optional
Display name of the customer who holds the referenced connection. Omitted when unknown.
meter_idstring · required
meter_serialstring · optional
Serial number of the referenced meter. Omitted when unknown.
meter_holder_namestring · optional
Display name of the customer who holds the account the meter is installed on. Omitted when unknown.
account_idstring · optional
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.
installed_atstring (date-time) · required
initial_readingstring · required
removed_atstring · optional · nullable
final_readingstring · optional
exchange_reasonstring · optional
installed_bystring · required
security_seal_numberstring · optional
replaced_installation_idstring · optional
idempotency_keystring · optional
created_atstring (date-time) · required
updated_atstring (date-time) · required
final_readingobject · optional
Show child 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.
rejection_reasonstring · optional
reviewed_bystring · optional
reviewed_atstring · optional · nullable
supersedes_idstring · optional
superseded_by_idstring · optional
correction_reasonstring · optional
created_atstring (date-time) · required
start_readingobject · optional
Show child 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.
rejection_reasonstring · optional
reviewed_bystring · optional
reviewed_atstring · optional · nullable
supersedes_idstring · optional
superseded_by_idstring · optional
correction_reasonstring · optional
created_atstring (date-time) · required
old_meterobject · optional
Show child attributes
meter_rolestring · optional
one of standard, master, submeter
parent_meter_idstring · optional
master_billing_modestring · optional
one of gross, net_of_submeters, monitor_only
idstring · required
tenant_idstring · required
account_idstring · optional
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.
serial_numberstring · required
unitstring · required
precisioninteger · required
manufacturerstring · optional
modelstring · optional
meter_typestring · optional
one of mechanical, ultrasonic, electromagnetic, smart, prepaid
diameter_mminteger · optional
unit_of_measurestring · optional
dial_digitsinteger · optional
dial_decimalsinteger · optional
pulse_multiplierstring · optional
maximum_readingstring · optional
device_statusstring · required
one of in_warehouse, installed, in_testing, scrapped
rollover_valuestring · optional
Optional meter modulus used to calculate a reviewed rollover consumption.
statusstring · required
one of active, inactive, retired
last_reset_atstring · optional · nullable
last_reset_valuestring · optional
installed_atstring (date-time) · required
removed_atstring · optional · nullable
created_atstring (date-time) · required
updated_atstring (date-time) · required
new_meterobject · optional
Show child attributes
meter_rolestring · optional
one of standard, master, submeter
parent_meter_idstring · optional
master_billing_modestring · optional
one of gross, net_of_submeters, monitor_only
idstring · required
tenant_idstring · required
account_idstring · optional
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.
serial_numberstring · required
unitstring · required
precisioninteger · required
manufacturerstring · optional
modelstring · optional
meter_typestring · optional
one of mechanical, ultrasonic, electromagnetic, smart, prepaid
diameter_mminteger · optional
unit_of_measurestring · optional
dial_digitsinteger · optional
dial_decimalsinteger · optional
pulse_multiplierstring · optional
maximum_readingstring · optional
device_statusstring · required
one of in_warehouse, installed, in_testing, scrapped
rollover_valuestring · optional
Optional meter modulus used to calculate a reviewed rollover consumption.
Returns the meter with its serial number, account, unit and precision, status, device status, role (standard, master or submeter) and installation dates. Returns 404 when the meter does not exist in the caller's tenant. Requires the business:meters:read permission.
Parameters
idstring · path · required
ID of the meter in the caller's tenant.
Returns
200Meter details
Show attributes
meter_rolestring · optional
one of standard, master, submeter
parent_meter_idstring · optional
master_billing_modestring · optional
one of gross, net_of_submeters, monitor_only
idstring · required
tenant_idstring · required
account_idstring · optional
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.
serial_numberstring · required
unitstring · required
precisioninteger · required
manufacturerstring · optional
modelstring · optional
meter_typestring · optional
one of mechanical, ultrasonic, electromagnetic, smart, prepaid
diameter_mminteger · optional
unit_of_measurestring · optional
dial_digitsinteger · optional
dial_decimalsinteger · optional
pulse_multiplierstring · optional
maximum_readingstring · optional
device_statusstring · required
one of in_warehouse, installed, in_testing, scrapped
rollover_valuestring · optional
Optional meter modulus used to calculate a reviewed rollover consumption.