Green Button specifies a full XML schema for representing a utility cusotmer's account, bill, and usage data. The schema is composed of specific object types that represent certain parts of a customer's data. These objects can be combined into an Atom Feed or downloaded individually.
At UtilityAPI, you can download Green Button XML formatted versions for any authorization on your dashboard or via our Green Button API.
Here are the official Green Button XML Schemas:
For the Green Button XML exports on your dashboard and batch endpoints on our
Green Button API, we merge all
of the relevant Green Button objects into an
Atom Feed
.
This lets you read through
all of the data objects as a list of entries. Each of these <entry>
items can have links (<link>
tags) that you can use to connect
objects to each other.
Here's an example of what a typical feed of greenbutton xml objects looks like:
<?xml version="1.0" encoding="UTF-8"?> <feed xmlns="http://www.w3.org/2005/Atom"> <id>3afa16f7-15e5-459f-b70d-429e3b62466f</id> <link rel="self" href="https://utilityapi.com/DataCustodian/espi/1_1/resource/Batch/Subscription/1a1a1a/UsagePoint/2b2b2b"></link> <title>Batch Feed</title> <updated>2018-01-01T00:00:00+00:00</updated> <entry xmlns="http://www.w3.org/2005/Atom"> <id>2fac0a41-8e44-4ed5-9d0f-78c0e2e4af9a</id> <link rel="self" href="https://utilityapi.com/DataCustodian/espi/1_1/resource/Subscription/1a1a1a/UsagePoint/2b2b2b/MeterReading/3c3c3c/IntervalBlock/01"/> <link rel="up" href="https://utilityapi.com/DataCustodian/espi/1_1/resource/Subscription/1a1a1a/UsagePoint/2b2b2b/MeterReading/3c3c3c/IntervalBlock"/> <published>2018-01-01T00:00:00+00:00</published> <updated>2018-01-01T00:00:00+00:00</updated> <title/> <content> <IntervalBlock xmlns="http://naesb.org/espi" xmlns:espi="http://naesb.org/espi"> ... </IntervalBlock> </content> </entry> <entry xmlns="http://www.w3.org/2005/Atom"> <id>611104fd-b3ef-4f99-be65-6dee50b94fa8</id> <link rel="self" href="https://utilityapi.com/DataCustodian/espi/1_1/resource/Subscription/1a1a1a/UsagePoint/2b2b2b/MeterReading/4d4d4d/IntervalBlock/01"/> <link rel="up" href="https://utilityapi.com/DataCustodian/espi/1_1/resource/Subscription/1a1a1a/UsagePoint/2b2b2b/MeterReading/4d4d4d/IntervalBlock"/> <published>2018-01-01T00:00:00+00:00</published> <updated>2018-01-01T00:00:00+00:00</updated> <title/> <content> <IntervalBlock xmlns="http://naesb.org/espi" xmlns:espi="http://naesb.org/espi"> ... </IntervalBlock> </content> </entry> ... </feed>
In <entry>
items, you will see some <link>
tags
that contain urls to other endpoints on the API.
<link rel="self"...
- Permalink for the entry.
<link rel="up"...
- Parent for the entry.
<link rel="related"...
- These are resources related to the entry (see below for where you will see these).
You will see related links to other resources for the following entries:
Below are the various objects you may see in our greenbutton xml feeds.
<ApplicationInformation>
dataCustodianApplicationStatus
- integer -
Status of the third party at the utility.
see possible values
1
- Under Review2
- In Production3
- On Hold4
- RevokeddataCustodianResourceEndpoint
- url -
The base url for the REST API.
redirect_uri
- url -
Third party OAuth redirect url (see OAuth Step 3).
thirdPartyNotifyUri
- url -
Third party notification endpoint (e.g. where to POST new data notifications).
client_id
- string -
Client identifier used for API authentication.
client_secret
- string -
Client secret used for API authentication.
registration_access_token
- string -
Access token for requesting GET /ApplicationInformation/{app_uid}.
thirdPartyApplicationDescription
* - string -
Third party submitted description.
thirdPartyApplicationStatus
* - integer -
Third party app status.
see possible values
1
- Development2
- ReviewTest3
- Production4
- RetiredthirdPartyApplicationType
* - integer -
The type of third party app.
see possible values
1
- Web2
- Desktop3
- Mobile4
- DevicethirdPartyApplicationUse
* - integer -
How the third party app is used.
see possible values
1
- EnergyManagement2
- Comparisons3
- Government4
- Academic5
- LawEnforcementthirdPartyPhone
* - string -
Third party phone number.
dataCustodianBulkRequestURI
- url -
API endpoint for GET /Bulk/{bulk_uid}.
thirdPartyScopeSelectionScreenURI
- url -
Where to redirect customer when they select a third party on utility website.
thirdPartyUserPortalScreenURI
* - url -
Link to third party data sharing portal.
logo_uri
* - url -
Third party logo url.
client_name
- string -
Third party name.
client_uri
* - url -
Third party generic url.
tos_uri
* - url -
Third party terms of service url.
policy_uri
* - url -
Third party privacy policy url.
software_id
- string -
Third party app software name.
software_version
- string -
Third party app software version number.
client_id_issued_at
- timestamp -
When client_id was issued.
client_secret_expires_at
- timestamp -
When client_secret will expire.
contacts
*† - string -
Third party contact emails.
token_endpoint_auth_method
- string -
How to authenicate on /token endpoint (will be "client_secret_basic").
scope
† - string -
The default scope string for authorizations.
grant_types
† - string -
Allowed OAuth 2.0 grant types.
see possible values
client_credentials
authorization_code
refresh_token
response_types
- string -
Allowed OAuth 2.0 response types.
see possible values
code
registration_client_uri
- url -
Where customers can register for third party.
dataCustodianId
- string -
Name of the utility.
dataCustodianScopeSelectionScreenURI
- url -
Where utility customers can manage and add third party authorizations.
<Authorization>
publishedPeriod
* - duration -
The overall date range of available data.
status
- integer -
The overall status of the authorization.
see possible values
0
- Revoked1
- Active2
- Deniedexpires_at
- timestamp -
When the authorization will expire.
grant_type
* - enum -
OAuth 2.0 grant type for the authorization.
see possible values
client_credentials
authorization_code
refresh_token
scope
- string -
The authorization scope (see Green Button Authorization Scope).
token_type
- enum -
OAuth 2.0 token type to use when authenticating.
see possible values
error
* - enum -
OAuth 2.0 error type, if any.
see possible values
invalid_request
invalid_client
invalid_grant
unauthorized_client
unsupported_grant_type
invalid_redirect_uri
invalid_client_metadata
invalid_client_id
access_denied
unsupported_response_type
server_error
temporarily_unavailable
error_description
* - string -
Description of OAuth 2.0 error, if any.
error_uri
* - url -
Link to more information on OAuth 2.0 error, if any.
resourceURI
- url -
Url for GET /Batch/Subscription/{auth_uid}.
<BatchList>
<ElectricPowerQualitySummary>
summaryInterval
- duration -
The time period this summary covers.
flickerPlt
* - integer -
The long term rapid voltage change.
flickerPst
* - integer -
The likelyhood that voltage fluctuations would result in flicker.
harmonicVoltage
* - integer -
The harmonic voltage for the period.
longInterruptions
* - integer -
How many long interruption events occurred.
mainsVoltage
* - integer -
What the mains voltage was.
measurementProtocol
* - integer -
What what standard measurement protocol was.
powerFrequency
* - integer -
A reading of the power frequency.
rapidVoltageChanges
* - integer -
How many rapid voltage changes occurred.
shortInterruptions
* - integer -
How many short interruption events occurred.
supplyVoltageDips
* - integer -
How many supply voltage dips occurred.
supplyVoltageVariations
* - integer -
How many supply voltage variations occurred.
tempOvervoltage
* - integer -
How many temporary over-voltage events occurred.
<IntervalBlock>
interval
- duration -
The start and duration of this interval reading set.
IntervalReading
† - object -
One of the actual interval readings.
timePeriod
* - duration -
The start and duration of the interval.
value
* - integer -
The reading value of the interval.
cost
* - integer -
How much this interval cost, in hundred-thousandths of the currency.
ReadingQuality
*† - enum -
The quality of the interval.
see possible values
0
- valid7
- manually edited8
- estimated using reference day9
- estimated using linear interpolation10
- questionable11
- derived12
- projected (forecast)13
- mixed14
- raw15
- normalized for weather16
- other17
- validated18
- verified19
- revenue-qualityconsumptionTier
* - integer -
The code for the consumption tier for the interval.
tou
* - integer -
The code for the time-of-use period for the interval.
tou
* - integer -
The critical peak period bucket.
<LocalTimeParameters>
tzOffset
- integer -
How many seconds this timezone is offset from UTC time.
dstStartRule
- dst rule -
When the start of daylight savings time is for this year.
dstEndRule
- dst rule -
When the end of daylight savings time is for this year.
dstOffset
- integer -
How many seconds to offset the time during daylight savings time.
<MeterReading>
<ReadingType>
accumulationBehaviour
* - enum -
How the values in the readings were accumulated.
see possible values
0
- none1
- bulkQuantity2
- continuousCumulative3
- cumulative4
- deltaData6
- indicating9
- summation10
- timeDelay12
- instantaneous13
- latchingQuantity14
- boundedQuantitycommodity
* - enum -
The type of commodity being read.
see possible values
0
- none1
- electricity SecondaryMetered2
- electricity PrimaryMetered3
- communication4
- air5
- insulativeGas6
- insulativeOil7
- naturalGas8
- propane9
- potableWater10
- steam11
- wasteWater12
- heatingFluid13
- coolingFluid14
- nonpotableWater15
- nox16
- so217
- ch418
- co219
- carbon20
- hch21
- pfc22
- sf623
- tvLicence24
- internet25
- refuse26
- electricity TransmissionMeteredconsumptionTier
* - integer -
The default consumption tier for the readings.
currency
* - enum -
The currency of cost values in the readings.
see possible values
840
- USD978
- EUR36
- AUD124
- CAD756
- CHF156
- CNY208
- DKK826
- GBP392
- JPY578
- NOK643
- RUB752
- SEK356
- INR0
- otherdataQualifier
* - enum -
The salient type for the readings.
see possible values
0
- none2
- average4
- excess5
- highThreshold7
- lowThreshold8
- maximum9
- minimum11
- nominal12
- normal16
- secondMaximum17
- secondMinimum23
- thirdMaximum24
- fourthMaximum25
- fifthMaximum26
- sumdefaultQuality
* - enum -
The default quality of the readings.
see possible values
0
- valid7
- manually edited8
- estimated using reference day9
- estimated using linear interpolation10
- questionable11
- derived12
- projected (forecast)13
- mixed14
- raw15
- normalized for weather16
- other17
- validated18
- verified19
- revenue-qualityflowDirection
* - enum -
The direction of flow for values in the readings.
see possible values
0
- none1
- forward2
- lagging3
- leading4
- net5
- q1plusQ27
- q1plusQ38
- q1plusQ49
- q1minusQ410
- q2plusQ311
- q2plusQ412
- q2minusQ313
- q3plusQ414
- q3minusQ215
- quadrant116
- quadrant217
- quadrant318
- quadrant419
- reverse20
- total21
- totalByPhaseintervalLength
* - integer -
The default interval length in seconds.
kind
* - enum -
What the value represents in the readings.
see possible values
0
- none2
- apparentPowerFactor3
- currency4
- current5
- currentAngle6
- currentImbalance7
- date8
- demand9
- distance10
- distortionVoltAmperes11
- energization12
- energy13
- energizationLoadSide14
- fan15
- frequency16
- Funds17
- ieee1366ASAI18
- ieee1366ASIDI19
- ieee1366ASIFI20
- ieee1366CAIDI21
- ieee1366CAIFI22
- ieee1366CEMIn23
- ieee1366CEMSMIn24
- ieee1366CTAIDI25
- ieee1366MAIFI26
- ieee1366MAIFIe27
- ieee1366SAIDI28
- ieee1366SAIFI31
- lineLosses32
- losses33
- negativeSequence34
- phasorPowerFactor35
- phasorReactivePower36
- positiveSequence37
- power38
- powerFactor40
- quantityPower41
- sag42
- swell43
- switchPosition44
- tapPosition45
- tariffRate46
- temperature47
- totalHarmonicDistortion48
- transformerLosses49
- unipedeVoltageDip10to1550
- unipedeVoltageDip15to3051
- unipedeVoltageDip30to6052
- unipedeVoltageDip60to9053
- unipedeVoltageDip90to10054
- voltage55
- voltageAngle56
- voltageExcursion57
- voltageImbalance58
- volume59
- zeroFlowDuration60
- zeroSequence64
- distortionPowerFactor81
- frequencyExcursion90
- applicationContext91
- apTitle92
- assetNumber93
- bandwidth94
- batteryVoltage95
- broadcastAddress96
- deviceAddressType197
- deviceAddressType298
- deviceAddressType399
- deviceAddressType4100
- deviceClass101
- electronicSerialNumber102
- endDeviceID103
- groupAddressType1104
- groupAddressType2105
- groupAddressType3106
- groupAddressType4107
- ipAddress108
- macAddress109
- mfgAssignedConfigurationID110
- mfgAssignedPhysicalSerialNumber111
- mfgAssignedProductNumber112
- mfgAssignedUniqueCommunicationAddress113
- multiCastAddress114
- oneWayAddress115
- signalStrength116
- twoWayAddress117
- signaltoNoiseRatio118
- alarm119
- batteryCarryover120
- dataOverflowAlarm121
- demandLimit122
- demandReset123
- diagnostic124
- emergencyLimit125
- encoderTamper126
- ieee1366MomentaryInterruption127
- ieee1366MomentaryInterruptionEvent128
- ieee1366SustainedInterruption129
- interruptionBehaviour130
- inversionTamper131
- loadInterrupt132
- loadShed133
- maintenance134
- physicalTamper135
- powerLossTamper136
- powerOutage137
- powerQuality138
- powerRestoration139
- programmed140
- pushbutton141
- relayActivation142
- relayCycle143
- removalTamper144
- reprogrammingTamper145
- reverseRotationTamper146
- switchArmed147
- switchDisabled148
- tamper149
- watchdogTimeout150
- billLastPeriod151
- billToDate152
- billCarryover153
- connectionFee154
- audibleVolume155
- volumetricFlowPhaseCodeKind
* - enum -
The kind of phase code associated with the readings.
see possible values
225
- ABCN224
- ABC193
- ABN41
- ACN97
- BCN132
- AB96
- AC66
- BC129
- AN65
- BN33
- CN128
- A64
- B32
- C16
- N272
- S2N784
- S12N528
- S1N256
- S2768
- S12769
- S12N0
- none136
- AtoAv72
- BAv40
- CAv17
- NG512
- S1powerOfTenMultiplier
* - enum -
The power to multiply the value by to get the unit of measure.
see possible values
-12
- Pico-9
- Nano-6
- Micro-3
- Milli-2
- Centi-1
- Deci0
- None1
- Deca2
- Hecto3
- Kilo6
- Mega9
- Giga12
- TeratimeAttribute
* - enum -
The classification of the time period of the readings.
see possible values
0
- none8
- billingPeriod11
- daily13
- monthly22
- seasonal24
- weekly32
- specifiedPeriodtou
* - integer -
The code for the default time-of-use period for the readings.
uom
* - enum -
The unit of measure for the readings.
see possible values
61
- VA38
- W63
- VAr71
- VAh72
- Wh73
- VArh29
- V30
- ohm5
- A25
- F28
- H23
- degC27
- sec159
- min160
- h9
- deg10
- rad31
- J32
- n53
- siemens0
- none33
- Hz3
- g39
- pa0
- none2
- m41
- m242
- m369
- A2105
- A2h70
- A2s106
- Ah152
- APerA103
- APerM68
- As79
- b113
- bm22
- bq132
- btu133
- btuPerH8
- cd76
- char75
- HzPerSec114
- code65
- cosTheta111
- count119
- ft3120
- ft3compensated123
- ft3compensatedPerH78
- gM2144
- gPerG21
- gy150
- HzPerHz77
- charPerSec130
- imperialGal131
- imperialGalPerH51
- jPerK165
- jPerKg6
- K158
- kat47
- kgM48
- kgPerM3134
- litre157
- litreCompensated138
- litreCompensatedPerH137
- litrePerH143
- litrePerLitre82
- litrePerSec156
- litreUncompensated139
- litreUncompensatedPerH35
- lm34
- lx49
- m2PerSec167
- m3compensated126
- m3compensatedPerH125
- m3PerH45
- m3PerSec166
- m3uncompensated127
- m3uncompensatedPerH118
- meCode7
- mol147
- molPerKg145
- molPerM3146
- molPerMol80
- money148
- mPerM46
- mPerM343
- mPerSec44
- mPerSec2102
- ohmM155
- paA140
- paG141
- psiA142
- psiG100
- q161
- q45163
- q45h162
- q60164
- q60h101
- qh54
- radPerSec154
- rev4
- revPerSec149
- secPerSec11
- sr109
- status24
- sv37
- t169
- therm108
- timeStamp128
- usGal129
- usGalPerH67
- V2104
- V2h117
- VAhPerRev116
- VArhPerRev74
- VPerHz151
- VPerV66
- Vs36
- wb107
- WhPerM3115
- WhPerRev50
- wPerMK81
- WPerSec153
- WPerVA168
- WPerWtou
* - integer -
The default critical peak period bucket for the readings.
interharmonic
* - fraction -
A basis of harmonic or interharmonic indication for the readings.
measuringPeriod
* - enum -
A time attribute inherent to the values in the readings.
see possible values
0
- none1
- tenMinute2
- fifteenMinute3
- oneMinute4
- twentyfourHour5
- thirtyMinute6
- fiveMinute7
- sixtyMinute10
- twoMinute14
- threeMinute15
- present16
- previous31
- twentyMinute50
- fixedBlock60Min51
- fixedBlock30Min52
- fixedBlock20Min53
- fixedBlock15Min54
- fixedBlock10Min55
- fixedBlock5Min56
- fixedBlock1Min57
- rollingBlock60MinIntvl30MinSubIntvl58
- rollingBlock60MinIntvl20MinSubIntvl59
- rollingBlock60MinIntvl15MinSubIntvl60
- rollingBlock60MinIntvl12MinSubIntvl61
- rollingBlock60MinIntvl10MinSubIntvl62
- rollingBlock60MinIntvl6MinSubIntvl63
- rollingBlock60MinIntvl5MinSubIntvl64
- rollingBlock60MinIntvl4MinSubIntvl65
- rollingBlock30MinIntvl15MinSubIntvl66
- rollingBlock30MinIntvl10MinSubIntvl67
- rollingBlock30MinIntvl6MinSubIntvl68
- rollingBlock30MinIntvl5MinSubIntvl69
- rollingBlock30MinIntvl3MinSubIntvl70
- rollingBlock30MinIntvl2MinSubIntvl71
- rollingBlock15MinIntvl5MinSubIntvl72
- rollingBlock15MinIntvl3MinSubIntvl73
- rollingBlock15MinIntvl1MinSubIntvl74
- rollingBlock10MinIntvl5MinSubIntvl75
- rollingBlock10MinIntvl2MinSubIntvl76
- rollingBlock10MinIntvl1MinSubIntvl77
- rollingBlock5MinIntvl1MinSubIntvlargument
* - fraction -
An argument used to convert the value to the unit of measure.
<ServiceStatus>
currentStatus
- enum -
The current status of the API.
see possible values
0
- Unavailable1
- Normal<UsagePoint>
roleFlags
* - hex -
Bits noting the roles assigned to this usage point.
ServiceCategory
* - object -
The type of service that this usage point is used for.
kind
- enum -
The type of service.
see possible values
0
- electricity1
- gas2
- water3
- time4
- heat5
- refuse6
- sewerage7
- rates8
- tvLicence9
- internetstatus
* - integer -
The current status of the usage point (0 = off, 1 = on).
ServiceDeliveryPoint
* - object -
Details about the service that this usage point is used for.
name
* - string -
The name of the service.
tariffProfile
* - string -
The tariff rate schedule for the service.
customerAgreement
* - string -
The service agreement id or contract.
tariffRiderRefs
* - object -
A list of tariff riders that are applied to this service.
tariffRiderRef
*† - object -
A specific tariff rider.
riderType
- string -
The name or type of tariff rider.
enrollmentStatus
- enum -
The current status of the rider.
see possible values
unenrolled
enrolled
enrolledPending
effectiveDate
- timestamp -
When the rider became effective.
amiBillingReady
* - enum -
The readiness status for billing.
see possible values
amiCapable
amiDisabled
billingApproved
enabled
nonAmi
nonMetered
operable
checkBilling
* - boolean -
Whether there may currently be a problem with billing.
connectionState
* - enum -
The status of connection to the network.
see possible values
connected
logicallyDisconnected
physicallyDisconnected
estimatedLoad
* - measurement -
The load estimate for this usage point.
grounded
* - boolean -
Whether this usage point is grounded.
isSdp
* - boolean -
Whether a service delivery point where the service changes hands.
isVirtual
* - boolean -
Whether this represents a virtual, not physical, usage point.
minimalUsageExpected
* - boolean -
Whether minimal usage is expected from this usage point.
nominalServiceVoltage
* - measurement -
The nominal service voltage for this usage point.
outageRegion
* - string -
The outage region(s) that this usage point is in.
phaseCode
* - enum -
The kind of phase code associated with this usage point.
see possible values
225
- ABCN224
- ABC193
- ABN41
- ACN97
- BCN132
- AB96
- AC66
- BC129
- AN65
- BN33
- CN128
- A64
- B32
- C16
- N272
- S2N784
- S12N528
- S1N256
- S2768
- S12769
- S12N0
- none136
- AtoAv72
- BAv40
- CAv17
- NG512
- S1ratedCurrent
* - measurement -
The current flow that this usage point is configured to deliver.
ratedPower
* - measurement -
The power that this usage point is configured to deliver.
readCycle
* - string -
The schedule on which the usage point is read.
readRoute
* - string -
Route ID used for reading the usage point.
serviceDeliveryRemark
* - string -
Notes about the service delivery.
servicePriority
* - string -
The level of priority for this service.
pnodeRefs
* - object -
What pnodes this usage point is assigned to.
pnodeRef
† - object -
A specific pnode.
apnodeType
- enum -
The type of pnode.
see possible values
AG
- Aggregated GenerationCPZ
- Custom Price ZoneDPZ
- Default Price ZoneLAP
- Load Aggregation PointTH
- Trading HubSYS
- System ZoneCA
- Control AreaDCA
- Designated Congestion AreaGA
- generic aggregationGH
- generic hubEHV
- 500 kV - Extra High Voltage aggregate price nodesZN
- ZoneINT
- InterfaceBUS
- Busref
- string -
The reference name of the pnode.
startEffectiveDate
* - timestamp -
When the pnode assignment became effective.
endEffectiveDate
* - timestamp -
When the pnode assignment ended.
aggregateNodeRefs
* - object -
What aggregation nodes this usage point is assigned to.
aggregateNodeRef
† - object -
A specific aggregation node.
anodeType
- enum -
The type of aggregation node.
see possible values
SYS
- System Zone/RegionRUC
- RUC ZoneLFZ
- Load Forecast ZoneREG
- Market Energy/Ancillary Service RegionAGR
- Aggregate Generation ResourcePOD
- Point of DeliveryALR
- Aggregate Load ResourceLTAC
- Load TransmissionAccessCharge (TAC) GroupACA
- Adjacent Control AreaASR
- Aggregated System ResourceECA
- Embedded Control Arearef
- string -
The reference name of the aggregation node.
startEffectiveDate
* - timestamp -
When the aggregation node assignment became effective.
endEffectiveDate
* - timestamp -
When the aggregation node assignment ended.
<UsageSummary>
billingPeriod
- duration -
The start and duration of the summary period (e.g. the bill start/end).
statusTimeStamp
- timestamp -
The issue time for the summary (e.g. the bill statement date).
billLastPeriod
* - integer -
The cost for the last bill, in hundred-thousandths of currency.
billToDate
* - integer -
The bill cost to date (if not over yet), in hundred-thousandths of currency.
costAdditionalLastPeriod
* - integer -
The total bill cost, in hundred-thousandths of currency.
costAdditionalDetailLastPeriod
*† - object -
A bill line item.
itemKind
- enum -
The type of line item.
see possible values
1
- Energy Generation Fee2
- Energy Delivery Fee3
- Energy Usage Fee4
- Administrative Fee5
- Tax6
- Energy Generation Credit7
- Energy Delivery Credit8
- Administrative Credit9
- Payment10
- Informationnote
- string -
Line item name and/or description.
amount
* - integer -
Line item cost, in hundred-thousandths of currency.
rounding
* - integer -
How much the line item was rounded.
dateTime
* - timestamp -
The date for the line item.
measurement
* - measurement -
The measured line item reading value and units.
unitCost
* - measurement -
The line item rate, in hundred-thousandths of currency.
itemPeriod
* - measurement -
The start and duration of the line item.
currency
* - enum -
The currency of cost values in the summary.
see possible values
840
- USD978
- EUR36
- AUD124
- CAD756
- CHF156
- CNY208
- DKK826
- GBP392
- JPY578
- NOK643
- RUB752
- SEK356
- INR0
- otheroverallConsumptionLastPeriod
* - measurement -
The total usage during the summary period.
currentBillingPeriodOverAllConsumption
* - measurement -
Total usage to date.
currentDayLastYearNetConsumption
* - measurement -
Usage a year ago today.
currentDayNetConsumption
* - measurement -
Today's net consumption.
currentDayOverallConsumption
* - measurement -
Today's overall consumption.
peakDemand
* - measurement -
Today's peak demand.
previousDayLastYearOverallConsumption
* - measurement -
Usage a year ago yesterday.
previousDayNetConsumption
* - measurement -
Yesterday's net consumption.
previousDayOverallConsumption
* - measurement -
Yesterday's overall consumption.
qualityOfReading
* - enum -
The quality of the summary readings.
see possible values
0
- valid7
- manually edited8
- estimated using reference day9
- estimated using linear interpolation10
- questionable11
- derived12
- projected (forecast)13
- mixed14
- raw15
- normalized for weather16
- other17
- validated18
- verified19
- revenue-qualityratchetDemand
* - measurement -
The ratchet demand over the ratchet demand period.
ratchetDemandPeriod
* - duration -
The start and duration of the ratchet demand period.
commodity
* - enum -
The type of commodity being summarized.
see possible values
0
- none1
- electricity SecondaryMetered2
- electricity PrimaryMetered3
- communication4
- air5
- insulativeGas6
- insulativeOil7
- naturalGas8
- propane9
- potableWater10
- steam11
- wasteWater12
- heatingFluid13
- coolingFluid14
- nonpotableWater15
- nox16
- so217
- ch418
- co219
- carbon20
- hch21
- pfc22
- sf623
- tvLicence24
- internet25
- refuse26
- electricity TransmissionMeteredtariffProfile
* - string -
The tariff rate schedule for the summary.
readCycle
* - string -
The schedule on which this summary was generated.
tariffRiderRefs
* - object -
A list of tariff riders that are applied to this summary.
tariffRiderRef
*† - object -
A specific tariff rider.
riderType
- string -
The name or type of tariff rider.
enrollmentStatus
- enum -
The status of the rider.
see possible values
unenrolled
enrolled
enrolledPending
effectiveDate
- timestamp -
When the rider became effective.
billingChargeSource
* - object -
The source of the billing charge.
agencyName
* - string -
The name of the billing source.
<SummaryMeasurement>
powerOfTenMultiplier
* - enum -
The power to multiply the value by to get the unit of measure.
see possible values
-12
- Pico-9
- Nano-6
- Micro-3
- Milli-2
- Centi-1
- Deci0
- None1
- Deca2
- Hecto3
- Kilo6
- Mega9
- Giga12
- TeratimeStamp
* - timestamp -
The time of the measurement.
uom
* - enum -
The unit of measure.
see possible values
61
- VA38
- W63
- VAr71
- VAh72
- Wh73
- VArh29
- V30
- ohm5
- A25
- F28
- H23
- degC27
- sec159
- min160
- h9
- deg10
- rad31
- J32
- n53
- siemens0
- none33
- Hz3
- g39
- pa0
- none2
- m41
- m242
- m369
- A2105
- A2h70
- A2s106
- Ah152
- APerA103
- APerM68
- As79
- b113
- bm22
- bq132
- btu133
- btuPerH8
- cd76
- char75
- HzPerSec114
- code65
- cosTheta111
- count119
- ft3120
- ft3compensated123
- ft3compensatedPerH78
- gM2144
- gPerG21
- gy150
- HzPerHz77
- charPerSec130
- imperialGal131
- imperialGalPerH51
- jPerK165
- jPerKg6
- K158
- kat47
- kgM48
- kgPerM3134
- litre157
- litreCompensated138
- litreCompensatedPerH137
- litrePerH143
- litrePerLitre82
- litrePerSec156
- litreUncompensated139
- litreUncompensatedPerH35
- lm34
- lx49
- m2PerSec167
- m3compensated126
- m3compensatedPerH125
- m3PerH45
- m3PerSec166
- m3uncompensated127
- m3uncompensatedPerH118
- meCode7
- mol147
- molPerKg145
- molPerM3146
- molPerMol80
- money148
- mPerM46
- mPerM343
- mPerSec44
- mPerSec2102
- ohmM155
- paA140
- paG141
- psiA142
- psiG100
- q161
- q45163
- q45h162
- q60164
- q60h101
- qh54
- radPerSec154
- rev4
- revPerSec149
- secPerSec11
- sr109
- status24
- sv37
- t169
- therm108
- timeStamp128
- usGal129
- usGalPerH67
- V2104
- V2h117
- VAhPerRev116
- VArhPerRev74
- VPerHz151
- VPerV66
- Vs36
- wb107
- WhPerM3115
- WhPerRev50
- wPerMK81
- WPerSec153
- WPerVA168
- WPerWvalue
* - integer -
The measurement value.
readingTypeRef
* - url -
A reference link for the type of reading.