Get Service Point Detail V2
This page documents version 2 of the Get Service Point Detail endpoint.
Data Holders can retire this version after June 14th 2027. Data Recipients must update to newer versions prior to this date.
Get Service Point Detail
Code samples
GET https://mtls.dh.example.com/cds-au/v1/energy/electricity/servicepoints/{servicePointId} HTTP/1.1
Host: mtls.dh.example.com
Accept: application/json
x-v: string
x-min-v: string
x-fapi-interaction-id: string
x-fapi-auth-date: string
x-fapi-customer-ip-address: string
x-cds-client-headers: string
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'x-v':'string',
'x-min-v':'string',
'x-fapi-interaction-id':'string',
'x-fapi-auth-date':'string',
'x-fapi-customer-ip-address':'string',
'x-cds-client-headers':'string'
};
fetch('https://mtls.dh.example.com/cds-au/v1/energy/electricity/servicepoints/{servicePointId}', {
method: 'GET',
headers: headers
}).then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET /energy/electricity/servicepoints/{servicePointId}
Obtain detailed standing information for a specific service point that is owned by the customer that has authorised the current session.
Other Versions: v1.
Endpoint Version
Parameters
| Name |
In |
Type |
Required |
Default |
Description |
| servicePointId |
path |
EnergyServicePointId |
mandatory |
|
The servicePointId to obtain data for. servicePointId values are returned by service point list endpoints. Note that it is not a nationalMeteringId. |
| x-v |
header |
string |
mandatory |
|
Version of the API endpoint requested by the client. Must be set to a positive integer. The endpoint should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the endpoint MUST respond with a 406 Not Acceptable. See HTTP Headers. |
| x-min-v |
header |
string |
optional |
|
Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The endpoint should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the endpoint MUST respond with a 406 Not Acceptable. |
| x-fapi-interaction-id |
header |
string |
optional |
|
An [RFC4122] UUID used as a correlation id. If provided, the data holder MUST play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| x-fapi-auth-date |
header |
string |
conditional |
|
The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls. |
| x-fapi-customer-ip-address |
header |
string |
optional |
|
The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls. |
| x-cds-client-headers |
header |
Base64 |
conditional |
|
The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the data recipient. Mandatory for customer present calls. Not required for unattended or unauthenticated calls. |
Example responses
200 Response
{
"data": {
"servicePointId": "string",
"nationalMeteringId": "string",
"servicePointClassification": "EXTERNAL_PROFILE",
"servicePointStatus": "ACTIVE",
"jurisdictionCode": "ALL",
"isGenerator": false,
"validFromDate": "string",
"lastUpdateDateTime": "string",
"lastConsumerChangeDate": "string",
"consumerProfile": {
"classification": "BUSINESS",
"threshold": "LOW"
},
"distributionLossFactor": {
"code": "string",
"description": "string",
"lossValue": "string"
},
"relatedParticipants": [
{
"party": "string",
"role": "FRMP"
}
],
"location": {
"addressUType": "paf",
"simple": {
"mailingName": "string",
"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"postcode": "string",
"city": "string",
"state": "string",
"country": "AUS"
},
"paf": {
"dpid": "string",
"thoroughfareNumber1": 0,
"thoroughfareNumber1Suffix": "string",
"thoroughfareNumber2": 0,
"thoroughfareNumber2Suffix": "string",
"flatUnitType": "string",
"flatUnitNumber": "string",
"floorLevelType": "string",
"floorLevelNumber": "string",
"lotNumber": "string",
"buildingName1": "string",
"buildingName2": "string",
"streetName": "string",
"streetType": "string",
"streetSuffix": "string",
"postalDeliveryType": "string",
"postalDeliveryNumber": 0,
"postalDeliveryNumberPrefix": "string",
"postalDeliveryNumberSuffix": "string",
"localityName": "string",
"postcode": "string",
"state": "string"
}
},
"meters": [
{
"meterId": "string",
"specifications": {
"status": "CURRENT",
"installationType": "BASIC",
"manufacturer": "string",
"model": "string",
"readType": "string",
"nextScheduledReadDate": "string"
},
"registers": [
{
"registerId": "string",
"registerSuffix": "string",
"averagedDailyLoad": 0,
"registerConsumptionType": "INTERVAL",
"networkTariffCode": "string",
"unitOfMeasure": "string",
"timeOfDay": "ALLDAY",
"multiplier": 0,
"controlledLoad": true,
"consumptionType": "ACTUAL"
}
]
}
]
},
"links": {
"self": "string"
},
"meta": {}
}
Responses
| Status |
Header |
Type |
Required |
Description |
| 200 |
x-v |
string |
mandatory |
The payload version that the endpoint has responded with. |
| 200 |
x-fapi-interaction-id |
string |
mandatory |
An [RFC4122] UUID used as a correlation id. If provided, the data holder MUST play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 400 |
x-fapi-interaction-id |
string |
mandatory |
An [RFC4122] UUID used as a correlation id. If provided, the data holder MUST play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 404 |
x-fapi-interaction-id |
string |
mandatory |
An [RFC4122] UUID used as a correlation id. If provided, the data holder MUST play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 406 |
x-fapi-interaction-id |
string |
mandatory |
An [RFC4122] UUID used as a correlation id. If provided, the data holder MUST play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
Schemas
EnergyPlanListResponse
{
"data": {
"plans": [
{
"planId": "string",
"effectiveFrom": "string",
"effectiveTo": "string",
"lastUpdated": "string",
"displayName": "string",
"description": "string",
"type": "STANDING",
"fuelType": "ELECTRICITY",
"brand": "string",
"brandName": "string",
"applicationUri": "string",
"additionalInformation": {
"overviewUri": "string",
"termsUri": "string",
"eligibilityUri": "string",
"pricingUri": "string",
"bundleUri": "string"
},
"customerType": "RESIDENTIAL",
"geography": {
"excludedPostcodes": [
"string"
],
"includedPostcodes": [
"string"
],
"distributors": [
"string"
]
}
}
]
},
"links": {
"self": "string",
"first": "string",
"prev": "string",
"next": "string",
"last": "string"
},
"meta": {
"totalRecords": 0,
"totalPages": 0
}
}
Properties
EnergyPlanResponseV3
{
"data": {
"planId": "string",
"effectiveFrom": "string",
"effectiveTo": "string",
"lastUpdated": "string",
"displayName": "string",
"description": "string",
"type": "STANDING",
"fuelType": "ELECTRICITY",
"brand": "string",
"brandName": "string",
"applicationUri": "string",
"additionalInformation": {
"overviewUri": "string",
"termsUri": "string",
"eligibilityUri": "string",
"pricingUri": "string",
"bundleUri": "string"
},
"customerType": "RESIDENTIAL",
"geography": {
"excludedPostcodes": [
"string"
],
"includedPostcodes": [
"string"
],
"distributors": [
"string"
]
},
"meteringCharges": [
{
"displayName": "string",
"description": "string",
"minimumValue": "string",
"maximumValue": "string",
"period": "string"
}
],
"gasContract": {
"additionalFeeInformation": "string",
"pricingModel": "SINGLE_RATE",
"timeZone": "LOCAL",
"isFixed": true,
"variation": "string",
"onExpiryDescription": "string",
"paymentOption": [
"PAPER_BILL"
],
"intrinsicGreenPower": {
"greenPercentage": "string"
},
"controlledLoad": [
{
"displayName": "string",
"rateBlockUType": "singleRate",
"startDate": "string",
"endDate": "string",
"singleRate": {
"displayName": "string",
"description": "string",
"dailySupplyCharge": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "P1Y"
},
"timeOfUseRates": [
{
"displayName": "string",
"description": "string",
"dailySupplyCharge": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "P1Y",
"timeOfUse": [
{
"days": [
"SUN"
],
"startTime": "string",
"endTime": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
],
"type": "PEAK"
}
]
}
],
"incentives": [
{
"displayName": "string",
"description": "string",
"category": "GIFT",
"eligibility": "string"
}
],
"discounts": [
{
"displayName": "string",
"description": "string",
"type": "CONDITIONAL",
"category": "PAY_ON_TIME",
"endDate": "string",
"methodUType": "percentOfBill",
"percentOfBill": {
"rate": "string"
},
"percentOfUse": {
"rate": "string"
},
"fixedAmount": {
"amount": "string"
},
"percentOverThreshold": {
"rate": "string",
"usageAmount": "string"
}
}
],
"greenPowerCharges": [
{
"displayName": "string",
"description": "string",
"scheme": "GREENPOWER",
"type": "FIXED_PER_DAY",
"tiers": [
{
"percentGreen": "string",
"rate": "string",
"amount": "string"
}
]
}
],
"eligibility": [
{
"type": "EXISTING_CUST",
"information": "string",
"description": "string"
}
],
"fees": [
{
"type": "EXIT",
"term": "FIXED",
"amount": "string",
"rate": "string",
"description": "string"
}
],
"solarFeedInTariff": [
{
"displayName": "string",
"description": "string",
"startDate": "string",
"endDate": "string",
"scheme": "PREMIUM",
"payerType": "GOVERNMENT",
"tariffUType": "singleTariff",
"singleTariff": {
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "P1Y"
},
"timeVaryingTariffs": [
{
"type": "PEAK",
"displayName": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "P1Y",
"timeVariations": [
{
"days": [
"SUN"
],
"startTime": "string",
"endTime": "string"
}
]
}
]
}
],
"tariffPeriod": [
{
"type": "ENVIRONMENTAL",
"displayName": "string",
"startDate": "string",
"endDate": "string",
"dailySupplyChargeType": "SINGLE",
"dailySupplyCharge": "string",
"bandedDailySupplyCharges": [
{
"unitPrice": "string",
"measureUnit": "DAYS",
"volume": 0
}
],
"timeZone": "LOCAL",
"rateBlockUType": "singleRate",
"singleRate": {
"displayName": "string",
"description": "string",
"generalUnitPrice": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "string"
},
"timeOfUseRates": [
{
"displayName": "string",
"description": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "P1Y",
"timeOfUse": [
{
"days": [
"SUN"
],
"startTime": "string",
"endTime": "string"
}
],
"type": "PEAK"
}
],
"demandCharges": [
{
"displayName": "string",
"description": "string",
"amount": "string",
"measureUnit": "KWH",
"startTime": "string",
"endTime": "string",
"days": [
"SUN"
],
"minDemand": "0.00",
"maxDemand": "string",
"measurementPeriod": "DAY",
"chargePeriod": "DAY"
}
]
}
],
"termType": "1_YEAR",
"benefitPeriod": "string",
"terms": "string",
"meterTypes": [
"string"
],
"coolingOffDays": 0,
"billFrequency": [
"string"
]
},
"electricityContract": {
"additionalFeeInformation": "string",
"pricingModel": "SINGLE_RATE",
"timeZone": "LOCAL",
"isFixed": true,
"variation": "string",
"onExpiryDescription": "string",
"paymentOption": [
"PAPER_BILL"
],
"intrinsicGreenPower": {
"greenPercentage": "string"
},
"controlledLoad": [
{
"displayName": "string",
"rateBlockUType": "singleRate",
"startDate": "string",
"endDate": "string",
"singleRate": {
"displayName": "string",
"description": "string",
"dailySupplyCharge": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "P1Y"
},
"timeOfUseRates": [
{
"displayName": "string",
"description": "string",
"dailySupplyCharge": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "P1Y",
"timeOfUse": [
{
"days": [
"SUN"
],
"startTime": "string",
"endTime": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
],
"type": "PEAK"
}
]
}
],
"incentives": [
{
"displayName": "string",
"description": "string",
"category": "GIFT",
"eligibility": "string"
}
],
"discounts": [
{
"displayName": "string",
"description": "string",
"type": "CONDITIONAL",
"category": "PAY_ON_TIME",
"endDate": "string",
"methodUType": "percentOfBill",
"percentOfBill": {
"rate": "string"
},
"percentOfUse": {
"rate": "string"
},
"fixedAmount": {
"amount": "string"
},
"percentOverThreshold": {
"rate": "string",
"usageAmount": "string"
}
}
],
"greenPowerCharges": [
{
"displayName": "string",
"description": "string",
"scheme": "GREENPOWER",
"type": "FIXED_PER_DAY",
"tiers": [
{
"percentGreen": "string",
"rate": "string",
"amount": "string"
}
]
}
],
"eligibility": [
{
"type": "EXISTING_CUST",
"information": "string",
"description": "string"
}
],
"fees": [
{
"type": "EXIT",
"term": "FIXED",
"amount": "string",
"rate": "string",
"description": "string"
}
],
"solarFeedInTariff": [
{
"displayName": "string",
"description": "string",
"startDate": "string",
"endDate": "string",
"scheme": "PREMIUM",
"payerType": "GOVERNMENT",
"tariffUType": "singleTariff",
"singleTariff": {
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "P1Y"
},
"timeVaryingTariffs": [
{
"type": "PEAK",
"displayName": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "P1Y",
"timeVariations": [
{
"days": [
"SUN"
],
"startTime": "string",
"endTime": "string"
}
]
}
]
}
],
"tariffPeriod": [
{
"type": "ENVIRONMENTAL",
"displayName": "string",
"startDate": "string",
"endDate": "string",
"dailySupplyChargeType": "SINGLE",
"dailySupplyCharge": "string",
"bandedDailySupplyCharges": [
{
"unitPrice": "string",
"measureUnit": "DAYS",
"volume": 0
}
],
"timeZone": "LOCAL",
"rateBlockUType": "singleRate",
"singleRate": {
"displayName": "string",
"description": "string",
"generalUnitPrice": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "string"
},
"timeOfUseRates": [
{
"displayName": "string",
"description": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "P1Y",
"timeOfUse": [
{
"days": [
"SUN"
],
"startTime": "string",
"endTime": "string"
}
],
"type": "PEAK"
}
],
"demandCharges": [
{
"displayName": "string",
"description": "string",
"amount": "string",
"measureUnit": "KWH",
"startTime": "string",
"endTime": "string",
"days": [
"SUN"
],
"minDemand": "0.00",
"maxDemand": "string",
"measurementPeriod": "DAY",
"chargePeriod": "DAY"
}
]
}
],
"termType": "1_YEAR",
"benefitPeriod": "string",
"terms": "string",
"meterTypes": [
"string"
],
"coolingOffDays": 0,
"billFrequency": [
"string"
]
}
},
"links": {
"self": "string"
},
"meta": {}
}
Properties
EnergyServicePointListResponseV2
{
"data": {
"servicePoints": [
{
"servicePointId": "string",
"nationalMeteringId": "string",
"servicePointClassification": "EXTERNAL_PROFILE",
"servicePointStatus": "ACTIVE",
"jurisdictionCode": "ALL",
"isGenerator": false,
"validFromDate": "string",
"lastUpdateDateTime": "string",
"lastConsumerChangeDate": "string",
"consumerProfile": {
"classification": "BUSINESS",
"threshold": "LOW"
}
}
]
},
"links": {
"self": "string",
"first": "string",
"prev": "string",
"next": "string",
"last": "string"
},
"meta": {
"totalRecords": 0,
"totalPages": 0
}
}
Properties
EnergyServicePointDetailResponseV2
{
"data": {
"servicePointId": "string",
"nationalMeteringId": "string",
"servicePointClassification": "EXTERNAL_PROFILE",
"servicePointStatus": "ACTIVE",
"jurisdictionCode": "ALL",
"isGenerator": false,
"validFromDate": "string",
"lastUpdateDateTime": "string",
"lastConsumerChangeDate": "string",
"consumerProfile": {
"classification": "BUSINESS",
"threshold": "LOW"
},
"distributionLossFactor": {
"code": "string",
"description": "string",
"lossValue": "string"
},
"relatedParticipants": [
{
"party": "string",
"role": "FRMP"
}
],
"location": {
"addressUType": "paf",
"simple": {
"mailingName": "string",
"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"postcode": "string",
"city": "string",
"state": "string",
"country": "AUS"
},
"paf": {
"dpid": "string",
"thoroughfareNumber1": 0,
"thoroughfareNumber1Suffix": "string",
"thoroughfareNumber2": 0,
"thoroughfareNumber2Suffix": "string",
"flatUnitType": "string",
"flatUnitNumber": "string",
"floorLevelType": "string",
"floorLevelNumber": "string",
"lotNumber": "string",
"buildingName1": "string",
"buildingName2": "string",
"streetName": "string",
"streetType": "string",
"streetSuffix": "string",
"postalDeliveryType": "string",
"postalDeliveryNumber": 0,
"postalDeliveryNumberPrefix": "string",
"postalDeliveryNumberSuffix": "string",
"localityName": "string",
"postcode": "string",
"state": "string"
}
},
"meters": [
{
"meterId": "string",
"specifications": {
"status": "CURRENT",
"installationType": "BASIC",
"manufacturer": "string",
"model": "string",
"readType": "string",
"nextScheduledReadDate": "string"
},
"registers": [
{
"registerId": "string",
"registerSuffix": "string",
"averagedDailyLoad": 0,
"registerConsumptionType": "INTERVAL",
"networkTariffCode": "string",
"unitOfMeasure": "string",
"timeOfDay": "ALLDAY",
"multiplier": 0,
"controlledLoad": true,
"consumptionType": "ACTUAL"
}
]
}
]
},
"links": {
"self": "string"
},
"meta": {}
}
Properties
EnergyUsageListResponse
{
"data": {
"reads": [
{
"servicePointId": "string",
"registerId": "string",
"registerSuffix": "string",
"meterId": "string",
"controlledLoad": true,
"readStartDate": "string",
"readEndDate": "string",
"unitOfMeasure": "string",
"readUType": "basicRead",
"basicRead": {
"quality": "ACTUAL",
"value": 0
},
"intervalRead": {
"readIntervalLength": 0,
"aggregateValue": 0,
"intervalReads": [
0
],
"readQualities": [
{
"startInterval": 1,
"endInterval": 1,
"quality": "SUBSTITUTE"
}
]
}
}
]
},
"links": {
"self": "string",
"first": "string",
"prev": "string",
"next": "string",
"last": "string"
},
"meta": {
"totalRecords": 0,
"totalPages": 0
}
}
Properties
| Name |
Type |
Required |
Default |
Description |
| data |
object |
mandatory |
|
none |
| » reads |
[EnergyUsageRead] |
mandatory |
|
Array of meter reads sorted by NMI in ascending order followed by readStartDate in descending order. |
| links |
LinksPaginated |
mandatory |
|
none |
| meta |
MetaPaginated |
mandatory |
|
none |
EnergyDerListResponse
{
"data": {
"derRecords": [
{
"servicePointId": "string",
"approvedCapacity": 0,
"availablePhasesCount": 3,
"installedPhasesCount": 3,
"islandableInstallation": true,
"hasCentralProtectionControl": false,
"protectionMode": {
"exportLimitKva": 0,
"underFrequencyProtection": 0,
"underFrequencyProtectionDelay": 0,
"overFrequencyProtection": 0,
"overFrequencyProtectionDelay": 0,
"underVoltageProtection": 0,
"underVoltageProtectionDelay": 0,
"overVoltageProtection": 0,
"overVoltageProtectionDelay": 0,
"sustainedOverVoltage": 0,
"sustainedOverVoltageDelay": 0,
"frequencyRateOfChange": 0,
"voltageVectorShift": 0,
"interTripScheme": "string",
"neutralVoltageDisplacement": 0
},
"acConnections": [
{
"connectionIdentifier": 0,
"count": 0,
"equipmentType": "INVERTER",
"manufacturerName": "string",
"inverterSeries": "string",
"inverterModelNumber": "string",
"commissioningDate": "string",
"status": "ACTIVE",
"inverterDeviceCapacity": 0,
"derDevices": [
{
"deviceIdentifier": 0,
"count": 0,
"manufacturer": "string",
"modelNumber": "string",
"status": "ACTIVE",
"type": "FOSSIL",
"subtype": "string",
"nominalRatedCapacity": 0,
"nominalStorageCapacity": 0
}
]
}
]
}
]
},
"links": {
"self": "string",
"first": "string",
"prev": "string",
"next": "string",
"last": "string"
},
"meta": {
"totalRecords": 0,
"totalPages": 0
}
}
Properties
EnergyDerDetailResponse
{
"data": {
"servicePointId": "string",
"approvedCapacity": 0,
"availablePhasesCount": 3,
"installedPhasesCount": 3,
"islandableInstallation": true,
"hasCentralProtectionControl": false,
"protectionMode": {
"exportLimitKva": 0,
"underFrequencyProtection": 0,
"underFrequencyProtectionDelay": 0,
"overFrequencyProtection": 0,
"overFrequencyProtectionDelay": 0,
"underVoltageProtection": 0,
"underVoltageProtectionDelay": 0,
"overVoltageProtection": 0,
"overVoltageProtectionDelay": 0,
"sustainedOverVoltage": 0,
"sustainedOverVoltageDelay": 0,
"frequencyRateOfChange": 0,
"voltageVectorShift": 0,
"interTripScheme": "string",
"neutralVoltageDisplacement": 0
},
"acConnections": [
{
"connectionIdentifier": 0,
"count": 0,
"equipmentType": "INVERTER",
"manufacturerName": "string",
"inverterSeries": "string",
"inverterModelNumber": "string",
"commissioningDate": "string",
"status": "ACTIVE",
"inverterDeviceCapacity": 0,
"derDevices": [
{
"deviceIdentifier": 0,
"count": 0,
"manufacturer": "string",
"modelNumber": "string",
"status": "ACTIVE",
"type": "FOSSIL",
"subtype": "string",
"nominalRatedCapacity": 0,
"nominalStorageCapacity": 0
}
]
}
]
},
"links": {
"self": "string"
},
"meta": {}
}
Properties
| Name |
Type |
Required |
Default |
Description |
| data |
EnergyDerRecord |
mandatory |
|
none |
| links |
Links |
mandatory |
|
none |
| meta |
Meta |
optional |
|
none |
EnergyAccountListResponseV2
{
"data": {
"accounts": [
{
"accountId": "string",
"accountNumber": "string",
"displayName": "string",
"openStatus": "CLOSED",
"creationDate": "string",
"plans": [
{
"nickname": "string",
"servicePointIds": [
"string"
],
"planOverview": {
"displayName": "string",
"startDate": "string",
"endDate": "string"
}
}
]
}
]
},
"links": {
"self": "string",
"first": "string",
"prev": "string",
"next": "string",
"last": "string"
},
"meta": {
"totalRecords": 0,
"totalPages": 0
}
}
Properties
EnergyAccountDetailResponseV4
{
"data": {
"accountId": "string",
"accountNumber": "string",
"displayName": "string",
"openStatus": "CLOSED",
"creationDate": "string",
"plans": [
{
"nickname": "string",
"servicePointIds": [
"string"
],
"planOverview": {
"displayName": "string",
"startDate": "string",
"endDate": "string"
},
"planDetail": {
"fuelType": "ELECTRICITY",
"isContingentPlan": false,
"meteringCharges": [
{
"displayName": "string",
"description": "string",
"minimumValue": "string",
"maximumValue": "string",
"period": "string"
}
],
"gasContract": {
"additionalFeeInformation": "string",
"pricingModel": "SINGLE_RATE",
"timeZone": "LOCAL",
"isFixed": true,
"variation": "string",
"onExpiryDescription": "string",
"paymentOption": [
"PAPER_BILL"
],
"intrinsicGreenPower": {
"greenPercentage": "string"
},
"controlledLoad": [
{
"displayName": "string",
"rateBlockUType": "singleRate",
"startDate": "string",
"endDate": "string",
"singleRate": {
"displayName": "string",
"description": "string",
"dailySupplyCharge": "string",
"rates": [
{}
],
"period": "P1Y"
},
"timeOfUseRates": [
{
"displayName": "string",
"description": "string",
"dailySupplyCharge": "string",
"rates": [],
"period": "P1Y",
"timeOfUse": [],
"type": "PEAK"
}
]
}
],
"incentives": [
{
"displayName": "string",
"description": "string",
"category": "GIFT",
"eligibility": "string"
}
],
"discounts": [
{
"displayName": "string",
"description": "string",
"type": "CONDITIONAL",
"category": "PAY_ON_TIME",
"endDate": "string",
"methodUType": "percentOfBill",
"percentOfBill": {
"rate": "string"
},
"percentOfUse": {
"rate": "string"
},
"fixedAmount": {
"amount": "string"
},
"percentOverThreshold": {
"rate": "string",
"usageAmount": "string"
}
}
],
"greenPowerCharges": [
{
"displayName": "string",
"description": "string",
"scheme": "GREENPOWER",
"type": "FIXED_PER_DAY",
"tiers": [
{
"percentGreen": "string",
"rate": "string",
"amount": "string"
}
]
}
],
"eligibility": [
{
"type": "EXISTING_CUST",
"information": "string",
"description": "string"
}
],
"fees": [
{
"type": "EXIT",
"term": "FIXED",
"amount": "string",
"rate": "string",
"description": "string"
}
],
"solarFeedInTariff": [
{
"displayName": "string",
"description": "string",
"startDate": "string",
"endDate": "string",
"scheme": "PREMIUM",
"payerType": "GOVERNMENT",
"tariffUType": "singleTariff",
"singleTariff": {
"rates": [
{}
],
"period": "P1Y"
},
"timeVaryingTariffs": [
{
"type": "PEAK",
"displayName": "string",
"rates": [],
"period": "P1Y",
"timeVariations": []
}
]
}
],
"tariffPeriod": [
{
"type": "ENVIRONMENTAL",
"displayName": "string",
"startDate": "string",
"endDate": "string",
"dailySupplyChargeType": "SINGLE",
"dailySupplyCharge": "string",
"bandedDailySupplyCharges": [
{
"unitPrice": "string",
"measureUnit": "DAYS",
"volume": 0
}
],
"timeZone": "LOCAL",
"rateBlockUType": "singleRate",
"singleRate": {
"displayName": "string",
"description": "string",
"generalUnitPrice": "string",
"rates": [
{}
],
"period": "string"
},
"timeOfUseRates": [
{
"displayName": "string",
"description": "string",
"rates": [],
"period": "P1Y",
"timeOfUse": [],
"type": "PEAK"
}
],
"demandCharges": [
{
"displayName": "string",
"description": "string",
"amount": "string",
"measureUnit": "KWH",
"startTime": "string",
"endTime": "string",
"days": [],
"minDemand": "0.00",
"maxDemand": "string",
"measurementPeriod": "DAY",
"chargePeriod": "DAY"
}
]
}
]
},
"electricityContract": {
"additionalFeeInformation": "string",
"pricingModel": "SINGLE_RATE",
"timeZone": "LOCAL",
"isFixed": true,
"variation": "string",
"onExpiryDescription": "string",
"paymentOption": [
"PAPER_BILL"
],
"intrinsicGreenPower": {
"greenPercentage": "string"
},
"controlledLoad": [
{
"displayName": "string",
"rateBlockUType": "singleRate",
"startDate": "string",
"endDate": "string",
"singleRate": {
"displayName": "string",
"description": "string",
"dailySupplyCharge": "string",
"rates": [
{}
],
"period": "P1Y"
},
"timeOfUseRates": [
{
"displayName": "string",
"description": "string",
"dailySupplyCharge": "string",
"rates": [],
"period": "P1Y",
"timeOfUse": [],
"type": "PEAK"
}
]
}
],
"incentives": [
{
"displayName": "string",
"description": "string",
"category": "GIFT",
"eligibility": "string"
}
],
"discounts": [
{
"displayName": "string",
"description": "string",
"type": "CONDITIONAL",
"category": "PAY_ON_TIME",
"endDate": "string",
"methodUType": "percentOfBill",
"percentOfBill": {
"rate": "string"
},
"percentOfUse": {
"rate": "string"
},
"fixedAmount": {
"amount": "string"
},
"percentOverThreshold": {
"rate": "string",
"usageAmount": "string"
}
}
],
"greenPowerCharges": [
{
"displayName": "string",
"description": "string",
"scheme": "GREENPOWER",
"type": "FIXED_PER_DAY",
"tiers": [
{
"percentGreen": "string",
"rate": "string",
"amount": "string"
}
]
}
],
"eligibility": [
{
"type": "EXISTING_CUST",
"information": "string",
"description": "string"
}
],
"fees": [
{
"type": "EXIT",
"term": "FIXED",
"amount": "string",
"rate": "string",
"description": "string"
}
],
"solarFeedInTariff": [
{
"displayName": "string",
"description": "string",
"startDate": "string",
"endDate": "string",
"scheme": "PREMIUM",
"payerType": "GOVERNMENT",
"tariffUType": "singleTariff",
"singleTariff": {
"rates": [
{}
],
"period": "P1Y"
},
"timeVaryingTariffs": [
{
"type": "PEAK",
"displayName": "string",
"rates": [],
"period": "P1Y",
"timeVariations": []
}
]
}
],
"tariffPeriod": [
{
"type": "ENVIRONMENTAL",
"displayName": "string",
"startDate": "string",
"endDate": "string",
"dailySupplyChargeType": "SINGLE",
"dailySupplyCharge": "string",
"bandedDailySupplyCharges": [
{
"unitPrice": "string",
"measureUnit": "DAYS",
"volume": 0
}
],
"timeZone": "LOCAL",
"rateBlockUType": "singleRate",
"singleRate": {
"displayName": "string",
"description": "string",
"generalUnitPrice": "string",
"rates": [
{}
],
"period": "string"
},
"timeOfUseRates": [
{
"displayName": "string",
"description": "string",
"rates": [],
"period": "P1Y",
"timeOfUse": [],
"type": "PEAK"
}
],
"demandCharges": [
{
"displayName": "string",
"description": "string",
"amount": "string",
"measureUnit": "KWH",
"startTime": "string",
"endTime": "string",
"days": [],
"minDemand": "0.00",
"maxDemand": "string",
"measurementPeriod": "DAY",
"chargePeriod": "DAY"
}
]
}
]
}
},
"authorisedContacts": [
{
"firstName": "string",
"lastName": "string",
"middleNames": [
"string"
],
"prefix": "string",
"suffix": "string"
}
]
}
]
},
"links": {
"self": "string"
},
"meta": {}
}
Properties
EnergyPaymentScheduleResponse
{
"data": {
"paymentSchedules": [
{
"amount": "string",
"paymentScheduleUType": "cardDebit",
"cardDebit": {
"cardScheme": "VISA",
"paymentFrequency": "string",
"calculationType": "STATIC"
},
"directDebit": {
"isTokenised": false,
"bsb": "string",
"accountNumber": "string",
"paymentFrequency": "string",
"calculationType": "STATIC"
},
"digitalWallet": {
"name": "string",
"identifier": "string",
"type": "EMAIL",
"provider": "PAYPAL_AU",
"paymentFrequency": "string",
"calculationType": "STATIC"
},
"manualPayment": {
"billFrequency": "string"
}
}
]
},
"links": {
"self": "string"
},
"meta": {}
}
Properties
| Name |
Type |
Required |
Default |
Description |
| data |
object |
mandatory |
|
none |
| » paymentSchedules |
[EnergyPaymentSchedule] |
mandatory |
|
Array may be empty if no payment schedules exist. |
| links |
Links |
mandatory |
|
none |
| meta |
Meta |
optional |
|
none |
EnergyConcessionsResponse
{
"data": {
"concessions": [
{
"type": "FIXED_AMOUNT",
"displayName": "string",
"additionalInfo": "string",
"additionalInfoUri": "string",
"startDate": "string",
"endDate": "string",
"discountFrequency": "string",
"amount": "string",
"percentage": "string",
"appliedTo": [
"USAGE"
]
}
]
},
"links": {
"self": "string"
},
"meta": {}
}
Properties
| Name |
Type |
Required |
Default |
Description |
| data |
object |
mandatory |
|
none |
| » concessions |
[EnergyConcession] |
mandatory |
|
Array may be empty if no concessions exist. |
| links |
Links |
mandatory |
|
none |
| meta |
Meta |
optional |
|
none |
EnergyBalanceListResponse
{
"data": {
"balances": [
{
"accountId": "string",
"balance": "string"
}
]
},
"links": {
"self": "string",
"first": "string",
"prev": "string",
"next": "string",
"last": "string"
},
"meta": {
"totalRecords": 0,
"totalPages": 0
}
}
Properties
| Name |
Type |
Required |
Default |
Description |
| data |
object |
mandatory |
|
none |
| » balances |
[object] |
mandatory |
|
Array of account balances. |
| »» accountId |
EnergyAccountId |
mandatory |
|
Unique identifier for the account. |
| »» balance |
AmountString |
mandatory |
|
The current balance of the account. A positive value indicates that amount is owing to be paid. A negative value indicates that the account is in credit. |
| links |
LinksPaginated |
mandatory |
|
none |
| meta |
MetaPaginated |
mandatory |
|
none |
EnergyBalanceResponse
{
"data": {
"balance": "string"
},
"links": {
"self": "string"
},
"meta": {}
}
Properties
| Name |
Type |
Required |
Default |
Description |
| data |
object |
mandatory |
|
none |
| » balance |
AmountString |
mandatory |
|
The current balance of the account. A positive value indicates that amount is owing to be paid. A negative value indicates that the account is in credit. |
| links |
Links |
mandatory |
|
none |
| meta |
Meta |
optional |
|
none |
EnergyInvoiceListResponse
{
"data": {
"invoices": [
{
"accountId": "string",
"invoiceNumber": "string",
"issueDate": "string",
"dueDate": "string",
"period": {
"startDate": "string",
"endDate": "string"
},
"invoiceAmount": "string",
"gstAmount": "0.00",
"payOnTimeDiscount": {
"discountAmount": "string",
"gstAmount": "0.00",
"date": "string"
},
"balanceAtIssue": "string",
"servicePoints": [
"string"
],
"gas": {
"totalUsageCharges": "string",
"totalGenerationCredits": "string",
"totalOnceOffCharges": "string",
"totalOnceOffDiscounts": "string",
"otherCharges": [
{
"type": "ENVIRONMENTAL",
"amount": "string",
"description": "string"
}
],
"totalGst": "0.00"
},
"electricity": {
"totalUsageCharges": "string",
"totalGenerationCredits": "string",
"totalOnceOffCharges": "string",
"totalOnceOffDiscounts": "string",
"otherCharges": [
{
"type": "ENVIRONMENTAL",
"amount": "string",
"description": "string"
}
],
"totalGst": "0.00"
},
"accountCharges": {
"totalCharges": "string",
"totalDiscounts": "string",
"totalGst": "0.00"
},
"paymentStatus": "PAID"
}
]
},
"links": {
"self": "string",
"first": "string",
"prev": "string",
"next": "string",
"last": "string"
},
"meta": {
"totalRecords": 0,
"totalPages": 0
}
}
Properties
| Name |
Type |
Required |
Default |
Description |
| data |
object |
mandatory |
|
none |
| » invoices |
[EnergyInvoice] |
mandatory |
|
Array of invoices sorted by issue date in descending order. |
| links |
LinksPaginated |
mandatory |
|
none |
| meta |
MetaPaginated |
mandatory |
|
none |
EnergyBillingListResponseV3
{
"data": {
"transactions": [
{
"accountId": "string",
"executionDateTime": "string",
"gst": "0.00",
"transactionUType": "usage",
"usage": {
"servicePointId": "string",
"invoiceNumber": "string",
"timeOfUseType": "PEAK",
"description": "string",
"isEstimate": false,
"startDate": "string",
"endDate": "string",
"measureUnit": "KWH",
"usage": 0,
"amount": "string",
"calculationFactors": [
{
"value": 0,
"type": "DLF"
}
],
"adjustments": [
{
"amount": "string",
"description": "string"
}
]
},
"demand": {
"servicePointId": "string",
"invoiceNumber": "string",
"timeOfUseType": "PEAK",
"description": "string",
"isEstimate": false,
"startDate": "string",
"endDate": "string",
"measureUnit": "KVA",
"rate": 0,
"amount": "string",
"calculationFactors": [
{
"value": 0,
"type": "DLF"
}
],
"adjustments": [
{
"amount": "string",
"description": "string"
}
]
},
"onceOff": {
"servicePointId": "string",
"invoiceNumber": "string",
"amount": "string",
"description": "string"
},
"otherCharges": {
"servicePointId": "string",
"invoiceNumber": "string",
"startDate": "string",
"endDate": "string",
"type": "ENVIRONMENTAL",
"amount": "string",
"description": "string",
"calculationFactors": [
{
"value": 0,
"type": "DLF"
}
],
"adjustments": [
{
"amount": "string",
"description": "string"
}
]
},
"payment": {
"amount": "string",
"method": "DIRECT_DEBIT"
}
}
]
},
"links": {
"self": "string",
"first": "string",
"prev": "string",
"next": "string",
"last": "string"
},
"meta": {
"totalRecords": 0,
"totalPages": 0
}
}
Properties
PrimaryResponseErrorListV1
{
"errors": [
{
"isSecondaryDataHolderError": false,
"code": "string",
"title": "string",
"detail": "string",
"meta": {
"urn": "string"
}
}
]
}
Properties
| Name |
Type |
Required |
Default |
Description |
| errors |
[PrimaryErrorV1] |
mandatory |
|
List of errors. |
PrimaryErrorV1
{
"isSecondaryDataHolderError": false,
"code": "string",
"title": "string",
"detail": "string",
"meta": {
"urn": "string"
}
}
Properties
allOf
| Name |
Type |
Required |
Default |
Description |
| anonymous |
object |
mandatory |
|
none |
| » isSecondaryDataHolderError |
Boolean |
optional |
false |
Indicates the error was propagated from a designated secondary data holder. |
and
| Name |
Type |
Required |
Default |
Description |
| anonymous |
ErrorV2 |
mandatory |
|
none |
ResponseErrorListV2
{
"errors": [
{
"code": "string",
"title": "string",
"detail": "string",
"meta": {
"urn": "string"
}
}
]
}
Properties
| Name |
Type |
Required |
Default |
Description |
| errors |
[ErrorV2] |
mandatory |
|
List of errors. |
ErrorV2
{
"code": "string",
"title": "string",
"detail": "string",
"meta": {
"urn": "string"
}
}
Properties
| Name |
Type |
Required |
Default |
Description |
| code |
string |
mandatory |
|
The code of the error encountered. Where the error is specific to the respondent, an application-specific error code, expressed as a string value. If the error is application-specific, the URN code that the specific error extends must be provided in the meta object. Otherwise, the value is the error code URN. |
| title |
string |
mandatory |
|
A short, human-readable summary of the problem that MUST NOT change from occurrence to occurrence of the problem represented by the error code. |
| detail |
string |
mandatory |
|
A human-readable explanation specific to this occurrence of the problem. |
| meta |
object |
conditional |
|
Additional data for customised error codes. |
| » urn |
string |
conditional |
|
The CDR error code URN which the application-specific error code extends. Mandatory if the error code is an application-specific error rather than a standardised error code. |
EnergyPlan
{
"planId": "string",
"effectiveFrom": "string",
"effectiveTo": "string",
"lastUpdated": "string",
"displayName": "string",
"description": "string",
"type": "STANDING",
"fuelType": "ELECTRICITY",
"brand": "string",
"brandName": "string",
"applicationUri": "string",
"additionalInformation": {
"overviewUri": "string",
"termsUri": "string",
"eligibilityUri": "string",
"pricingUri": "string",
"bundleUri": "string"
},
"customerType": "RESIDENTIAL",
"geography": {
"excludedPostcodes": [
"string"
],
"includedPostcodes": [
"string"
],
"distributors": [
"string"
]
}
}
Properties
| Name |
Type |
Required |
Default |
Description |
| planId |
EnergyPlanId |
mandatory |
|
The unique identifier for the Energy plan. |
| effectiveFrom |
DateTimeString |
optional |
|
The date and time from which this plan is effective (i.e. is available for origination). Used to enable the articulation of products to the regime before they are available for customers to originate. |
| effectiveTo |
DateTimeString |
optional |
|
The date and time at which this plan will be retired and will no longer be offered. Used to enable the managed deprecation of plans. |
| lastUpdated |
DateTimeString |
mandatory |
|
The last date and time that the information for this plan was changed (or the creation date for the plan if it has never been altered). |
| displayName |
string |
optional |
|
The display name of the plan. |
| description |
string |
optional |
|
A description of the plan. |
| type |
Enum |
mandatory |
|
The type of the plan. |
| fuelType |
Enum |
mandatory |
|
The fuel types covered by the plan. |
| brand |
ASCIIString |
mandatory |
|
The ID of the brand under which this plan is offered. |
| brandName |
string |
mandatory |
|
The display name of the brand under which this plan is offered. |
| applicationUri |
URIString |
optional |
|
A link to an application web page where this plan can be applied for. |
| additionalInformation |
object |
optional |
|
Object that contains links to additional information on specific topics. |
| » overviewUri |
URIString |
optional |
|
A link to a general overview of the plan. |
| » termsUri |
URIString |
optional |
|
A link to terms and conditions for the plan. |
| » eligibilityUri |
URIString |
optional |
|
A link to detail on eligibility criteria for the plan. |
| » pricingUri |
URIString |
optional |
|
A link to detail on pricing for the plan. |
| » bundleUri |
URIString |
optional |
|
A link to detail on bundles that this plan can be a part of. |
| customerType |
Enum |
optional |
|
The type of customer that the plan is offered to. If absent then the plan is available to all customers. |
| geography |
object |
optional |
|
Describes the geographical area that the plan is available for. If absent then it is assumed the plan is not geographically limited. |
| » excludedPostcodes |
[string] |
optional |
|
Array of valid Australian postcodes that are specifically excluded from the plan. Each element is a single four digit postcode (e.g., 3000) or a range of postcodes defined by two four digit postcodes and a hyphen (e.g., 3000-3999). |
| » includedPostcodes |
[string] |
optional |
|
Array of valid Australian postcodes that are included from the plan. If absent defaults to all non-excluded postcodes. Each element is a single four digit postcode (e.g., 3000) or a range of postcodes defined by two four digit postcodes and a hyphen (e.g., 3000-3999). |
| » distributors |
[string] |
mandatory |
|
Array of distributors for the plan. Must have at least one entry. |
Enumerated Values
| Property |
Value |
| type |
STANDING |
| type |
MARKET |
| type |
REGULATED |
| fuelType |
ELECTRICITY |
| fuelType |
GAS |
| fuelType |
DUAL |
| customerType |
RESIDENTIAL |
| customerType |
BUSINESS |
EnergyPlanDetailV3
{
"planId": "string",
"effectiveFrom": "string",
"effectiveTo": "string",
"lastUpdated": "string",
"displayName": "string",
"description": "string",
"type": "STANDING",
"fuelType": "ELECTRICITY",
"brand": "string",
"brandName": "string",
"applicationUri": "string",
"additionalInformation": {
"overviewUri": "string",
"termsUri": "string",
"eligibilityUri": "string",
"pricingUri": "string",
"bundleUri": "string"
},
"customerType": "RESIDENTIAL",
"geography": {
"excludedPostcodes": [
"string"
],
"includedPostcodes": [
"string"
],
"distributors": [
"string"
]
},
"meteringCharges": [
{
"displayName": "string",
"description": "string",
"minimumValue": "string",
"maximumValue": "string",
"period": "string"
}
],
"gasContract": {
"additionalFeeInformation": "string",
"pricingModel": "SINGLE_RATE",
"timeZone": "LOCAL",
"isFixed": true,
"variation": "string",
"onExpiryDescription": "string",
"paymentOption": [
"PAPER_BILL"
],
"intrinsicGreenPower": {
"greenPercentage": "string"
},
"controlledLoad": [
{
"displayName": "string",
"rateBlockUType": "singleRate",
"startDate": "string",
"endDate": "string",
"singleRate": {
"displayName": "string",
"description": "string",
"dailySupplyCharge": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "P1Y"
},
"timeOfUseRates": [
{
"displayName": "string",
"description": "string",
"dailySupplyCharge": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "P1Y",
"timeOfUse": [
{
"days": [
"SUN"
],
"startTime": "string",
"endTime": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
],
"type": "PEAK"
}
]
}
],
"incentives": [
{
"displayName": "string",
"description": "string",
"category": "GIFT",
"eligibility": "string"
}
],
"discounts": [
{
"displayName": "string",
"description": "string",
"type": "CONDITIONAL",
"category": "PAY_ON_TIME",
"endDate": "string",
"methodUType": "percentOfBill",
"percentOfBill": {
"rate": "string"
},
"percentOfUse": {
"rate": "string"
},
"fixedAmount": {
"amount": "string"
},
"percentOverThreshold": {
"rate": "string",
"usageAmount": "string"
}
}
],
"greenPowerCharges": [
{
"displayName": "string",
"description": "string",
"scheme": "GREENPOWER",
"type": "FIXED_PER_DAY",
"tiers": [
{
"percentGreen": "string",
"rate": "string",
"amount": "string"
}
]
}
],
"eligibility": [
{
"type": "EXISTING_CUST",
"information": "string",
"description": "string"
}
],
"fees": [
{
"type": "EXIT",
"term": "FIXED",
"amount": "string",
"rate": "string",
"description": "string"
}
],
"solarFeedInTariff": [
{
"displayName": "string",
"description": "string",
"startDate": "string",
"endDate": "string",
"scheme": "PREMIUM",
"payerType": "GOVERNMENT",
"tariffUType": "singleTariff",
"singleTariff": {
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "P1Y"
},
"timeVaryingTariffs": [
{
"type": "PEAK",
"displayName": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "P1Y",
"timeVariations": [
{
"days": [
"SUN"
],
"startTime": "string",
"endTime": "string"
}
]
}
]
}
],
"tariffPeriod": [
{
"type": "ENVIRONMENTAL",
"displayName": "string",
"startDate": "string",
"endDate": "string",
"dailySupplyChargeType": "SINGLE",
"dailySupplyCharge": "string",
"bandedDailySupplyCharges": [
{
"unitPrice": "string",
"measureUnit": "DAYS",
"volume": 0
}
],
"timeZone": "LOCAL",
"rateBlockUType": "singleRate",
"singleRate": {
"displayName": "string",
"description": "string",
"generalUnitPrice": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "string"
},
"timeOfUseRates": [
{
"displayName": "string",
"description": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "P1Y",
"timeOfUse": [
{
"days": [
"SUN"
],
"startTime": "string",
"endTime": "string"
}
],
"type": "PEAK"
}
],
"demandCharges": [
{
"displayName": "string",
"description": "string",
"amount": "string",
"measureUnit": "KWH",
"startTime": "string",
"endTime": "string",
"days": [
"SUN"
],
"minDemand": "0.00",
"maxDemand": "string",
"measurementPeriod": "DAY",
"chargePeriod": "DAY"
}
]
}
],
"termType": "1_YEAR",
"benefitPeriod": "string",
"terms": "string",
"meterTypes": [
"string"
],
"coolingOffDays": 0,
"billFrequency": [
"string"
]
},
"electricityContract": {
"additionalFeeInformation": "string",
"pricingModel": "SINGLE_RATE",
"timeZone": "LOCAL",
"isFixed": true,
"variation": "string",
"onExpiryDescription": "string",
"paymentOption": [
"PAPER_BILL"
],
"intrinsicGreenPower": {
"greenPercentage": "string"
},
"controlledLoad": [
{
"displayName": "string",
"rateBlockUType": "singleRate",
"startDate": "string",
"endDate": "string",
"singleRate": {
"displayName": "string",
"description": "string",
"dailySupplyCharge": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "P1Y"
},
"timeOfUseRates": [
{
"displayName": "string",
"description": "string",
"dailySupplyCharge": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "P1Y",
"timeOfUse": [
{
"days": [
"SUN"
],
"startTime": "string",
"endTime": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
],
"type": "PEAK"
}
]
}
],
"incentives": [
{
"displayName": "string",
"description": "string",
"category": "GIFT",
"eligibility": "string"
}
],
"discounts": [
{
"displayName": "string",
"description": "string",
"type": "CONDITIONAL",
"category": "PAY_ON_TIME",
"endDate": "string",
"methodUType": "percentOfBill",
"percentOfBill": {
"rate": "string"
},
"percentOfUse": {
"rate": "string"
},
"fixedAmount": {
"amount": "string"
},
"percentOverThreshold": {
"rate": "string",
"usageAmount": "string"
}
}
],
"greenPowerCharges": [
{
"displayName": "string",
"description": "string",
"scheme": "GREENPOWER",
"type": "FIXED_PER_DAY",
"tiers": [
{
"percentGreen": "string",
"rate": "string",
"amount": "string"
}
]
}
],
"eligibility": [
{
"type": "EXISTING_CUST",
"information": "string",
"description": "string"
}
],
"fees": [
{
"type": "EXIT",
"term": "FIXED",
"amount": "string",
"rate": "string",
"description": "string"
}
],
"solarFeedInTariff": [
{
"displayName": "string",
"description": "string",
"startDate": "string",
"endDate": "string",
"scheme": "PREMIUM",
"payerType": "GOVERNMENT",
"tariffUType": "singleTariff",
"singleTariff": {
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "P1Y"
},
"timeVaryingTariffs": [
{
"type": "PEAK",
"displayName": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "P1Y",
"timeVariations": [
{
"days": [
"SUN"
],
"startTime": "string",
"endTime": "string"
}
]
}
]
}
],
"tariffPeriod": [
{
"type": "ENVIRONMENTAL",
"displayName": "string",
"startDate": "string",
"endDate": "string",
"dailySupplyChargeType": "SINGLE",
"dailySupplyCharge": "string",
"bandedDailySupplyCharges": [
{
"unitPrice": "string",
"measureUnit": "DAYS",
"volume": 0
}
],
"timeZone": "LOCAL",
"rateBlockUType": "singleRate",
"singleRate": {
"displayName": "string",
"description": "string",
"generalUnitPrice": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "string"
},
"timeOfUseRates": [
{
"displayName": "string",
"description": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "P1Y",
"timeOfUse": [
{
"days": [
"SUN"
],
"startTime": "string",
"endTime": "string"
}
],
"type": "PEAK"
}
],
"demandCharges": [
{
"displayName": "string",
"description": "string",
"amount": "string",
"measureUnit": "KWH",
"startTime": "string",
"endTime": "string",
"days": [
"SUN"
],
"minDemand": "0.00",
"maxDemand": "string",
"measurementPeriod": "DAY",
"chargePeriod": "DAY"
}
]
}
],
"termType": "1_YEAR",
"benefitPeriod": "string",
"terms": "string",
"meterTypes": [
"string"
],
"coolingOffDays": 0,
"billFrequency": [
"string"
]
}
}
Properties
allOf
| Name |
Type |
Required |
Default |
Description |
| anonymous |
EnergyPlan |
mandatory |
|
none |
and
| Name |
Type |
Required |
Default |
Description |
| anonymous |
object |
mandatory |
|
none |
| » meteringCharges |
[object] |
optional |
|
Charges for metering included in the plan. |
| »» displayName |
string |
mandatory |
|
Display name of the charge. |
| »» description |
string |
optional |
|
Description of the charge. |
| »» minimumValue |
AmountString |
mandatory |
|
Minimum value of the charge if the charge is a range or the absolute value of the charge if no range is specified. |
| »» maximumValue |
AmountString |
optional |
|
The upper limit of the charge if the charge could occur in a range. |
| »» period |
ExternalRef |
optional |
|
The charges that occur on a schedule indicates the frequency. Formatted according to ISO 8601 Durations (excludes recurrence syntax). |
| » gasContract |
EnergyPlanContractFullV3 |
conditional |
|
The details of the terms for the supply of electricity under this plan. Is mandatory if fuelType is set to GAS or DUAL. |
| » electricityContract |
EnergyPlanContractFullV3 |
conditional |
|
The details of the terms for the supply of electricity under this plan. Is mandatory if fuelType is set to ELECTRICITY or DUAL. |
EnergyPlanContractV3
{
"additionalFeeInformation": "string",
"pricingModel": "SINGLE_RATE",
"timeZone": "LOCAL",
"isFixed": true,
"variation": "string",
"onExpiryDescription": "string",
"paymentOption": [
"PAPER_BILL"
],
"intrinsicGreenPower": {
"greenPercentage": "string"
},
"controlledLoad": [
{
"displayName": "string",
"rateBlockUType": "singleRate",
"startDate": "string",
"endDate": "string",
"singleRate": {
"displayName": "string",
"description": "string",
"dailySupplyCharge": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "P1Y"
},
"timeOfUseRates": [
{
"displayName": "string",
"description": "string",
"dailySupplyCharge": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "P1Y",
"timeOfUse": [
{
"days": [
"SUN"
],
"startTime": "string",
"endTime": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
],
"type": "PEAK"
}
]
}
],
"incentives": [
{
"displayName": "string",
"description": "string",
"category": "GIFT",
"eligibility": "string"
}
],
"discounts": [
{
"displayName": "string",
"description": "string",
"type": "CONDITIONAL",
"category": "PAY_ON_TIME",
"endDate": "string",
"methodUType": "percentOfBill",
"percentOfBill": {
"rate": "string"
},
"percentOfUse": {
"rate": "string"
},
"fixedAmount": {
"amount": "string"
},
"percentOverThreshold": {
"rate": "string",
"usageAmount": "string"
}
}
],
"greenPowerCharges": [
{
"displayName": "string",
"description": "string",
"scheme": "GREENPOWER",
"type": "FIXED_PER_DAY",
"tiers": [
{
"percentGreen": "string",
"rate": "string",
"amount": "string"
}
]
}
],
"eligibility": [
{
"type": "EXISTING_CUST",
"information": "string",
"description": "string"
}
],
"fees": [
{
"type": "EXIT",
"term": "FIXED",
"amount": "string",
"rate": "string",
"description": "string"
}
],
"solarFeedInTariff": [
{
"displayName": "string",
"description": "string",
"startDate": "string",
"endDate": "string",
"scheme": "PREMIUM",
"payerType": "GOVERNMENT",
"tariffUType": "singleTariff",
"singleTariff": {
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "P1Y"
},
"timeVaryingTariffs": [
{
"type": "PEAK",
"displayName": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "P1Y",
"timeVariations": [
{
"days": [
"SUN"
],
"startTime": "string",
"endTime": "string"
}
]
}
]
}
],
"tariffPeriod": [
{
"type": "ENVIRONMENTAL",
"displayName": "string",
"startDate": "string",
"endDate": "string",
"dailySupplyChargeType": "SINGLE",
"dailySupplyCharge": "string",
"bandedDailySupplyCharges": [
{
"unitPrice": "string",
"measureUnit": "DAYS",
"volume": 0
}
],
"timeZone": "LOCAL",
"rateBlockUType": "singleRate",
"singleRate": {
"displayName": "string",
"description": "string",
"generalUnitPrice": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "string"
},
"timeOfUseRates": [
{
"displayName": "string",
"description": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "P1Y",
"timeOfUse": [
{
"days": [
"SUN"
],
"startTime": "string",
"endTime": "string"
}
],
"type": "PEAK"
}
],
"demandCharges": [
{
"displayName": "string",
"description": "string",
"amount": "string",
"measureUnit": "KWH",
"startTime": "string",
"endTime": "string",
"days": [
"SUN"
],
"minDemand": "0.00",
"maxDemand": "string",
"measurementPeriod": "DAY",
"chargePeriod": "DAY"
}
]
}
]
}
Properties
| Name |
Type |
Required |
Default |
Description |
| additionalFeeInformation |
string |
optional |
|
Free text field containing additional information of the fees for this contract. |
| pricingModel |
Enum |
mandatory |
|
The pricing model for the contract. Contracts for gas must use SINGLE_RATE. Note that the detail for the enumeration values are:SINGLE_RATE: all energy usage is charged at a single unit rate no matter when it is consumed. Multiple unit rates may exist that correspond to varying volumes of usage i.e. a 'block' or 'step' tariff (first 50kWh @ X cents, next 50kWh at Y cents etc.)SINGLE_RATE_CONT_LOAD: as above, but with an additional, separate unit rate charged for all energy usage from a controlled load i.e. separately metered appliance like hot water service, pool pump etc.TIME_OF_USE: energy usage is charged at unit rates that vary dependent on time of day and day of week that the energy is consumedTIME_OF_USE_CONT_LOAD: as above, but with an additional, separate unit rate charged for all energy usage from a controlled load i.e. separately metered appliance like hot water service, pool pump etc.FLEXIBLE: energy usage is charged at unit rates that vary based on external factorsFLEXIBLE_CONT_LOAD: as above, but with an additional, separate unit rate charged for all energy usage from a controlled load i.e. separately metered appliance like hot water service, pool pump etc.QUOTA: all energy usage is charged at a single fixed rate, up to a specified usage quota/allowance. All excess usage beyond the allowance is then charged at a single unit rate. i.e. $50/month for up to 150kWh included usage.
|
| timeZone |
Enum |
conditional |
AEST |
Required if pricingModel is set to TIME_OF_USE. Defines the time zone to use for calculation of the time of use thresholds. Defaults to AEST if absent. |
| isFixed |
Boolean |
mandatory |
|
Flag indicating whether prices are fixed or variable. |
| variation |
string |
conditional |
|
Free text description of price variation policy and conditions for the contract. Mandatory if isFixed is false. |
| onExpiryDescription |
string |
optional |
|
Free text field that describes what will occur on or prior to expiry of the fixed contract term or benefit period. |
| paymentOption |
[Enum] |
mandatory |
|
Payment options for this contract. |
| intrinsicGreenPower |
object |
optional |
|
Describes intrinsic green power for the plan. If present then the plan includes a percentage of green power in the base plan. Should not be present for gas contracts. |
| » greenPercentage |
RateString |
mandatory |
|
Percentage of green power intrinsically included in the plan. |
| controlledLoad |
[EnergyPlanControlledLoadV2] |
conditional |
|
Required if pricing model is SINGLE_RATE_CONT_LOAD or TIME_OF_USE_CONT_LOAD or FLEXIBLE_CONT_LOAD. |
| incentives |
[EnergyPlanIncentives] |
optional |
|
Optional list of incentives available for the contract. |
| discounts |
[EnergyPlanDiscounts] |
optional |
|
Optional list of discounts available for the contract. |
| greenPowerCharges |
[EnergyPlanGreenPowerCharges] |
optional |
|
Optional list of charges applicable to green power. |
| eligibility |
[EnergyPlanEligibility] |
optional |
|
Eligibility restrictions or requirements. |
| fees |
[EnergyPlanFees] |
optional |
|
An array of fees applicable to the plan. |
| solarFeedInTariff |
[EnergyPlanSolarFeedInTariffV3] |
optional |
|
Array of feed in tariffs for solar power. |
| tariffPeriod |
[EnergyPlanTariffPeriodV2] |
mandatory |
|
Array of tariffs that apply to periods throughout the year. |
Enumerated Values
| Property |
Value |
| pricingModel |
SINGLE_RATE |
| pricingModel |
SINGLE_RATE_CONT_LOAD |
| pricingModel |
TIME_OF_USE |
| pricingModel |
TIME_OF_USE_CONT_LOAD |
| pricingModel |
FLEXIBLE |
| pricingModel |
FLEXIBLE_CONT_LOAD |
| pricingModel |
QUOTA |
| timeZone |
LOCAL |
| timeZone |
AEST |
| paymentOption |
PAPER_BILL |
| paymentOption |
CREDIT_CARD |
| paymentOption |
DIRECT_DEBIT |
| paymentOption |
BPAY |
| paymentOption |
OTHER |
EnergyPlanContractFullV3
{
"additionalFeeInformation": "string",
"pricingModel": "SINGLE_RATE",
"timeZone": "LOCAL",
"isFixed": true,
"variation": "string",
"onExpiryDescription": "string",
"paymentOption": [
"PAPER_BILL"
],
"intrinsicGreenPower": {
"greenPercentage": "string"
},
"controlledLoad": [
{
"displayName": "string",
"rateBlockUType": "singleRate",
"startDate": "string",
"endDate": "string",
"singleRate": {
"displayName": "string",
"description": "string",
"dailySupplyCharge": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "P1Y"
},
"timeOfUseRates": [
{
"displayName": "string",
"description": "string",
"dailySupplyCharge": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "P1Y",
"timeOfUse": [
{
"days": [
"SUN"
],
"startTime": "string",
"endTime": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
],
"type": "PEAK"
}
]
}
],
"incentives": [
{
"displayName": "string",
"description": "string",
"category": "GIFT",
"eligibility": "string"
}
],
"discounts": [
{
"displayName": "string",
"description": "string",
"type": "CONDITIONAL",
"category": "PAY_ON_TIME",
"endDate": "string",
"methodUType": "percentOfBill",
"percentOfBill": {
"rate": "string"
},
"percentOfUse": {
"rate": "string"
},
"fixedAmount": {
"amount": "string"
},
"percentOverThreshold": {
"rate": "string",
"usageAmount": "string"
}
}
],
"greenPowerCharges": [
{
"displayName": "string",
"description": "string",
"scheme": "GREENPOWER",
"type": "FIXED_PER_DAY",
"tiers": [
{
"percentGreen": "string",
"rate": "string",
"amount": "string"
}
]
}
],
"eligibility": [
{
"type": "EXISTING_CUST",
"information": "string",
"description": "string"
}
],
"fees": [
{
"type": "EXIT",
"term": "FIXED",
"amount": "string",
"rate": "string",
"description": "string"
}
],
"solarFeedInTariff": [
{
"displayName": "string",
"description": "string",
"startDate": "string",
"endDate": "string",
"scheme": "PREMIUM",
"payerType": "GOVERNMENT",
"tariffUType": "singleTariff",
"singleTariff": {
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "P1Y"
},
"timeVaryingTariffs": [
{
"type": "PEAK",
"displayName": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "P1Y",
"timeVariations": [
{
"days": [
"SUN"
],
"startTime": "string",
"endTime": "string"
}
]
}
]
}
],
"tariffPeriod": [
{
"type": "ENVIRONMENTAL",
"displayName": "string",
"startDate": "string",
"endDate": "string",
"dailySupplyChargeType": "SINGLE",
"dailySupplyCharge": "string",
"bandedDailySupplyCharges": [
{
"unitPrice": "string",
"measureUnit": "DAYS",
"volume": 0
}
],
"timeZone": "LOCAL",
"rateBlockUType": "singleRate",
"singleRate": {
"displayName": "string",
"description": "string",
"generalUnitPrice": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "string"
},
"timeOfUseRates": [
{
"displayName": "string",
"description": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "P1Y",
"timeOfUse": [
{
"days": [
"SUN"
],
"startTime": "string",
"endTime": "string"
}
],
"type": "PEAK"
}
],
"demandCharges": [
{
"displayName": "string",
"description": "string",
"amount": "string",
"measureUnit": "KWH",
"startTime": "string",
"endTime": "string",
"days": [
"SUN"
],
"minDemand": "0.00",
"maxDemand": "string",
"measurementPeriod": "DAY",
"chargePeriod": "DAY"
}
]
}
],
"termType": "1_YEAR",
"benefitPeriod": "string",
"terms": "string",
"meterTypes": [
"string"
],
"coolingOffDays": 0,
"billFrequency": [
"string"
]
}
Properties
allOf
and
| Name |
Type |
Required |
Default |
Description |
| anonymous |
object |
mandatory |
|
none |
| » termType |
Enum |
optional |
|
The term for the contract. If absent assumes no specified term. |
| » benefitPeriod |
string |
conditional |
|
Description of the benefit period. Should only be present if termType has the value ONGOING. |
| » terms |
string |
optional |
|
Free text description of the terms for the contract. |
| » meterTypes |
[string] |
optional |
|
An array of the meter types that this contract is available for. |
| » coolingOffDays |
PositiveInteger |
conditional |
|
Number of days in the cooling off period for the contract. Mandatory for plans with type of MARKET. |
| » billFrequency |
[string] |
mandatory |
|
An array of the available billing schedules for this contract. Formatted according to ISO 8601 Durations (excludes recurrence syntax). |
Enumerated Values
| Property |
Value |
| termType |
1_YEAR |
| termType |
2_YEAR |
| termType |
3_YEAR |
| termType |
4_YEAR |
| termType |
5_YEAR |
| termType |
ONGOING |
| termType |
OTHER |
EnergyPlanControlledLoadV2
{
"displayName": "string",
"rateBlockUType": "singleRate",
"startDate": "string",
"endDate": "string",
"singleRate": {
"displayName": "string",
"description": "string",
"dailySupplyCharge": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "P1Y"
},
"timeOfUseRates": [
{
"displayName": "string",
"description": "string",
"dailySupplyCharge": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "P1Y",
"timeOfUse": [
{
"days": [
"SUN"
],
"startTime": "string",
"endTime": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
],
"type": "PEAK"
}
]
}
Properties
| Name |
Type |
Required |
Default |
Description |
| displayName |
string |
mandatory |
|
A display name for the controlled load. |
| rateBlockUType |
Enum |
mandatory |
|
Specifies the type of controlled load rate. |
| startDate |
DateString |
optional |
|
Optional start date of the application of the controlled load rate. |
| endDate |
DateString |
optional |
|
Optional end date of the application of the controlled load rate. |
| singleRate |
object |
conditional |
|
Object representing a single controlled load rate. Required if rateBlockUType is singleRate. |
| » displayName |
string |
mandatory |
|
Display name of the controlled load rate. |
| » description |
string |
optional |
|
Description of the controlled load rate. |
| » dailySupplyCharge |
AmountString |
optional |
|
The daily supply charge (exclusive of GST) for this controlled load tier. |
| » rates |
[object] |
mandatory |
|
Array of controlled load rates in order of usage volume. |
| »» unitPrice |
AmountString |
mandatory |
|
Unit price of usage per measure unit (exclusive of GST). |
| »» measureUnit |
MeasureUnitEnum |
optional |
KWH |
The measurement unit of rate. Assumed to be KWH if absent. |
| »» volume |
number |
optional |
|
Volume in kWh that this rate applies to. Only applicable for 'stepped' rates where different rates apply for different volumes of usage in a period. |
| » period |
ExternalRef |
optional |
P1Y |
Usage period for which the block rate applies. Formatted according to ISO 8601 Durations (excludes recurrence syntax). Defaults to P1Y if absent. |
| timeOfUseRates |
[object] |
conditional |
|
Array of objects representing time of use rates. Required if rateBlockUType is timeOfUseRates. |
| » displayName |
string |
mandatory |
|
Display name of the controlled load rate. |
| » description |
string |
optional |
|
Description of the controlled load rate. |
| » dailySupplyCharge |
AmountString |
optional |
|
The daily supply charge (exclusive of GST) for this controlled load tier. |
| » rates |
[object] |
mandatory |
|
Array of controlled load rates in order of usage volume. |
| »» unitPrice |
AmountString |
mandatory |
|
Unit price of usage per measure unit (exclusive of GST). |
| »» measureUnit |
MeasureUnitEnum |
optional |
KWH |
The measurement unit of rate. Assumed to be KWH if absent. |
| »» volume |
number |
optional |
|
Volume in kWh that this rate applies to. Only applicable for 'stepped' rates where different rates apply for different volumes of usage in a period. |
| » period |
ExternalRef |
optional |
P1Y |
Usage period for which the block rate applies. Formatted according to ISO 8601 Durations (excludes recurrence syntax). Defaults to P1Y if absent. |
| » timeOfUse |
[object] |
mandatory |
|
Array of time windows for which this time of use rate applies. |
| »» days |
[EnergyDaysEnum] |
optional |
|
The days that this time window applies to. |
| »» startTime |
ExternalRef |
conditional |
|
The beginning of the time window per day for which the controlled load rate applies. Required if endTime provided. Formatted according to ISO 8601 Times. If the time is provided without a UTC offset, the time zone will be determined by the value of EnergyPlanContract.timeZone. |
| »» endTime |
ExternalRef |
conditional |
|
The end of the time window per day for which the controlled load rate applies. Required if startTime provided. Formatted according to ISO 8601 Times. If the time is provided without a UTC offset, the time zone will be determined by the value of EnergyPlanContract.timeZone. |
| »» additionalInfo |
string |
conditional |
|
Display text providing more information on the controlled load, for e.g., controlled load availability if specific day/time is not known. Required if startTime and endTime absent or if additionalInfoUri provided. |
| »» additionalInfoUri |
URIString |
optional |
|
Optional link to additional information regarding the controlled load. |
| » type |
Enum |
mandatory |
|
The type of usage that the rate applies to. |
Enumerated Values
| Property |
Value |
| rateBlockUType |
singleRate |
| rateBlockUType |
timeOfUseRates |
| type |
PEAK |
| type |
OFF_PEAK |
| type |
SHOULDER |
| type |
SOLAR_SPONGE |
EnergyPlanIncentives
{
"displayName": "string",
"description": "string",
"category": "GIFT",
"eligibility": "string"
}
Properties
| Name |
Type |
Required |
Default |
Description |
| displayName |
string |
mandatory |
|
The display name of the incentive. |
| description |
string |
mandatory |
|
The description of the incentive. |
| category |
Enum |
mandatory |
|
The type of the incentive. |
| eligibility |
string |
optional |
|
A display message outlining an eligibility criteria that may apply. |
Enumerated Values
| Property |
Value |
| category |
GIFT |
| category |
ACCOUNT_CREDIT |
| category |
OTHER |
EnergyPlanDiscounts
{
"displayName": "string",
"description": "string",
"type": "CONDITIONAL",
"category": "PAY_ON_TIME",
"endDate": "string",
"methodUType": "percentOfBill",
"percentOfBill": {
"rate": "string"
},
"percentOfUse": {
"rate": "string"
},
"fixedAmount": {
"amount": "string"
},
"percentOverThreshold": {
"rate": "string",
"usageAmount": "string"
}
}
Properties
| Name |
Type |
Required |
Default |
Description |
| displayName |
string |
mandatory |
|
The display name of the discount. |
| description |
string |
optional |
|
The description of the discount. |
| type |
Enum |
mandatory |
|
The type of the discount. |
| category |
Enum |
optional |
|
The type of the discount. Mandatory if the discount type is CONDITIONAL. |
| endDate |
DateString |
optional |
|
Optional end date for the discount after which the discount is no longer available. |
| methodUType |
Enum |
mandatory |
|
The method of calculation of the discount. |
| percentOfBill |
object |
conditional |
|
Required if methodUType is percentOfBill. |
| » rate |
RateString |
mandatory |
|
The rate of the discount applied to the bill amount. |
| percentOfUse |
object |
conditional |
|
Required if methodUType is percentOfUse. |
| » rate |
RateString |
mandatory |
|
The rate of the discount applied to the usageamount. |
| fixedAmount |
object |
conditional |
|
Required if methodUType is fixedAmount. |
| » amount |
AmountString |
mandatory |
|
The amount of the discount. |
| percentOverThreshold |
object |
conditional |
|
Required if methodUType is percentOverThreshold. |
| » rate |
RateString |
mandatory |
|
The rate of the discount over the usage amount. |
| » usageAmount |
AmountString |
mandatory |
|
The usage amount threshold above which the discount applies. |
Enumerated Values
| Property |
Value |
| type |
CONDITIONAL |
| type |
GUARANTEED |
| type |
OTHER |
| category |
PAY_ON_TIME |
| category |
DIRECT_DEBIT |
| category |
GUARANTEED_DISCOUNT |
| category |
OTHER |
| methodUType |
percentOfBill |
| methodUType |
percentOfUse |
| methodUType |
fixedAmount |
| methodUType |
percentOverThreshold |
EnergyPlanGreenPowerCharges
{
"displayName": "string",
"description": "string",
"scheme": "GREENPOWER",
"type": "FIXED_PER_DAY",
"tiers": [
{
"percentGreen": "string",
"rate": "string",
"amount": "string"
}
]
}
Properties
| Name |
Type |
Required |
Default |
Description |
| displayName |
string |
mandatory |
|
The display name of the charge. |
| description |
string |
optional |
|
The description of the charge. |
| scheme |
Enum |
mandatory |
|
The applicable green power scheme. |
| type |
Enum |
mandatory |
|
The type of charge. |
| tiers |
[object] |
mandatory |
|
Array of charge tiers based on the percentage of green power used for the period implied by the type. Array is in order of increasing percentage of green power. |
| » percentGreen |
RateString |
mandatory |
|
The upper percentage of green power used applicable for this tier. |
| » rate |
RateString |
conditional |
|
The rate of the charge if the type implies the application of a rate. |
| » amount |
AmountString |
conditional |
|
The amount of the charge if the type implies the application of a fixed amount. |
Enumerated Values
| Property |
Value |
| scheme |
GREENPOWER |
| scheme |
OTHER |
| type |
FIXED_PER_DAY |
| type |
FIXED_PER_WEEK |
| type |
FIXED_PER_MONTH |
| type |
FIXED_PER_UNIT |
| type |
PERCENT_OF_USE |
| type |
PERCENT_OF_BILL |
EnergyPlanEligibility
{
"type": "EXISTING_CUST",
"information": "string",
"description": "string"
}
Properties
| Name |
Type |
Required |
Default |
Description |
| type |
Enum |
mandatory |
|
The type of the eligibility restriction.
The CONTINGENT_PLAN value indicates that the plan is contingent on the customer taking up an alternate fuel plan from the same retailer (for instance, if the fuelType is ELECTRICITY then a GAS plan from the same retailer must be taken up). |
| information |
string |
mandatory |
|
Information of the eligibility restriction specific to the type of the restriction. |
| description |
string |
optional |
|
A description of the eligibility restriction. |
Enumerated Values
| Property |
Value |
| type |
EXISTING_CUST |
| type |
EXISTING_POOL |
| type |
EXISTING_SOLAR |
| type |
EXISTING_BATTERY |
| type |
EXISTING_SMART_METER |
| type |
EXISTING_BASIC_METER |
| type |
SENIOR_CARD |
| type |
SMALL_BUSINESS |
| type |
NO_SOLAR_FIT |
| type |
NEW_CUSTOMER |
| type |
ONLINE_ONLY |
| type |
REQ_EQUIP_SUPPLIER |
| type |
THIRD_PARTY_ONLY |
| type |
SPORT_CLUB_MEMBER |
| type |
ORG_MEMBER |
| type |
SPECIFIC_LOCATION |
| type |
MINIMUM_USAGE |
| type |
LOYALTY_MEMBER |
| type |
GROUP_BUY_MEMBER |
| type |
CONTINGENT_PLAN |
| type |
OTHER |
EnergyPlanFees
{
"type": "EXIT",
"term": "FIXED",
"amount": "string",
"rate": "string",
"description": "string"
}
Properties
| Name |
Type |
Required |
Default |
Description |
| type |
Enum |
mandatory |
|
The type of the fee. |
| term |
Enum |
mandatory |
|
The term of the fee. |
| amount |
AmountString |
conditional |
|
The fee amount. Required if term is not PERCENT_OF_BILL. |
| rate |
RateString |
conditional |
|
The fee rate. Required if term is PERCENT_OF_BILL. |
| description |
string |
optional |
|
A description of the fee. |
Enumerated Values
| Property |
Value |
| type |
EXIT |
| type |
ESTABLISHMENT |
| type |
LATE_PAYMENT |
| type |
DISCONNECTION |
| type |
DISCONNECT_MOVE_OUT |
| type |
DISCONNECT_NON_PAY |
| type |
RECONNECTION |
| type |
CONNECTION |
| type |
PAYMENT_PROCESSING |
| type |
CC_PROCESSING |
| type |
CHEQUE_DISHONOUR |
| type |
DD_DISHONOUR |
| type |
MEMBERSHIP |
| type |
CONTRIBUTION |
| type |
PAPER_BILL |
| type |
OTHER |
| term |
FIXED |
| term |
1_YEAR |
| term |
2_YEAR |
| term |
3_YEAR |
| term |
4_YEAR |
| term |
5_YEAR |
| term |
PERCENT_OF_BILL |
| term |
ANNUAL |
| term |
DAILY |
| term |
WEEKLY |
| term |
MONTHLY |
| term |
BIANNUAL |
| term |
VARIABLE |
EnergyPlanSolarFeedInTariffV3
{
"displayName": "string",
"description": "string",
"startDate": "string",
"endDate": "string",
"scheme": "PREMIUM",
"payerType": "GOVERNMENT",
"tariffUType": "singleTariff",
"singleTariff": {
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "P1Y"
},
"timeVaryingTariffs": [
{
"type": "PEAK",
"displayName": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "P1Y",
"timeVariations": [
{
"days": [
"SUN"
],
"startTime": "string",
"endTime": "string"
}
]
}
]
}
Properties
| Name |
Type |
Required |
Default |
Description |
| displayName |
string |
mandatory |
|
The name of the tariff. |
| description |
string |
optional |
|
A description of the tariff. |
| startDate |
DateString |
optional |
|
The start date of the application of the feed in tariff. |
| endDate |
DateString |
optional |
|
The end date of the application of the feed in tariff. |
| scheme |
Enum |
mandatory |
|
The applicable scheme. |
| payerType |
Enum |
mandatory |
|
The type of the payer. |
| tariffUType |
Enum |
mandatory |
|
Reference to the applicable tariff structure. |
| singleTariff |
object |
conditional |
|
Represents a constant tariff. Mandatory if tariffUType is set to singleTariff. |
| » rates |
[object] |
mandatory |
|
Array of feed in rates. |
| »» unitPrice |
AmountString |
mandatory |
|
Unit price of usage per measure unit (exclusive of GST). |
| »» measureUnit |
MeasureUnitEnum |
optional |
KWH |
The measurement unit of rate. Assumed to be KWH if absent. |
| »» volume |
number |
optional |
|
Volume that this rate applies to. Only applicable for 'stepped' rates where different rates apply for different volumes of usage in a period. |
| » period |
ExternalRef |
optional |
P1Y |
Usage period for which the block rate applies. Formatted according to ISO 8601 Durations (excludes recurrence syntax). Defaults to P1Y if absent. |
| timeVaryingTariffs |
[object] |
conditional |
|
Represents a tariff based on time of day. Mandatory if tariffUType is set to timeVaryingTariffs. |
| » type |
Enum |
optional |
|
The type of the charging time period. If absent applies to all periods. |
| » displayName |
string |
mandatory |
|
Display name of the tariff. |
| » rates |
[object] |
optional |
|
Array of feed in rates. |
| »» unitPrice |
AmountString |
mandatory |
|
Unit price of usage per measure unit (exclusive of GST). |
| »» measureUnit |
MeasureUnitEnum |
optional |
KWH |
The measurement unit of rate. Assumed to be KWH if absent. |
| »» volume |
number |
optional |
|
Volume that this rate applies to. Only applicable for 'stepped' rates where different rates apply for different volumes of usage in a period. |
| » period |
ExternalRef |
optional |
P1Y |
Usage period for which the block rate applies. Formatted according to ISO 8601 Durations (excludes recurrence syntax). Defaults to P1Y if absent. |
| » timeVariations |
[object] |
mandatory |
|
Array of time windows for which this tariff is applicable. |
| »» days |
[EnergyDaysEnum] |
mandatory |
|
The days that this time window applies to. At least one entry required. |
| »» startTime |
ExternalRef |
optional |
|
The beginning of the time window per day for which the tariff applies. If absent assumes start of day (i.e. midnight). Formatted according to ISO 8601 Times. If the time is provided without a UTC offset, the time zone will be determined by the value of EnergyPlanContract.timeZone. |
| »» endTime |
ExternalRef |
optional |
|
The end of the time window per day for which the tariff applies. If absent assumes end of day (i.e. one second before midnight). Formatted according to ISO 8601 Times. If the time is provided without a UTC offset, the time zone will be determined by the value of EnergyPlanContract.timeZone. |
Enumerated Values
| Property |
Value |
| scheme |
PREMIUM |
| scheme |
CURRENT |
| scheme |
VARIABLE |
| scheme |
OTHER |
| payerType |
GOVERNMENT |
| payerType |
RETAILER |
| tariffUType |
singleTariff |
| tariffUType |
timeVaryingTariffs |
| type |
PEAK |
| type |
OFF_PEAK |
| type |
SHOULDER |
EnergyPlanTariffPeriodV2
{
"type": "ENVIRONMENTAL",
"displayName": "string",
"startDate": "string",
"endDate": "string",
"dailySupplyChargeType": "SINGLE",
"dailySupplyCharge": "string",
"bandedDailySupplyCharges": [
{
"unitPrice": "string",
"measureUnit": "DAYS",
"volume": 0
}
],
"timeZone": "LOCAL",
"rateBlockUType": "singleRate",
"singleRate": {
"displayName": "string",
"description": "string",
"generalUnitPrice": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "string"
},
"timeOfUseRates": [
{
"displayName": "string",
"description": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "P1Y",
"timeOfUse": [
{
"days": [
"SUN"
],
"startTime": "string",
"endTime": "string"
}
],
"type": "PEAK"
}
],
"demandCharges": [
{
"displayName": "string",
"description": "string",
"amount": "string",
"measureUnit": "KWH",
"startTime": "string",
"endTime": "string",
"days": [
"SUN"
],
"minDemand": "0.00",
"maxDemand": "string",
"measurementPeriod": "DAY",
"chargePeriod": "DAY"
}
]
}
Properties
| Name |
Type |
Required |
Default |
Description |
| type |
Enum |
optional |
OTHER |
Type of charge. Assumed to be OTHER if absent. |
| displayName |
string |
mandatory |
|
The name of the tariff period. |
| startDate |
string |
mandatory |
|
The start date of the tariff period in a calendar year. Formatted in mm-dd format. |
| endDate |
string |
mandatory |
|
The end date of the tariff period in a calendar year. Formatted in mm-dd format. |
| dailySupplyChargeType |
Enum |
optional |
|
Specifies if daily supply charge is single or banded. |
| dailySupplyCharge |
AmountString |
conditional |
|
The amount of access charge for the tariff period, in dollars per day exclusive of GST. Mandatory if dailySupplyChargeType is SINGLE. |
| bandedDailySupplyCharges |
[object] |
conditional |
|
Array representing banded daily supply charge rates. Mandatory if dailySupplyChargeType is BAND. |
| » unitPrice |
AmountString |
mandatory |
|
The amount of daily supply charge for the band, in dollars per day exclusive of GST. |
| » measureUnit |
MeasureUnitEnum |
optional |
DAYS |
The measurement unit of rate. Assumed to be DAYS if absent. |
| » volume |
number |
optional |
|
Volume the charge applies to. |
| timeZone |
Enum |
optional |
|
Specifies the charge specific time zone for calculation of the time of use thresholds. If absent, timezone value in EnergyPlanContract is assumed. |
| rateBlockUType |
Enum |
mandatory |
|
Specifies the type of rate applicable to this tariff period. |
| singleRate |
object |
conditional |
|
Object representing a single rate. Required if rateBlockUType is singleRate. |
| » displayName |
string |
mandatory |
|
Display name of the rate. |
| » description |
string |
optional |
|
Description of the rate. |
| » generalUnitPrice |
AmountString |
conditional |
|
The block rate (unit price) for any usage above the included fixed usage, in dollars per kWh inclusive of GST. Only required if pricingModel field is QUOTA. |
| » rates |
[object] |
mandatory |
|
Array of rates in order of usage volume. |
| »» unitPrice |
AmountString |
mandatory |
|
Unit price of usage per measure unit (exclusive of GST). |
| »» measureUnit |
MeasureUnitEnum |
optional |
KWH |
The measurement unit of rate. Assumed to be KWH if absent. |
| »» volume |
number |
optional |
|
Volume in kWh that this rate applies to. Only applicable for 'stepped' rates where different rates apply for different volumes of usage in a period. |
| » period |
ExternalRef |
optional |
|
Usage period for which the block rate applies. Formatted according to ISO 8601 Durations (excludes recurrence syntax). |
| timeOfUseRates |
[object] |
conditional |
|
Array of objects representing time of use rates that apply throughout the tariffPeriod. Required if rateBlockUType is timeOfUseRates. |
| » displayName |
string |
mandatory |
|
Display name of the rate. |
| » description |
string |
optional |
|
Description of the rate. |
| » rates |
[object] |
mandatory |
|
Array of rates in order of usage volume. |
| »» unitPrice |
AmountString |
mandatory |
|
Unit price of usage per measure unit (exclusive of GST). |
| »» measureUnit |
MeasureUnitEnum |
optional |
KWH |
The measurement unit of rate. Assumed to be KWH if absent. |
| »» volume |
number |
optional |
|
Volume in kWh that this rate applies to. Only applicable for 'stepped' rates where different rates apply for different volumes of usage in a period. |
| » period |
ExternalRef |
optional |
P1Y |
Usage period for which the block rate applies. Formatted according to ISO 8601 Durations (excludes recurrence syntax). Defaults to P1Y if absent. |
| » timeOfUse |
[object] |
mandatory |
|
Array of time windows for which this time of use rate applies. |
| »» days |
[EnergyDaysEnum] |
mandatory |
|
The days that this time window applies to. |
| »» startTime |
ExternalRef |
mandatory |
|
The beginning of the time window per day for which the rate applies. Formatted according to ISO 8601 Times. If the time is provided without a UTC offset, the time zone will be determined by the value of EnergyPlanContract.timeZone. |
| »» endTime |
ExternalRef |
mandatory |
|
The end of the time window per day for which the rate applies. Formatted according to ISO 8601 Times. If the time is provided without a UTC offset, the time zone will be determined by the value of EnergyPlanContract.timeZone. |
| » type |
Enum |
mandatory |
|
The type of usage that the rate applies to. |
| demandCharges |
[object] |
conditional |
|
Array of demand charges. Required if rateBlockUType is demandCharges. |
| » displayName |
string |
mandatory |
|
Display name of the charge. |
| » description |
string |
optional |
|
Description of the charge. |
| » amount |
AmountString |
mandatory |
|
The charge amount per measure unit exclusive of GST. |
| » measureUnit |
MeasureUnitEnum |
optional |
KWH |
The measurement unit of charge amount. Assumed to be KWH if absent. |
| » startTime |
ExternalRef |
mandatory |
|
Start of the period. Formatted according to ISO 8601 Times. If the time is provided without a UTC offset, the time zone will be determined by the value of EnergyPlanContract.timeZone. |
| » endTime |
ExternalRef |
mandatory |
|
End of the period. Formatted according to ISO 8601 Times. If the time is provided without a UTC offset, the time zone will be determined by the value of EnergyPlanContract.timeZone. |
| » days |
[EnergyDaysEnum] |
optional |
|
The days that the demand tariff applies to. |
| » minDemand |
AmountString |
optional |
0.00 |
Minimum demand for this demand tariff in kW. If absent then 0.00 is assumed. |
| » maxDemand |
AmountString |
optional |
|
Maximum demand for this demand tariff in kW. If present, must be higher than the value of the minDemand field. |
| » measurementPeriod |
Enum |
mandatory |
|
Application period for the demand tariff. |
| » chargePeriod |
Enum |
mandatory |
|
Charge period for the demand tariff. |
Enumerated Values
| Property |
Value |
| type |
ENVIRONMENTAL |
| type |
REGULATED |
| type |
NETWORK |
| type |
METERING |
| type |
RETAIL_SERVICE |
| type |
RCTI |
| type |
OTHER |
| dailySupplyChargeType |
SINGLE |
| dailySupplyChargeType |
BAND |
| timeZone |
LOCAL |
| timeZone |
AEST |
| rateBlockUType |
singleRate |
| rateBlockUType |
timeOfUseRates |
| rateBlockUType |
demandCharges |
| type |
PEAK |
| type |
OFF_PEAK |
| type |
SHOULDER |
| type |
SHOULDER1 |
| type |
SHOULDER2 |
| measurementPeriod |
DAY |
| measurementPeriod |
MONTH |
| measurementPeriod |
TARIFF_PERIOD |
| chargePeriod |
DAY |
| chargePeriod |
MONTH |
| chargePeriod |
TARIFF_PERIOD |
EnergyDaysEnum
"SUN"
Properties
| Name |
Type |
Required |
Default |
Description |
| anonymous |
Enum |
mandatory |
|
none |
Enumerated Values
| Property |
Value |
| anonymous |
SUN |
| anonymous |
MON |
| anonymous |
TUE |
| anonymous |
WED |
| anonymous |
THU |
| anonymous |
FRI |
| anonymous |
SAT |
| anonymous |
PUBLIC_HOLIDAYS |
EnergyServicePointV2
{
"servicePointId": "string",
"nationalMeteringId": "string",
"servicePointClassification": "EXTERNAL_PROFILE",
"servicePointStatus": "ACTIVE",
"jurisdictionCode": "ALL",
"isGenerator": false,
"validFromDate": "string",
"lastUpdateDateTime": "string",
"lastConsumerChangeDate": "string",
"consumerProfile": {
"classification": "BUSINESS",
"threshold": "LOW"
}
}
Properties
| Name |
Type |
Required |
Default |
Description |
| servicePointId |
EnergyServicePointId |
mandatory |
|
Unique identifier for the service point. |
| nationalMeteringId |
string |
mandatory |
|
The independent ID of the service point, known in the industry as the NMI. |
| servicePointClassification |
Enum |
mandatory |
|
The classification of the service point as defined in MSATS procedures. |
| servicePointStatus |
Enum |
mandatory |
|
Code used to indicate the status of the service point. Note the details for the enumeration values below:ACTIVE: An active, energised, service pointDE_ENERGISED: The service point exists but is deenergisedEXTINCT: The service point has been permanently decommissionedGREENFIELD: Applies to a service point that has never been energisedOFF_MARKET: Applies when the service point is no longer settled in the NEM.
|
| jurisdictionCode |
Enum |
mandatory |
|
Jurisdiction code to which the service point belongs.This code defines the jurisdictional rules which apply to the service point. Note the details of enumeration values below:ALL: All JurisdictionsACT: Australian Capital TerritoryNEM: National Electricity MarketNSW: New South WalesQLD: QueenslandSA: South AustraliaTAS: TasmaniaVIC: Victoria.
|
| isGenerator |
Boolean |
optional |
false |
This flag determines whether the energy at this connection point is to be treated as consumer load or as a generating unit (this may include generator auxiliary loads). If absent defaults to false.
Note: Only applicable for scheduled or semischeduled generators, does not indicate on site generation by consumer. |
| validFromDate |
DateString |
mandatory |
|
The latest start date from which the constituent data sets of this service point became valid. |
| lastUpdateDateTime |
DateTimeString |
mandatory |
|
The date and time that the information for this service point was modified. |
| lastConsumerChangeDate |
DateString |
optional |
|
The date the account holder changed for the NMI. |
| consumerProfile |
object |
optional |
|
none |
| » classification |
Enum |
optional |
|
A code that defines the consumer class as defined in the National Energy Retail Regulations, or in overriding Jurisdictional instruments. |
| » threshold |
Enum |
optional |
|
A code that defines the consumption threshold as defined in the National Energy Retail Regulations, or in overriding Jurisdictional instruments. Note the details of enumeration values below: LOW: Consumption is less than the 'lower consumption threshold' as defined in the National Energy Retail RegulationsMEDIUM: Consumption is equal to or greater than the 'lower consumption threshold', but less than the 'upper consumption threshold', as defined in the National Energy Retail RegulationsHIGH: Consumption is equal to or greater than the 'upper consumption threshold' as defined in the National Energy Retail Regulations.
|
Enumerated Values
| Property |
Value |
| servicePointClassification |
EXTERNAL_PROFILE |
| servicePointClassification |
GENERATOR |
| servicePointClassification |
LARGE |
| servicePointClassification |
SMALL |
| servicePointClassification |
WHOLESALE |
| servicePointClassification |
NON_CONTEST_UNMETERED_LOAD |
| servicePointClassification |
NON_REGISTERED_EMBEDDED_GENERATOR |
| servicePointClassification |
DISTRIBUTION_WHOLESALE |
| servicePointStatus |
ACTIVE |
| servicePointStatus |
DE_ENERGISED |
| servicePointStatus |
EXTINCT |
| servicePointStatus |
GREENFIELD |
| servicePointStatus |
OFF_MARKET |
| jurisdictionCode |
ALL |
| jurisdictionCode |
ACT |
| jurisdictionCode |
NEM |
| jurisdictionCode |
NSW |
| jurisdictionCode |
QLD |
| jurisdictionCode |
SA |
| jurisdictionCode |
TAS |
| jurisdictionCode |
VIC |
| classification |
BUSINESS |
| classification |
RESIDENTIAL |
| threshold |
LOW |
| threshold |
MEDIUM |
| threshold |
HIGH |
EnergyServicePointDetailV2
{
"servicePointId": "string",
"nationalMeteringId": "string",
"servicePointClassification": "EXTERNAL_PROFILE",
"servicePointStatus": "ACTIVE",
"jurisdictionCode": "ALL",
"isGenerator": false,
"validFromDate": "string",
"lastUpdateDateTime": "string",
"lastConsumerChangeDate": "string",
"consumerProfile": {
"classification": "BUSINESS",
"threshold": "LOW"
},
"distributionLossFactor": {
"code": "string",
"description": "string",
"lossValue": "string"
},
"relatedParticipants": [
{
"party": "string",
"role": "FRMP"
}
],
"location": {
"addressUType": "paf",
"simple": {
"mailingName": "string",
"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"postcode": "string",
"city": "string",
"state": "string",
"country": "AUS"
},
"paf": {
"dpid": "string",
"thoroughfareNumber1": 0,
"thoroughfareNumber1Suffix": "string",
"thoroughfareNumber2": 0,
"thoroughfareNumber2Suffix": "string",
"flatUnitType": "string",
"flatUnitNumber": "string",
"floorLevelType": "string",
"floorLevelNumber": "string",
"lotNumber": "string",
"buildingName1": "string",
"buildingName2": "string",
"streetName": "string",
"streetType": "string",
"streetSuffix": "string",
"postalDeliveryType": "string",
"postalDeliveryNumber": 0,
"postalDeliveryNumberPrefix": "string",
"postalDeliveryNumberSuffix": "string",
"localityName": "string",
"postcode": "string",
"state": "string"
}
},
"meters": [
{
"meterId": "string",
"specifications": {
"status": "CURRENT",
"installationType": "BASIC",
"manufacturer": "string",
"model": "string",
"readType": "string",
"nextScheduledReadDate": "string"
},
"registers": [
{
"registerId": "string",
"registerSuffix": "string",
"averagedDailyLoad": 0,
"registerConsumptionType": "INTERVAL",
"networkTariffCode": "string",
"unitOfMeasure": "string",
"timeOfDay": "ALLDAY",
"multiplier": 0,
"controlledLoad": true,
"consumptionType": "ACTUAL"
}
]
}
]
}
Properties
allOf
and
| Name |
Type |
Required |
Default |
Description |
| anonymous |
object |
mandatory |
|
none |
| » distributionLossFactor |
object |
mandatory |
|
none |
| »» code |
string |
mandatory |
|
A code used to identify data loss factor for the service point values. Refer to AEMO distribution loss factor documents for each financial year to interpret. |
| »» description |
string |
mandatory |
|
Description of the data loss factor code and value. |
| »» lossValue |
string |
mandatory |
|
The value associated with the loss factor code. |
| » relatedParticipants |
[object] |
mandatory |
|
none |
| »» party |
string |
mandatory |
|
The name of the party/organisation related to this service point. |
| »» role |
Enum |
mandatory |
|
The role performed by this participant in relation to the service point. Note the details of enumeration values below: FRMP: Financially Responsible Market ParticipantLNSP: Local Network Service Provider or Embedded Network Manager for child connection pointsDRSP: wholesale Demand Response and/or market ancillary Service Provider and note that where it is not relevant for a NMI it will not be included.
|
| » location |
CommonPhysicalAddress |
mandatory |
|
Location of the servicepoint. |
| » meters |
[object] |
optional |
|
The meters associated with the service point. This may be empty where there are no meters physically installed at the service point. |
| »» meterId |
string |
mandatory |
|
The meter ID uniquely identifies a meter for a given service point. It is unique in the context of the service point. It is not globally unique. |
| »» specifications |
object |
mandatory |
|
Technical characteristics of the meter. |
| »»» status |
Enum |
mandatory |
|
A code to denote the status of the meter. Note the details of enumeration values below: CURRENT: Applies when a meter is current and not disconnectedDISCONNECTED: Applies when a meter is present but has been remotely disconnected.
|
| »»» installationType |
Enum |
mandatory |
|
The metering Installation type code indicates whether the metering installation has to be manually read. Note the details of enumeration values below: BASIC: Accumulation Meter – Type 6COMMS1: Interval Meter with communications – Type 1COMMS2: Interval Meter with communications – Type 2COMMS3: Interval Meter with communications – Type 3COMMS4: Interval Meter with communications – Type 4COMMS4C: CT connected metering installation that meets the minimum services specificationsCOMMS4D: Whole current metering installation that meets the minimum services specificationsMRAM: Small customer metering installation – Type 4AMRIM: Manually Read Interval Meter – Type 5UMCP: Unmetered Supply – Type 7VICAMI: A relevant metering installation as defined in clause 9.9C of the NERNCONUML: Non-contestable unmeter load - Introduced as part of Global Settlement.
|
| »»» manufacturer |
string |
optional |
|
Free text field to identify the manufacturer of the installed meter. |
| »»» model |
string |
optional |
|
Free text field to identify the meter manufacturer's designation for the meter model. |
| »»» readType |
string |
optional |
|
Code to denote the method and frequency of Meter Reading. The value is formatted as follows: - First Character = Remote (
R) or Manual (M) - Second Character = Mode:
T = telephone, W = wireless, P = powerline, I = infra-red, G = galvanic, V = visual - Third Character = Frequency of Scheduled Meter Readings:
1 = Twelve times per year, 2 = Six times per year, 3 = Four times per year, D = Daily or weekly - Optional Fourth Character = to identify what interval length the meter is capable of reading. This includes five, 15 and 30 minute granularity as the following:
A = 5 minute, B = 15 minute, C = 30 minute, D = Cannot convert to 5 minute (i.e. due to metering installation de-energised), M = Manually Read Accumulation Meter.
For example, MV3 = Manual, Visual, QuarterlyMV3M = Manual, Visual, Quarterly, Manually Read Accumulation MeterRWDC = Remote, Wireless, Daily, 30 minutes interval.
|
| »»» nextScheduledReadDate |
DateString |
optional |
|
This date is the next scheduled meter read date (NSRD) if a manual Meter Reading is required. |
| »» registers |
[object] |
optional |
|
Usage data registers available from the meter. This may be empty where there are no meters physically installed at the service point. |
| »»» registerId |
string |
mandatory |
|
Unique identifier of the register within this service point. Is not globally unique. |
| »»» registerSuffix |
string |
optional |
|
Register suffix of the meter register where the meter reads are obtained. |
| »»» averagedDailyLoad |
number |
optional |
|
The energy delivered through a connection point or metering point over an extended period normalised to a 'per day' basis (kWh). This value is calculated annually. |
| »»» registerConsumptionType |
Enum |
mandatory |
|
Indicates the consumption type of register. |
| »»» networkTariffCode |
string |
optional |
|
The Network Tariff Code is a free text field containing a code supplied and published by the local network service provider. |
| »»» unitOfMeasure |
string |
optional |
|
The unit of measure for data held in this register. |
| »»» timeOfDay |
Enum |
optional |
|
Code to identify the time validity of register contents. |
| »»» multiplier |
number |
optional |
|
Multiplier required to take a register value and turn it into a value representing billable energy. |
| »»» controlledLoad |
Boolean |
optional |
|
Indicates whether the energy recorded by this register is created under a Controlled Load regime. |
| »»» consumptionType |
Enum |
optional |
|
Actual/Subtractive Indicator. Note the details of enumeration values below: ACTUAL: implies volume of energy actually metered between two datesCUMULATIVE: indicates a meter reading for a specific date. A second Meter Reading is required to determine the consumption between those two Meter Reading dates.
|
Enumerated Values
| Property |
Value |
| role |
FRMP |
| role |
LNSP |
| role |
DRSP |
| status |
CURRENT |
| status |
DISCONNECTED |
| installationType |
BASIC |
| installationType |
COMMS1 |
| installationType |
COMMS2 |
| installationType |
COMMS3 |
| installationType |
COMMS4 |
| installationType |
COMMS4C |
| installationType |
COMMS4D |
| installationType |
MRAM |
| installationType |
MRIM |
| installationType |
PROF |
| installationType |
SAMPLE |
| installationType |
UMCP |
| installationType |
VICAMI |
| installationType |
NCOLNUML |
| registerConsumptionType |
INTERVAL |
| registerConsumptionType |
BASIC |
| registerConsumptionType |
PROFILE_DATA |
| registerConsumptionType |
ACTIVE_IMPORT |
| registerConsumptionType |
ACTIVE |
| registerConsumptionType |
REACTIVE_IMPORT |
| registerConsumptionType |
REACTIVE |
| timeOfDay |
ALLDAY |
| timeOfDay |
INTERVAL |
| timeOfDay |
PEAK |
| timeOfDay |
BUSINESS |
| timeOfDay |
SHOULDER |
| timeOfDay |
EVENING |
| timeOfDay |
OFFPEAK |
| timeOfDay |
CONTROLLED |
| timeOfDay |
DEMAND |
| consumptionType |
ACTUAL |
| consumptionType |
CUMULATIVE |
EnergyUsageRead
{
"servicePointId": "string",
"registerId": "string",
"registerSuffix": "string",
"meterId": "string",
"controlledLoad": true,
"readStartDate": "string",
"readEndDate": "string",
"unitOfMeasure": "string",
"readUType": "basicRead",
"basicRead": {
"quality": "ACTUAL",
"value": 0
},
"intervalRead": {
"readIntervalLength": 0,
"aggregateValue": 0,
"intervalReads": [
0
],
"readQualities": [
{
"startInterval": 1,
"endInterval": 1,
"quality": "SUBSTITUTE"
}
]
}
}
Properties
| Name |
Type |
Required |
Default |
Description |
| servicePointId |
EnergyServicePointId |
mandatory |
|
Unique identifier for the service point. |
| registerId |
string |
optional |
|
Register ID of the meter register where the meter reads are obtained. |
| registerSuffix |
string |
mandatory |
|
Register suffix of the meter register where the meter reads are obtained. |
| meterId |
string |
optional |
|
Meter id/serial number as it appears in customer's bill. ID permanence rules do not apply. |
| controlledLoad |
Boolean |
optional |
|
Indicates whether the energy recorded by this register is created under a Controlled Load regime. |
| readStartDate |
DateString |
mandatory |
|
Date when the meter reads start in AEST and assumed to start from 12:00am AEST. |
| readEndDate |
DateString |
optional |
|
Date when the meter reads end in AEST. If absent then assumed to be equal to readStartDate. In this case the entry represents data for a single date specified by readStartDate. |
| unitOfMeasure |
ExternalRef |
optional |
|
Unit of measure of the meter reads. Refer to Appendix B of MDFF Specification NEM12 NEM13 v2.1 for a list of possible values. |
| readUType |
Enum |
mandatory |
|
Specify the type of the meter read data. |
| basicRead |
object |
conditional |
|
Mandatory if readUType is set to basicRead. |
| » quality |
Enum |
optional |
ACTUAL |
The quality of the read taken. If absent then assumed to be ACTUAL. |
| » value |
number |
mandatory |
|
Meter read value. If positive then it means consumption, if negative it means export. |
| intervalRead |
object |
conditional |
|
Mandatory if readUType is set to intervalRead. |
| » readIntervalLength |
PositiveInteger |
conditional |
|
Read interval length in minutes. Required when interval-reads query parameter equals FULL or MIN_30. |
| » aggregateValue |
number |
mandatory |
|
The aggregate sum of the interval read values. If positive then it means net consumption, if negative it means net export. |
| » intervalReads |
[number] |
conditional |
|
Array of Interval read values. If positive then it means consumption, if negative it means export. Required when interval-reads query parameter equals FULL or MIN_30.
Each read value indicates the read for the interval specified by readIntervalLength beginning at midnight of readStartDate (for example 00:00 to 00:30 would be the first reading in a 30 minute Interval). |
| » readQualities |
[object] |
conditional |
|
Specifies quality of reads that are not ACTUAL. For read indices that are not specified, quality is assumed to be ACTUAL. If not present, all quality of all reads are assumed to be actual. Required when interval-reads query parameter equals FULL or MIN_30. |
| »» startInterval |
PositiveInteger |
mandatory |
|
Start interval for read quality flag. First read begins at 1. |
| »» endInterval |
PositiveInteger |
mandatory |
|
End interval for read quality flag. |
| »» quality |
Enum |
mandatory |
|
The quality of the read taken. |
Enumerated Values
| Property |
Value |
| readUType |
basicRead |
| readUType |
intervalRead |
| quality |
ACTUAL |
| quality |
SUBSTITUTE |
| quality |
FINAL_SUBSTITUTE |
| quality |
SUBSTITUTE |
| quality |
FINAL_SUBSTITUTE |
EnergyDerRecord
{
"servicePointId": "string",
"approvedCapacity": 0,
"availablePhasesCount": 3,
"installedPhasesCount": 3,
"islandableInstallation": true,
"hasCentralProtectionControl": false,
"protectionMode": {
"exportLimitKva": 0,
"underFrequencyProtection": 0,
"underFrequencyProtectionDelay": 0,
"overFrequencyProtection": 0,
"overFrequencyProtectionDelay": 0,
"underVoltageProtection": 0,
"underVoltageProtectionDelay": 0,
"overVoltageProtection": 0,
"overVoltageProtectionDelay": 0,
"sustainedOverVoltage": 0,
"sustainedOverVoltageDelay": 0,
"frequencyRateOfChange": 0,
"voltageVectorShift": 0,
"interTripScheme": "string",
"neutralVoltageDisplacement": 0
},
"acConnections": [
{
"connectionIdentifier": 0,
"count": 0,
"equipmentType": "INVERTER",
"manufacturerName": "string",
"inverterSeries": "string",
"inverterModelNumber": "string",
"commissioningDate": "string",
"status": "ACTIVE",
"inverterDeviceCapacity": 0,
"derDevices": [
{
"deviceIdentifier": 0,
"count": 0,
"manufacturer": "string",
"modelNumber": "string",
"status": "ACTIVE",
"type": "FOSSIL",
"subtype": "string",
"nominalRatedCapacity": 0,
"nominalStorageCapacity": 0
}
]
}
]
}
Properties
| Name |
Type |
Required |
Default |
Description |
| servicePointId |
EnergyServicePointId |
mandatory |
|
Unique identifier for the service point. |
| approvedCapacity |
number |
mandatory |
|
Approved small generating unit capacity as agreed with NSP in the connection agreement, expressed in kVA. Value of 0 indicates no DER record exists for the given servicePointId. |
| availablePhasesCount |
NaturalNumber |
mandatory |
|
The number of phases available for the installation of DER. Acceptable values are 0, 1, 2 or 3. Value of 0 indicates no DER record exists for the given servicePointId. |
| installedPhasesCount |
NaturalNumber |
mandatory |
|
The number of phases that DER is connected to. Acceptable values are 0, 1, 2 or 3. Value of 0 indicates no DER record exists for the given servicePointId. |
| islandableInstallation |
Boolean |
mandatory |
|
For identification of small generating units designed with the ability to operate in an islanded mode. |
| hasCentralProtectionControl |
Boolean |
optional |
false |
For DER installations where NSPs specify the need for additional forms of protection above those inbuilt in an inverter. If absent then assumed to be false. |
| protectionMode |
object |
conditional |
|
Required only when the hasCentralProtectionControl flag is set to true. One or more of the object fields will be provided to describe the protection modes in place. |
| » exportLimitKva |
number |
optional |
|
Maximum amount of power (kVA) that may be exported from a connection point to the grid, as monitored by a control/relay function. An absent value indicates no limit. |
| » underFrequencyProtection |
number |
optional |
|
Protective function limit in Hz. |
| » underFrequencyProtectionDelay |
number |
optional |
|
Trip delay time in seconds. |
| » overFrequencyProtection |
number |
optional |
|
Protective function limit in Hz. |
| » overFrequencyProtectionDelay |
number |
optional |
|
Trip delay time in seconds. |
| » underVoltageProtection |
number |
optional |
|
Protective function limit in V. |
| » underVoltageProtectionDelay |
number |
optional |
|
Trip delay time in seconds. |
| » overVoltageProtection |
number |
optional |
|
Protective function limit in V. |
| » overVoltageProtectionDelay |
number |
optional |
|
Trip delay time in seconds. |
| » sustainedOverVoltage |
number |
optional |
|
Sustained over voltage. |
| » sustainedOverVoltageDelay |
number |
optional |
|
Sustained Over voltage protection delay in seconds. |
| » frequencyRateOfChange |
number |
optional |
|
Rate of change of frequency trip point (Hz/s). |
| » voltageVectorShift |
number |
optional |
|
Trip angle in degrees. |
| » interTripScheme |
string |
optional |
|
Description of the form of inter-trip (e.g., 'from local substation'). |
| » neutralVoltageDisplacement |
number |
optional |
|
Trip voltage. |
| acConnections |
[object] |
mandatory |
|
none |
| » connectionIdentifier |
number |
mandatory |
|
AC Connection ID as defined in the DER register. Does not align with CDR ID permanence standards. |
| » count |
PositiveInteger |
mandatory |
|
Number of AC Connections in the group. For the suite of AC Connections to be considered as a group, all of the AC Connections included must have the same attributes. |
| » equipmentType |
Enum |
optional |
OTHER |
Indicates whether the DER device is connected via an inverter (and what category of inverter it is) or not (e.g., rotating machine). If absent, assume equipment type to be OTHER. |
| » manufacturerName |
string |
conditional |
|
The name of the inverter manufacturer. Mandatory if equipmentType is INVERTER. |
| » inverterSeries |
string |
conditional |
|
The inverter series. Mandatory if equipmentType is INVERTER. |
| » inverterModelNumber |
string |
conditional |
|
The inverter model number. Mandatory if equipmentType is INVERTER. |
| » commissioningDate |
DateString |
mandatory |
|
The date that the DER installation is commissioned. |
| » status |
Enum |
mandatory |
|
Code used to indicate the status of the Inverter. This will be used to identify if an inverter is active or inactive or decommissioned. |
| » inverterDeviceCapacity |
number |
conditional |
|
The rated AC output power that is listed in the product specified by the manufacturer. Mandatory if equipmentType is INVERTER. Default is 0 if value not known. |
| » derDevices |
[object] |
mandatory |
|
none |
| »» deviceIdentifier |
number |
mandatory |
|
Unique identifier for a single DER device or a group of DER devices with the same attributes. Does not align with CDR ID permanence standards. |
| »» count |
PositiveInteger |
mandatory |
|
Number of devices in the group of DER devices. |
| »» manufacturer |
string |
optional |
|
The name of the device manufacturer. If absent then assumed to be "unknown". |
| »» modelNumber |
string |
optional |
|
The model number of the device. If absent then assumed to be "unknown". |
| »» status |
Enum |
optional |
|
Code used to indicate the status of the device. This will be used to identify if an inverter is active or inactive or decommissioned. |
| »» type |
Enum |
mandatory |
|
Used to indicate the primary technology used in the DER device. |
| »» subtype |
string |
optional |
|
Used to indicate the primary technology used in the DER device. This field is also used to record for example the battery chemistry, or the type of PV panel. It is also used to record if a battery is contained in an electric vehicle connected in a vehicle-to-grid arrangement. If absent then assumed to be "other". |
| »» nominalRatedCapacity |
number |
mandatory |
|
Maximum output in kVA that is listed in the product specification by the manufacturer. This refers to the capacity of each unit within the device group. Default is 0 if value not known. |
| »» nominalStorageCapacity |
number |
conditional |
|
Maximum storage capacity in kVAh. This refers to the capacity of each storage module within the device group. Mandatory if type is equal to STORAGE. Default is 0 if value not known. |
Enumerated Values
| Property |
Value |
| equipmentType |
INVERTER |
| equipmentType |
OTHER |
| status |
ACTIVE |
| status |
INACTIVE |
| status |
DECOMMISSIONED |
| status |
ACTIVE |
| status |
INACTIVE |
| status |
DECOMMISSIONED |
| type |
FOSSIL |
| type |
HYDRO |
| type |
WIND |
| type |
SOLAR_PV |
| type |
RENEWABLE |
| type |
GEOTHERMAL |
| type |
STORAGE |
| type |
OTHER |
EnergyAccountBaseV2
{
"accountId": "string",
"accountNumber": "string",
"displayName": "string",
"openStatus": "CLOSED",
"creationDate": "string"
}
Properties
| Name |
Type |
Required |
Default |
Description |
| accountId |
EnergyAccountId |
mandatory |
|
Unique identifier for the account. |
| accountNumber |
string |
optional |
|
Optional identifier of the account as defined by the data holder. This must be the value presented on physical statements (if it exists) and must not be used for the value of accountId. |
| displayName |
string |
optional |
|
An optional display name for the account if one exists or can be derived. The content of this field is at the discretion of the data holder. |
| openStatus |
Enum |
optional |
OPEN |
Open or closed status for the account. If not present then OPEN is assumed. |
| creationDate |
DateString |
conditional |
|
The date that the account was created or opened. Mandatory if openStatus is OPEN. |
Enumerated Values
| Property |
Value |
| openStatus |
CLOSED |
| openStatus |
OPEN |
EnergyAccountV2
{
"accountId": "string",
"accountNumber": "string",
"displayName": "string",
"openStatus": "CLOSED",
"creationDate": "string",
"plans": [
{
"nickname": "string",
"servicePointIds": [
"string"
],
"planOverview": {
"displayName": "string",
"startDate": "string",
"endDate": "string"
}
}
]
}
Properties
allOf
and
| Name |
Type |
Required |
Default |
Description |
| anonymous |
object |
mandatory |
|
The array of plans containing service points and associated plan details. |
| » plans |
[object] |
mandatory |
|
The array of plans containing service points and associated plan details. |
| »» nickname |
string |
optional |
|
Optional display name for the plan provided by the customer to help differentiate multiple plans. |
| »» servicePointIds |
[EnergyServicePointId] |
mandatory |
|
An array of servicePointId values, representing NMIs, that this plan is linked to. If there are no service points allocated to this plan then an empty array would be expected. |
| »» planOverview |
object |
conditional |
|
Mandatory if openStatus is OPEN. |
| »»» displayName |
string |
optional |
|
The name of the plan if one exists. |
| »»» startDate |
DateString |
mandatory |
|
The start date of the applicability of this plan. |
| »»» endDate |
DateString |
optional |
|
The end date of the applicability of this plan. |
EnergyAccountDetailV4
{
"accountId": "string",
"accountNumber": "string",
"displayName": "string",
"openStatus": "CLOSED",
"creationDate": "string",
"plans": [
{
"nickname": "string",
"servicePointIds": [
"string"
],
"planOverview": {
"displayName": "string",
"startDate": "string",
"endDate": "string"
},
"planDetail": {
"fuelType": "ELECTRICITY",
"isContingentPlan": false,
"meteringCharges": [
{
"displayName": "string",
"description": "string",
"minimumValue": "string",
"maximumValue": "string",
"period": "string"
}
],
"gasContract": {
"additionalFeeInformation": "string",
"pricingModel": "SINGLE_RATE",
"timeZone": "LOCAL",
"isFixed": true,
"variation": "string",
"onExpiryDescription": "string",
"paymentOption": [
"PAPER_BILL"
],
"intrinsicGreenPower": {
"greenPercentage": "string"
},
"controlledLoad": [
{
"displayName": "string",
"rateBlockUType": "singleRate",
"startDate": "string",
"endDate": "string",
"singleRate": {
"displayName": "string",
"description": "string",
"dailySupplyCharge": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "P1Y"
},
"timeOfUseRates": [
{
"displayName": "string",
"description": "string",
"dailySupplyCharge": "string",
"rates": [
{}
],
"period": "P1Y",
"timeOfUse": [
{}
],
"type": "PEAK"
}
]
}
],
"incentives": [
{
"displayName": "string",
"description": "string",
"category": "GIFT",
"eligibility": "string"
}
],
"discounts": [
{
"displayName": "string",
"description": "string",
"type": "CONDITIONAL",
"category": "PAY_ON_TIME",
"endDate": "string",
"methodUType": "percentOfBill",
"percentOfBill": {
"rate": "string"
},
"percentOfUse": {
"rate": "string"
},
"fixedAmount": {
"amount": "string"
},
"percentOverThreshold": {
"rate": "string",
"usageAmount": "string"
}
}
],
"greenPowerCharges": [
{
"displayName": "string",
"description": "string",
"scheme": "GREENPOWER",
"type": "FIXED_PER_DAY",
"tiers": [
{
"percentGreen": "string",
"rate": "string",
"amount": "string"
}
]
}
],
"eligibility": [
{
"type": "EXISTING_CUST",
"information": "string",
"description": "string"
}
],
"fees": [
{
"type": "EXIT",
"term": "FIXED",
"amount": "string",
"rate": "string",
"description": "string"
}
],
"solarFeedInTariff": [
{
"displayName": "string",
"description": "string",
"startDate": "string",
"endDate": "string",
"scheme": "PREMIUM",
"payerType": "GOVERNMENT",
"tariffUType": "singleTariff",
"singleTariff": {
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "P1Y"
},
"timeVaryingTariffs": [
{
"type": "PEAK",
"displayName": "string",
"rates": [
{}
],
"period": "P1Y",
"timeVariations": [
{}
]
}
]
}
],
"tariffPeriod": [
{
"type": "ENVIRONMENTAL",
"displayName": "string",
"startDate": "string",
"endDate": "string",
"dailySupplyChargeType": "SINGLE",
"dailySupplyCharge": "string",
"bandedDailySupplyCharges": [
{
"unitPrice": "string",
"measureUnit": "DAYS",
"volume": 0
}
],
"timeZone": "LOCAL",
"rateBlockUType": "singleRate",
"singleRate": {
"displayName": "string",
"description": "string",
"generalUnitPrice": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "string"
},
"timeOfUseRates": [
{
"displayName": "string",
"description": "string",
"rates": [
{}
],
"period": "P1Y",
"timeOfUse": [
{}
],
"type": "PEAK"
}
],
"demandCharges": [
{
"displayName": "string",
"description": "string",
"amount": "string",
"measureUnit": "KWH",
"startTime": "string",
"endTime": "string",
"days": [
"SUN"
],
"minDemand": "0.00",
"maxDemand": "string",
"measurementPeriod": "DAY",
"chargePeriod": "DAY"
}
]
}
]
},
"electricityContract": {
"additionalFeeInformation": "string",
"pricingModel": "SINGLE_RATE",
"timeZone": "LOCAL",
"isFixed": true,
"variation": "string",
"onExpiryDescription": "string",
"paymentOption": [
"PAPER_BILL"
],
"intrinsicGreenPower": {
"greenPercentage": "string"
},
"controlledLoad": [
{
"displayName": "string",
"rateBlockUType": "singleRate",
"startDate": "string",
"endDate": "string",
"singleRate": {
"displayName": "string",
"description": "string",
"dailySupplyCharge": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "P1Y"
},
"timeOfUseRates": [
{
"displayName": "string",
"description": "string",
"dailySupplyCharge": "string",
"rates": [
{}
],
"period": "P1Y",
"timeOfUse": [
{}
],
"type": "PEAK"
}
]
}
],
"incentives": [
{
"displayName": "string",
"description": "string",
"category": "GIFT",
"eligibility": "string"
}
],
"discounts": [
{
"displayName": "string",
"description": "string",
"type": "CONDITIONAL",
"category": "PAY_ON_TIME",
"endDate": "string",
"methodUType": "percentOfBill",
"percentOfBill": {
"rate": "string"
},
"percentOfUse": {
"rate": "string"
},
"fixedAmount": {
"amount": "string"
},
"percentOverThreshold": {
"rate": "string",
"usageAmount": "string"
}
}
],
"greenPowerCharges": [
{
"displayName": "string",
"description": "string",
"scheme": "GREENPOWER",
"type": "FIXED_PER_DAY",
"tiers": [
{
"percentGreen": "string",
"rate": "string",
"amount": "string"
}
]
}
],
"eligibility": [
{
"type": "EXISTING_CUST",
"information": "string",
"description": "string"
}
],
"fees": [
{
"type": "EXIT",
"term": "FIXED",
"amount": "string",
"rate": "string",
"description": "string"
}
],
"solarFeedInTariff": [
{
"displayName": "string",
"description": "string",
"startDate": "string",
"endDate": "string",
"scheme": "PREMIUM",
"payerType": "GOVERNMENT",
"tariffUType": "singleTariff",
"singleTariff": {
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "P1Y"
},
"timeVaryingTariffs": [
{
"type": "PEAK",
"displayName": "string",
"rates": [
{}
],
"period": "P1Y",
"timeVariations": [
{}
]
}
]
}
],
"tariffPeriod": [
{
"type": "ENVIRONMENTAL",
"displayName": "string",
"startDate": "string",
"endDate": "string",
"dailySupplyChargeType": "SINGLE",
"dailySupplyCharge": "string",
"bandedDailySupplyCharges": [
{
"unitPrice": "string",
"measureUnit": "DAYS",
"volume": 0
}
],
"timeZone": "LOCAL",
"rateBlockUType": "singleRate",
"singleRate": {
"displayName": "string",
"description": "string",
"generalUnitPrice": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "string"
},
"timeOfUseRates": [
{
"displayName": "string",
"description": "string",
"rates": [
{}
],
"period": "P1Y",
"timeOfUse": [
{}
],
"type": "PEAK"
}
],
"demandCharges": [
{
"displayName": "string",
"description": "string",
"amount": "string",
"measureUnit": "KWH",
"startTime": "string",
"endTime": "string",
"days": [
"SUN"
],
"minDemand": "0.00",
"maxDemand": "string",
"measurementPeriod": "DAY",
"chargePeriod": "DAY"
}
]
}
]
}
},
"authorisedContacts": [
{
"firstName": "string",
"lastName": "string",
"middleNames": [
"string"
],
"prefix": "string",
"suffix": "string"
}
]
}
]
}
Properties
allOf
and
| Name |
Type |
Required |
Default |
Description |
| anonymous |
object |
mandatory |
|
The array of plans containing service points and associated plan details. |
| » plans |
[object] |
mandatory |
|
The array of plans containing service points and associated plan details. |
| »» nickname |
string |
optional |
|
Optional display name for the plan provided by the customer to help differentiate multiple plans. |
| »» servicePointIds |
[EnergyServicePointId] |
mandatory |
|
An array of servicePointId values, representing NMIs, that this account is linked to. |
| »» planOverview |
object |
conditional |
|
Mandatory if openStatus is OPEN. |
| »»» displayName |
string |
optional |
|
The name of the plan if one exists. |
| »»» startDate |
DateString |
mandatory |
|
The start date of the applicability of this plan. |
| »»» endDate |
DateString |
optional |
|
The end date of the applicability of this plan. |
| »» planDetail |
object |
conditional |
|
Detail on the plan applicable to this account. Mandatory if openStatus is OPEN. |
| »»» fuelType |
Enum |
mandatory |
|
The fuel types covered by the plan. |
| »»» isContingentPlan |
Boolean |
optional |
false |
Flag that indicates that the plan is contingent on the customer taking up an alternate fuel plan from the same retailer (for instance, if the fuelType is ELECTRICITY then a GAS plan from the same retailer must be taken up). Has no meaning if the plan has a fuelType of DUAL. If absent the value is assumed to be false. |
| »»» meteringCharges |
[object] |
optional |
|
Charges for metering included in the plan. |
| »»»» displayName |
string |
mandatory |
|
Display name of the charge. |
| »»»» description |
string |
optional |
|
Description of the charge. |
| »»»» minimumValue |
AmountString |
mandatory |
|
Minimum value of the charge if the charge is a range or the absolute value of the charge if no range is specified. |
| »»»» maximumValue |
AmountString |
optional |
|
The upper limit of the charge if the charge could occur in a range. |
| »»»» period |
ExternalRef |
optional |
|
The charges that occur on a schedule indicates the frequency. Formatted according to ISO 8601 Durations (excludes recurrence syntax). |
| »»» gasContract |
EnergyPlanContractV3 |
conditional |
|
The details of the terms for the supply of electricity under this plan. Is mandatory if fuelType is set to GAS or DUAL. |
| »»» electricityContract |
EnergyPlanContractV3 |
conditional |
|
The details of the terms for the supply of electricity under this plan. Is mandatory if fuelType is set to ELECTRICITY or DUAL. |
| »» authorisedContacts |
[object] |
optional |
|
An array of additional contacts that are authorised to act on this account. |
| »»» firstName |
string |
optional |
|
For people with single names this field need not be present. The single name should be in the lastName field. |
| »»» lastName |
string |
mandatory |
|
For people with single names the single name should be in this field. |
| »»» middleNames |
[string] |
optional |
|
Field is mandatory but array may be empty. |
| »»» prefix |
string |
optional |
|
Also known as title or salutation. The prefix to the name (e.g., Mr, Mrs, Ms, Miss, Sir, etc.) |
| »»» suffix |
string |
optional |
|
Used for a trailing suffix to the name (e.g., Jr.) |
Enumerated Values
| Property |
Value |
| fuelType |
ELECTRICITY |
| fuelType |
GAS |
| fuelType |
DUAL |
EnergyPaymentSchedule
{
"amount": "string",
"paymentScheduleUType": "cardDebit",
"cardDebit": {
"cardScheme": "VISA",
"paymentFrequency": "string",
"calculationType": "STATIC"
},
"directDebit": {
"isTokenised": false,
"bsb": "string",
"accountNumber": "string",
"paymentFrequency": "string",
"calculationType": "STATIC"
},
"digitalWallet": {
"name": "string",
"identifier": "string",
"type": "EMAIL",
"provider": "PAYPAL_AU",
"paymentFrequency": "string",
"calculationType": "STATIC"
},
"manualPayment": {
"billFrequency": "string"
}
}
Properties
| Name |
Type |
Required |
Default |
Description |
| amount |
AmountString |
optional |
|
Optional payment amount indicating that a constant payment amount is scheduled to be paid (used in bill smoothing scenarios). |
| paymentScheduleUType |
Enum |
mandatory |
|
The type of object present in this response. |
| cardDebit |
object |
conditional |
|
Represents a regular credit card payment schedule. Mandatory if paymentScheduleUType is set to cardDebit. |
| » cardScheme |
Enum |
mandatory |
|
The type of credit card held on file. |
| » paymentFrequency |
ExternalRef |
mandatory |
|
The frequency that payments will occur. Formatted according to ISO 8601 Durations (excludes recurrence syntax). |
| » calculationType |
Enum |
mandatory |
|
The mechanism by which the payment amount is calculated. Explanation of values are as follows:
STATIC: Indicates a consistent, static amount, per paymentBALANCE: Indicates that the outstanding balance for the account is paid per periodCALCULATED: Indicates that the payment amount is variable and calculated using a pre-defined algorithm.
|
| directDebit |
object |
conditional |
|
Represents a regular direct debit from a specified bank account. Mandatory if paymentScheduleUType is set to directDebit. |
| » isTokenised |
Boolean |
optional |
false |
Flag indicating that the account details are tokenised, or held in a closed system, and is not accessible through any other channels. false if absent. |
| » bsb |
string |
conditional |
|
The unmasked BSB for the account to be debited. Is expected to be formatted as digits only with leading zeros included and no punctuation or spaces. Is required if isTokenised is absent or false. |
| » accountNumber |
string |
conditional |
|
The unmasked account number for the account to be debited. Is expected to be formatted as digits only with leading zeros included and no punctuation or spaces. Is required if isTokenised is absent or false. |
| » paymentFrequency |
ExternalRef |
mandatory |
|
The frequency that payments will occur. Formatted according to ISO 8601 Durations (excludes recurrence syntax). |
| » calculationType |
Enum |
mandatory |
|
The mechanism by which the payment amount is calculated. Explanation of values are as follows:
STATIC: Indicates a consistent, static amount, per paymentBALANCE: Indicates that the outstanding balance for the account is paid per periodCALCULATED: Indicates that the payment amount is variable and calculated using a pre-defined algorithm.
|
| digitalWallet |
object |
conditional |
|
Represents a regular payment from a digital wallet. Mandatory if paymentScheduleUType is set to digitalWallet. |
| » name |
string |
mandatory |
|
The display name of the wallet as given by the customer, else a default value defined by the data holder. |
| » identifier |
string |
mandatory |
|
The identifier of the digital wallet (dependent on type). |
| » type |
Enum |
mandatory |
|
The type of the digital wallet identifier. |
| » provider |
Enum |
mandatory |
|
The provider of the digital wallet. |
| » paymentFrequency |
ExternalRef |
mandatory |
|
The frequency that payments will occur. Formatted according to ISO 8601 Durations (excludes recurrence syntax). |
| » calculationType |
Enum |
mandatory |
|
The mechanism by which the payment amount is calculated. Explanation of values are as follows:
STATIC: Indicates a consistent, static amount, per paymentBALANCE: Indicates that the outstanding balance for the account is paid per periodCALCULATED: Indicates that the payment amount is variable and calculated using a pre-defined algorithm.
|
| manualPayment |
object |
conditional |
|
Represents a manual payment schedule where the customer pays in response to a delivered statement. Mandatory if paymentScheduleUType is set to manualPayment. |
| » billFrequency |
ExternalRef |
mandatory |
|
The frequency with which a bill will be issued. Formatted according to ISO 8601 Durations (excludes recurrence syntax). |
Enumerated Values
| Property |
Value |
| paymentScheduleUType |
cardDebit |
| paymentScheduleUType |
directDebit |
| paymentScheduleUType |
manualPayment |
| paymentScheduleUType |
digitalWallet |
| cardScheme |
VISA |
| cardScheme |
MASTERCARD |
| cardScheme |
AMEX |
| cardScheme |
DINERS |
| cardScheme |
OTHER |
| cardScheme |
UNKNOWN |
| calculationType |
STATIC |
| calculationType |
BALANCE |
| calculationType |
CALCULATED |
| calculationType |
STATIC |
| calculationType |
BALANCE |
| calculationType |
CALCULATED |
| type |
EMAIL |
| type |
CONTACT_NAME |
| type |
TELEPHONE |
| provider |
PAYPAL_AU |
| provider |
OTHER |
| calculationType |
STATIC |
| calculationType |
BALANCE |
| calculationType |
CALCULATED |
EnergyConcession
{
"type": "FIXED_AMOUNT",
"displayName": "string",
"additionalInfo": "string",
"additionalInfoUri": "string",
"startDate": "string",
"endDate": "string",
"discountFrequency": "string",
"amount": "string",
"percentage": "string",
"appliedTo": [
"USAGE"
]
}
Properties
| Name |
Type |
Required |
Default |
Description |
| type |
Enum |
mandatory |
|
Indicator of the method of concession calculation. |
| displayName |
string |
mandatory |
|
The display name of the concession. |
| additionalInfo |
string |
conditional |
|
Display text providing more information on the concession. Mandatory if type is VARIABLE. |
| additionalInfoUri |
URIString |
optional |
|
Optional link to additional information regarding the concession. |
| startDate |
DateString |
optional |
|
Optional start date for the application of the concession. |
| endDate |
DateString |
optional |
|
Optional end date for the application of the concession. |
| discountFrequency |
ExternalRef |
conditional |
|
Conditional attribute for frequency at which a concession is applied. Required if type is FIXED_AMOUNT or FIXED_PERCENTAGE. Formatted according to ISO 8601 Durations (excludes recurrence syntax). |
| amount |
AmountString |
conditional |
|
Conditional attribute for the amount of discount for the concession- required if type is FIXED_AMOUNT. |
| percentage |
RateString |
conditional |
|
Conditional attribute for the percentage of discount of concession - required if type is FIXED_PERCENTAGE. |
| appliedTo |
[Enum] |
optional |
USAGE |
Array of ENUMs to specify what the concession applies to. Multiple ENUM values can be provided. If absent, USAGE is assumed. |
Enumerated Values
| Property |
Value |
| type |
FIXED_AMOUNT |
| type |
FIXED_PERCENTAGE |
| type |
VARIABLE |
| appliedTo |
INVOICE |
| appliedTo |
USAGE |
| appliedTo |
SERVICE_CHARGE |
| appliedTo |
CONTROLLED_LOAD |
EnergyInvoice
{
"accountId": "string",
"invoiceNumber": "string",
"issueDate": "string",
"dueDate": "string",
"period": {
"startDate": "string",
"endDate": "string"
},
"invoiceAmount": "string",
"gstAmount": "0.00",
"payOnTimeDiscount": {
"discountAmount": "string",
"gstAmount": "0.00",
"date": "string"
},
"balanceAtIssue": "string",
"servicePoints": [
"string"
],
"gas": {
"totalUsageCharges": "string",
"totalGenerationCredits": "string",
"totalOnceOffCharges": "string",
"totalOnceOffDiscounts": "string",
"otherCharges": [
{
"type": "ENVIRONMENTAL",
"amount": "string",
"description": "string"
}
],
"totalGst": "0.00"
},
"electricity": {
"totalUsageCharges": "string",
"totalGenerationCredits": "string",
"totalOnceOffCharges": "string",
"totalOnceOffDiscounts": "string",
"otherCharges": [
{
"type": "ENVIRONMENTAL",
"amount": "string",
"description": "string"
}
],
"totalGst": "0.00"
},
"accountCharges": {
"totalCharges": "string",
"totalDiscounts": "string",
"totalGst": "0.00"
},
"paymentStatus": "PAID"
}
Properties
| Name |
Type |
Required |
Default |
Description |
| accountId |
EnergyAccountId |
mandatory |
|
Unique identifier for the account. |
| invoiceNumber |
string |
mandatory |
|
The number assigned to this invoice by the energy Retailer. |
| issueDate |
DateString |
mandatory |
|
The date that the invoice was actually issued (as opposed to generated or calculated). |
| dueDate |
DateString |
optional |
|
The date that the invoice is due to be paid. |
| period |
object |
conditional |
|
Object containing the start and end date for the period covered by the invoice. Mandatory if any usage or demand based charges are included in the invoice. |
| » startDate |
DateString |
mandatory |
|
The start date of the period covered by this invoice. |
| » endDate |
DateString |
mandatory |
|
The end date of the period covered by this invoice. |
| invoiceAmount |
AmountString |
optional |
|
The net amount due for this invoice regardless of previous balance. |
| gstAmount |
AmountString |
optional |
0.00 |
The total GST amount for this invoice. If absent then zero is assumed. |
| payOnTimeDiscount |
object |
optional |
|
A discount for on time payment. |
| » discountAmount |
AmountString |
mandatory |
|
The amount that will be discounted if the invoice is paid by the date specified. |
| » gstAmount |
AmountString |
optional |
0.00 |
The GST amount that will be discounted if the invoice is paid by the date specified. If absent then zero is assumed. |
| » date |
DateString |
mandatory |
|
The date by which the invoice must be paid to receive the pay on time discount. |
| balanceAtIssue |
AmountString |
mandatory |
|
The account balance at the time the invoice was issued. |
| servicePoints |
[string] |
mandatory |
|
Array of service point IDs to which this invoice applies. May be empty if the invoice contains no electricity usage related charges. |
| gas |
EnergyInvoiceGasUsageCharges |
optional |
|
Object containing charges and credits related to gas usage. |
| electricity |
EnergyInvoiceElectricityUsageCharges |
optional |
|
Object containing charges and credits related to electricity usage. |
| accountCharges |
EnergyInvoiceAccountCharges |
optional |
|
Object contains account level charges and credits related to electricity usage. |
| paymentStatus |
Enum |
mandatory |
|
Indicator of the payment status for the invoice. |
Enumerated Values
| Property |
Value |
| paymentStatus |
PAID |
| paymentStatus |
PARTIALLY_PAID |
| paymentStatus |
NOT_PAID |
EnergyInvoiceGasUsageCharges
{
"totalUsageCharges": "string",
"totalGenerationCredits": "string",
"totalOnceOffCharges": "string",
"totalOnceOffDiscounts": "string",
"otherCharges": [
{
"type": "ENVIRONMENTAL",
"amount": "string",
"description": "string"
}
],
"totalGst": "0.00"
}
Properties
| Name |
Type |
Required |
Default |
Description |
| totalUsageCharges |
AmountString |
mandatory |
|
The aggregate total of usage charges for the period covered by the invoice (exclusive of GST). |
| totalGenerationCredits |
AmountString |
mandatory |
|
The aggregate total of generation credits for the period covered by the invoice (exclusive of GST). |
| totalOnceOffCharges |
AmountString |
mandatory |
|
The aggregate total of any once off charges arising from gas usage for the period covered by the invoice (exclusive of GST). |
| totalOnceOffDiscounts |
AmountString |
mandatory |
|
The aggregate total of any once off discounts or credits arising from gas usage for the period covered by the invoice (exclusive of GST). |
| otherCharges |
[object] |
optional |
|
Optional array of charges that may be part of the invoice (for e.g., environmental charges for C&I consumers) (exclusive of GST). |
| » type |
Enum |
optional |
OTHER |
Type of charge. Assumed to be OTHER if absent. |
| » amount |
AmountString |
mandatory |
|
The aggregate total of charges for this item (exclusive of GST). |
| » description |
string |
mandatory |
|
A free text description of the type of charge. |
| totalGst |
AmountString |
optional |
0.00 |
The total GST for all gas usage charges. If absent then zero is assumed. |
Enumerated Values
| Property |
Value |
| type |
ENVIRONMENTAL |
| type |
REGULATED |
| type |
NETWORK |
| type |
METERING |
| type |
RETAIL_SERVICE |
| type |
RCTI |
| type |
OTHER |
EnergyInvoiceElectricityUsageCharges
{
"totalUsageCharges": "string",
"totalGenerationCredits": "string",
"totalOnceOffCharges": "string",
"totalOnceOffDiscounts": "string",
"otherCharges": [
{
"type": "ENVIRONMENTAL",
"amount": "string",
"description": "string"
}
],
"totalGst": "0.00"
}
Properties
| Name |
Type |
Required |
Default |
Description |
| totalUsageCharges |
AmountString |
mandatory |
|
The aggregate total of usage charges for the period covered by the invoice (exclusive of GST). |
| totalGenerationCredits |
AmountString |
mandatory |
|
The aggregate total of generation credits for the period covered by the invoice (exclusive of GST). |
| totalOnceOffCharges |
AmountString |
mandatory |
|
The aggregate total of any once off charges arising from electricity usage for the period covered by the invoice (exclusive of GST). |
| totalOnceOffDiscounts |
AmountString |
mandatory |
|
The aggregate total of any once off discounts or credits arising from electricity usage for the period covered by the invoice (exclusive of GST). |
| otherCharges |
[object] |
optional |
|
Optional array of charges that may be part of the invoice (for e.g., environmental charges for C&I consumers) (exclusive of GST). |
| » type |
Enum |
optional |
OTHER |
Type of charge. Assumed to be OTHER if absent. |
| » amount |
AmountString |
mandatory |
|
The aggregate total of charges for this item (exclusive of GST). |
| » description |
string |
mandatory |
|
A free text description of the type of charge. |
| totalGst |
AmountString |
optional |
0.00 |
The total GST for all electricity usage charges. If absent then zero is assumed. |
Enumerated Values
| Property |
Value |
| type |
ENVIRONMENTAL |
| type |
REGULATED |
| type |
NETWORK |
| type |
METERING |
| type |
RETAIL_SERVICE |
| type |
RCTI |
| type |
OTHER |
EnergyInvoiceAccountCharges
{
"totalCharges": "string",
"totalDiscounts": "string",
"totalGst": "0.00"
}
Object contains account level charges and credits related to electricity usage.
Properties
| Name |
Type |
Required |
Default |
Description |
| totalCharges |
AmountString |
mandatory |
|
The aggregate total of account level charges for the period covered by the invoice. |
| totalDiscounts |
AmountString |
mandatory |
|
The aggregate total of account level discounts or credits for the period covered by the invoice. |
| totalGst |
AmountString |
optional |
0.00 |
The total GST for all account level charges. If absent then zero is assumed. |
EnergyBillingTransactionV3
{
"accountId": "string",
"executionDateTime": "string",
"gst": "0.00",
"transactionUType": "usage",
"usage": {
"servicePointId": "string",
"invoiceNumber": "string",
"timeOfUseType": "PEAK",
"description": "string",
"isEstimate": false,
"startDate": "string",
"endDate": "string",
"measureUnit": "KWH",
"usage": 0,
"amount": "string",
"calculationFactors": [
{
"value": 0,
"type": "DLF"
}
],
"adjustments": [
{
"amount": "string",
"description": "string"
}
]
},
"demand": {
"servicePointId": "string",
"invoiceNumber": "string",
"timeOfUseType": "PEAK",
"description": "string",
"isEstimate": false,
"startDate": "string",
"endDate": "string",
"measureUnit": "KVA",
"rate": 0,
"amount": "string",
"calculationFactors": [
{
"value": 0,
"type": "DLF"
}
],
"adjustments": [
{
"amount": "string",
"description": "string"
}
]
},
"onceOff": {
"servicePointId": "string",
"invoiceNumber": "string",
"amount": "string",
"description": "string"
},
"otherCharges": {
"servicePointId": "string",
"invoiceNumber": "string",
"startDate": "string",
"endDate": "string",
"type": "ENVIRONMENTAL",
"amount": "string",
"description": "string",
"calculationFactors": [
{
"value": 0,
"type": "DLF"
}
],
"adjustments": [
{
"amount": "string",
"description": "string"
}
]
},
"payment": {
"amount": "string",
"method": "DIRECT_DEBIT"
}
}
Properties
| Name |
Type |
Required |
Default |
Description |
| accountId |
EnergyAccountId |
mandatory |
|
Unique identifier for the account. |
| executionDateTime |
DateTimeString |
mandatory |
|
The date and time that the transaction occurred. |
| gst |
AmountString |
optional |
0.00 |
The GST incurred in the transaction. Should not be included for credits or payments. If absent then zero is assumed. |
| transactionUType |
Enum |
mandatory |
|
Indicator of the type of transaction object present in this record. |
| usage |
EnergyBillingUsageTransactionV2 |
conditional |
|
Represents a usage charge or generation credit. Mandatory if transactionUType is equal to usage. |
| demand |
EnergyBillingDemandTransactionV3 |
conditional |
|
Represents a demand charge or generation credit. Mandatory if transactionUType is equal to demand. |
| onceOff |
EnergyBillingOnceOffTransaction |
conditional |
|
Represents a once off charge or credit. Mandatory if transactionUType is equal to onceOff. |
| otherCharges |
EnergyBillingOtherTransaction |
conditional |
|
Represents charge other than usage and once off. Mandatory if transactionUType is equal to otherCharges. |
| payment |
EnergyBillingPaymentTransaction |
conditional |
|
Represents a payment to the account. Mandatory if transactionUType is equal to payment. |
Enumerated Values
| Property |
Value |
| transactionUType |
usage |
| transactionUType |
demand |
| transactionUType |
onceOff |
| transactionUType |
otherCharges |
| transactionUType |
payment |
EnergyBillingUsageTransactionV2
{
"servicePointId": "string",
"invoiceNumber": "string",
"timeOfUseType": "PEAK",
"description": "string",
"isEstimate": false,
"startDate": "string",
"endDate": "string",
"measureUnit": "KWH",
"usage": 0,
"amount": "string",
"calculationFactors": [
{
"value": 0,
"type": "DLF"
}
],
"adjustments": [
{
"amount": "string",
"description": "string"
}
]
}
Properties
| Name |
Type |
Required |
Default |
Description |
| servicePointId |
EnergyServicePointId |
optional |
|
Unique identifier for the service point. |
| invoiceNumber |
string |
optional |
|
The number of the invoice in which this transaction is included if it has been issued. |
| timeOfUseType |
Enum |
mandatory |
|
The time of use type that the transaction applies to. |
| description |
string |
optional |
|
Optional description of the transaction that can be used for display purposes. |
| isEstimate |
Boolean |
optional |
false |
Flag indicating if the usage is estimated or actual. true indicates estimate. false or absent indicates actual. |
| startDate |
DateTimeString |
mandatory |
|
Date and time when the usage period starts. |
| endDate |
DateTimeString |
mandatory |
|
Date and time when the usage period ends. |
| measureUnit |
MeasureUnitEnum |
optional |
KWH |
The measurement unit of rate. Assumed to be KWH if absent. |
| usage |
number |
mandatory |
|
The usage for the period in measure unit. A negative value indicates power generated. |
| amount |
AmountString |
mandatory |
|
The amount charged or credited for this transaction prior to any adjustments being applied. A negative value indicates a credit. |
| calculationFactors |
[object] |
optional |
|
Additional calculation factors that inform the transaction. |
| » value |
number |
mandatory |
|
The value of the calculation factor. |
| » type |
Enum |
mandatory |
|
The type of the calculation factor. |
| adjustments |
[object] |
optional |
|
Optional array of adjustments arising for this transaction. |
| » amount |
AmountString |
mandatory |
|
The amount of the adjustment. |
| » description |
string |
mandatory |
|
A free text description of the adjustment. |
Enumerated Values
| Property |
Value |
| timeOfUseType |
PEAK |
| timeOfUseType |
OFF_PEAK |
| timeOfUseType |
OFF_PEAK_DEMAND_CHARGE |
| timeOfUseType |
SHOULDER |
| timeOfUseType |
SHOULDER1 |
| timeOfUseType |
SHOULDER2 |
| timeOfUseType |
CONTROLLED_LOAD |
| timeOfUseType |
SOLAR |
| timeOfUseType |
AGGREGATE |
| timeOfUseType |
ALL_DAY |
| type |
DLF |
| type |
MLF |
EnergyBillingDemandTransactionV3
{
"servicePointId": "string",
"invoiceNumber": "string",
"timeOfUseType": "PEAK",
"description": "string",
"isEstimate": false,
"startDate": "string",
"endDate": "string",
"measureUnit": "KVA",
"rate": 0,
"amount": "string",
"calculationFactors": [
{
"value": 0,
"type": "DLF"
}
],
"adjustments": [
{
"amount": "string",
"description": "string"
}
]
}
Properties
| Name |
Type |
Required |
Default |
Description |
| servicePointId |
EnergyServicePointId |
optional |
|
Unique identifier for the service point. |
| invoiceNumber |
string |
optional |
|
The number of the invoice in which this transaction is included if it has been issued. |
| timeOfUseType |
Enum |
mandatory |
|
The time of use type that the transaction applies to. |
| description |
string |
optional |
|
Optional description of the transaction that can be used for display purposes. |
| isEstimate |
Boolean |
optional |
false |
Flag indicating if the usage is estimated or actual. true indicates estimate. false or absent indicates actual. |
| startDate |
DateTimeString |
mandatory |
|
Date and time when the demand period starts. |
| endDate |
DateTimeString |
mandatory |
|
Date and time when the demand period ends. |
| measureUnit |
MeasureUnitEnum |
optional |
KVA |
The measurement unit of rate. Assumed to be KVA if absent. |
| rate |
number |
mandatory |
|
The rate for the demand charge in measureUnit. Assumed to be KVA if measureUnit not provided. A negative value indicates power generated. |
| amount |
AmountString |
mandatory |
|
The amount charged or credited for this transaction prior to any adjustments being applied. A negative value indicates a credit. |
| calculationFactors |
[object] |
optional |
|
Additional calculation factors that inform the transaction. |
| » value |
number |
mandatory |
|
The value of the calculation factor. |
| » type |
Enum |
mandatory |
|
The type of the calculation factor. |
| adjustments |
[object] |
optional |
|
Optional array of adjustments arising for this transaction. |
| » amount |
AmountString |
mandatory |
|
The amount of the adjustment. |
| » description |
string |
mandatory |
|
A free text description of the adjustment. |
Enumerated Values
| Property |
Value |
| timeOfUseType |
PEAK |
| timeOfUseType |
OFF_PEAK |
| timeOfUseType |
OFF_PEAK_DEMAND_CHARGE |
| timeOfUseType |
SHOULDER |
| timeOfUseType |
SHOULDER1 |
| timeOfUseType |
SHOULDER2 |
| timeOfUseType |
CONTROLLED_LOAD |
| timeOfUseType |
SOLAR |
| timeOfUseType |
AGGREGATE |
| timeOfUseType |
ALL_DAY |
| timeOfUseType |
EXCESS |
| type |
DLF |
| type |
MLF |
MeasureUnitEnum
"KWH"
Properties
| Name |
Type |
Required |
Default |
Description |
| anonymous |
Enum |
mandatory |
|
none |
Enumerated Values
| Property |
Value |
| anonymous |
KWH |
| anonymous |
KVA |
| anonymous |
KVAR |
| anonymous |
KVARH |
| anonymous |
KW |
| anonymous |
DAYS |
| anonymous |
METER |
| anonymous |
MONTH |
EnergyBillingOnceOffTransaction
{
"servicePointId": "string",
"invoiceNumber": "string",
"amount": "string",
"description": "string"
}
Properties
| Name |
Type |
Required |
Default |
Description |
| servicePointId |
EnergyServicePointId |
optional |
|
Unique identifier for the service point. |
| invoiceNumber |
string |
optional |
|
The number of the invoice in which this transaction is included if it has been issued. |
| amount |
AmountString |
mandatory |
|
The amount of the charge or credit. A positive value indicates a charge and a negative value indicates a credit. |
| description |
string |
mandatory |
|
A free text description of the item. |
EnergyBillingOtherTransaction
{
"servicePointId": "string",
"invoiceNumber": "string",
"startDate": "string",
"endDate": "string",
"type": "ENVIRONMENTAL",
"amount": "string",
"description": "string",
"calculationFactors": [
{
"value": 0,
"type": "DLF"
}
],
"adjustments": [
{
"amount": "string",
"description": "string"
}
]
}
Properties
| Name |
Type |
Required |
Default |
Description |
| servicePointId |
EnergyServicePointId |
optional |
|
Unique identifier for the service point. |
| invoiceNumber |
string |
optional |
|
The number of the invoice in which this transaction is included if it has been issued. |
| startDate |
DateString |
optional |
|
Optional start date for the application of the charge. |
| endDate |
DateString |
optional |
|
Optional end date for the application of the charge. |
| type |
Enum |
optional |
OTHER |
Type of charge. Assumed to be OTHER if absent. |
| amount |
AmountString |
mandatory |
|
The amount of the charge. |
| description |
string |
mandatory |
|
A free text description of the item. |
| calculationFactors |
[object] |
optional |
|
Additional calculation factors that inform the transaction. |
| » value |
number |
mandatory |
|
The value of the calculation factor. |
| » type |
Enum |
mandatory |
|
The type of the calculation factor. |
| adjustments |
[object] |
optional |
|
Optional array of adjustments arising for this transaction. |
| » amount |
AmountString |
mandatory |
|
The amount of the adjustment. |
| » description |
string |
mandatory |
|
A free text description of the adjustment. |
Enumerated Values
| Property |
Value |
| type |
ENVIRONMENTAL |
| type |
REGULATED |
| type |
NETWORK |
| type |
METERING |
| type |
RETAIL_SERVICE |
| type |
RCTI |
| type |
OTHER |
| type |
DLF |
| type |
MLF |
EnergyBillingPaymentTransaction
{
"amount": "string",
"method": "DIRECT_DEBIT"
}
Properties
| Name |
Type |
Required |
Default |
Description |
| amount |
AmountString |
mandatory |
|
The amount paid. |
| method |
Enum |
mandatory |
|
The method of payment. |
Enumerated Values
| Property |
Value |
| method |
DIRECT_DEBIT |
| method |
CARD |
| method |
TRANSFER |
| method |
BPAY |
| method |
CASH |
| method |
CHEQUE |
| method |
OTHER |
CommonPhysicalAddress
{
"addressUType": "paf",
"simple": {
"mailingName": "string",
"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"postcode": "string",
"city": "string",
"state": "string",
"country": "AUS"
},
"paf": {
"dpid": "string",
"thoroughfareNumber1": 0,
"thoroughfareNumber1Suffix": "string",
"thoroughfareNumber2": 0,
"thoroughfareNumber2Suffix": "string",
"flatUnitType": "string",
"flatUnitNumber": "string",
"floorLevelType": "string",
"floorLevelNumber": "string",
"lotNumber": "string",
"buildingName1": "string",
"buildingName2": "string",
"streetName": "string",
"streetType": "string",
"streetSuffix": "string",
"postalDeliveryType": "string",
"postalDeliveryNumber": 0,
"postalDeliveryNumberPrefix": "string",
"postalDeliveryNumberSuffix": "string",
"localityName": "string",
"postcode": "string",
"state": "string"
}
}
Properties
| Name |
Type |
Required |
Default |
Description |
| addressUType |
Enum |
mandatory |
|
The type of address object present. |
| simple |
CommonSimpleAddress |
conditional |
|
Required if addressUType is set to simple. |
| paf |
CommonPAFAddress |
conditional |
|
Australian address formatted according to the file format defined by the PAF file format. Required if addressUType is set to paf. |
Enumerated Values
| Property |
Value |
| addressUType |
paf |
| addressUType |
simple |
CommonSimpleAddress
{
"mailingName": "string",
"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"postcode": "string",
"city": "string",
"state": "string",
"country": "AUS"
}
Required if addressUType is set to simple.
Properties
| Name |
Type |
Required |
Default |
Description |
| mailingName |
string |
optional |
|
Name of the individual or business formatted for inclusion in an address used for physical mail. |
| addressLine1 |
string |
mandatory |
|
First line of the standard address object. |
| addressLine2 |
string |
optional |
|
Second line of the standard address object. |
| addressLine3 |
string |
optional |
|
Third line of the standard address object. |
| postcode |
string |
conditional |
|
Mandatory for Australian addresses. |
| city |
string |
mandatory |
|
Name of the city or locality. |
| state |
string |
mandatory |
|
Free text if the country is not Australia. If country is Australia then must be one of the values defined by the State Type Abbreviation in the PAF file format. NSW, QLD, VIC, NT, WA, SA, TAS, ACT, AAT. |
| country |
ExternalRef |
optional |
AUS |
A valid ISO 3166 Alpha-3 country code. Australia (AUS) is assumed if country is not present. |
CommonPAFAddress
{
"dpid": "string",
"thoroughfareNumber1": 0,
"thoroughfareNumber1Suffix": "string",
"thoroughfareNumber2": 0,
"thoroughfareNumber2Suffix": "string",
"flatUnitType": "string",
"flatUnitNumber": "string",
"floorLevelType": "string",
"floorLevelNumber": "string",
"lotNumber": "string",
"buildingName1": "string",
"buildingName2": "string",
"streetName": "string",
"streetType": "string",
"streetSuffix": "string",
"postalDeliveryType": "string",
"postalDeliveryNumber": 0,
"postalDeliveryNumberPrefix": "string",
"postalDeliveryNumberSuffix": "string",
"localityName": "string",
"postcode": "string",
"state": "string"
}
Australian address formatted according to the file format defined by the PAF file format. Required if addressUType is set to paf.
Properties
| Name |
Type |
Required |
Default |
Description |
| dpid |
string |
optional |
|
Unique identifier for an address as defined by Australia Post. Also known as Delivery Point Identifier. |
| thoroughfareNumber1 |
PositiveInteger |
optional |
|
Thoroughfare number for a property (first number in a property ranged address). |
| thoroughfareNumber1Suffix |
string |
optional |
|
Suffix for the thoroughfare number. Only relevant if thoroughfareNumber1 is populated. |
| thoroughfareNumber2 |
PositiveInteger |
optional |
|
Second thoroughfare number (only used if the property has a ranged address e.g., 23-25). |
| thoroughfareNumber2Suffix |
string |
optional |
|
Suffix for the second thoroughfare number. Only relevant if thoroughfareNumber2 is populated. |
| flatUnitType |
string |
optional |
|
Type of flat or unit for the address. |
| flatUnitNumber |
string |
optional |
|
Unit number (including suffix, if applicable). |
| floorLevelType |
string |
optional |
|
Type of floor or level for the address. |
| floorLevelNumber |
string |
optional |
|
Floor or level number (including alpha characters). |
| lotNumber |
string |
optional |
|
Allotment number for the address. |
| buildingName1 |
string |
optional |
|
Building/Property name 1. |
| buildingName2 |
string |
optional |
|
Building/Property name 2. |
| streetName |
string |
optional |
|
The name of the street. |
| streetType |
string |
optional |
|
The street type. Valid enumeration defined by Australia Post PAF code file. |
| streetSuffix |
string |
optional |
|
The street type suffix. Valid enumeration defined by Australia Post PAF code file. |
| postalDeliveryType |
string |
optional |
|
Postal delivery type. (e.g., PO BOX). Valid enumeration defined by Australia Post PAF code file. |
| postalDeliveryNumber |
PositiveInteger |
optional |
|
Postal delivery number if the address is a postal delivery type. |
| postalDeliveryNumberPrefix |
string |
optional |
|
Postal delivery number prefix related to the postal delivery number. |
| postalDeliveryNumberSuffix |
string |
optional |
|
Postal delivery number suffix related to the postal delivery number. |
| localityName |
string |
mandatory |
|
Full name of locality. |
| postcode |
string |
mandatory |
|
Postcode for the locality. |
| state |
string |
mandatory |
|
State in which the address belongs. Valid enumeration defined by Australia Post PAF code file State Type Abbreviation. NSW, QLD, VIC, NT, WA, SA, TAS, ACT, AAT. |
RequestServicePointIdListV1
{
"data": {
"servicePointIds": [
"string"
]
},
"meta": {}
}
Properties
| Name |
Type |
Required |
Default |
Description |
| data |
object |
mandatory |
|
none |
| » servicePointIds |
[EnergyServicePointId] |
mandatory |
|
Array of servicePointId values to obtain data for. |
| meta |
Meta |
optional |
|
none |
RequestAccountIdListV1
{
"data": {
"accountIds": [
"string"
]
},
"meta": {}
}
Properties
| Name |
Type |
Required |
Default |
Description |
| data |
object |
mandatory |
|
none |
| » accountIds |
[EnergyAccountId] |
mandatory |
|
Array of accountId values to obtain data for. |
| meta |
Meta |
optional |
|
none |
EnergyPlanId
"string"
The unique identifier for the Energy plan.
Properties
| Name |
Type |
Required |
Default |
Description |
| anonymous |
ASCIIString |
mandatory |
|
The unique identifier for the Energy plan. |
EnergyServicePointId
"string"
A unique identifier for an Energy service point, generated according to CDR ID Permanence requirements.
Properties
| Name |
Type |
Required |
Default |
Description |
| anonymous |
ASCIIString |
mandatory |
|
A unique identifier for an Energy service point, generated according to CDR ID Permanence requirements. |
EnergyAccountId
"string"
A unique identifier for an Energy account, generated according to CDR ID Permanence requirements.
Properties
| Name |
Type |
Required |
Default |
Description |
| anonymous |
ASCIIString |
mandatory |
|
A unique identifier for an Energy account, generated according to CDR ID Permanence requirements. |
Links
{
"self": "string"
}
Properties
| Name |
Type |
Required |
Default |
Description |
| self |
URIString |
mandatory |
|
Fully qualified link that generated the current response document. |
{}
None
LinksPaginated
{
"self": "string",
"first": "string",
"prev": "string",
"next": "string",
"last": "string"
}
Properties
| Name |
Type |
Required |
Default |
Description |
| self |
URIString |
mandatory |
|
Fully qualified link that generated the current response document. |
| first |
URIString |
conditional |
|
URI to the first page of this set. Mandatory if this response is not the first page. |
| prev |
URIString |
conditional |
|
URI to the previous page of this set. Mandatory if this response is not the first page. |
| next |
URIString |
conditional |
|
URI to the next page of this set. Mandatory if this response is not the last page. |
| last |
URIString |
conditional |
|
URI to the last page of this set. Mandatory if this response is not the last page. |
{
"totalRecords": 0,
"totalPages": 0
}
| Name |
Type |
Required |
Default |
Description |
| totalRecords |
NaturalNumber |
mandatory |
|
The total number of records in the full set. See pagination. |
| totalPages |
NaturalNumber |
mandatory |
|
The total number of pages in the full set. See pagination. |
