PUT /api/v202510/meter/{meterId}/convertToEsaCalculatedMeter

Converts an existing meter to an ESA Calculated Meter by creating a formula-based primary value channel

ConvertToEsaCalculatedMeterV202510 Permissions: Meters (Edit)
Use this endpoint to turn a regular meter into an ESA Calculated Meter. The meter must have NO existing EsaChannels. A Primary Value ESAChannel is created from the provided formula. The formula may only reference other ESA Meters (their Primary Value Channels are used in calculation).

Request Headers

Header Value Required Description
ECI-ApiKey string Yes Your API key. See Authentication.
Content-Type application/json Yes All requests must specify JSON content type, including the request body.

Path Parameters

Name Description Type Required
meterId Unique numeric identifier of the meter to convert (must have no existing ESA channels) integer (int32) Required

Request Body

EsaChannelCreate
Property Description Type
channelDescription The channel description Max length of 255 string
channelImportId The channel import identifier Max length of 255 string
channelInfo The name of the ESA channel Max length of 50 Required string
dataPointId The DatapointId identifier Required integer (int32)
esaChannelVersion EsaChannelVersionCreate
EsaChannelVersionCreate properties
Property Description Type
formula The formula that should be used to calculate the channel’s values. Should only be provided when channel’s IsCalculated property equals true. string
isValuePositive Indicates if the final value is always positive boolean
maximumReading The channel Maximum Computed Reading Must be between -999999999999999 and 999999999999999 Max scale of 15, max precision of 30 NULL Valid number (double)
minimumReading The channel Minimum Computed Reading Must be between -999999999999999 and 999999999999999 Max scale of 15, max precision of 30 NULL Valid number (double)
multiplier The channel multiplier Must be between -9999999999999 and 9999999999999 Required Max scale of 15, max precision of 30 number (double)
observationRuleId Indicates the channel observation rule Demand channels cannot have the odometer observation rule Required Must be a valid value for ObservationRuleEnum: Odometer = 1, Trip = 2 integer (int32)
offset The channel offset Exclusive to the Trip observation rule Must be between -9999999999999 and 9999999999999 Max scale of 15, max precision of 30 number (double)
rollbackAllowance The channel Odometer Rollover Allowance. Exclusive to the Odometer observation rule If not provided, the default 0.1 is used Must be between 0 and 1 Max scale of 15, max precision of 30 NULL Valid Must be null when ObservationRuleId is set to Trip, case sensitive number (double)
rolloverValue The channel Odometer Rollover Value. Exclusive to the Odometer observation rule If not provided, the default 999999999999999 is used Must be between 0 and 999999999999999 Max scale of 15, max precision of 30 NULL Valid Must be null when ObservationRuleId is set to Trip, case sensitive number (double)
unitId The channel unit identifier. It cannot be a Money unit type. Required integer (int32)
intervalMinutes The channel interval identifier One of ‘5’, ‘10’, ‘15’, ‘30’, ‘60’, ‘1440’, ‘10080’, ‘43200’ Case sensitive Required when IsCalculated is set to False, case sensitive. Must be null when IsCalculated is set to True, case sensitive integer (int32)
isCalculated Indicates whether or not this is a calculated channel with a formula. When IsCalculated is true, the formula will need to be provided in channel version. Conversions from Non-Calculated Channel to Calculated Channel: If the channel has no readings, If the channel has only one version, If the channel is not in other formulas Conversions from Calculated Channel to Non-Calculated Channel: If the channel has no readings boolean
isPrimaryDemand If the channel is demand value boolean
isPrimaryValue If the channel is primary value boolean
observationTypeId The channel type identifier Required integer (int32)
summarizationMethodId The channel summarization method identifier Required integer (int32)
Example Request Body application/json 
{  "channelDescription": "string",  "channelImportId": "string",  "channelInfo": "string",  "dataPointId": 1,  "esaChannelVersion": {    "formula": "string",    "isValuePositive": false,    "maximumReading": 1.0,    "minimumReading": 1.0,    "multiplier": 1.0,    "observationRuleId": 1,    "offset": 1.0,    "rollbackAllowance": 1.0,    "rolloverValue": 1.0,    "unitId": 1
  },  "intervalMinutes": 1,  "isCalculated": false,  "isPrimaryDemand": false,  "isPrimaryValue": false,  "observationTypeId": 1,  "summarizationMethodId": 1
}

