Tenancies

Get Meter Readings by Tenancy Id

get/tenancies/{tenancyId}/meter-readings

Request

  • Base URL: https://api.alto.zoopladev.co.uk
  • URL: https://api.alto.zoopladev.co.uk/tenancies/{tenancyId}/meter-readings
  • Auth: appAuth (a scheme the document does not define)

Path parameters

tenancyIdinteger required

Headers

AgencyRefstring required

A GUID required in the header of all API requests that grants access to an agent's data

Response

OK

idstring nullable

The unique identifier for a specific utility reading within a tenancy.

utilityType'Unspecified' | 'Gas' | 'Electricity' | 'Oil' | 'Water' | 'BulkLPG' | 'Council' | 'Sewerage'

The type of utility (e.g., electricity, water, gas) for which the reading is recorded. This is represented by the UtilityType enum. Use the name of type of the utility as the 'id' when you need to update a meter reading

inHighValueinteger nullable

The initial (move-in) high-value meter reading. This may capture peak usage rates or other high-end metrics. It's nullable to handle cases where this data might not be available or applicable.

inLowValueinteger nullable

The initial (move-in) low-value meter reading. This typically represents off-peak or lower usage rates. Nullable to account for situations where this reading is not applicable or available.

outHighValueinteger nullable

The final (move-out) high-value meter reading. Similar to InHighValue but recorded at the end of the tenancy. Nullable for cases where the reading isn't available or needed.

outLowValueinteger nullable

The final (move-out) low-value meter reading. Similar to InLowValue, but for the end of the tenancy period. Nullable for cases where this data is not available or relevant.

inValueinteger nullable

The overall move-in meter reading. This is a general reading, not specifically high or low value. Nullable to accommodate situations where it might not be available.

outValueinteger nullable

The overall move-out meter reading. Like InValue, but for when the tenancy ends. Nullable to handle cases where the reading is not obtained.

Changes

No recorded changes to this operation across all 1 revision of this API.