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.
Parâmetros
limitinteger · consulta · opcional
Maximum resources to return (default 20, maximum 100).
afterstring · consulta · opcional
Opaque cursor returned by the previous page.
qstring · consulta · opcional
Resource-specific text search.
account_idstring · consulta · opcional
Returns only meters assigned to this customer account.
statusstring · consulta · opcional
Operational status: active, inactive or retired; any other value returns 400.
um de active, inactive, retired
device_statusstring · consulta · opcional
Physical device state: in_warehouse, installed, in_testing or scrapped.
um de in_warehouse, installed, in_testing, scrapped
Devolve
200Meters in the authenticated utility tenant
Mostrar atributos
dataarray of Meter · obrigatório
Mostrar atributos filhos
meter_rolestring · opcional
um de standard, master, submeter
parent_meter_idstring · opcional
master_billing_modestring · opcional
um de gross, net_of_submeters, monitor_only
idstring · obrigatório
tenant_idstring · obrigatório
account_idstring · opcional
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.
serial_numberstring · obrigatório
unitstring · obrigatório
precisioninteger · obrigatório
manufacturerstring · opcional
modelstring · opcional
meter_typestring · opcional
um de mechanical, ultrasonic, electromagnetic, smart, prepaid
diameter_mminteger · opcional
unit_of_measurestring · opcional
dial_digitsinteger · opcional
dial_decimalsinteger · opcional
pulse_multiplierstring · opcional
maximum_readingstring · opcional
device_statusstring · obrigatório
um de in_warehouse, installed, in_testing, scrapped
rollover_valuestring · opcional
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.
Corpo application/json
manufacturerstring · opcional
modelstring · opcional
meter_typestring · opcional
diameter_mminteger · opcional
dial_digitsinteger · opcional
Integer dial digits; derives maximum_reading (99999 for five digits).
dial_decimalsinteger · opcional
pulse_multiplierstring · opcional
maximum_readingstring · opcional
Largest dial value; rollover modulus is this plus one smallest dial unit.
device_statusstring · opcional
A warehouse or testing meter needs no account.
um de in_warehouse, in_testing, installed
account_idstring · obrigatório
serial_numberstring · obrigatório
unitstring · obrigatório
precisioninteger · obrigatório
rollover_valuestring · opcional
installed_atstring (date-time) · opcional
Devolve
201Meter registered
Mostrar atributos
meter_rolestring · opcional
um de standard, master, submeter
parent_meter_idstring · opcional
master_billing_modestring · opcional
um de gross, net_of_submeters, monitor_only
idstring · obrigatório
tenant_idstring · obrigatório
account_idstring · opcional
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.
serial_numberstring · obrigatório
unitstring · obrigatório
precisioninteger · obrigatório
manufacturerstring · opcional
modelstring · opcional
meter_typestring · opcional
um de mechanical, ultrasonic, electromagnetic, smart, prepaid
diameter_mminteger · opcional
unit_of_measurestring · opcional
dial_digitsinteger · opcional
dial_decimalsinteger · opcional
pulse_multiplierstring · opcional
maximum_readingstring · opcional
device_statusstring · obrigatório
um de in_warehouse, installed, in_testing, scrapped
rollover_valuestring · opcional
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.
Corpo application/json
connection_idstring · obrigatório
meter_idstring · obrigatório
account_idstring · opcional
installed_atstring (date-time) · opcional
initial_readingstring · obrigatório
security_seal_numberstring · opcional
idempotency_keystring · obrigatório
location_idstring · opcional
Store or van the meter is taken from; inventory refuses the installation when its serial is elsewhere.
Devolve
201Installation recorded
Mostrar atributos
idstring · obrigatório
tenant_idstring · obrigatório
connection_idstring · obrigatório
connection_holder_namestring · opcional
Display name of the customer who holds the referenced connection. Omitted when unknown.
meter_idstring · obrigatório
meter_serialstring · opcional
Serial number of the referenced meter. Omitted when unknown.
meter_holder_namestring · opcional
Display name of the customer who holds the account the meter is installed on. Omitted when unknown.
account_idstring · opcional
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.
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.
Corpo application/json
connection_idstring · obrigatório
old_meter_idstring · obrigatório
new_meter_idstring · obrigatório
exchanged_atstring (date-time) · opcional
final_readingstring · obrigatório
start_readingstring · obrigatório
exchange_reasonstring · obrigatório
security_seal_numberstring · opcional
old_meter_statusstring · opcional
um de in_testing, in_warehouse, scrapped
idempotency_keystring · obrigatório
new_meter_location_idstring · opcional
Store or van the new meter is taken from.
return_location_idstring · opcional
Where an old meter returned in_warehouse goes; the default warehouse when empty.
Devolve
201Exchange recorded
Mostrar atributos
closed_installationobject · opcional
Mostrar atributos filhos
idstring · obrigatório
tenant_idstring · obrigatório
connection_idstring · obrigatório
connection_holder_namestring · opcional
Display name of the customer who holds the referenced connection. Omitted when unknown.
meter_idstring · obrigatório
meter_serialstring · opcional
Serial number of the referenced meter. Omitted when unknown.
meter_holder_namestring · opcional
Display name of the customer who holds the account the meter is installed on. Omitted when unknown.
account_idstring · opcional
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.
installed_atstring (date-time) · obrigatório
initial_readingstring · obrigatório
removed_atstring · opcional · anulável
final_readingstring · opcional
exchange_reasonstring · opcional
installed_bystring · obrigatório
security_seal_numberstring · opcional
replaced_installation_idstring · opcional
idempotency_keystring · opcional
created_atstring (date-time) · obrigatório
updated_atstring (date-time) · obrigatório
new_installationobject · opcional
Mostrar atributos filhos
idstring · obrigatório
tenant_idstring · obrigatório
connection_idstring · obrigatório
connection_holder_namestring · opcional
Display name of the customer who holds the referenced connection. Omitted when unknown.
meter_idstring · obrigatório
meter_serialstring · opcional
Serial number of the referenced meter. Omitted when unknown.
meter_holder_namestring · opcional
Display name of the customer who holds the account the meter is installed on. Omitted when unknown.
account_idstring · opcional
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.
installed_atstring (date-time) · obrigatório
initial_readingstring · obrigatório
removed_atstring · opcional · anulável
final_readingstring · opcional
exchange_reasonstring · opcional
installed_bystring · obrigatório
security_seal_numberstring · opcional
replaced_installation_idstring · opcional
idempotency_keystring · opcional
created_atstring (date-time) · obrigatório
updated_atstring (date-time) · obrigatório
final_readingobject · opcional
Mostrar atributos filhos
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.
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
start_readingobject · opcional
Mostrar atributos filhos
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.
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
old_meterobject · opcional
Mostrar atributos filhos
meter_rolestring · opcional
um de standard, master, submeter
parent_meter_idstring · opcional
master_billing_modestring · opcional
um de gross, net_of_submeters, monitor_only
idstring · obrigatório
tenant_idstring · obrigatório
account_idstring · opcional
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.
serial_numberstring · obrigatório
unitstring · obrigatório
precisioninteger · obrigatório
manufacturerstring · opcional
modelstring · opcional
meter_typestring · opcional
um de mechanical, ultrasonic, electromagnetic, smart, prepaid
diameter_mminteger · opcional
unit_of_measurestring · opcional
dial_digitsinteger · opcional
dial_decimalsinteger · opcional
pulse_multiplierstring · opcional
maximum_readingstring · opcional
device_statusstring · obrigatório
um de in_warehouse, installed, in_testing, scrapped
rollover_valuestring · opcional
Optional meter modulus used to calculate a reviewed rollover consumption.
statusstring · obrigatório
um de active, inactive, retired
last_reset_atstring · opcional · anulável
last_reset_valuestring · opcional
installed_atstring (date-time) · obrigatório
removed_atstring · opcional · anulável
created_atstring (date-time) · obrigatório
updated_atstring (date-time) · obrigatório
new_meterobject · opcional
Mostrar atributos filhos
meter_rolestring · opcional
um de standard, master, submeter
parent_meter_idstring · opcional
master_billing_modestring · opcional
um de gross, net_of_submeters, monitor_only
idstring · obrigatório
tenant_idstring · obrigatório
account_idstring · opcional
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.
serial_numberstring · obrigatório
unitstring · obrigatório
precisioninteger · obrigatório
manufacturerstring · opcional
modelstring · opcional
meter_typestring · opcional
um de mechanical, ultrasonic, electromagnetic, smart, prepaid
diameter_mminteger · opcional
unit_of_measurestring · opcional
dial_digitsinteger · opcional
dial_decimalsinteger · opcional
pulse_multiplierstring · opcional
maximum_readingstring · opcional
device_statusstring · obrigatório
um de in_warehouse, installed, in_testing, scrapped
rollover_valuestring · opcional
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.
Parâmetros
idstring · caminho · obrigatório
ID of the meter in the caller's tenant.
Devolve
200Meter details
Mostrar atributos
meter_rolestring · opcional
um de standard, master, submeter
parent_meter_idstring · opcional
master_billing_modestring · opcional
um de gross, net_of_submeters, monitor_only
idstring · obrigatório
tenant_idstring · obrigatório
account_idstring · opcional
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.
serial_numberstring · obrigatório
unitstring · obrigatório
precisioninteger · obrigatório
manufacturerstring · opcional
modelstring · opcional
meter_typestring · opcional
um de mechanical, ultrasonic, electromagnetic, smart, prepaid
diameter_mminteger · opcional
unit_of_measurestring · opcional
dial_digitsinteger · opcional
dial_decimalsinteger · opcional
pulse_multiplierstring · opcional
maximum_readingstring · opcional
device_statusstring · obrigatório
um de in_warehouse, installed, in_testing, scrapped
rollover_valuestring · opcional
Optional meter modulus used to calculate a reviewed rollover consumption.