Responses

200 OK The request succeeded and the response body contains the requested data.

Response Body Parameters

MeterResponse
Property Description Type
accounts MeterAccountChild[]
MeterAccountChild properties
Property Description Type
accountCode The code of the MeterAccount for this MeterAccount meter string
accountGeneralLedger GeneralLedgerChild
GeneralLedgerChild properties
Property Description Type
generalLedgerCode The general ledger code (e.g., GL account number) string
generalLedgerId The unique identifier of the general ledger entry. Null if no general ledger is assigned. integer (int32)
generalLedgerInfo The general ledger description/name string
accountId The MeterAccount identifier for this MeterAccount meter integer (int32)
accountInfo The info of the MeterAccount for this MeterAccount meter string
accountMeterId The MeterAccount meter identifier integer (int32)
active Indicates whether the Account is active or inactive boolean
dataAccessReleaseId The data access release identifier for this MeterAccount meter relationship, null if there is no release integer (int32)
endDate The ending date and time for this MeterAccount meter relationship string (date-time)
hasCalculatedMeter Indicates whether the Account has a child calculated meter boolean
hasSplitChildMeter Indicates whether the Account has a child split meter boolean
hasSplitParentMeter Indicates whether the Account is a recipient of a split boolean
hasSubAccount Indicates whether the Account has a sub-account boolean
isSubAccount Indicates whether the Account is a sub-account boolean
meterGeneralLedger GeneralLedgerChild
GeneralLedgerChild properties
Property Description Type
generalLedgerCode The general ledger code (e.g., GL account number) string
generalLedgerId The unique identifier of the general ledger entry. Null if no general ledger is assigned. integer (int32)
generalLedgerInfo The general ledger description/name string
startDate The beginning date and time for this MeterAccount meter relationship string (date-time)
vendor VendorChild
VendorChild properties
Property Description Type
vendorCode The vendor code string
vendorId The vendor identifier integer (int32)
vendorInfo The vendor info string
vendorType VendorTypeChild
VendorTypeChild properties
Property Description Type
vendorTypeCode The vendor type code string
vendorTypeId The vendor type identifier integer (int32)
active Indicates whether the Meter is Active boolean
address AddressChild
AddressChild properties
Property Description Type
addressTypeId The address type identifier integer (int32)
city The city of the place Must be between 0 and 100 characters string
country The country of the place Must be between 0 and 64 characters string
latitude The latitude of the place Required when the country is not United States or Canada Must be between -90 and 90 Required when Longitude is set number (double)
line1 The line 1 of the address Must be between 0 and 100 characters string
line2 The line 2 of the address Must be between 0 and 100 characters string
line3 The line 3 of the address Must be between 0 and 100 characters string
longitude The longitude of the place Required when the country is not United States or Canada Must be between -180 and 180 Required when Latitude is set number (double)
postalCode The postal code of the place Must be between 0 and 32 characters string
remitTo Remit To field is the name of the person or company who should receive the payment. It’s required for bill pay customers. Must be between 0 and 100 characters string
state The state of the place Must be between 0 and 100 characters string
billEntryNote The bill entry note string
channels An array of channels assigned to this meter ChannelChild[]
ChannelChild properties
Property Description Type
channelCode The channel code Combines observationTypeCode:unitCode:observationMethodCode:observationRuleCode:interval in minutes string
channelId The channel identifier integer (int32)
interval The channel interval in seconds. Monthly = 2592000 Weekly = 604800 Daily = 86400 Hourly = 3600 Thirty_Minutes = 1800 Fifteen_Minutes = 900 integer (int32)
commodity CommodityChild
CommodityChild properties
Property Description Type
commodityCode The commodity code Required (defined) string
commodityIcon Icon
Icon properties
Property Description Type
code The icon code Must be between 0 and 64 characters Required when Color is set string
color The icon color Must be between 0 and 32 characters Required when Code is set string
commodityId The commodity identifier Required (defined) integer (int32)
commodityInfo The commodity info Required (defined) string
createdBy UserChild
UserChild properties
Property Description Type
fullName The user’s full name string
userCode The user code string
userId The user identifier integer (int32)
createdDate The date and time the meter was created string (date-time)
demandUnit UnitChild
UnitChild properties
Property Description Type
unitCode The unit code string
unitId The unit identifier integer (int32)
unitInfo The unit info string
emissionSource EmissionSourceLink
EmissionSourceLink properties
Property Description Type
emissionSourceId The identifier for an Emission source. integer (int32)
includeInCostAvoidance Indicates if the meter should be included in cost avoidance boolean
includeInEnergyStar Indicates if the building is included in ENERGY STAR submissions boolean
isCalculatedMeter Indicates whether the Meter is a calculated meter boolean
isEsaCalculatedMeter Indicates whether the Meter is an ESA calculated meter boolean
isSplitChildMeter Indicates whether the Meter is a child of a split boolean
isSplitParentMeter Indicates whether the Meter is a parent of a split boolean
meterCode The meter code string
meterDescription A description of the meter string
meterId The identifier for the meter integer (int32)
meterInfo The meter info string
meterTimeZone TimeZoneChild
TimeZoneChild properties
Property Description Type
timeZoneCode string
timeZoneId integer (int32)
timeZoneInfo string
meterType MeterTypeChild
MeterTypeChild properties
Property Description Type
meterTypeCode Short code for the meter type (e.g., “ELEC”, “GAS”) string
meterTypeId Unique numeric identifier of the meter type integer (int32)
meterTypeInfo Descriptive name of the meter type string
modifiedBy UserChild
UserChild properties
Property Description Type
fullName The user’s full name string
userCode The user code string
userId The user identifier integer (int32)
modifiedDate The date and time of the most recent modification of the meter string (date-time)
place PlaceChild
PlaceChild properties
Property Description Type
isDataRolledUp Tells whether or not the place’s data is rolled up to its parents. boolean
placeCode The place code string
placeId The place identifier integer (int32)
placeInfo The place info string
placeType PlaceTypeResponse
PlaceTypeResponse properties
Property Description Type
icon Icon
Icon properties
Property Description Type
code The icon code Must be between 0 and 64 characters Required when Color is set string
color The icon color Must be between 0 and 32 characters Required when Code is set string
isSystemPlaceType Flag to indicate if the place type is a system-level place type boolean
placeEntityType PlaceEntityTypeV202406
PlaceEntityTypeV202406 properties
Property Description Type
placeEntityTypeId The place entity type identifier integer (int32)
placeEntityTypeInfo The place entity type name string
placeTypeCode The place type code string
placeTypeId The place type identifier integer (int32)
placeTypeInfo The place type info string
structure Indicates if the place is a structure boolean
primaryUse PrimaryUseChild
PrimaryUseChild properties
Property Description Type
primaryUseCode string
primaryUseId integer (int32)
primaryUseInfo string
properties An array of meter properties object
route RouteChild
RouteChild properties
Property Description Type
routeCode The route code string
routeId The route identifier integer (int32)
routeInfo The route info string
sentinelStatus Provides some insight into the current Sentinel enabled status. string
serialNumber Meter’s currently assigned serial number string
serialNumberHistory MeterSerialNumberHistoryChild
MeterSerialNumberHistoryChild properties
Property Description Type
previousSerialNumber Previous serial number of the meter string
serialNumberChangeDate Date that serial number changed string (date-time)
useUnit UnitChild
UnitChild properties
Property Description Type
unitCode The unit code string
unitId The unit identifier integer (int32)
unitInfo The unit info string
watticsDataPoint WatticsDataPoint
WatticsDataPoint properties
Property Description Type
watticsDataPointId The identifier for a SmartAnalytics (Wattics) meter integer (int32)
Example Response application/json 
{  "accounts": [
    {    "accountCode": "string",    "accountGeneralLedger": {      "generalLedgerCode": "string",      "generalLedgerId": 1,      "generalLedgerInfo": "string"
    },    "accountId": 1,    "accountInfo": "string",    "accountMeterId": 1,    "active": false,    "dataAccessReleaseId": 1,    "endDate": "2026-06-29",    "hasCalculatedMeter": false,    "hasSplitChildMeter": false,    "hasSplitParentMeter": false,    "hasSubAccount": false,    "isSubAccount": false,    "meterGeneralLedger": {      "generalLedgerCode": "string",      "generalLedgerId": 1,      "generalLedgerInfo": "string"
    },    "startDate": "2026-06-29",    "vendor": {      "vendorCode": "string",      "vendorId": 1,      "vendorInfo": "string"
    },    "vendorType": {      "vendorTypeCode": "string",      "vendorTypeId": 1
    }
  }
  ],  "active": false,  "address": {    "addressTypeId": 1,    "city": "string",    "country": "string",    "latitude": 1.0,    "line1": "string",    "line2": "string",    "line3": "string",    "longitude": 1.0,    "postalCode": "string",    "remitTo": "string",    "state": "string"
  },  "billEntryNote": "string",  "channels": [
    {    "channelCode": "string",    "channelId": 1,    "interval": 1
  }
  ],  "commodity": {    "commodityCode": "string",    "commodityIcon": {      "code": "string",      "color": "string"
    },    "commodityId": 1,    "commodityInfo": "string"
  },  "createdBy": {    "fullName": "string",    "userCode": "string",    "userId": 1
  },  "createdDate": "2026-06-29",  "demandUnit": {    "unitCode": "string",    "unitId": 1,    "unitInfo": "string"
  },  "emissionSource": {    "emissionSourceId": 1
  },  "includeInCostAvoidance": false,  "includeInEnergyStar": false,  "isCalculatedMeter": false,  "isEsaCalculatedMeter": false,  "isSplitChildMeter": false,  "isSplitParentMeter": false,  "meterCode": "string",  "meterDescription": "string",  "meterId": 1,  "meterInfo": "string",  "meterTimeZone": {    "timeZoneCode": "string",    "timeZoneId": 1,    "timeZoneInfo": "string"
  },  "meterType": {    "meterTypeCode": "string",    "meterTypeId": 1,    "meterTypeInfo": "string"
  },  "modifiedBy": {    "fullName": "string",    "userCode": "string",    "userId": 1
  },  "modifiedDate": "2026-06-29",  "place": {    "isDataRolledUp": false,    "placeCode": "string",    "placeId": 1,    "placeInfo": "string",    "placeType": {      "icon": {},      "isSystemPlaceType": false,      "placeEntityType": {},      "placeTypeCode": "string",      "placeTypeId": 1,      "placeTypeInfo": "string",      "structure": false
    }
  },  "primaryUse": {    "primaryUseCode": "string",    "primaryUseId": 1,    "primaryUseInfo": "string"
  },  "properties": {},  "route": {    "routeCode": "string",    "routeId": 1,    "routeInfo": "string"
  },  "sentinelStatus": "string",  "serialNumber": "string",  "serialNumberHistory": {    "previousSerialNumber": "string",    "serialNumberChangeDate": "2026-06-29"
  },  "useUnit": {    "unitCode": "string",    "unitId": 1,    "unitInfo": "string"
  },  "watticsDataPoint": {    "watticsDataPointId": 1
  }
}