AGL CDR Energy API is one of 3 APIs that AGL Energy publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Consumer Data Right, CDR, Energy, Usage, and Billing. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, and API documentation.
This API exposes
23 operations
across 18 paths,
organized into 7 resource areas,
and defines 133 schemas.
It is described by OpenAPI 3.0.3, at version 1.36.0.
Requests are made against a single base URL, https://mtls.dh.example.com/cds-au/v1.
The identity and technical contract details declared by the specification.
EnergyPlanListResponse
object
3 properties
3 required
EnergyPlanResponseV3
object
3 properties
2 required
EnergyServicePointListResponseV2
object
3 properties
3 required
EnergyServicePointDetailResponseV2
object
3 properties
2 required
EnergyUsageListResponse
object
3 properties
3 required
EnergyDerListResponse
object
3 properties
3 required
EnergyDerDetailResponse
object
3 properties
2 required
EnergyAccountListResponseV2
object
3 properties
3 required
EnergyAccountDetailResponseV4
object
3 properties
2 required
EnergyPaymentScheduleResponse
object
3 properties
2 required
EnergyConcessionsResponse
object
3 properties
2 required
EnergyBalanceListResponse
object
3 properties
3 required
EnergyBalanceResponse
object
3 properties
2 required
EnergyInvoiceListResponse
object
3 properties
3 required
EnergyBillingListResponseV3
object
3 properties
3 required
PrimaryResponseErrorListV1
object
1 property
1 required
ResponseErrorListV2
object
1 property
1 required
ErrorV2
object
4 properties
3 required
EnergyPlan
object
14 properties
6 required
EnergyPlanContractV3
object
16 properties
4 required
EnergyPlanControlledLoadV2
object
6 properties
2 required
EnergyPlanIncentives
object
4 properties
3 required
EnergyPlanDiscounts
object
10 properties
3 required
EnergyPlanGreenPowerCharges
object
5 properties
4 required
EnergyPlanEligibility
object
3 properties
2 required
EnergyPlanFees
object
5 properties
2 required
EnergyPlanSolarFeedInTariffV3
object
9 properties
4 required
EnergyPlanTariffPeriodV2
object
12 properties
4 required
EnergyServicePointV2
object
10 properties
7 required
EnergyServicePointDetailV2
EnergyUsageRead
object
11 properties
4 required
EnergyDerRecord
object
8 properties
6 required
EnergyAccountBaseV2
object
5 properties
1 required
EnergyPaymentSchedule
object
6 properties
1 required
EnergyConcession
object
10 properties
2 required
EnergyInvoice
object
14 properties
6 required
EnergyInvoiceGasUsageCharges
object
6 properties
4 required
EnergyInvoiceElectricityUsageCharges
object
6 properties
4 required
EnergyInvoiceAccountCharges
object
Object contains account level charges and credits related to electricity usage.
3 properties
2 required
EnergyBillingTransactionV3
object
9 properties
3 required
EnergyBillingUsageTransactionV2
object
12 properties
5 required
EnergyBillingDemandTransactionV3
object
12 properties
5 required
EnergyBillingOnceOffTransaction
object
4 properties
2 required
EnergyBillingOtherTransaction
object
9 properties
2 required
EnergyBillingPaymentTransaction
object
2 properties
2 required
CommonPhysicalAddress
object
3 properties
1 required
CommonSimpleAddress
object
Required if addressUType is set to simple.
8 properties
3 required
CommonPAFAddress
object
Australian address formatted according to the file format defined by the [PAF file format](https://auspost.com.au/content/dam/auspostcorp/media/documents/austr…
22 properties
3 required
RequestServicePointIdListV1
object
2 properties
1 required
RequestAccountIdListV1
object
2 properties
1 required
EnergyPlanId
string
The unique identifier for the Energy plan.
EnergyServicePointId
string
A unique identifier for an Energy service point, generated according to [CDR ID Permanence](id-permanence) requirements.
EnergyAccountId
string
A unique identifier for an Energy account, generated according to [CDR ID Permanence](id-permanence) requirements.
Links
object
1 property
1 required
LinksPaginated
object
5 properties
1 required
MetaPaginated
object
2 properties
2 required
EnergyPlanListResponse_data
object
1 property
1 required
EnergyServicePointListResponseV2_data
object
1 property
1 required
EnergyUsageListResponse_data
object
1 property
1 required
EnergyDerListResponse_data
object
1 property
1 required
EnergyAccountListResponseV2_data
object
1 property
1 required
EnergyPaymentScheduleResponse_data
object
1 property
1 required
EnergyConcessionsResponse_data
object
1 property
1 required
EnergyBalanceListResponse_data_balances
object
2 properties
2 required
EnergyBalanceListResponse_data
object
1 property
1 required
EnergyBalanceResponse_data
object
1 property
1 required
EnergyInvoiceListResponse_data
object
1 property
1 required
EnergyBillingListResponseV3_data
object
1 property
1 required
PrimaryErrorV1_allOf
object
1 property
ErrorV2_meta
object
Additional data for customised error codes.
1 property
EnergyPlan_additionalInformation
object
Object that contains links to additional information on specific topics.
5 properties
EnergyPlan_geography
object
Describes the geographical area that the plan is available for. If absent then it is assumed the plan is not geographically limited.
3 properties
1 required
EnergyPlanDetailV3_allOf_meteringCharges
object
5 properties
2 required
EnergyPlanDetailV3_allOf
object
3 properties
EnergyPlanContractV3_intrinsicGreenPower
object
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 con…
1 property
1 required
EnergyPlanContractFullV3_allOf
object
6 properties
1 required
EnergyPlanControlledLoadV2_singleRate_rates
object
3 properties
1 required
EnergyPlanControlledLoadV2_singleRate
object
Object representing a single controlled load rate. Required if rateBlockUType is singleRate.
5 properties
2 required
EnergyPlanControlledLoadV2_timeOfUse
object
5 properties
EnergyPlanControlledLoadV2_timeOfUseRates
object
7 properties
4 required
EnergyPlanDiscounts_percentOfBill
object
Required if methodUType is percentOfBill.
1 property
1 required
EnergyPlanDiscounts_percentOfUse
object
Required if methodUType is percentOfUse.
1 property
1 required
EnergyPlanDiscounts_fixedAmount
object
Required if methodUType is fixedAmount.
1 property
1 required
EnergyPlanDiscounts_percentOverThreshold
object
Required if methodUType is percentOverThreshold.
2 properties
2 required
EnergyPlanGreenPowerCharges_tiers
object
3 properties
1 required
EnergyPlanSolarFeedInTariffV3_singleTariff_rates
object
3 properties
1 required
EnergyPlanSolarFeedInTariffV3_singleTariff
object
Represents a constant tariff. Mandatory if tariffUType is set to singleTariff.
2 properties
1 required
EnergyPlanSolarFeedInTariffV3_timeVariations
object
3 properties
1 required
EnergyPlanSolarFeedInTariffV3_timeVaryingTariffs
object
5 properties
2 required
EnergyPlanTariffPeriodV2_bandedDailySupplyCharges
object
3 properties
1 required
EnergyPlanTariffPeriodV2_singleRate
object
Object representing a single rate. Required if rateBlockUType is singleRate.
5 properties
2 required
EnergyPlanTariffPeriodV2_timeOfUse
object
3 properties
3 required
EnergyPlanTariffPeriodV2_timeOfUseRates
object
6 properties
4 required
EnergyPlanTariffPeriodV2_demandCharges
object
11 properties
6 required
EnergyServicePointV2_consumerProfile
object
2 properties
EnergyServicePointDetailV2_allOf_distributionLossFactor
object
3 properties
3 required
EnergyServicePointDetailV2_allOf_relatedParticipants
object
2 properties
2 required
EnergyServicePointDetailV2_allOf_specifications
object
Technical characteristics of the meter.
6 properties
2 required
EnergyServicePointDetailV2_allOf_registers
object
10 properties
2 required
EnergyServicePointDetailV2_allOf_meters
object
3 properties
2 required
EnergyServicePointDetailV2_allOf
object
4 properties
3 required
EnergyUsageRead_basicRead
object
Mandatory if readUType is set to basicRead.
2 properties
1 required
EnergyUsageRead_intervalRead_readQualities
object
3 properties
3 required
EnergyUsageRead_intervalRead
object
Mandatory if readUType is set to intervalRead.
4 properties
1 required
EnergyDerRecord_protectionMode
object
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 p…
15 properties
EnergyDerRecord_derDevices
object
9 properties
4 required
EnergyDerRecord_acConnections
object
10 properties
5 required
EnergyAccountV2_allOf_planOverview
object
Mandatory if openStatus is OPEN.
3 properties
1 required
EnergyAccountV2_allOf_plans
object
3 properties
1 required
EnergyAccountV2_allOf
object
The array of plans containing service points and associated plan details.
1 property
1 required
EnergyAccountDetailV4_allOf_planDetail
object
Detail on the plan applicable to this account. Mandatory if openStatus is OPEN.
5 properties
1 required
EnergyAccountDetailV4_allOf_authorisedContacts
object
5 properties
1 required
EnergyAccountDetailV4_allOf_plans
object
5 properties
1 required
EnergyAccountDetailV4_allOf
object
The array of plans containing service points and associated plan details.
1 property
1 required
EnergyPaymentSchedule_cardDebit
object
Represents a regular credit card payment schedule. Mandatory if paymentScheduleUType is set to cardDebit.
3 properties
3 required
EnergyPaymentSchedule_directDebit
object
Represents a regular direct debit from a specified bank account. Mandatory if paymentScheduleUType is set to directDebit.
5 properties
2 required
EnergyPaymentSchedule_digitalWallet
object
Represents a regular payment from a digital wallet. Mandatory if paymentScheduleUType is set to digitalWallet.
6 properties
6 required
EnergyPaymentSchedule_manualPayment
object
Represents a manual payment schedule where the customer pays in response to a delivered statement. Mandatory if paymentScheduleUType is set to manualPayment.
1 property
1 required
EnergyInvoice_period
object
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.
2 properties
2 required
EnergyInvoice_payOnTimeDiscount
object
A discount for on time payment.
3 properties
2 required
EnergyInvoiceGasUsageCharges_otherCharges
object
3 properties
2 required
EnergyBillingUsageTransactionV2_calculationFactors
object
2 properties
2 required
EnergyBillingUsageTransactionV2_adjustments
object
2 properties
2 required
RequestServicePointIdListV1_data
object
1 property
1 required
RequestAccountIdListV1_data
object
1 property
1 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs AGL Energy publishes across the network.
