UtilityPlatform APIs

Get /api/v202203/utilityPlatform/place/{placeId}/meter

Operation: GetUtilityPlatformMetersByPlaceV202203 Permissions: Meters (View)

Get meters on a particular place


Post /api/v202203/utilityPlatform/place/{placeId}/meter

Operation: CreateUtilityPlatformMetersByPlaceV202203 Permissions: Meters (Create)

Create meters on a particular place


Get /api/v202203/utilityPlatform/meter/{meterId}/dataAccessReleaseState

Operation: GetDataAccessReleaseStateV202203

Get the status of a meter’s data access release


Post /api/v202203/utilityPlatform/meter/{meterId}/sendDataAccessReleaseRequest

Operation: SendDataAccessReleaseRequestEmailV202203 Permissions: Meters (Edit)

Email a data access release request


Post /api/v202203/utilityPlatform/meter/{meterId}/release

Operation: AssignDataAccessReleaseV202203

Apply a release to a meter


Post /api/v202203/utilityPlatform/place/{placeId}/release

Operation: ReleaseAccountAndAllMeterToABuildingV202203

Release all account and meters to a specific place


Get /api/v202203/utilityPlatform/dataAccessRelease/{dataAccessReleaseId}

Operation: GetDataAccessReleaseDetailsV202203 Permissions: Meters (Edit)

Get data access release details


Post /api/v202203/utilityPlatform/meter/search

Operation: SearchUtilityPlatformMetersV202203 Paginated Permissions: Meters (Edit)

Search utility platform meters


Post /api/v202203/utilityPlatform/address/search

Operation: SearchUtilityPlatformServiceAddressesV202203 Paginated Permissions: Meters (Edit)

Search service addresses


Put /api/v202203/utilityPlatform/place/{placeId}/aggregateMeter

Operation: UpsertAggregateMeterV202203 Permissions: Meters (Create)

Create a new aggregate meter, update an existing version, create a new version
If AggregateMeterId is null: a new aggregate meter and version is always created
If AggregateMeterId is not null: it must exist and only associated with 1 account otherwise error
If AggregateMeterId exists: we will always update the Aggregate’s MeterInfo and AccountInfo
If AggregateMeterId exists and no version exists on the same account and meter with the specified billing period: a new version is created
If AggregateMeterId exists and a version exists on the same account and meter with the specified billing period: the version is updated


Post /api/v202203/utilityPlatform/aggregations/exec

Operation: ExecuteProcessorAggregationsV202203 Permissions: Chargebacks (Run)

Process one or more Calculated Bill aggregations within a billing period range ending with the specified billing period.
If billing period is not supplied, the current period will be assumed.