{ "openapi": "3.0.3", "info": { "title": "CDR Energy API", "version": "1.36.0", "description": "Specifications for resource endpoints applicable to data holders in the Energy sector.", "contact": { "name": "Data Standards Body", "email": "contact@dsb.gov.au", "url": "https://dsb.gov.au/" } }, "servers": [ { "description": "MTLS", "url": "https://mtls.dh.example.com/cds-au/v1" } ], "tags": [ { "name": "Energy Plans", "x-shortName": "Plans", "description": "Energy Plan endpoints" }, { "name": "Electricity Service Points", "x-shortName": "Service Points", "description": "Electricity Service Point endpoints" }, { "name": "Electricity Usage", "x-shortName": "Usage", "description": "Electricity Usage endpoints" }, { "name": "Distributed Energy Resources", "x-shortName": "Distributed Energy Resources", "description": "Distributed Energy Resource endpoints" }, { "name": "Energy Accounts", "x-shortName": "Accounts", "description": "Energy Account endpoints" }, { "name": "Energy Account Balances", "x-shortName": "Account Balances", "description": "Energy Account Balance endpoints" }, { "name": "Energy Account Billing", "x-shortName": "Billing", "description": "Energy Account Billing endpoints" } ], "paths": { "/energy/plans": { "get": { "servers": [ { "description": "TLS", "url": "https://tls.dh.example.com/cds-au/v1" } ], "summary": "Get Generic Plans", "operationId": "listEnergyPlans", "description": "Obtain a list of energy plans that are currently offered to the market.\n\nNote that the results returned by this endpoint are expected to be ordered in descending order according to _lastUpdated_.", "tags": [ "Energy Plans" ], "x-version": "1", "parameters": [ { "name": "type", "in": "query", "description": "Used to filter results on the _type_ field. Any one of the valid values for this field can be supplied plus `ALL`. If absent defaults to `ALL`.", "schema": { "type": "string", "default": "ALL", "enum": [ "STANDING", "MARKET", "REGULATED", "ALL" ] } }, { "name": "fuelType", "in": "query", "description": "Used to filter results on the _fuelType_ field. Any one of the valid values for this field can be supplied plus `ALL`. If absent defaults to `ALL`.", "schema": { "type": "string", "default": "ALL", "enum": [ "ELECTRICITY", "GAS", "DUAL", "ALL" ] } }, { "name": "effective", "in": "query", "description": "Allows for the filtering of plans based on whether the current time is within the period of time defined as effective by the _effectiveFrom_ and _effectiveTo_ fields. Valid values are `CURRENT`, `FUTURE` and `ALL`. If absent defaults to `CURRENT`.", "schema": { "type": "string", "default": "CURRENT", "enum": [ "CURRENT", "FUTURE", "ALL" ] } }, { "name": "updated-since", "in": "query", "description": "Only include plans that have been updated after the specified date and time. If absent defaults to include all plans.", "schema": { "type": "string" }, "x-cds-type": "DateTimeString" }, { "name": "brand", "in": "query", "description": "Used to filter results on the _brand_ field. If absent defaults to include all plans.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/QueryPage" }, { "$ref": "#/components/parameters/QueryPageSize" }, { "$ref": "#/components/parameters/HeaderXV" }, { "$ref": "#/components/parameters/HeaderXMinV" } ], "responses": { "200": { "$ref": "#/components/responses/ListEnergyPlans200" }, "400": { "$ref": "#/components/responses/ListEnergyPlans400" }, "406": { "$ref": "#/components/responses/ListEnergyPlans406" }, "422": { "$ref": "#/components/responses/ListEnergyPlans422" } } } }, "/energy/plans/{planId}": { "get": { "servers": [ { "description": "TLS", "url": "https://tls.dh.example.com/cds-au/v1" } ], "summary": "Get Generic Plan Detail", "operationId": "getEnergyPlanDetail", "description": "Obtain detailed information on a single energy plan offered openly to the market.\n\nOther Versions: [v1](includes/obsolete/get-generic-plan-detail-v1.html), [v2](includes/obsolete/get-generic-plan-detail-v2.html).", "tags": [ "Energy Plans" ], "x-version": "3", "x-version-notes": "The dailySupplyChargeType field was added in endpoint v3 as part of Standards v1.30.0. In Standards v1.32.0, the description of that field was changed to remove the default value, but it did not result in a new endpoint version. Refer to the [v1.32.0 release notes](includes/releasenotes/releasenotes.1.32.0.html) for more details.", "parameters": [ { "name": "planId", "description": "ID of the specific plan requested.", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/EnergyPlanId" } }, { "$ref": "#/components/parameters/HeaderXV" }, { "$ref": "#/components/parameters/HeaderXMinV" } ], "responses": { "200": { "$ref": "#/components/responses/GetEnergyPlanDetail200" }, "400": { "$ref": "#/components/responses/GetEnergyPlanDetail400" }, "404": { "$ref": "#/components/responses/GetEnergyPlanDetail404" }, "406": { "$ref": "#/components/responses/GetEnergyPlanDetail406" } } } }, "/energy/electricity/servicepoints": { "get": { "summary": "Get Service Points", "description": "Obtain a list of service points owned by the customer that has authorised the current session.\n\nOther Versions: [v1](includes/obsolete/get-service-points-v1.html).", "operationId": "listElectricityServicePoints", "x-scopes": [ "energy:electricity.servicepoints.basic:read" ], "tags": [ "Electricity Service Points" ], "x-version": "2", "parameters": [ { "$ref": "#/components/parameters/QueryPage" }, { "$ref": "#/components/parameters/QueryPageSize" }, { "$ref": "#/components/parameters/HeaderXV" }, { "$ref": "#/components/parameters/HeaderXMinV" }, { "$ref": "#/components/parameters/HeaderXFAPIInteractionId" }, { "$ref": "#/components/parameters/HeaderXFAPIAuthDate" }, { "$ref": "#/components/parameters/HeaderXFAPICustomerIPAddress" }, { "$ref": "#/components/parameters/HeaderXCDSClientHeaders" } ], "responses": { "200": { "$ref": "#/components/responses/ListElectricityServicePoints200" }, "400": { "$ref": "#/components/responses/ListElectricityServicePoints400" }, "406": { "$ref": "#/components/responses/ListElectricityServicePoints406" }, "422": { "$ref": "#/components/responses/ListElectricityServicePoints422" } } } }, "/energy/electricity/servicepoints/{servicePointId}": { "get": { "summary": "Get Service Point Detail", "operationId": "getElectricityServicePointDetail", "x-scopes": [ "energy:electricity.servicepoints.detail:read" ], "description": "Obtain detailed standing information for a specific service point that is owned by the customer that has authorised the current session.\n\nOther Versions: [v1](includes/obsolete/get-service-point-detail-v1.html).", "tags": [ "Electricity Service Points" ], "x-version": "2", "parameters": [ { "$ref": "#/components/parameters/PathServicePointId" }, { "$ref": "#/components/parameters/HeaderXV" }, { "$ref": "#/components/parameters/HeaderXMinV" }, { "$ref": "#/components/parameters/HeaderXFAPIInteractionId" }, { "$ref": "#/components/parameters/HeaderXFAPIAuthDate" }, { "$ref": "#/components/parameters/HeaderXFAPICustomerIPAddress" }, { "$ref": "#/components/parameters/HeaderXCDSClientHeaders" } ], "responses": { "200": { "$ref": "#/components/responses/GetElectricityServicePointDetail200" }, "400": { "$ref": "#/components/responses/GetElectricityServicePointDetail400" }, "404": { "$ref": "#/components/responses/GetElectricityServicePointDetail404" }, "406": { "$ref": "#/components/responses/GetElectricityServicePointDetail406" } } } }, "/energy/electricity/servicepoints/{servicePointId}/usage": { "get": { "summary": "Get Usage For Service Point", "operationId": "getElectricityServicePointUsage", "x-scopes": [ "energy:electricity.usage:read" ], "description": "Obtain a list of electricity usage data from a particular service point.", "tags": [ "Electricity Usage" ], "x-version": "1", "parameters": [ { "$ref": "#/components/parameters/PathServicePointId" }, { "$ref": "#/components/parameters/QueryOldestDate" }, { "$ref": "#/components/parameters/QueryNewestDate" }, { "$ref": "#/components/parameters/QueryEnergyIntervalReads" }, { "$ref": "#/components/parameters/QueryPage" }, { "$ref": "#/components/parameters/QueryPageSize" }, { "$ref": "#/components/parameters/HeaderXV" }, { "$ref": "#/components/parameters/HeaderXMinV" }, { "$ref": "#/components/parameters/HeaderXFAPIInteractionId" }, { "$ref": "#/components/parameters/HeaderXFAPIAuthDate" }, { "$ref": "#/components/parameters/HeaderXFAPICustomerIPAddress" }, { "$ref": "#/components/parameters/HeaderXCDSClientHeaders" } ], "responses": { "200": { "$ref": "#/components/responses/GetElectricityServicePointUsage200" }, "400": { "$ref": "#/components/responses/GetElectricityServicePointUsage400" }, "404": { "$ref": "#/components/responses/GetElectricityServicePointUsage404" }, "406": { "$ref": "#/components/responses/GetElectricityServicePointUsage406" }, "422": { "$ref": "#/components/responses/GetElectricityServicePointUsage422" } } } }, "/energy/electricity/servicepoints/usage": { "get": { "summary": "Get Bulk Usage", "operationId": "listElectricityUsageBulk", "x-scopes": [ "energy:electricity.usage:read" ], "description": "Obtain usage data for all service points associated with the customer.", "tags": [ "Electricity Usage" ], "x-version": "1", "parameters": [ { "$ref": "#/components/parameters/QueryEnergyIntervalReads" }, { "$ref": "#/components/parameters/QueryOldestDate" }, { "$ref": "#/components/parameters/QueryNewestDate" }, { "$ref": "#/components/parameters/QueryPage" }, { "$ref": "#/components/parameters/QueryPageSize" }, { "$ref": "#/components/parameters/HeaderXV" }, { "$ref": "#/components/parameters/HeaderXMinV" }, { "$ref": "#/components/parameters/HeaderXFAPIInteractionId" }, { "$ref": "#/components/parameters/HeaderXFAPIAuthDate" }, { "$ref": "#/components/parameters/HeaderXFAPICustomerIPAddress" }, { "$ref": "#/components/parameters/HeaderXCDSClientHeaders" } ], "responses": { "200": { "$ref": "#/components/responses/ListElectricityUsageBulk200" }, "400": { "$ref": "#/components/responses/ListElectricityUsageBulk400" }, "406": { "$ref": "#/components/responses/ListElectricityUsageBulk406" }, "422": { "$ref": "#/components/responses/ListElectricityUsageBulk422" } } }, "post": { "summary": "Get Usage For Specific Service Points", "operationId": "listElectricityUsageForServicePoints", "x-scopes": [ "energy:electricity.usage:read" ], "description": "Obtain the electricity usage data for a specific set of service points.", "tags": [ "Electricity Usage" ], "x-version": "1", "parameters": [ { "$ref": "#/components/parameters/QueryOldestDate" }, { "$ref": "#/components/parameters/QueryNewestDate" }, { "$ref": "#/components/parameters/QueryEnergyIntervalReads" }, { "$ref": "#/components/parameters/QueryPage" }, { "$ref": "#/components/parameters/QueryPageSize" }, { "$ref": "#/components/parameters/HeaderXV" }, { "$ref": "#/components/parameters/HeaderXMinV" }, { "$ref": "#/components/parameters/HeaderXFAPIInteractionId" }, { "$ref": "#/components/parameters/HeaderXFAPIAuthDate" }, { "$ref": "#/components/parameters/HeaderXFAPICustomerIPAddress" }, { "$ref": "#/components/parameters/HeaderXCDSClientHeaders" } ], "requestBody": { "$ref": "#/components/requestBodies/RequestServicePointIds" }, "responses": { "200": { "$ref": "#/components/responses/ListElectricityUsageForServicePoints200" }, "400": { "$ref": "#/components/responses/ListElectricityUsageForServicePoints400" }, "406": { "$ref": "#/components/responses/ListElectricityUsageForServicePoints406" }, "422": { "$ref": "#/components/responses/ListElectricityUsageForServicePoints422" } } } }, "/energy/electricity/servicepoints/{servicePointId}/der": { "get": { "summary": "Get DER For Service Point", "operationId": "getElectricityDERForServicePoint", "description": "Obtain a list of DER data from a particular service point.", "x-scopes": [ "energy:electricity.der:read" ], "tags": [ "Distributed Energy Resources" ], "x-version": "1", "parameters": [ { "$ref": "#/components/parameters/PathServicePointId" }, { "$ref": "#/components/parameters/HeaderXV" }, { "$ref": "#/components/parameters/HeaderXMinV" }, { "$ref": "#/components/parameters/HeaderXFAPIInteractionId" }, { "$ref": "#/components/parameters/HeaderXFAPIAuthDate" }, { "$ref": "#/components/parameters/HeaderXFAPICustomerIPAddress" }, { "$ref": "#/components/parameters/HeaderXCDSClientHeaders" } ], "responses": { "200": { "$ref": "#/components/responses/GetElectricityDERForServicePoint200" }, "400": { "$ref": "#/components/responses/GetElectricityDERForServicePoint400" }, "404": { "$ref": "#/components/responses/GetElectricityDERForServicePoint404" }, "406": { "$ref": "#/components/responses/GetElectricityDERForServicePoint406" } } } }, "/energy/electricity/servicepoints/der": { "get": { "summary": "Get Bulk DER", "operationId": "listElectricityDERBulk", "description": "Obtain DER data for all service points associated with the customer.", "x-scopes": [ "energy:electricity.der:read" ], "tags": [ "Distributed Energy Resources" ], "x-version": "1", "parameters": [ { "$ref": "#/components/parameters/QueryPage" }, { "$ref": "#/components/parameters/QueryPageSize" }, { "$ref": "#/components/parameters/HeaderXV" }, { "$ref": "#/components/parameters/HeaderXMinV" }, { "$ref": "#/components/parameters/HeaderXFAPIInteractionId" }, { "$ref": "#/components/parameters/HeaderXFAPIAuthDate" }, { "$ref": "#/components/parameters/HeaderXFAPICustomerIPAddress" }, { "$ref": "#/components/parameters/HeaderXCDSClientHeaders" } ], "responses": { "200": { "$ref": "#/components/responses/ListElectricityDERBulk200" }, "400": { "$ref": "#/components/responses/ListElectricityDERBulk400" }, "406": { "$ref": "#/components/responses/ListElectricityDERBulk406" }, "422": { "$ref": "#/components/responses/ListElectricityDERBulk422" } } }, "post": { "summary": "Get DER For Specific Service Points", "operationId": "listElectricityDERForSpecificServicePoints", "description": "Obtain DER data for a specific set of service points.", "x-scopes": [ "energy:electricity.der:read" ], "tags": [ "Distributed Energy Resources" ], "x-version": "1", "parameters": [ { "$ref": "#/components/parameters/QueryPage" }, { "$ref": "#/components/parameters/QueryPageSize" }, { "$ref": "#/components/parameters/HeaderXV" }, { "$ref": "#/components/parameters/HeaderXMinV" }, { "$ref": "#/components/parameters/HeaderXFAPIInteractionId" }, { "$ref": "#/components/parameters/HeaderXFAPIAuthDate" }, { "$ref": "#/components/parameters/HeaderXFAPICustomerIPAddress" }, { "$ref": "#/components/parameters/HeaderXCDSClientHeaders" } ], "requestBody": { "$ref": "#/components/requestBodies/RequestServicePointIds" }, "responses": { "200": { "$ref": "#/components/responses/ListElectricityDERForSpecificServicePoints200" }, "400": { "$ref": "#/components/responses/ListElectricityDERForSpecificServicePoints400" }, "406": { "$ref": "#/components/responses/ListElectricityDERForSpecificServicePoints406" }, "422": { "$ref": "#/components/responses/ListElectricityDERForSpecificServicePoints422" } } } }, "/energy/accounts": { "get": { "summary": "Get Energy Accounts", "operationId": "listEnergyAccounts", "description": "Obtain the list of energy accounts available under the authorised consent.\n\nOther Versions: [v1](includes/obsolete/get-energy-accounts-v1.html).", "x-scopes": [ "energy:accounts.basic:read" ], "tags": [ "Energy Accounts" ], "x-version": "2", "parameters": [ { "$ref": "#/components/parameters/QueryEnergyAccountOpenStatus" }, { "$ref": "#/components/parameters/QueryPage" }, { "$ref": "#/components/parameters/QueryPageSize" }, { "$ref": "#/components/parameters/HeaderXV" }, { "$ref": "#/components/parameters/HeaderXMinV" }, { "$ref": "#/components/parameters/HeaderXFAPIInteractionId" }, { "$ref": "#/components/parameters/HeaderXFAPIAuthDate" }, { "$ref": "#/components/parameters/HeaderXFAPICustomerIPAddress" }, { "$ref": "#/components/parameters/HeaderXCDSClientHeaders" } ], "responses": { "200": { "$ref": "#/components/responses/ListEnergyAccounts200" }, "400": { "$ref": "#/components/responses/ListEnergyAccounts400" }, "406": { "$ref": "#/components/responses/ListEnergyAccounts406" }, "422": { "$ref": "#/components/responses/ListEnergyAccounts422" } } } }, "/energy/accounts/{accountId}": { "get": { "summary": "Get Energy Account Detail", "operationId": "getEnergyAccountDetail", "description": "Obtain detailed information for a specific energy account.\n\nOther Versions: [v1](includes/obsolete/get-energy-account-detail-v1.html), [v2](includes/obsolete/get-energy-account-detail-v2.html), [v3](includes/obsolete/get-energy-account-detail-v3.html).", "x-scopes": [ "energy:accounts.detail:read" ], "tags": [ "Energy Accounts" ], "x-version": "4", "x-version-notes": "The dailySupplyChargeType field was added in endpoint v3 as part of Standards v1.30.0. In Standards v1.32.0, the description of that field was changed to remove the default value, but it did not result in a new endpoint version. Refer to the [v1.32.0 release notes](includes/releasenotes/releasenotes.1.32.0.html) for more details.", "parameters": [ { "$ref": "#/components/parameters/PathAccountId" }, { "$ref": "#/components/parameters/HeaderXV" }, { "$ref": "#/components/parameters/HeaderXMinV" }, { "$ref": "#/components/parameters/HeaderXFAPIInteractionId" }, { "$ref": "#/components/parameters/HeaderXFAPIAuthDate" }, { "$ref": "#/components/parameters/HeaderXFAPICustomerIPAddress" }, { "$ref": "#/components/parameters/HeaderXCDSClientHeaders" } ], "responses": { "200": { "$ref": "#/components/responses/GetEnergyAccountDetail200" }, "400": { "$ref": "#/components/responses/GetEnergyAccountDetail400" }, "404": { "$ref": "#/components/responses/GetEnergyAccountDetail404" }, "406": { "$ref": "#/components/responses/GetEnergyAccountDetail406" } } } }, "/energy/accounts/{accountId}/payment-schedule": { "get": { "summary": "Get Agreed Payment Schedule", "operationId": "getEnergyAccountPaymentSchedule", "description": "Obtain the agreed payment schedule and details, if any, for a specific energy account.\n\nSome general notes about this endpoint:\n\n ", "x-scopes": [ "energy:accounts.paymentschedule:read" ], "tags": [ "Energy Accounts" ], "x-version": "1", "parameters": [ { "$ref": "#/components/parameters/PathAccountId" }, { "$ref": "#/components/parameters/HeaderXV" }, { "$ref": "#/components/parameters/HeaderXMinV" }, { "$ref": "#/components/parameters/HeaderXFAPIInteractionId" }, { "$ref": "#/components/parameters/HeaderXFAPIAuthDate" }, { "$ref": "#/components/parameters/HeaderXFAPICustomerIPAddress" }, { "$ref": "#/components/parameters/HeaderXCDSClientHeaders" } ], "responses": { "200": { "$ref": "#/components/responses/GetEnergyAccountPaymentSchedule200" }, "400": { "$ref": "#/components/responses/GetEnergyAccountPaymentSchedule400" }, "404": { "$ref": "#/components/responses/GetEnergyAccountPaymentSchedule404" }, "406": { "$ref": "#/components/responses/GetEnergyAccountPaymentSchedule406" } } } }, "/energy/accounts/{accountId}/concessions": { "get": { "summary": "Get Concessions", "operationId": "getEnergyAccountConcessions", "description": "Obtain the details of any concessions or arrangements applied to a specific energy account.", "x-scopes": [ "energy:accounts.concessions:read" ], "tags": [ "Energy Accounts" ], "x-version": "1", "parameters": [ { "$ref": "#/components/parameters/PathAccountId" }, { "$ref": "#/components/parameters/HeaderXV" }, { "$ref": "#/components/parameters/HeaderXMinV" }, { "$ref": "#/components/parameters/HeaderXFAPIInteractionId" }, { "$ref": "#/components/parameters/HeaderXFAPIAuthDate" }, { "$ref": "#/components/parameters/HeaderXFAPICustomerIPAddress" }, { "$ref": "#/components/parameters/HeaderXCDSClientHeaders" } ], "responses": { "200": { "$ref": "#/components/responses/GetEnergyAccountConcessions200" }, "400": { "$ref": "#/components/responses/GetEnergyAccountConcessions400" }, "404": { "$ref": "#/components/responses/GetEnergyAccountConcessions404" }, "406": { "$ref": "#/components/responses/GetEnergyAccountConcessions406" } } } }, "/energy/accounts/{accountId}/balance": { "get": { "summary": "Get Balance For Energy Account", "operationId": "getEnergyAccountBalance", "description": "Obtain the current balance for a specific account.", "x-scopes": [ "energy:billing:read" ], "tags": [ "Energy Account Balances" ], "x-version": "1", "parameters": [ { "$ref": "#/components/parameters/PathAccountId" }, { "$ref": "#/components/parameters/HeaderXV" }, { "$ref": "#/components/parameters/HeaderXMinV" }, { "$ref": "#/components/parameters/HeaderXFAPIInteractionId" }, { "$ref": "#/components/parameters/HeaderXFAPIAuthDate" }, { "$ref": "#/components/parameters/HeaderXFAPICustomerIPAddress" }, { "$ref": "#/components/parameters/HeaderXCDSClientHeaders" } ], "responses": { "200": { "$ref": "#/components/responses/GetEnergyAccountBalance200" }, "400": { "$ref": "#/components/responses/GetEnergyAccountBalance400" }, "404": { "$ref": "#/components/responses/GetEnergyAccountBalance404" }, "406": { "$ref": "#/components/responses/GetEnergyAccountBalance406" } } } }, "/energy/accounts/balances": { "get": { "summary": "Get Bulk Balances for Energy", "operationId": "listEnergyAccountBalancesBulk", "description": "Obtain the current balance for all accounts.", "x-scopes": [ "energy:billing:read" ], "tags": [ "Energy Account Balances" ], "x-version": "1", "parameters": [ { "$ref": "#/components/parameters/QueryPage" }, { "$ref": "#/components/parameters/QueryPageSize" }, { "$ref": "#/components/parameters/HeaderXV" }, { "$ref": "#/components/parameters/HeaderXMinV" }, { "$ref": "#/components/parameters/HeaderXFAPIInteractionId" }, { "$ref": "#/components/parameters/HeaderXFAPIAuthDate" }, { "$ref": "#/components/parameters/HeaderXFAPICustomerIPAddress" }, { "$ref": "#/components/parameters/HeaderXCDSClientHeaders" } ], "responses": { "200": { "$ref": "#/components/responses/ListEnergyAccountBalancesBulk200" }, "400": { "$ref": "#/components/responses/ListEnergyAccountBalancesBulk400" }, "406": { "$ref": "#/components/responses/ListEnergyAccountBalancesBulk406" }, "422": { "$ref": "#/components/responses/ListEnergyAccountBalancesBulk422" } } }, "post": { "summary": "Get Balances For Specific Energy Accounts", "operationId": "listEnergyAccountBalancesSpecificAccounts", "description": "Obtain the current balance for a specified set of accounts.", "x-scopes": [ "energy:billing:read" ], "tags": [ "Energy Account Balances" ], "x-version": "1", "parameters": [ { "$ref": "#/components/parameters/QueryPage" }, { "$ref": "#/components/parameters/QueryPageSize" }, { "$ref": "#/components/parameters/HeaderXV" }, { "$ref": "#/components/parameters/HeaderXMinV" }, { "$ref": "#/components/parameters/HeaderXFAPIInteractionId" }, { "$ref": "#/components/parameters/HeaderXFAPIAuthDate" }, { "$ref": "#/components/parameters/HeaderXFAPICustomerIPAddress" }, { "$ref": "#/components/parameters/HeaderXCDSClientHeaders" } ], "requestBody": { "$ref": "#/components/requestBodies/RequestAccountIds" }, "responses": { "200": { "$ref": "#/components/responses/ListEnergyAccountBalancesSpecificAccounts200" }, "400": { "$ref": "#/components/responses/ListEnergyAccountBalancesSpecificAccounts400" }, "406": { "$ref": "#/components/responses/ListEnergyAccountBalancesSpecificAccounts406" }, "422": { "$ref": "#/components/responses/ListEnergyAccountBalancesSpecificAccounts422" } } } }, "/energy/accounts/{accountId}/invoices": { "get": { "summary": "Get Invoices For Account", "operationId": "getEnergyAccountInvoices", "description": "Obtain the invoices for a specific account.", "x-scopes": [ "energy:billing:read" ], "tags": [ "Energy Account Billing" ], "x-version": "1", "parameters": [ { "$ref": "#/components/parameters/PathAccountId" }, { "$ref": "#/components/parameters/QueryNewestDateInvoices" }, { "$ref": "#/components/parameters/QueryOldestDateInvoices" }, { "$ref": "#/components/parameters/QueryPage" }, { "$ref": "#/components/parameters/QueryPageSize" }, { "$ref": "#/components/parameters/HeaderXV" }, { "$ref": "#/components/parameters/HeaderXMinV" }, { "$ref": "#/components/parameters/HeaderXFAPIInteractionId" }, { "$ref": "#/components/parameters/HeaderXFAPIAuthDate" }, { "$ref": "#/components/parameters/HeaderXFAPICustomerIPAddress" }, { "$ref": "#/components/parameters/HeaderXCDSClientHeaders" } ], "responses": { "200": { "$ref": "#/components/responses/GetEnergyAccountInvoices200" }, "400": { "$ref": "#/components/responses/GetEnergyAccountInvoices400" }, "404": { "$ref": "#/components/responses/GetEnergyAccountInvoices404" }, "406": { "$ref": "#/components/responses/GetEnergyAccountInvoices406" }, "422": { "$ref": "#/components/responses/GetEnergyAccountInvoices422" } } } }, "/energy/accounts/invoices": { "get": { "summary": "Get Bulk Invoices", "operationId": "listEnergyAccountInvoicesBulk", "description": "Obtain the invoices for all accounts.", "x-scopes": [ "energy:billing:read" ], "tags": [ "Energy Account Billing" ], "x-version": "1", "parameters": [ { "$ref": "#/components/parameters/QueryNewestDateInvoices" }, { "$ref": "#/components/parameters/QueryOldestDateInvoices" }, { "$ref": "#/components/parameters/QueryPage" }, { "$ref": "#/components/parameters/QueryPageSize" }, { "$ref": "#/components/parameters/HeaderXV" }, { "$ref": "#/components/parameters/HeaderXMinV" }, { "$ref": "#/components/parameters/HeaderXFAPIInteractionId" }, { "$ref": "#/components/parameters/HeaderXFAPIAuthDate" }, { "$ref": "#/components/parameters/HeaderXFAPICustomerIPAddress" }, { "$ref": "#/components/parameters/HeaderXCDSClientHeaders" } ], "responses": { "200": { "$ref": "#/components/responses/ListEnergyAccountInvoicesBulk200" }, "400": { "$ref": "#/components/responses/ListEnergyAccountInvoicesBulk400" }, "406": { "$ref": "#/components/responses/ListEnergyAccountInvoicesBulk406" }, "422": { "$ref": "#/components/responses/ListEnergyAccountInvoicesBulk422" } } }, "post": { "summary": "Get Invoices For Specific Accounts", "operationId": "listEnergyInvoicesForSpecificAccounts", "description": "Obtain invoices for a specified set of accounts.", "x-scopes": [ "energy:billing:read" ], "tags": [ "Energy Account Billing" ], "x-version": "1", "parameters": [ { "$ref": "#/components/parameters/QueryNewestDateInvoices" }, { "$ref": "#/components/parameters/QueryOldestDateInvoices" }, { "$ref": "#/components/parameters/QueryPage" }, { "$ref": "#/components/parameters/QueryPageSize" }, { "$ref": "#/components/parameters/HeaderXV" }, { "$ref": "#/components/parameters/HeaderXMinV" }, { "$ref": "#/components/parameters/HeaderXFAPIInteractionId" }, { "$ref": "#/components/parameters/HeaderXFAPIAuthDate" }, { "$ref": "#/components/parameters/HeaderXFAPICustomerIPAddress" }, { "$ref": "#/components/parameters/HeaderXCDSClientHeaders" } ], "requestBody": { "$ref": "#/components/requestBodies/RequestAccountIds" }, "responses": { "200": { "$ref": "#/components/responses/ListEnergyInvoicesForSpecificAccounts200" }, "400": { "$ref": "#/components/responses/ListEnergyInvoicesForSpecificAccounts400" }, "406": { "$ref": "#/components/responses/ListEnergyInvoicesForSpecificAccounts406" }, "422": { "$ref": "#/components/responses/ListEnergyInvoicesForSpecificAccounts422" } } } }, "/energy/accounts/{accountId}/billing": { "get": { "summary": "Get Billing For Account", "operationId": "getBillingForEnergyAccount", "description": "Obtain the billing transactions for a specific account.\n\nDeprecated Versions: \n\n- [v1](includes/obsolete/get-billing-for-account-v1.html) - This version is to be ceased to be called by data recipients by September 9th 2024 and **MAY** be decommissioned by data holders as of that date \n- [v2](includes/obsolete/get-billing-for-account-v2.html) - This version **MAY** be retired by September 9th 2024 if v3 is implemented.", "x-scopes": [ "energy:billing:read" ], "tags": [ "Energy Account Billing" ], "x-version": "3", "parameters": [ { "$ref": "#/components/parameters/PathAccountId" }, { "$ref": "#/components/parameters/QueryNewestTime" }, { "$ref": "#/components/parameters/QueryOldestTime" }, { "$ref": "#/components/parameters/QueryPage" }, { "$ref": "#/components/parameters/QueryPageSize" }, { "$ref": "#/components/parameters/HeaderXV" }, { "$ref": "#/components/parameters/HeaderXMinV" }, { "$ref": "#/components/parameters/HeaderXFAPIInteractionId" }, { "$ref": "#/components/parameters/HeaderXFAPIAuthDate" }, { "$ref": "#/components/parameters/HeaderXFAPICustomerIPAddress" }, { "$ref": "#/components/parameters/HeaderXCDSClientHeaders" } ], "responses": { "200": { "$ref": "#/components/responses/GetBillingForEnergyAccount200" }, "400": { "$ref": "#/components/responses/GetBillingForEnergyAccount400" }, "404": { "$ref": "#/components/responses/GetBillingForEnergyAccount404" }, "406": { "$ref": "#/components/responses/GetBillingForEnergyAccount406" }, "422": { "$ref": "#/components/responses/GetBillingForEnergyAccount422" } } } }, "/energy/accounts/billing": { "get": { "summary": "Get Bulk Billing", "operationId": "listEnergyAccountBillingBulk", "description": "Obtain billing transactions for all accounts.\n\nDeprecated Versions: \n\n- [v1](includes/obsolete/get-bulk-billing-v1.html) - This version is to be ceased to be called by data recipients by September 9th 2024 and **MAY** be decommissioned by data holders as of that date \n- [v2](includes/obsolete/get-bulk-billing-v2.html) - This version **MAY** be retired by September 9th 2024 if v3 is implemented.", "x-scopes": [ "energy:billing:read" ], "tags": [ "Energy Account Billing" ], "x-version": "3", "parameters": [ { "$ref": "#/components/parameters/QueryNewestTime" }, { "$ref": "#/components/parameters/QueryOldestTime" }, { "$ref": "#/components/parameters/QueryPage" }, { "$ref": "#/components/parameters/QueryPageSize" }, { "$ref": "#/components/parameters/HeaderXV" }, { "$ref": "#/components/parameters/HeaderXMinV" }, { "$ref": "#/components/parameters/HeaderXFAPIInteractionId" }, { "$ref": "#/components/parameters/HeaderXFAPIAuthDate" }, { "$ref": "#/components/parameters/HeaderXFAPICustomerIPAddress" }, { "$ref": "#/components/parameters/HeaderXCDSClientHeaders" } ], "responses": { "200": { "$ref": "#/components/responses/ListEnergyAccountBillingBulk200" }, "400": { "$ref": "#/components/responses/ListEnergyAccountBillingBulk400" }, "406": { "$ref": "#/components/responses/ListEnergyAccountBillingBulk406" }, "422": { "$ref": "#/components/responses/ListEnergyAccountBillingBulk422" } } }, "post": { "summary": "Get Billing For Specific Accounts", "operationId": "listEnergyAccountBillingForSpecificAccounts", "description": "Obtain billing for a specified set of accounts.\n\nDeprecated Versions: \n\n- [v1](includes/obsolete/get-billing-for-specific-accounts-v1.html) - This version is to be ceased to be called by data recipients by September 9th 2024 and **MAY** be decommissioned by data holders as of that date \n- [v2](includes/obsolete/get-billing-for-specific-accounts-v2.html) - This version **MAY** be retired by September 9th 2024 if v3 is implemented.", "x-scopes": [ "energy:billing:read" ], "tags": [ "Energy Account Billing" ], "x-version": "3", "parameters": [ { "$ref": "#/components/parameters/QueryNewestTime" }, { "$ref": "#/components/parameters/QueryOldestTime" }, { "$ref": "#/components/parameters/QueryPage" }, { "$ref": "#/components/parameters/QueryPageSize" }, { "$ref": "#/components/parameters/HeaderXV" }, { "$ref": "#/components/parameters/HeaderXMinV" }, { "$ref": "#/components/parameters/HeaderXFAPIInteractionId" }, { "$ref": "#/components/parameters/HeaderXFAPIAuthDate" }, { "$ref": "#/components/parameters/HeaderXFAPICustomerIPAddress" }, { "$ref": "#/components/parameters/HeaderXCDSClientHeaders" } ], "requestBody": { "$ref": "#/components/requestBodies/RequestAccountIds" }, "responses": { "200": { "$ref": "#/components/responses/ListEnergyAccountBillingForSpecificAccounts200" }, "400": { "$ref": "#/components/responses/ListEnergyAccountBillingForSpecificAccounts400" }, "406": { "$ref": "#/components/responses/ListEnergyAccountBillingForSpecificAccounts406" }, "422": { "$ref": "#/components/responses/ListEnergyAccountBillingForSpecificAccounts422" } } } } }, "components": { "parameters": { "PathServicePointId": { "name": "servicePointId", "description": "The _servicePointId_ to obtain data for. _servicePointId_ values are returned by service point list endpoints. Note that it is not a _nationalMeteringId_.", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/EnergyServicePointId" } }, "PathAccountId": { "name": "accountId", "in": "path", "description": "The _accountId_ to obtain data for. _accountId_ values are returned by account list endpoints.", "required": true, "schema": { "$ref": "#/components/schemas/EnergyAccountId" } }, "QueryEnergyAccountOpenStatus": { "name": "open-status", "in": "query", "description": "Used to filter results according to open/closed status. Values can be `OPEN`, `CLOSED` or `ALL`. If absent then `ALL` is assumed.", "schema": { "type": "string", "default": "ALL", "enum": [ "ALL", "CLOSED", "OPEN" ] } }, "QueryEnergyIntervalReads": { "name": "interval-reads", "description": "Type of interval reads. Any one of the valid values for this field can be supplied. If absent defaults to `NONE`.", "in": "query", "schema": { "type": "string", "default": "NONE", "enum": [ "NONE", "MIN_30", "FULL" ] } }, "QueryNewestTime": { "name": "newest-time", "in": "query", "description": "Constrain the request to records with effective time at or before this date/time. If absent defaults to current date/time. Format is aligned to DateTimeString common type.", "schema": { "type": "string" }, "x-cds-type": "DateTimeString" }, "QueryOldestTime": { "name": "oldest-time", "in": "query", "description": "Constrain the request to records with effective time at or after this date/time. If absent defaults to _newest-time_ minus 12 months. Format is aligned to DateTimeString common type.", "schema": { "type": "string" }, "x-cds-type": "DateTimeString" }, "QueryNewestDate": { "name": "newest-date", "in": "query", "description": "Constrain the request to records with effective date at or before this date. If absent defaults to current date. Format is aligned to DateString common type.", "schema": { "type": "string" }, "x-cds-type": "DateString" }, "QueryOldestDate": { "name": "oldest-date", "in": "query", "description": "Constrain the request to records with effective date at or after this date. If absent defaults to _newest-date_ minus 24 months. Format is aligned to DateString common type.", "schema": { "type": "string" }, "x-cds-type": "DateString" }, "QueryNewestDateInvoices": { "name": "newest-date", "in": "query", "description": "Constrain the request to records with issue date at or before this date. If absent defaults to current date. Format is aligned to DateString common type.", "schema": { "type": "string" }, "x-cds-type": "DateString" }, "QueryOldestDateInvoices": { "name": "oldest-date", "in": "query", "description": "Constrain the request to records with issue date at or after this date. If absent defaults to _newest-date_ minus 24 months. Format is aligned to DateString common type.", "schema": { "type": "string" }, "x-cds-type": "DateString" }, "QueryPage": { "name": "page", "description": "Page of results to request (standard pagination).", "in": "query", "schema": { "type": "integer", "default": "1" }, "x-cds-type": "PositiveInteger" }, "QueryPageSize": { "name": "page-size", "description": "Page size to request. Default is 25 (standard pagination).", "in": "query", "schema": { "type": "integer", "default": "25" }, "x-cds-type": "PositiveInteger" }, "HeaderXV": { "name": "x-v", "description": "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_](#request-headers) and [_x-v_](#request-headers). If the value of [_x-min-v_](#request-headers) is equal to or higher than the value of [_x-v_](#request-headers) then the [_x-min-v_](#request-headers) 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](#request-headers).", "in": "header", "required": true, "schema": { "type": "string" } }, "HeaderXMinV": { "name": "x-min-v", "description": "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_](#request-headers) and [_x-v_](#request-headers). If all versions requested are not supported then the endpoint **MUST** respond with a `406 Not Acceptable`.", "in": "header", "schema": { "type": "string" } }, "HeaderXFAPIInteractionId": { "name": "x-fapi-interaction-id", "description": "An **[[RFC4122]](#nref-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]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", "in": "header", "schema": { "type": "string" } }, "HeaderXFAPIAuthDate": { "name": "x-fapi-auth-date", "description": "The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.", "in": "header", "x-conditional": true, "schema": { "type": "string" } }, "HeaderXFAPICustomerIPAddress": { "name": "x-fapi-customer-ip-address", "description": "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.", "in": "header", "schema": { "type": "string" } }, "HeaderXCDSClientHeaders": { "name": "x-cds-client-headers", "description": "The customer's original standard http headers [Base64](#common-field-types) 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.", "in": "header", "x-conditional": true, "schema": { "type": "string" }, "x-cds-type": "Base64" } }, "headers": { "XV": { "description": "The [payload version](#response-headers) that the endpoint has responded with.", "required": true, "schema": { "type": "string" } }, "XFAPIInteractionId": { "description": "An **[[RFC4122]](#nref-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]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", "required": true, "schema": { "type": "string" } } }, "requestBodies": { "RequestServicePointIds": { "description": "Request payload containing a list of _servicePointId_ values to obtain data for.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestServicePointIdListV1" } } }, "required": true }, "RequestAccountIds": { "description": "Request payload containing a list of _accountId_ values to obtain data for.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestAccountIdListV1" } } }, "required": true } }, "responses": { "ListEnergyPlans200": { "description": "Successful response", "headers": { "x-v": { "$ref": "#/components/headers/XV" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnergyPlanListResponse" } } } }, "ListEnergyPlans400": { "description": "The following error codes **MUST** be supported:
", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorListV2" } } } }, "ListEnergyPlans406": { "description": "The following error codes **MUST** be supported:
", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorListV2" } } } }, "ListEnergyPlans422": { "description": "The following error codes **MUST** be supported:
", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorListV2" } } } }, "GetEnergyPlanDetail200": { "description": "Successful response", "headers": { "x-v": { "$ref": "#/components/headers/XV" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnergyPlanResponseV3" } } } }, "GetEnergyPlanDetail400": { "description": "The following error codes **MUST** be supported:
", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorListV2" } } } }, "GetEnergyPlanDetail404": { "description": "The following error codes **MUST** be supported:
", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorListV2" } } } }, "GetEnergyPlanDetail406": { "description": "The following error codes **MUST** be supported:
", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorListV2" } } } }, "ListElectricityServicePoints200": { "description": "Successful response", "headers": { "x-v": { "$ref": "#/components/headers/XV" }, "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnergyServicePointListResponseV2" } } } }, "ListElectricityServicePoints400": { "description": "The following error codes **MUST** be supported:
", "headers": { "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrimaryResponseErrorListV1" } } } }, "ListElectricityServicePoints406": { "description": "The following error codes **MUST** be supported:
", "headers": { "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrimaryResponseErrorListV1" } } } }, "ListElectricityServicePoints422": { "description": "The following error codes **MUST** be supported:
", "headers": { "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrimaryResponseErrorListV1" } } } }, "GetElectricityServicePointDetail200": { "description": "Successful response", "headers": { "x-v": { "$ref": "#/components/headers/XV" }, "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnergyServicePointDetailResponseV2" } } } }, "GetElectricityServicePointDetail400": { "description": "The following error codes **MUST** be supported:
", "headers": { "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrimaryResponseErrorListV1" } } } }, "GetElectricityServicePointDetail404": { "description": "The following error codes **MUST** be supported:
", "headers": { "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrimaryResponseErrorListV1" } } } }, "GetElectricityServicePointDetail406": { "description": "The following error codes **MUST** be supported:
", "headers": { "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrimaryResponseErrorListV1" } } } }, "GetElectricityServicePointUsage200": { "description": "Successful response", "headers": { "x-v": { "$ref": "#/components/headers/XV" }, "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnergyUsageListResponse" } } } }, "GetElectricityServicePointUsage400": { "description": "The following error codes **MUST** be supported:
", "headers": { "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrimaryResponseErrorListV1" } } } }, "GetElectricityServicePointUsage404": { "description": "The following error codes **MUST** be supported:
", "headers": { "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrimaryResponseErrorListV1" } } } }, "GetElectricityServicePointUsage406": { "description": "The following error codes **MUST** be supported:
", "headers": { "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrimaryResponseErrorListV1" } } } }, "GetElectricityServicePointUsage422": { "description": "The following error codes **MUST** be supported:
", "headers": { "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrimaryResponseErrorListV1" } } } }, "ListElectricityUsageBulk200": { "description": "Successful response", "headers": { "x-v": { "$ref": "#/components/headers/XV" }, "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnergyUsageListResponse" } } } }, "ListElectricityUsageBulk400": { "description": "The following error codes **MUST** be supported:
", "headers": { "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrimaryResponseErrorListV1" } } } }, "ListElectricityUsageBulk406": { "description": "The following error codes **MUST** be supported:
", "headers": { "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrimaryResponseErrorListV1" } } } }, "ListElectricityUsageBulk422": { "description": "The following error codes **MUST** be supported:
", "headers": { "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrimaryResponseErrorListV1" } } } }, "ListElectricityUsageForServicePoints200": { "description": "Successful response", "headers": { "x-v": { "$ref": "#/components/headers/XV" }, "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnergyUsageListResponse" } } } }, "ListElectricityUsageForServicePoints400": { "description": "The following error codes **MUST** be supported:
", "headers": { "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrimaryResponseErrorListV1" } } } }, "ListElectricityUsageForServicePoints406": { "description": "The following error codes **MUST** be supported:
", "headers": { "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrimaryResponseErrorListV1" } } } }, "ListElectricityUsageForServicePoints422": { "description": "The following error codes **MUST** be supported:
", "headers": { "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrimaryResponseErrorListV1" } } } }, "GetElectricityDERForServicePoint200": { "description": "Successful response", "headers": { "x-v": { "$ref": "#/components/headers/XV" }, "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnergyDerDetailResponse" } } } }, "GetElectricityDERForServicePoint400": { "description": "The following error codes **MUST** be supported:
", "headers": { "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrimaryResponseErrorListV1" } } } }, "GetElectricityDERForServicePoint404": { "description": "The following error codes **MUST** be supported:
", "headers": { "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrimaryResponseErrorListV1" } } } }, "GetElectricityDERForServicePoint406": { "description": "The following error codes **MUST** be supported:
", "headers": { "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrimaryResponseErrorListV1" } } } }, "ListElectricityDERBulk200": { "description": "Successful response", "headers": { "x-v": { "$ref": "#/components/headers/XV" }, "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnergyDerListResponse" } } } }, "ListElectricityDERBulk400": { "description": "The following error codes **MUST** be supported:
", "headers": { "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrimaryResponseErrorListV1" } } } }, "ListElectricityDERBulk406": { "description": "The following error codes **MUST** be supported:
", "headers": { "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrimaryResponseErrorListV1" } } } }, "ListElectricityDERBulk422": { "description": "The following error codes **MUST** be supported:
", "headers": { "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrimaryResponseErrorListV1" } } } }, "ListElectricityDERForSpecificServicePoints200": { "description": "Successful response", "headers": { "x-v": { "$ref": "#/components/headers/XV" }, "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnergyDerListResponse" } } } }, "ListElectricityDERForSpecificServicePoints400": { "description": "The following error codes **MUST** be supported:
", "headers": { "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrimaryResponseErrorListV1" } } } }, "ListElectricityDERForSpecificServicePoints406": { "description": "The following error codes **MUST** be supported:
", "headers": { "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrimaryResponseErrorListV1" } } } }, "ListElectricityDERForSpecificServicePoints422": { "description": "The following error codes **MUST** be supported:
", "headers": { "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrimaryResponseErrorListV1" } } } }, "ListEnergyAccounts200": { "description": "Successful response", "headers": { "x-v": { "$ref": "#/components/headers/XV" }, "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnergyAccountListResponseV2" } } } }, "ListEnergyAccounts400": { "description": "The following error codes **MUST** be supported:
", "headers": { "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorListV2" } } } }, "ListEnergyAccounts406": { "description": "The following error codes **MUST** be supported:
", "headers": { "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorListV2" } } } }, "ListEnergyAccounts422": { "description": "The following error codes **MUST** be supported:
", "headers": { "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorListV2" } } } }, "GetEnergyAccountDetail200": { "description": "Successful response", "headers": { "x-v": { "$ref": "#/components/headers/XV" }, "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnergyAccountDetailResponseV4" } } } }, "GetEnergyAccountDetail400": { "description": "The following error codes **MUST** be supported:
", "headers": { "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorListV2" } } } }, "GetEnergyAccountDetail404": { "description": "The following error codes **MUST** be supported:
", "headers": { "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorListV2" } } } }, "GetEnergyAccountDetail406": { "description": "The following error codes **MUST** be supported:
", "headers": { "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorListV2" } } } }, "GetEnergyAccountPaymentSchedule200": { "description": "Successful response", "headers": { "x-v": { "$ref": "#/components/headers/XV" }, "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnergyPaymentScheduleResponse" } } } }, "GetEnergyAccountPaymentSchedule400": { "description": "The following error codes **MUST** be supported:
", "headers": { "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorListV2" } } } }, "GetEnergyAccountPaymentSchedule404": { "description": "The following error codes **MUST** be supported:
", "headers": { "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorListV2" } } } }, "GetEnergyAccountPaymentSchedule406": { "description": "The following error codes **MUST** be supported:
", "headers": { "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorListV2" } } } }, "GetEnergyAccountConcessions200": { "description": "Successful response", "headers": { "x-v": { "$ref": "#/components/headers/XV" }, "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnergyConcessionsResponse" } } } }, "GetEnergyAccountConcessions400": { "description": "The following error codes **MUST** be supported:
", "headers": { "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorListV2" } } } }, "GetEnergyAccountConcessions404": { "description": "The following error codes **MUST** be supported:
", "headers": { "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorListV2" } } } }, "GetEnergyAccountConcessions406": { "description": "The following error codes **MUST** be supported:
", "headers": { "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorListV2" } } } }, "GetEnergyAccountBalance200": { "description": "Successful response", "headers": { "x-v": { "$ref": "#/components/headers/XV" }, "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnergyBalanceResponse" } } } }, "GetEnergyAccountBalance400": { "description": "The following error codes **MUST** be supported:
", "headers": { "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorListV2" } } } }, "GetEnergyAccountBalance404": { "description": "The following error codes **MUST** be supported:
", "headers": { "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorListV2" } } } }, "GetEnergyAccountBalance406": { "description": "The following error codes **MUST** be supported:
", "headers": { "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorListV2" } } } }, "ListEnergyAccountBalancesBulk200": { "description": "Successful response", "headers": { "x-v": { "$ref": "#/components/headers/XV" }, "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnergyBalanceListResponse" } } } }, "ListEnergyAccountBalancesBulk400": { "description": "The following error codes **MUST** be supported:
", "headers": { "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorListV2" } } } }, "ListEnergyAccountBalancesBulk406": { "description": "The following error codes **MUST** be supported:
", "headers": { "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorListV2" } } } }, "ListEnergyAccountBalancesBulk422": { "description": "The following error codes **MUST** be supported:
", "headers": { "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorListV2" } } } }, "ListEnergyAccountBalancesSpecificAccounts200": { "description": "Successful response", "headers": { "x-v": { "$ref": "#/components/headers/XV" }, "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnergyBalanceListResponse" } } } }, "ListEnergyAccountBalancesSpecificAccounts400": { "description": "The following error codes **MUST** be supported:
", "headers": { "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorListV2" } } } }, "ListEnergyAccountBalancesSpecificAccounts406": { "description": "The following error codes **MUST** be supported:
", "headers": { "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorListV2" } } } }, "ListEnergyAccountBalancesSpecificAccounts422": { "description": "The following error codes **MUST** be supported:
", "headers": { "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorListV2" } } } }, "GetEnergyAccountInvoices200": { "description": "Successful response", "headers": { "x-v": { "$ref": "#/components/headers/XV" }, "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnergyInvoiceListResponse" } } } }, "GetEnergyAccountInvoices400": { "description": "The following error codes **MUST** be supported:
", "headers": { "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorListV2" } } } }, "GetEnergyAccountInvoices404": { "description": "The following error codes **MUST** be supported:
", "headers": { "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorListV2" } } } }, "GetEnergyAccountInvoices406": { "description": "The following error codes **MUST** be supported:
", "headers": { "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorListV2" } } } }, "GetEnergyAccountInvoices422": { "description": "The following error codes **MUST** be supported:
", "headers": { "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorListV2" } } } }, "ListEnergyAccountInvoicesBulk200": { "description": "Successful response", "headers": { "x-v": { "$ref": "#/components/headers/XV" }, "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnergyInvoiceListResponse" } } } }, "ListEnergyAccountInvoicesBulk400": { "description": "The following error codes **MUST** be supported:
", "headers": { "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorListV2" } } } }, "ListEnergyAccountInvoicesBulk406": { "description": "The following error codes **MUST** be supported:
", "headers": { "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorListV2" } } } }, "ListEnergyAccountInvoicesBulk422": { "description": "The following error codes **MUST** be supported:
", "headers": { "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorListV2" } } } }, "ListEnergyInvoicesForSpecificAccounts200": { "description": "Successful response", "headers": { "x-v": { "$ref": "#/components/headers/XV" }, "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnergyInvoiceListResponse" } } } }, "ListEnergyInvoicesForSpecificAccounts400": { "description": "The following error codes **MUST** be supported:
", "headers": { "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorListV2" } } } }, "ListEnergyInvoicesForSpecificAccounts406": { "description": "The following error codes **MUST** be supported:
", "headers": { "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorListV2" } } } }, "ListEnergyInvoicesForSpecificAccounts422": { "description": "The following error codes **MUST** be supported:
", "headers": { "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorListV2" } } } }, "GetBillingForEnergyAccount200": { "description": "Successful response", "headers": { "x-v": { "$ref": "#/components/headers/XV" }, "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnergyBillingListResponseV3" } } } }, "GetBillingForEnergyAccount400": { "description": "The following error codes **MUST** be supported:
", "headers": { "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorListV2" } } } }, "GetBillingForEnergyAccount404": { "description": "The following error codes **MUST** be supported:
", "headers": { "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorListV2" } } } }, "GetBillingForEnergyAccount406": { "description": "The following error codes **MUST** be supported:
", "headers": { "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorListV2" } } } }, "GetBillingForEnergyAccount422": { "description": "The following error codes **MUST** be supported:
", "headers": { "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorListV2" } } } }, "ListEnergyAccountBillingBulk200": { "description": "Successful response", "headers": { "x-v": { "$ref": "#/components/headers/XV" }, "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnergyBillingListResponseV3" } } } }, "ListEnergyAccountBillingBulk400": { "description": "The following error codes **MUST** be supported:
", "headers": { "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorListV2" } } } }, "ListEnergyAccountBillingBulk406": { "description": "The following error codes **MUST** be supported:
", "headers": { "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorListV2" } } } }, "ListEnergyAccountBillingBulk422": { "description": "The following error codes **MUST** be supported:
", "headers": { "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorListV2" } } } }, "ListEnergyAccountBillingForSpecificAccounts200": { "description": "Successful response", "headers": { "x-v": { "$ref": "#/components/headers/XV" }, "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnergyBillingListResponseV3" } } } }, "ListEnergyAccountBillingForSpecificAccounts400": { "description": "The following error codes **MUST** be supported:
", "headers": { "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorListV2" } } } }, "ListEnergyAccountBillingForSpecificAccounts406": { "description": "The following error codes **MUST** be supported:
", "headers": { "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorListV2" } } } }, "ListEnergyAccountBillingForSpecificAccounts422": { "description": "The following error codes **MUST** be supported:
", "headers": { "x-fapi-interaction-id": { "$ref": "#/components/headers/XFAPIInteractionId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorListV2" } } } } }, "schemas": { "EnergyPlanListResponse": { "type": "object", "required": [ "data", "links", "meta" ], "properties": { "data": { "type": "object", "required": [ "plans" ], "properties": { "plans": { "description": "Array of plans.", "type": "array", "items": { "$ref": "#/components/schemas/EnergyPlan" } } } }, "links": { "$ref": "#/components/schemas/LinksPaginated" }, "meta": { "$ref": "#/components/schemas/MetaPaginated" } } }, "EnergyPlanResponseV3": { "type": "object", "required": [ "data", "links" ], "properties": { "data": { "$ref": "#/components/schemas/EnergyPlanDetailV3" }, "links": { "$ref": "#/components/schemas/Links" }, "meta": { "$ref": "#/components/schemas/Meta" } } }, "EnergyServicePointListResponseV2": { "type": "object", "required": [ "data", "links", "meta" ], "properties": { "data": { "type": "object", "required": [ "servicePoints" ], "properties": { "servicePoints": { "type": "array", "items": { "$ref": "#/components/schemas/EnergyServicePointV2" } } } }, "links": { "$ref": "#/components/schemas/LinksPaginated" }, "meta": { "$ref": "#/components/schemas/MetaPaginated" } } }, "EnergyServicePointDetailResponseV2": { "type": "object", "required": [ "data", "links" ], "properties": { "data": { "$ref": "#/components/schemas/EnergyServicePointDetailV2" }, "links": { "$ref": "#/components/schemas/Links" }, "meta": { "$ref": "#/components/schemas/Meta" } } }, "EnergyUsageListResponse": { "type": "object", "required": [ "data", "links", "meta" ], "properties": { "data": { "type": "object", "required": [ "reads" ], "properties": { "reads": { "description": "Array of meter reads sorted by NMI in ascending order followed by _readStartDate_ in descending order.", "type": "array", "items": { "$ref": "#/components/schemas/EnergyUsageRead" } } } }, "links": { "$ref": "#/components/schemas/LinksPaginated" }, "meta": { "$ref": "#/components/schemas/MetaPaginated" } } }, "EnergyDerListResponse": { "type": "object", "required": [ "data", "links", "meta" ], "properties": { "data": { "type": "object", "required": [ "derRecords" ], "properties": { "derRecords": { "description": "Array of meter reads.", "type": "array", "items": { "$ref": "#/components/schemas/EnergyDerRecord" } } } }, "links": { "$ref": "#/components/schemas/LinksPaginated" }, "meta": { "$ref": "#/components/schemas/MetaPaginated" } } }, "EnergyDerDetailResponse": { "type": "object", "required": [ "data", "links" ], "properties": { "data": { "$ref": "#/components/schemas/EnergyDerRecord" }, "links": { "$ref": "#/components/schemas/Links" }, "meta": { "$ref": "#/components/schemas/Meta" } } }, "EnergyAccountListResponseV2": { "type": "object", "required": [ "data", "links", "meta" ], "properties": { "data": { "type": "object", "required": [ "accounts" ], "properties": { "accounts": { "description": "Array of accounts.", "type": "array", "items": { "$ref": "#/components/schemas/EnergyAccountV2" } } } }, "links": { "$ref": "#/components/schemas/LinksPaginated" }, "meta": { "$ref": "#/components/schemas/MetaPaginated" } } }, "EnergyAccountDetailResponseV4": { "type": "object", "required": [ "data", "links" ], "properties": { "data": { "$ref": "#/components/schemas/EnergyAccountDetailV4" }, "links": { "$ref": "#/components/schemas/Links" }, "meta": { "$ref": "#/components/schemas/Meta" } } }, "EnergyPaymentScheduleResponse": { "type": "object", "required": [ "data", "links" ], "properties": { "data": { "type": "object", "required": [ "paymentSchedules" ], "properties": { "paymentSchedules": { "description": "Array may be empty if no payment schedules exist.", "type": "array", "items": { "$ref": "#/components/schemas/EnergyPaymentSchedule" } } } }, "links": { "$ref": "#/components/schemas/Links" }, "meta": { "$ref": "#/components/schemas/Meta" } } }, "EnergyConcessionsResponse": { "type": "object", "required": [ "data", "links" ], "properties": { "data": { "type": "object", "required": [ "concessions" ], "properties": { "concessions": { "description": "Array may be empty if no concessions exist.", "type": "array", "items": { "$ref": "#/components/schemas/EnergyConcession" } } } }, "links": { "$ref": "#/components/schemas/Links" }, "meta": { "$ref": "#/components/schemas/Meta" } } }, "EnergyBalanceListResponse": { "type": "object", "required": [ "data", "links", "meta" ], "properties": { "data": { "type": "object", "required": [ "balances" ], "properties": { "balances": { "description": "Array of account balances.", "type": "array", "items": { "type": "object", "required": [ "accountId", "balance" ], "properties": { "accountId": { "description": "Unique identifier for the account.", "allOf": [{ "$ref": "#/components/schemas/EnergyAccountId" }] }, "balance": { "description": "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.", "type": "string", "x-cds-type": "AmountString" } } } } } }, "links": { "$ref": "#/components/schemas/LinksPaginated" }, "meta": { "$ref": "#/components/schemas/MetaPaginated" } } }, "EnergyBalanceResponse": { "type": "object", "required": [ "data", "links" ], "properties": { "data": { "type": "object", "required": [ "balance" ], "properties": { "balance": { "description": "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.", "type": "string", "x-cds-type": "AmountString" } } }, "links": { "$ref": "#/components/schemas/Links" }, "meta": { "$ref": "#/components/schemas/Meta" } } }, "EnergyInvoiceListResponse": { "type": "object", "required": [ "data", "links", "meta" ], "properties": { "data": { "type": "object", "required": [ "invoices" ], "properties": { "invoices": { "description": "Array of invoices sorted by issue date in descending order.", "type": "array", "items": { "$ref": "#/components/schemas/EnergyInvoice" } } } }, "links": { "$ref": "#/components/schemas/LinksPaginated" }, "meta": { "$ref": "#/components/schemas/MetaPaginated" } } }, "EnergyBillingListResponseV3": { "type": "object", "required": [ "data", "links", "meta" ], "properties": { "data": { "type": "object", "required": [ "transactions" ], "properties": { "transactions": { "description": "Array of transactions sorted by date and time in descending order.", "type": "array", "items": { "$ref": "#/components/schemas/EnergyBillingTransactionV3" } } } }, "links": { "$ref": "#/components/schemas/LinksPaginated" }, "meta": { "$ref": "#/components/schemas/MetaPaginated" } } }, "PrimaryResponseErrorListV1": { "type": "object", "required": [ "errors" ], "properties": { "errors": { "description": "List of errors.", "type": "array", "items": { "$ref": "#/components/schemas/PrimaryErrorV1" } } } }, "PrimaryErrorV1": { "type": "object", "allOf": [ { "type": "object", "properties": { "isSecondaryDataHolderError": { "type": "boolean", "description": "Indicates the error was propagated from a designated secondary data holder.", "default": false } } }, { "$ref": "#/components/schemas/ErrorV2" } ] }, "ResponseErrorListV2": { "type": "object", "required": [ "errors" ], "properties": { "errors": { "description": "List of errors.", "type": "array", "items": { "$ref": "#/components/schemas/ErrorV2" } } } }, "ErrorV2": { "type": "object", "required": [ "code", "title", "detail" ], "x-conditional": [ "meta" ], "properties": { "code": { "type": "string", "description": "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": { "type": "string", "description": "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": { "type": "string", "description": "A human-readable explanation specific to this occurrence of the problem." }, "meta": { "type": "object", "x-conditional": [ "urn" ], "description": "Additional data for customised error codes.", "properties": { "urn": { "type": "string", "description": "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": { "type": "object", "required": [ "planId", "lastUpdated", "type", "fuelType", "brand", "brandName" ], "properties": { "planId": { "$ref": "#/components/schemas/EnergyPlanId" }, "effectiveFrom": { "type": "string", "x-cds-type": "DateTimeString", "description": "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": { "type": "string", "x-cds-type": "DateTimeString", "description": "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": { "type": "string", "x-cds-type": "DateTimeString", "description": "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": { "type": "string", "description": "The display name of the plan." }, "description": { "type": "string", "description": "A description of the plan." }, "type": { "type": "string", "description": "The type of the plan.", "enum": [ "STANDING", "MARKET", "REGULATED" ] }, "fuelType": { "type": "string", "description": "The fuel types covered by the plan.", "enum": [ "ELECTRICITY", "GAS", "DUAL" ] }, "brand": { "type": "string", "x-cds-type": "ASCIIString", "description": "The ID of the brand under which this plan is offered." }, "brandName": { "type": "string", "description": "The display name of the brand under which this plan is offered." }, "applicationUri": { "type": "string", "x-cds-type": "URIString", "description": "A link to an application web page where this plan can be applied for." }, "additionalInformation": { "type": "object", "description": "Object that contains links to additional information on specific topics.", "properties": { "overviewUri": { "type": "string", "x-cds-type": "URIString", "description": "A link to a general overview of the plan." }, "termsUri": { "type": "string", "x-cds-type": "URIString", "description": "A link to terms and conditions for the plan." }, "eligibilityUri": { "type": "string", "x-cds-type": "URIString", "description": "A link to detail on eligibility criteria for the plan." }, "pricingUri": { "type": "string", "x-cds-type": "URIString", "description": "A link to detail on pricing for the plan." }, "bundleUri": { "type": "string", "x-cds-type": "URIString", "description": "A link to detail on bundles that this plan can be a part of." } } }, "customerType": { "type": "string", "description": "The type of customer that the plan is offered to. If absent then the plan is available to all customers.", "enum": [ "RESIDENTIAL", "BUSINESS" ] }, "geography": { "type": "object", "required": [ "distributors" ], "description": "Describes the geographical area that the plan is available for. If absent then it is assumed the plan is not geographically limited.", "properties": { "excludedPostcodes": { "description": "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`).", "type": "array", "items": { "type": "string" } }, "includedPostcodes": { "description": "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`).", "type": "array", "items": { "type": "string" } }, "distributors": { "description": "Array of distributors for the plan. Must have at least one entry.", "type": "array", "items": { "type": "string" } } } } } }, "EnergyPlanDetailV3": { "allOf": [ { "$ref": "#/components/schemas/EnergyPlan" }, { "type": "object", "x-conditional": [ "gasContract", "electricityContract" ], "properties": { "meteringCharges": { "description": "Charges for metering included in the plan.", "type": "array", "items": { "type": "object", "required": [ "displayName", "minimumValue" ], "properties": { "displayName": { "type": "string", "description": "Display name of the charge." }, "description": { "type": "string", "description": "Description of the charge." }, "minimumValue": { "type": "string", "x-cds-type": "AmountString", "description": "Minimum value of the charge if the charge is a range or the absolute value of the charge if no range is specified." }, "maximumValue": { "type": "string", "x-cds-type": "AmountString", "description": "The upper limit of the charge if the charge could occur in a range." }, "period": { "type": "string", "x-cds-type": "ExternalRef", "description": "The charges that occur on a schedule indicates the frequency. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax)." } } } }, "gasContract": { "description": "The details of the terms for the supply of electricity under this plan. Is mandatory if _fuelType_ is set to `GAS` or `DUAL`.", "allOf": [ { "$ref": "#/components/schemas/EnergyPlanContractFullV3" } ] }, "electricityContract": { "description": "The details of the terms for the supply of electricity under this plan. Is mandatory if _fuelType_ is set to `ELECTRICITY` or `DUAL`.", "allOf": [ { "$ref": "#/components/schemas/EnergyPlanContractFullV3" } ] } } } ] }, "EnergyPlanContractV3": { "type": "object", "required": [ "pricingModel", "isFixed", "paymentOption", "tariffPeriod" ], "x-conditional": [ "timeZone", "variation", "controlledLoad" ], "properties": { "additionalFeeInformation": { "type": "string", "description": "Free text field containing additional information of the fees for this contract." }, "pricingModel": { "type": "string", "description": "The pricing model for the contract. Contracts for gas must use `SINGLE_RATE`. Note that the detail for the enumeration values are:", "enum": [ "SINGLE_RATE", "SINGLE_RATE_CONT_LOAD", "TIME_OF_USE", "TIME_OF_USE_CONT_LOAD", "FLEXIBLE", "FLEXIBLE_CONT_LOAD", "QUOTA" ] }, "timeZone": { "type": "string", "description": "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.", "default": "AEST", "enum": [ "LOCAL", "AEST" ] }, "isFixed": { "type": "boolean", "description": "Flag indicating whether prices are fixed or variable." }, "variation": { "type": "string", "description": "Free text description of price variation policy and conditions for the contract. Mandatory if _isFixed_ is `false`." }, "onExpiryDescription": { "type": "string", "description": "Free text field that describes what will occur on or prior to expiry of the fixed contract term or benefit period." }, "paymentOption": { "description": "Payment options for this contract.", "type": "array", "items": { "type": "string", "enum": [ "PAPER_BILL", "CREDIT_CARD", "DIRECT_DEBIT", "BPAY", "OTHER" ] } }, "intrinsicGreenPower": { "description": "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.", "type": "object", "required": [ "greenPercentage" ], "properties": { "greenPercentage": { "type": "string", "x-cds-type": "RateString", "description": "Percentage of green power intrinsically included in the plan." } } }, "controlledLoad": { "description": "Required if pricing model is `SINGLE_RATE_CONT_LOAD` or `TIME_OF_USE_CONT_LOAD` or `FLEXIBLE_CONT_LOAD`.", "type": "array", "items": { "$ref": "#/components/schemas/EnergyPlanControlledLoadV2" } }, "incentives": { "description": "Optional list of incentives available for the contract.", "type": "array", "items": { "$ref": "#/components/schemas/EnergyPlanIncentives" } }, "discounts": { "description": "Optional list of discounts available for the contract.", "type": "array", "items": { "$ref": "#/components/schemas/EnergyPlanDiscounts" } }, "greenPowerCharges": { "description": "Optional list of charges applicable to green power.", "type": "array", "items": { "$ref": "#/components/schemas/EnergyPlanGreenPowerCharges" } }, "eligibility": { "description": "Eligibility restrictions or requirements.", "type": "array", "items": { "$ref": "#/components/schemas/EnergyPlanEligibility" } }, "fees": { "description": "An array of fees applicable to the plan.", "type": "array", "items": { "$ref": "#/components/schemas/EnergyPlanFees" } }, "solarFeedInTariff": { "description": "Array of feed in tariffs for solar power.", "type": "array", "items": { "$ref": "#/components/schemas/EnergyPlanSolarFeedInTariffV3" } }, "tariffPeriod": { "description": "Array of tariffs that apply to periods throughout the year.", "type": "array", "items": { "$ref": "#/components/schemas/EnergyPlanTariffPeriodV2" } } } }, "EnergyPlanContractFullV3": { "allOf": [ { "$ref": "#/components/schemas/EnergyPlanContractV3" }, { "type": "object", "required": [ "billFrequency" ], "x-conditional": [ "benefitPeriod", "variation", "coolingOffDays" ], "properties": { "termType": { "type": "string", "description": "The term for the contract. If absent assumes no specified term.", "enum": [ "1_YEAR", "2_YEAR", "3_YEAR", "4_YEAR", "5_YEAR", "ONGOING", "OTHER" ] }, "benefitPeriod": { "type": "string", "description": "Description of the benefit period. Should only be present if _termType_ has the value `ONGOING`." }, "terms": { "type": "string", "description": "Free text description of the terms for the contract." }, "meterTypes": { "description": "An array of the meter types that this contract is available for.", "type": "array", "items": { "type": "string" } }, "coolingOffDays": { "type": "integer", "x-cds-type": "PositiveInteger", "description": "Number of days in the cooling off period for the contract. Mandatory for plans with type of `MARKET`." }, "billFrequency": { "description": "An array of the available billing schedules for this contract. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax).", "type": "array", "items": { "type": "string" } } } } ] }, "EnergyPlanControlledLoadV2": { "type": "object", "required": [ "displayName", "rateBlockUType" ], "x-conditional": [ "singleRate", "timeOfUseRates" ], "properties": { "displayName": { "type": "string", "description": "A display name for the controlled load." }, "rateBlockUType": { "type": "string", "description": "Specifies the type of controlled load rate.", "enum": [ "singleRate", "timeOfUseRates" ] }, "startDate": { "description": "Optional start date of the application of the controlled load rate.", "type": "string", "x-cds-type": "DateString" }, "endDate": { "description": "Optional end date of the application of the controlled load rate.", "type": "string", "x-cds-type": "DateString" }, "singleRate": { "type": "object", "description": "Object representing a single controlled load rate. Required if _rateBlockUType_ is `singleRate`.", "required": [ "displayName", "rates" ], "properties": { "displayName": { "type": "string", "description": "Display name of the controlled load rate." }, "description": { "type": "string", "description": "Description of the controlled load rate." }, "dailySupplyCharge": { "type": "string", "x-cds-type": "AmountString", "description": "The daily supply charge (exclusive of GST) for this controlled load tier." }, "rates": { "description": "Array of controlled load rates in order of usage volume.", "type": "array", "items": { "type": "object", "required": [ "unitPrice" ], "properties": { "unitPrice": { "type": "string", "x-cds-type": "AmountString", "description": "Unit price of usage per measure unit (exclusive of GST)." }, "measureUnit": { "type": "string", "description": "The measurement unit of rate. Assumed to be `KWH` if absent.", "default": "KWH", "allOf": [ { "$ref": "#/components/schemas/MeasureUnitEnum" } ] }, "volume": { "type": "number", "description": "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": { "type": "string", "x-cds-type": "ExternalRef", "description": "Usage period for which the block rate applies. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax). Defaults to `P1Y` if absent.", "default": "P1Y" } } }, "timeOfUseRates": { "description": "Array of objects representing time of use rates. Required if _rateBlockUType_ is `timeOfUseRates`.", "type": "array", "items": { "type": "object", "required": [ "displayName", "type", "rates", "timeOfUse" ], "properties": { "displayName": { "type": "string", "description": "Display name of the controlled load rate." }, "description": { "type": "string", "description": "Description of the controlled load rate." }, "dailySupplyCharge": { "type": "string", "x-cds-type": "AmountString", "description": "The daily supply charge (exclusive of GST) for this controlled load tier." }, "rates": { "description": "Array of controlled load rates in order of usage volume.", "type": "array", "items": { "type": "object", "required": [ "unitPrice" ], "properties": { "unitPrice": { "type": "string", "x-cds-type": "AmountString", "description": "Unit price of usage per measure unit (exclusive of GST)." }, "measureUnit": { "type": "string", "description": "The measurement unit of rate. Assumed to be `KWH` if absent.", "default": "KWH", "allOf": [ { "$ref": "#/components/schemas/MeasureUnitEnum" } ] }, "volume": { "type": "number", "description": "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": { "type": "string", "x-cds-type": "ExternalRef", "description": "Usage period for which the block rate applies. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax). Defaults to `P1Y` if absent.", "default": "P1Y" }, "timeOfUse": { "description": "Array of time windows for which this time of use rate applies.", "type": "array", "items": { "type": "object", "x-conditional": [ "startTime", "endTime", "additionalInfo" ], "properties": { "days": { "description": "The days that this time window applies to.", "type": "array", "items": { "$ref": "#/components/schemas/EnergyDaysEnum" } }, "startTime": { "type": "string", "x-cds-type": "ExternalRef", "description": "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](https://en.wikipedia.org/wiki/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": { "type": "string", "x-cds-type": "ExternalRef", "description": "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](https://en.wikipedia.org/wiki/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": { "description": "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.", "type": "string" }, "additionalInfoUri": { "description": "Optional link to additional information regarding the controlled load.", "type": "string", "x-cds-type": "URIString" } } } }, "type": { "type": "string", "description": "The type of usage that the rate applies to.", "enum": [ "PEAK", "OFF_PEAK", "SHOULDER", "SOLAR_SPONGE" ] } } } } } }, "EnergyPlanIncentives": { "type": "object", "required": [ "displayName", "description", "category" ], "properties": { "displayName": { "type": "string", "description": "The display name of the incentive." }, "description": { "type": "string", "description": "The description of the incentive." }, "category": { "type": "string", "description": "The type of the incentive.", "enum": [ "GIFT", "ACCOUNT_CREDIT", "OTHER" ] }, "eligibility": { "type": "string", "description": "A display message outlining an eligibility criteria that may apply." } } }, "EnergyPlanDiscounts": { "type": "object", "required": [ "displayName", "type", "methodUType" ], "x-conditional": [ "percentOfBill", "percentOfUse", "fixedAmount", "percentOverThreshold" ], "properties": { "displayName": { "type": "string", "description": "The display name of the discount." }, "description": { "type": "string", "description": "The description of the discount." }, "type": { "type": "string", "description": "The type of the discount.", "enum": [ "CONDITIONAL", "GUARANTEED", "OTHER" ] }, "category": { "type": "string", "description": "The type of the discount. Mandatory if the discount _type_ is `CONDITIONAL`.", "enum": [ "PAY_ON_TIME", "DIRECT_DEBIT", "GUARANTEED_DISCOUNT", "OTHER" ] }, "endDate": { "type": "string", "x-cds-type": "DateString", "description": "Optional end date for the discount after which the discount is no longer available." }, "methodUType": { "type": "string", "description": "The method of calculation of the discount.", "enum": [ "percentOfBill", "percentOfUse", "fixedAmount", "percentOverThreshold" ] }, "percentOfBill": { "type": "object", "description": "Required if _methodUType_ is `percentOfBill`.", "required": [ "rate" ], "properties": { "rate": { "type": "string", "x-cds-type": "RateString", "description": "The rate of the discount applied to the bill amount." } } }, "percentOfUse": { "type": "object", "description": "Required if _methodUType_ is `percentOfUse`.", "required": [ "rate" ], "properties": { "rate": { "type": "string", "x-cds-type": "RateString", "description": "The rate of the discount applied to the _usageamount_." } } }, "fixedAmount": { "type": "object", "description": "Required if _methodUType_ is `fixedAmount`.", "required": [ "amount" ], "properties": { "amount": { "type": "string", "x-cds-type": "AmountString", "description": "The amount of the discount." } } }, "percentOverThreshold": { "type": "object", "description": "Required if _methodUType_ is `percentOverThreshold`.", "required": [ "rate", "usageAmount" ], "properties": { "rate": { "type": "string", "x-cds-type": "RateString", "description": "The rate of the discount over the usage amount." }, "usageAmount": { "type": "string", "x-cds-type": "AmountString", "description": "The usage amount threshold above which the discount applies." } } } } }, "EnergyPlanGreenPowerCharges": { "type": "object", "required": [ "displayName", "scheme", "type", "tiers" ], "properties": { "displayName": { "type": "string", "description": "The display name of the charge." }, "description": { "type": "string", "description": "The description of the charge." }, "scheme": { "type": "string", "description": "The applicable green power scheme.", "enum": [ "GREENPOWER", "OTHER" ] }, "type": { "type": "string", "description": "The type of charge.", "enum": [ "FIXED_PER_DAY", "FIXED_PER_WEEK", "FIXED_PER_MONTH", "FIXED_PER_UNIT", "PERCENT_OF_USE", "PERCENT_OF_BILL" ] }, "tiers": { "description": "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.", "type": "array", "items": { "type": "object", "required": [ "percentGreen" ], "x-conditional": [ "rate", "amount" ], "properties": { "percentGreen": { "type": "string", "x-cds-type": "RateString", "description": "The upper percentage of green power used applicable for this tier." }, "rate": { "type": "string", "x-cds-type": "RateString", "description": "The rate of the charge if the type implies the application of a rate." }, "amount": { "type": "string", "x-cds-type": "AmountString", "description": "The amount of the charge if the type implies the application of a fixed amount." } } } } } }, "EnergyPlanEligibility": { "type": "object", "required": [ "type", "information" ], "properties": { "type": { "type": "string", "description": "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).", "enum": [ "EXISTING_CUST", "EXISTING_POOL", "EXISTING_SOLAR", "EXISTING_BATTERY", "EXISTING_SMART_METER", "EXISTING_BASIC_METER", "SENIOR_CARD", "SMALL_BUSINESS", "NO_SOLAR_FIT", "NEW_CUSTOMER", "ONLINE_ONLY", "REQ_EQUIP_SUPPLIER", "THIRD_PARTY_ONLY", "SPORT_CLUB_MEMBER", "ORG_MEMBER", "SPECIFIC_LOCATION", "MINIMUM_USAGE", "LOYALTY_MEMBER", "GROUP_BUY_MEMBER", "CONTINGENT_PLAN", "OTHER" ] }, "information": { "type": "string", "description": "Information of the eligibility restriction specific to the type of the restriction." }, "description": { "type": "string", "description": "A description of the eligibility restriction." } } }, "EnergyPlanFees": { "type": "object", "required": [ "type", "term" ], "x-conditional": [ "amount", "rate" ], "properties": { "type": { "type": "string", "description": "The type of the fee.", "enum": [ "EXIT", "ESTABLISHMENT", "LATE_PAYMENT", "DISCONNECTION", "DISCONNECT_MOVE_OUT", "DISCONNECT_NON_PAY", "RECONNECTION", "CONNECTION", "PAYMENT_PROCESSING", "CC_PROCESSING", "CHEQUE_DISHONOUR", "DD_DISHONOUR", "MEMBERSHIP", "CONTRIBUTION", "PAPER_BILL", "OTHER" ] }, "term": { "type": "string", "description": "The term of the fee.", "enum": [ "FIXED", "1_YEAR", "2_YEAR", "3_YEAR", "4_YEAR", "5_YEAR", "PERCENT_OF_BILL", "ANNUAL", "DAILY", "WEEKLY", "MONTHLY", "BIANNUAL", "VARIABLE" ] }, "amount": { "type": "string", "x-cds-type": "AmountString", "description": "The fee amount. Required if _term_ is not `PERCENT_OF_BILL`." }, "rate": { "type": "string", "x-cds-type": "RateString", "description": "The fee rate. Required if _term_ is `PERCENT_OF_BILL`." }, "description": { "type": "string", "description": "A description of the fee." } } }, "EnergyPlanSolarFeedInTariffV3": { "type": "object", "required": [ "displayName", "scheme", "payerType", "tariffUType" ], "x-conditional": [ "singleTariff", "timeVaryingTariffs" ], "properties": { "displayName": { "type": "string", "description": "The name of the tariff." }, "description": { "type": "string", "description": "A description of the tariff." }, "startDate": { "description": "The start date of the application of the feed in tariff.", "type": "string", "x-cds-type": "DateString" }, "endDate": { "description": "The end date of the application of the feed in tariff.", "type": "string", "x-cds-type": "DateString" }, "scheme": { "type": "string", "description": "The applicable scheme.", "enum": [ "PREMIUM", "CURRENT", "VARIABLE", "OTHER" ] }, "payerType": { "type": "string", "description": "The type of the payer.", "enum": [ "GOVERNMENT", "RETAILER" ] }, "tariffUType": { "type": "string", "description": "Reference to the applicable tariff structure.", "enum": [ "singleTariff", "timeVaryingTariffs" ] }, "singleTariff": { "type": "object", "description": "Represents a constant tariff. Mandatory if _tariffUType_ is set to `singleTariff`.", "required": [ "rates" ], "properties": { "rates": { "description": "Array of feed in rates.", "type": "array", "items": { "type": "object", "required": [ "unitPrice" ], "properties": { "unitPrice": { "type": "string", "x-cds-type": "AmountString", "description": "Unit price of usage per measure unit (exclusive of GST)." }, "measureUnit": { "type": "string", "description": "The measurement unit of rate. Assumed to be `KWH` if absent.", "default": "KWH", "allOf": [ { "$ref": "#/components/schemas/MeasureUnitEnum" } ] }, "volume": { "type": "number", "description": "Volume that this rate applies to. Only applicable for 'stepped' rates where different rates apply for different volumes of usage in a period." } } } }, "period": { "type": "string", "x-cds-type": "ExternalRef", "description": "Usage period for which the block rate applies. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax). Defaults to `P1Y` if absent.", "default": "P1Y" } } }, "timeVaryingTariffs": { "type": "array", "description": "Represents a tariff based on time of day. Mandatory if _tariffUType_ is set to `timeVaryingTariffs`.", "items": { "type": "object", "required": [ "timeVariations", "displayName" ], "properties": { "type": { "type": "string", "description": "The type of the charging time period. If absent applies to all periods.", "enum": [ "PEAK", "OFF_PEAK", "SHOULDER" ] }, "displayName": { "type": "string", "description": "Display name of the tariff." }, "rates": { "description": "Array of feed in rates.", "type": "array", "items": { "type": "object", "required": [ "unitPrice" ], "properties": { "unitPrice": { "type": "string", "x-cds-type": "AmountString", "description": "Unit price of usage per measure unit (exclusive of GST)." }, "measureUnit": { "type": "string", "description": "The measurement unit of rate. Assumed to be `KWH` if absent.", "default": "KWH", "allOf": [ { "$ref": "#/components/schemas/MeasureUnitEnum" } ] }, "volume": { "type": "number", "description": "Volume that this rate applies to. Only applicable for 'stepped' rates where different rates apply for different volumes of usage in a period." } } } }, "period": { "type": "string", "x-cds-type": "ExternalRef", "description": "Usage period for which the block rate applies. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax). Defaults to `P1Y` if absent.", "default": "P1Y" }, "timeVariations": { "description": "Array of time windows for which this tariff is applicable.", "type": "array", "items": { "type": "object", "required": [ "days" ], "properties": { "days": { "description": "The days that this time window applies to. At least one entry required.", "type": "array", "items": { "$ref": "#/components/schemas/EnergyDaysEnum" } }, "startTime": { "description": "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](https://en.wikipedia.org/wiki/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": "string", "x-cds-type": "ExternalRef" }, "endTime": { "description": "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](https://en.wikipedia.org/wiki/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": "string", "x-cds-type": "ExternalRef" } } } } } } } } }, "EnergyPlanTariffPeriodV2": { "type": "object", "required": [ "displayName", "startDate", "endDate", "rateBlockUType" ], "x-conditional": [ "singleRate", "timeOfUseRates", "demandCharges", "dailySupplyCharge", "bandedDailySupplyCharges" ], "properties": { "type": { "description": "Type of charge. Assumed to be `OTHER` if absent.", "default": "OTHER", "type": "string", "enum": [ "ENVIRONMENTAL", "REGULATED", "NETWORK", "METERING", "RETAIL_SERVICE", "RCTI", "OTHER" ] }, "displayName": { "type": "string", "description": "The name of the tariff period." }, "startDate": { "type": "string", "description": "The start date of the tariff period in a calendar year. Formatted in mm-dd format." }, "endDate": { "type": "string", "description": "The end date of the tariff period in a calendar year. Formatted in mm-dd format." }, "dailySupplyChargeType": { "type": "string", "description": "Specifies if daily supply charge is single or banded.", "enum": [ "SINGLE", "BAND" ] }, "dailySupplyCharge": { "type": "string", "x-cds-type": "AmountString", "description": "The amount of access charge for the tariff period, in dollars per day exclusive of GST. Mandatory if _dailySupplyChargeType_ is `SINGLE`." }, "bandedDailySupplyCharges": { "type": "array", "description": "Array representing banded daily supply charge rates. Mandatory if _dailySupplyChargeType_ is `BAND`.", "items": { "type": "object", "required": [ "unitPrice" ], "properties": { "unitPrice": { "type": "string", "x-cds-type": "AmountString", "description": "The amount of daily supply charge for the band, in dollars per day exclusive of GST." }, "measureUnit": { "type": "string", "description": "The measurement unit of rate. Assumed to be `DAYS` if absent.", "default": "DAYS", "allOf": [ { "$ref": "#/components/schemas/MeasureUnitEnum" } ] }, "volume": { "type": "number", "description": "Volume the charge applies to." } } } }, "timeZone": { "type": "string", "description": "Specifies the charge specific time zone for calculation of the time of use thresholds. If absent, timezone value in EnergyPlanContract is assumed.", "enum": [ "LOCAL", "AEST" ] }, "rateBlockUType": { "type": "string", "description": "Specifies the type of rate applicable to this tariff period.", "enum": [ "singleRate", "timeOfUseRates", "demandCharges" ] }, "singleRate": { "type": "object", "description": "Object representing a single rate. Required if _rateBlockUType_ is `singleRate`.", "required": [ "displayName", "rates" ], "x-conditional": [ "generalUnitPrice" ], "properties": { "displayName": { "type": "string", "description": "Display name of the rate." }, "description": { "type": "string", "description": "Description of the rate." }, "generalUnitPrice": { "type": "string", "x-cds-type": "AmountString", "description": "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": { "description": "Array of rates in order of usage volume.", "type": "array", "items": { "type": "object", "required": [ "unitPrice" ], "properties": { "unitPrice": { "type": "string", "x-cds-type": "AmountString", "description": "Unit price of usage per measure unit (exclusive of GST)." }, "measureUnit": { "type": "string", "description": "The measurement unit of rate. Assumed to be `KWH` if absent.", "default": "KWH", "allOf": [ { "$ref": "#/components/schemas/MeasureUnitEnum" } ] }, "volume": { "type": "number", "description": "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": { "type": "string", "x-cds-type": "ExternalRef", "description": "Usage period for which the block rate applies. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax)." } } }, "timeOfUseRates": { "description": "Array of objects representing time of use rates that apply throughout the _tariffPeriod_. Required if _rateBlockUType_ is `timeOfUseRates`.", "type": "array", "items": { "type": "object", "required": [ "displayName", "type", "rates", "timeOfUse" ], "properties": { "displayName": { "type": "string", "description": "Display name of the rate." }, "description": { "type": "string", "description": "Description of the rate." }, "rates": { "description": "Array of rates in order of usage volume.", "type": "array", "items": { "type": "object", "required": [ "unitPrice" ], "properties": { "unitPrice": { "type": "string", "x-cds-type": "AmountString", "description": "Unit price of usage per measure unit (exclusive of GST)." }, "measureUnit": { "type": "string", "description": "The measurement unit of rate. Assumed to be `KWH` if absent.", "default": "KWH", "allOf": [ { "$ref": "#/components/schemas/MeasureUnitEnum" } ] }, "volume": { "type": "number", "description": "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": { "type": "string", "x-cds-type": "ExternalRef", "description": "Usage period for which the block rate applies. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax). Defaults to `P1Y` if absent.", "default": "P1Y" }, "timeOfUse": { "description": "Array of time windows for which this time of use rate applies.", "type": "array", "items": { "type": "object", "required": [ "days", "startTime", "endTime" ], "properties": { "days": { "description": "The days that this time window applies to.", "type": "array", "items": { "$ref": "#/components/schemas/EnergyDaysEnum" } }, "startTime": { "type": "string", "x-cds-type": "ExternalRef", "description": "The beginning of the time window per day for which the rate applies. Formatted according to [ISO 8601 Times](https://en.wikipedia.org/wiki/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": { "type": "string", "x-cds-type": "ExternalRef", "description": "The end of the time window per day for which the rate applies. Formatted according to [ISO 8601 Times](https://en.wikipedia.org/wiki/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": { "type": "string", "description": "The type of usage that the rate applies to.", "enum": [ "PEAK", "OFF_PEAK", "SHOULDER", "SHOULDER1", "SHOULDER2" ] } } } }, "demandCharges": { "description": "Array of demand charges. Required if _rateBlockUType_ is `demandCharges`.", "type": "array", "items": { "type": "object", "required": [ "displayName", "amount", "startTime", "endTime", "measurementPeriod", "chargePeriod" ], "properties": { "displayName": { "type": "string", "description": "Display name of the charge." }, "description": { "type": "string", "description": "Description of the charge." }, "amount": { "type": "string", "x-cds-type": "AmountString", "description": "The charge amount per measure unit exclusive of GST." }, "measureUnit": { "type": "string", "description": "The measurement unit of charge amount. Assumed to be `KWH` if absent.", "default": "KWH", "allOf": [ { "$ref": "#/components/schemas/MeasureUnitEnum" } ] }, "startTime": { "type": "string", "x-cds-type": "ExternalRef", "description": "Start of the period. Formatted according to [ISO 8601 Times](https://en.wikipedia.org/wiki/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": { "type": "string", "x-cds-type": "ExternalRef", "description": "End of the period. Formatted according to [ISO 8601 Times](https://en.wikipedia.org/wiki/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": { "description": "The days that the demand tariff applies to.", "type": "array", "items": { "$ref": "#/components/schemas/EnergyDaysEnum" } }, "minDemand": { "type": "string", "x-cds-type": "AmountString", "description": "Minimum demand for this demand tariff in kW. If absent then `0.00` is assumed.", "default": "0.00" }, "maxDemand": { "type": "string", "x-cds-type": "AmountString", "description": "Maximum demand for this demand tariff in kW. If present, must be higher than the value of the _minDemand_ field." }, "measurementPeriod": { "type": "string", "description": "Application period for the demand tariff.", "enum": [ "DAY", "MONTH", "TARIFF_PERIOD" ] }, "chargePeriod": { "type": "string", "description": "Charge period for the demand tariff.", "enum": [ "DAY", "MONTH", "TARIFF_PERIOD" ] } } } } } }, "EnergyDaysEnum": { "type": "string", "enum": [ "SUN", "MON", "TUE", "WED", "THU", "FRI", "SAT", "PUBLIC_HOLIDAYS" ] }, "EnergyServicePointV2": { "type": "object", "required": [ "servicePointId", "nationalMeteringId", "servicePointClassification", "servicePointStatus", "jurisdictionCode", "validFromDate", "lastUpdateDateTime" ], "properties": { "servicePointId": { "description": "Unique identifier for the service point.", "allOf": [{ "$ref": "#/components/schemas/EnergyServicePointId" }] }, "nationalMeteringId": { "type": "string", "description": "The independent ID of the service point, known in the industry as the NMI." }, "servicePointClassification": { "type": "string", "description": "The classification of the service point as defined in MSATS procedures.", "enum": [ "EXTERNAL_PROFILE", "GENERATOR", "LARGE", "SMALL", "WHOLESALE", "NON_CONTEST_UNMETERED_LOAD", "NON_REGISTERED_EMBEDDED_GENERATOR", "DISTRIBUTION_WHOLESALE" ] }, "servicePointStatus": { "type": "string", "description": "Code used to indicate the status of the service point. Note the details for the enumeration values below:", "enum": [ "ACTIVE", "DE_ENERGISED", "EXTINCT", "GREENFIELD", "OFF_MARKET" ] }, "jurisdictionCode": { "type": "string", "description": "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:", "enum": [ "ALL", "ACT", "NEM", "NSW", "QLD", "SA", "TAS", "VIC" ] }, "isGenerator": { "type": "boolean", "description": "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.", "default": false }, "validFromDate": { "type": "string", "x-cds-type": "DateString", "description": "The latest start date from which the constituent data sets of this service point became valid." }, "lastUpdateDateTime": { "type": "string", "x-cds-type": "DateTimeString", "description": "The date and time that the information for this service point was modified." }, "lastConsumerChangeDate": { "type": "string", "x-cds-type": "DateString", "description": "The date the account holder changed for the NMI." }, "consumerProfile": { "type": "object", "properties": { "classification": { "type": "string", "description": "A code that defines the consumer class as defined in the National Energy Retail Regulations, or in overriding Jurisdictional instruments.", "enum": [ "BUSINESS", "RESIDENTIAL" ] }, "threshold": { "description": "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: ", "enum": [ "LOW", "MEDIUM", "HIGH" ] } } } } }, "EnergyServicePointDetailV2": { "allOf": [ { "$ref": "#/components/schemas/EnergyServicePointV2" }, { "required": [ "distributionLossFactor", "relatedParticipants", "location" ], "properties": { "distributionLossFactor": { "type": "object", "required": [ "code", "description", "lossValue" ], "properties": { "code": { "type": "string", "description": "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": { "type": "string", "description": "Description of the data loss factor code and value." }, "lossValue": { "type": "string", "description": "The value associated with the loss factor code." } } }, "relatedParticipants": { "type": "array", "items": { "type": "object", "required": [ "party", "role" ], "properties": { "party": { "type": "string", "description": "The name of the party/organisation related to this service point." }, "role": { "type": "string", "description": "The role performed by this participant in relation to the service point. Note the details of enumeration values below: ", "enum": [ "FRMP", "LNSP", "DRSP" ] } } } }, "location": { "description": "Location of the servicepoint.", "allOf": [ { "$ref": "#/components/schemas/CommonPhysicalAddress" } ] }, "meters": { "description": "The meters associated with the service point. This may be empty where there are no meters physically installed at the service point.", "type": "array", "items": { "type": "object", "required": [ "meterId", "specifications" ], "properties": { "meterId": { "type": "string", "description": "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": { "type": "object", "description": "Technical characteristics of the meter.", "required": [ "status", "installationType" ], "properties": { "status": { "type": "string", "description": "A code to denote the status of the meter. Note the details of enumeration values below: ", "enum": [ "CURRENT", "DISCONNECTED" ] }, "installationType": { "type": "string", "description": "The metering Installation type code indicates whether the metering installation has to be manually read. Note the details of enumeration values below: ", "enum": [ "BASIC", "COMMS1", "COMMS2", "COMMS3", "COMMS4", "COMMS4C", "COMMS4D", "MRAM", "MRIM", "PROF", "SAMPLE", "UMCP", "VICAMI", "NCOLNUML" ] }, "manufacturer": { "type": "string", "description": "Free text field to identify the manufacturer of the installed meter." }, "model": { "type": "string", "description": "Free text field to identify the meter manufacturer's designation for the meter model." }, "readType": { "type": "string", "description": "Code to denote the method and frequency of Meter Reading. The value is formatted as follows: For example, " }, "nextScheduledReadDate": { "type": "string", "x-cds-type": "DateString", "description": "This date is the next scheduled meter read date (NSRD) if a manual Meter Reading is required." } } }, "registers": { "description": "Usage data registers available from the meter. This may be empty where there are no meters physically installed at the service point.", "type": "array", "items": { "type": "object", "required": [ "registerId", "registerConsumptionType" ], "properties": { "registerId": { "type": "string", "description": "Unique identifier of the register within this service point. Is not globally unique." }, "registerSuffix": { "type": "string", "description": "Register suffix of the meter register where the meter reads are obtained." }, "averagedDailyLoad": { "type": "number", "description": "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": { "type": "string", "description": "Indicates the consumption type of register.", "enum": [ "INTERVAL", "BASIC", "PROFILE_DATA", "ACTIVE_IMPORT", "ACTIVE", "REACTIVE_IMPORT", "REACTIVE" ] }, "networkTariffCode": { "type": "string", "description": "The Network Tariff Code is a free text field containing a code supplied and published by the local network service provider." }, "unitOfMeasure": { "type": "string", "description": "The unit of measure for data held in this register." }, "timeOfDay": { "type": "string", "description": "Code to identify the time validity of register contents.", "enum": [ "ALLDAY", "INTERVAL", "PEAK", "BUSINESS", "SHOULDER", "EVENING", "OFFPEAK", "CONTROLLED", "DEMAND" ] }, "multiplier": { "type": "number", "description": "Multiplier required to take a register value and turn it into a value representing billable energy." }, "controlledLoad": { "type": "boolean", "description": "Indicates whether the energy recorded by this register is created under a Controlled Load regime." }, "consumptionType": { "type": "string", "description": "Actual/Subtractive Indicator. Note the details of enumeration values below: ", "enum": [ "ACTUAL", "CUMULATIVE" ] } } } } } } } } } ] }, "EnergyUsageRead": { "type": "object", "required": [ "servicePointId", "registerSuffix", "readStartDate", "readUType" ], "x-conditional": [ "basicRead", "intervalRead" ], "properties": { "servicePointId": { "description": "Unique identifier for the service point.", "allOf": [{ "$ref": "#/components/schemas/EnergyServicePointId" }] }, "registerId": { "description": "Register ID of the meter register where the meter reads are obtained.", "type": "string" }, "registerSuffix": { "description": "Register suffix of the meter register where the meter reads are obtained.", "type": "string" }, "meterId": { "description": "Meter id/serial number as it appears in customer's bill. ID permanence rules do not apply.", "type": "string" }, "controlledLoad": { "description": "Indicates whether the energy recorded by this register is created under a Controlled Load regime.", "type": "boolean" }, "readStartDate": { "description": "Date when the meter reads start in AEST and assumed to start from 12:00am AEST.", "type": "string", "x-cds-type": "DateString" }, "readEndDate": { "description": "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_.", "type": "string", "x-cds-type": "DateString" }, "unitOfMeasure": { "description": "Unit of measure of the meter reads. Refer to Appendix B of MDFF Specification NEM12 NEM13 v2.1 for a list of possible values.", "type": "string", "x-cds-type": "ExternalRef" }, "readUType": { "description": "Specify the type of the meter read data.", "type": "string", "enum": [ "basicRead", "intervalRead" ] }, "basicRead": { "description": "Mandatory if _readUType_ is set to `basicRead`.", "type": "object", "required": [ "value" ], "properties": { "quality": { "description": "The quality of the read taken. If absent then assumed to be `ACTUAL`.", "type": "string", "enum": [ "ACTUAL", "SUBSTITUTE", "FINAL_SUBSTITUTE" ], "default": "ACTUAL" }, "value": { "description": "Meter read value. If positive then it means consumption, if negative it means export.", "type": "number" } } }, "intervalRead": { "description": "Mandatory if _readUType_ is set to `intervalRead`.", "type": "object", "required": [ "aggregateValue" ], "x-conditional": [ "readIntervalLength", "intervalReads", "readQualities" ], "properties": { "readIntervalLength": { "description": "Read interval length in minutes. Required when _interval-reads_ query parameter equals `FULL` or `MIN_30`.", "type": "integer", "x-cds-type": "PositiveInteger" }, "aggregateValue": { "description": "The aggregate sum of the interval read values. If positive then it means net consumption, if negative it means net export.", "type": "number" }, "intervalReads": { "description": "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).", "type": "array", "items": { "type": "number" } }, "readQualities": { "description": " 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`.", "type": "array", "items": { "type": "object", "required": [ "startInterval", "endInterval", "quality" ], "properties": { "startInterval": { "description": "Start interval for read quality flag. First read begins at `1`.", "type": "integer", "x-cds-type": "PositiveInteger", "example": 1 }, "endInterval": { "description": "End interval for read quality flag.", "type": "integer", "x-cds-type": "PositiveInteger", "example": 1 }, "quality": { "description": "The quality of the read taken.", "type": "string", "enum": [ "SUBSTITUTE", "FINAL_SUBSTITUTE" ] } } } } } } } }, "EnergyDerRecord": { "type": "object", "required": [ "servicePointId", "approvedCapacity", "availablePhasesCount", "installedPhasesCount", "islandableInstallation", "acConnections" ], "x-conditional": [ "protectionMode" ], "properties": { "servicePointId": { "description": "Unique identifier for the service point.", "allOf": [{ "$ref": "#/components/schemas/EnergyServicePointId" }] }, "approvedCapacity": { "description": "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_.", "type": "number" }, "availablePhasesCount": { "description": "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_.", "type": "integer", "x-cds-type": "NaturalNumber", "minimum": 0, "maximum": 3 }, "installedPhasesCount": { "description": "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_.", "type": "integer", "x-cds-type": "NaturalNumber", "minimum": 0, "maximum": 3 }, "islandableInstallation": { "description": "For identification of small generating units designed with the ability to operate in an islanded mode.", "type": "boolean" }, "hasCentralProtectionControl": { "description": "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`.", "type": "boolean", "default": false }, "protectionMode": { "description": "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.", "type": "object", "properties": { "exportLimitKva": { "description": "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.", "type": "number" }, "underFrequencyProtection": { "description": "Protective function limit in Hz.", "type": "number" }, "underFrequencyProtectionDelay": { "description": "Trip delay time in seconds.", "type": "number" }, "overFrequencyProtection": { "description": "Protective function limit in Hz.", "type": "number" }, "overFrequencyProtectionDelay": { "description": "Trip delay time in seconds.", "type": "number" }, "underVoltageProtection": { "description": "Protective function limit in V.", "type": "number" }, "underVoltageProtectionDelay": { "description": "Trip delay time in seconds.", "type": "number" }, "overVoltageProtection": { "description": "Protective function limit in V.", "type": "number" }, "overVoltageProtectionDelay": { "description": "Trip delay time in seconds.", "type": "number" }, "sustainedOverVoltage": { "description": "Sustained over voltage.", "type": "number" }, "sustainedOverVoltageDelay": { "description": "Sustained Over voltage protection delay in seconds.", "type": "number" }, "frequencyRateOfChange": { "description": "Rate of change of frequency trip point (Hz/s).", "type": "number" }, "voltageVectorShift": { "description": "Trip angle in degrees.", "type": "number" }, "interTripScheme": { "description": "Description of the form of inter-trip (e.g., 'from local substation').", "type": "string" }, "neutralVoltageDisplacement": { "description": "Trip voltage.", "type": "number" } } }, "acConnections": { "type": "array", "items": { "type": "object", "required": [ "connectionIdentifier", "count", "commissioningDate", "status", "derDevices" ], "x-conditional": [ "manufacturerName", "inverterSeries", "inverterModelNumber", "inverterDeviceCapacity" ], "properties": { "connectionIdentifier": { "description": "AC Connection ID as defined in the DER register. Does not align with CDR ID permanence standards.", "type": "number" }, "count": { "description": "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.", "type": "integer", "x-cds-type": "PositiveInteger" }, "equipmentType": { "description": "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`.", "default": "OTHER", "type": "string", "enum": [ "INVERTER", "OTHER" ] }, "manufacturerName": { "description": "The name of the inverter manufacturer. Mandatory if _equipmentType_ is `INVERTER`.", "type": "string" }, "inverterSeries": { "description": "The inverter series. Mandatory if _equipmentType_ is `INVERTER`.", "type": "string" }, "inverterModelNumber": { "description": "The inverter model number. Mandatory if _equipmentType_ is `INVERTER`.", "type": "string" }, "commissioningDate": { "description": "The date that the DER installation is commissioned.", "type": "string", "x-cds-type": "DateString" }, "status": { "description": "Code used to indicate the status of the Inverter. This will be used to identify if an inverter is active or inactive or decommissioned.", "type": "string", "enum": [ "ACTIVE", "INACTIVE", "DECOMMISSIONED" ] }, "inverterDeviceCapacity": { "description": "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.", "type": "number" }, "derDevices": { "type": "array", "items": { "type": "object", "required": [ "deviceIdentifier", "count", "type", "nominalRatedCapacity" ], "x-conditional": [ "nominalStorageCapacity" ], "properties": { "deviceIdentifier": { "description": "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.", "type": "number" }, "count": { "description": "Number of devices in the group of DER devices.", "type": "integer", "x-cds-type": "PositiveInteger" }, "manufacturer": { "description": "The name of the device manufacturer. If absent then assumed to be \"unknown\".", "type": "string" }, "modelNumber": { "description": "The model number of the device. If absent then assumed to be \"unknown\".", "type": "string" }, "status": { "description": "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": "string", "enum": [ "ACTIVE", "INACTIVE", "DECOMMISSIONED" ] }, "type": { "description": "Used to indicate the primary technology used in the DER device.", "type": "string", "enum": [ "FOSSIL", "HYDRO", "WIND", "SOLAR_PV", "RENEWABLE", "GEOTHERMAL", "STORAGE", "OTHER" ] }, "subtype": { "description": "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\".", "type": "string" }, "nominalRatedCapacity": { "description": "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.", "type": "number" }, "nominalStorageCapacity": { "description": "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.", "type": "number" } } } } } } } } }, "EnergyAccountBaseV2": { "type": "object", "required": [ "accountId" ], "x-conditional": [ "creationDate" ], "properties": { "accountId": { "description": "Unique identifier for the account.", "allOf": [{ "$ref": "#/components/schemas/EnergyAccountId" }] }, "accountNumber": { "description": "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_.", "type": "string" }, "displayName": { "description": "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.", "type": "string" }, "openStatus": { "type": "string", "description": "Open or closed status for the account. If not present then `OPEN` is assumed.", "default": "OPEN", "enum": [ "CLOSED", "OPEN" ] }, "creationDate": { "description": "The date that the account was created or opened. Mandatory if _openStatus_ is `OPEN`.", "type": "string", "x-cds-type": "DateString" } } }, "EnergyAccountV2": { "allOf": [ { "$ref": "#/components/schemas/EnergyAccountBaseV2" }, { "description": "The array of plans containing service points and associated plan details.", "type": "object", "required": [ "plans" ], "properties": { "plans": { "description": "The array of plans containing service points and associated plan details.", "type": "array", "items": { "type": "object", "required": [ "servicePointIds" ], "x-conditional": [ "planOverview" ], "properties": { "nickname": { "description": "Optional display name for the plan provided by the customer to help differentiate multiple plans.", "type": "string" }, "servicePointIds": { "description": "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.", "type": "array", "items": { "$ref": "#/components/schemas/EnergyServicePointId" } }, "planOverview": { "description": "Mandatory if _openStatus_ is `OPEN`.", "type": "object", "required": [ "startDate" ], "properties": { "displayName": { "description": "The name of the plan if one exists.", "type": "string" }, "startDate": { "description": "The start date of the applicability of this plan.", "type": "string", "x-cds-type": "DateString" }, "endDate": { "description": "The end date of the applicability of this plan.", "type": "string", "x-cds-type": "DateString" } } } } } } } } ] }, "EnergyAccountDetailV4": { "allOf": [ { "$ref": "#/components/schemas/EnergyAccountBaseV2" }, { "description": "The array of plans containing service points and associated plan details.", "type": "object", "required": [ "plans" ], "properties": { "plans": { "description": "The array of plans containing service points and associated plan details.", "type": "array", "items": { "type": "object", "required": [ "servicePointIds" ], "x-conditional": [ "planOverview", "planDetail" ], "properties": { "nickname": { "description": "Optional display name for the plan provided by the customer to help differentiate multiple plans.", "type": "string" }, "servicePointIds": { "description": "An array of _servicePointId_ values, representing NMIs, that this account is linked to.", "type": "array", "items": { "$ref": "#/components/schemas/EnergyServicePointId" } }, "planOverview": { "description": "Mandatory if _openStatus_ is `OPEN`.", "type": "object", "required": [ "startDate" ], "properties": { "displayName": { "description": "The name of the plan if one exists.", "type": "string" }, "startDate": { "description": "The start date of the applicability of this plan.", "type": "string", "x-cds-type": "DateString" }, "endDate": { "description": "The end date of the applicability of this plan.", "type": "string", "x-cds-type": "DateString" } } }, "planDetail": { "description": "Detail on the plan applicable to this account. Mandatory if _openStatus_ is `OPEN`.", "type": "object", "required": [ "fuelType" ], "x-conditional": [ "gasContract", "electricityContract" ], "properties": { "fuelType": { "type": "string", "description": "The fuel types covered by the plan.", "enum": [ "ELECTRICITY", "GAS", "DUAL" ] }, "isContingentPlan": { "type": "boolean", "description": "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`.", "default": false }, "meteringCharges": { "description": "Charges for metering included in the plan.", "type": "array", "items": { "type": "object", "required": [ "displayName", "minimumValue" ], "properties": { "displayName": { "type": "string", "description": "Display name of the charge." }, "description": { "type": "string", "description": "Description of the charge." }, "minimumValue": { "type": "string", "x-cds-type": "AmountString", "description": "Minimum value of the charge if the charge is a range or the absolute value of the charge if no range is specified." }, "maximumValue": { "type": "string", "x-cds-type": "AmountString", "description": "The upper limit of the charge if the charge could occur in a range." }, "period": { "type": "string", "x-cds-type": "ExternalRef", "description": "The charges that occur on a schedule indicates the frequency. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax)." } } } }, "gasContract": { "description": "The details of the terms for the supply of electricity under this plan. Is mandatory if _fuelType_ is set to `GAS` or `DUAL`.", "allOf": [ { "$ref": "#/components/schemas/EnergyPlanContractV3" } ] }, "electricityContract": { "description": "The details of the terms for the supply of electricity under this plan. Is mandatory if _fuelType_ is set to `ELECTRICITY` or `DUAL`.", "allOf": [ { "$ref": "#/components/schemas/EnergyPlanContractV3" } ] } } }, "authorisedContacts": { "description": "An array of additional contacts that are authorised to act on this account.", "type": "array", "items": { "type": "object", "required": [ "lastName" ], "properties": { "firstName": { "description": "For people with single names this field need not be present. The single name should be in the _lastName_ field.", "type": "string" }, "lastName": { "description": "For people with single names the single name should be in this field.", "type": "string" }, "middleNames": { "description": "Field is mandatory but array may be empty.", "type": "array", "items": { "type": "string" } }, "prefix": { "description": "Also known as title or salutation. The prefix to the name (e.g., Mr, Mrs, Ms, Miss, Sir, etc.)", "type": "string" }, "suffix": { "description": "Used for a trailing suffix to the name (e.g., Jr.)", "type": "string" } } } } } } } } } ] }, "EnergyPaymentSchedule": { "type": "object", "required": [ "paymentScheduleUType" ], "x-conditional": [ "cardDebit", "directDebit", "manualPayment", "digitalWallet" ], "properties": { "amount": { "description": "Optional payment amount indicating that a constant payment amount is scheduled to be paid (used in bill smoothing scenarios).", "type": "string", "x-cds-type": "AmountString" }, "paymentScheduleUType": { "description": "The type of object present in this response.", "type": "string", "enum": [ "cardDebit", "directDebit", "manualPayment", "digitalWallet" ] }, "cardDebit": { "description": "Represents a regular credit card payment schedule. Mandatory if _paymentScheduleUType_ is set to `cardDebit`.", "type": "object", "required": [ "cardScheme", "paymentFrequency", "calculationType" ], "properties": { "cardScheme": { "description": "The type of credit card held on file.", "type": "string", "enum": [ "VISA", "MASTERCARD", "AMEX", "DINERS", "OTHER", "UNKNOWN" ] }, "paymentFrequency": { "description": "The frequency that payments will occur. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax).", "type": "string", "x-cds-type": "ExternalRef" }, "calculationType": { "description": "The mechanism by which the payment amount is calculated. Explanation of values are as follows:
", "type": "string", "enum": [ "STATIC", "BALANCE", "CALCULATED" ] } } }, "directDebit": { "description": "Represents a regular direct debit from a specified bank account. Mandatory if _paymentScheduleUType_ is set to `directDebit`.", "type": "object", "required": [ "paymentFrequency", "calculationType" ], "x-conditional": [ "bsb", "accountNumber" ], "properties": { "isTokenised": { "description": "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.", "default": false, "type": "boolean" }, "bsb": { "description": "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`.", "type": "string" }, "accountNumber": { "description": "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`.", "type": "string" }, "paymentFrequency": { "description": "The frequency that payments will occur. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax).", "type": "string", "x-cds-type": "ExternalRef" }, "calculationType": { "description": "The mechanism by which the payment amount is calculated. Explanation of values are as follows:
", "type": "string", "enum": [ "STATIC", "BALANCE", "CALCULATED" ] } } }, "digitalWallet": { "description": "Represents a regular payment from a digital wallet. Mandatory if _paymentScheduleUType_ is set to `digitalWallet`.", "type": "object", "required": [ "name", "identifier", "type", "provider", "paymentFrequency", "calculationType" ], "properties": { "name": { "type": "string", "description": "The display name of the wallet as given by the customer, else a default value defined by the data holder." }, "identifier": { "type": "string", "description": "The identifier of the digital wallet (dependent on type)." }, "type": { "type": "string", "description": "The type of the digital wallet identifier.", "enum": [ "EMAIL", "CONTACT_NAME", "TELEPHONE" ] }, "provider": { "type": "string", "description": "The provider of the digital wallet.", "enum": [ "PAYPAL_AU", "OTHER" ] }, "paymentFrequency": { "description": "The frequency that payments will occur. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax).", "type": "string", "x-cds-type": "ExternalRef" }, "calculationType": { "description": "The mechanism by which the payment amount is calculated. Explanation of values are as follows:
", "type": "string", "enum": [ "STATIC", "BALANCE", "CALCULATED" ] } } }, "manualPayment": { "description": "Represents a manual payment schedule where the customer pays in response to a delivered statement. Mandatory if _paymentScheduleUType_ is set to `manualPayment`.", "type": "object", "required": [ "billFrequency" ], "properties": { "billFrequency": { "description": "The frequency with which a bill will be issued. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax).", "type": "string", "x-cds-type": "ExternalRef" } } } } }, "EnergyConcession": { "type": "object", "required": [ "type", "displayName" ], "x-conditional": [ "additionalInfo", "discountFrequency", "amount", "percentage" ], "properties": { "type": { "description": "Indicator of the method of concession calculation.", "type": "string", "enum": [ "FIXED_AMOUNT", "FIXED_PERCENTAGE", "VARIABLE" ] }, "displayName": { "description": "The display name of the concession.", "type": "string" }, "additionalInfo": { "description": "Display text providing more information on the concession. Mandatory if _type_ is `VARIABLE`.", "type": "string" }, "additionalInfoUri": { "description": "Optional link to additional information regarding the concession.", "type": "string", "x-cds-type": "URIString" }, "startDate": { "description": "Optional start date for the application of the concession.", "type": "string", "x-cds-type": "DateString" }, "endDate": { "description": "Optional end date for the application of the concession.", "type": "string", "x-cds-type": "DateString" }, "discountFrequency": { "description": "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](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax).", "type": "string", "x-cds-type": "ExternalRef" }, "amount": { "description": "Conditional attribute for the amount of discount for the concession- required if type is `FIXED_AMOUNT`.", "type": "string", "x-cds-type": "AmountString" }, "percentage": { "description": "Conditional attribute for the percentage of discount of concession - required if type is `FIXED_PERCENTAGE`.", "type": "string", "x-cds-type": "RateString" }, "appliedTo": { "description": "Array of ENUMs to specify what the concession applies to. Multiple ENUM values can be provided. If absent, `USAGE` is assumed.", "type": "array", "default": ["USAGE"], "items": { "type": "string", "enum": [ "INVOICE", "USAGE", "SERVICE_CHARGE", "CONTROLLED_LOAD" ] } } } }, "EnergyInvoice": { "type": "object", "required": [ "accountId", "invoiceNumber", "issueDate", "balanceAtIssue", "servicePoints", "paymentStatus" ], "x-conditional": [ "period" ], "properties": { "accountId": { "description": "Unique identifier for the account.", "allOf": [{ "$ref": "#/components/schemas/EnergyAccountId" }] }, "invoiceNumber": { "description": "The number assigned to this invoice by the energy Retailer.", "type": "string" }, "issueDate": { "description": "The date that the invoice was actually issued (as opposed to generated or calculated).", "type": "string", "x-cds-type": "DateString" }, "dueDate": { "description": "The date that the invoice is due to be paid.", "type": "string", "x-cds-type": "DateString" }, "period": { "description": "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.", "type": "object", "required": [ "startDate", "endDate" ], "properties": { "startDate": { "description": "The start date of the period covered by this invoice.", "type": "string", "x-cds-type": "DateString" }, "endDate": { "description": "The end date of the period covered by this invoice.", "type": "string", "x-cds-type": "DateString" } } }, "invoiceAmount": { "description": "The net amount due for this invoice regardless of previous balance.", "type": "string", "x-cds-type": "AmountString" }, "gstAmount": { "description": "The total GST amount for this invoice. If absent then zero is assumed.", "default": "0.00", "type": "string", "x-cds-type": "AmountString" }, "payOnTimeDiscount": { "description": "A discount for on time payment.", "type": "object", "required": [ "discountAmount", "date" ], "properties": { "discountAmount": { "description": "The amount that will be discounted if the invoice is paid by the date specified.", "type": "string", "x-cds-type": "AmountString" }, "gstAmount": { "description": "The GST amount that will be discounted if the invoice is paid by the date specified. If absent then zero is assumed.", "default": "0.00", "type": "string", "x-cds-type": "AmountString" }, "date": { "description": "The date by which the invoice must be paid to receive the pay on time discount.", "type": "string", "x-cds-type": "DateString" } } }, "balanceAtIssue": { "description": "The account balance at the time the invoice was issued.", "type": "string", "x-cds-type": "AmountString" }, "servicePoints": { "description": "Array of service point IDs to which this invoice applies. May be empty if the invoice contains no electricity usage related charges.", "type": "array", "items": { "type": "string" } }, "gas": { "description": "Object containing charges and credits related to gas usage.", "allOf": [ { "$ref": "#/components/schemas/EnergyInvoiceGasUsageCharges" } ] }, "electricity": { "description": "Object containing charges and credits related to electricity usage.", "allOf": [ { "$ref": "#/components/schemas/EnergyInvoiceElectricityUsageCharges" } ] }, "accountCharges": { "$ref": "#/components/schemas/EnergyInvoiceAccountCharges" }, "paymentStatus": { "description": "Indicator of the payment status for the invoice.", "type": "string", "enum": [ "PAID", "PARTIALLY_PAID", "NOT_PAID" ] } } }, "EnergyInvoiceGasUsageCharges": { "type": "object", "required": [ "totalUsageCharges", "totalGenerationCredits", "totalOnceOffCharges", "totalOnceOffDiscounts" ], "properties": { "totalUsageCharges": { "description": "The aggregate total of usage charges for the period covered by the invoice (exclusive of GST).", "type": "string", "x-cds-type": "AmountString" }, "totalGenerationCredits": { "description": "The aggregate total of generation credits for the period covered by the invoice (exclusive of GST).", "type": "string", "x-cds-type": "AmountString" }, "totalOnceOffCharges": { "description": "The aggregate total of any once off charges arising from gas usage for the period covered by the invoice (exclusive of GST).", "type": "string", "x-cds-type": "AmountString" }, "totalOnceOffDiscounts": { "description": "The aggregate total of any once off discounts or credits arising from gas usage for the period covered by the invoice (exclusive of GST).", "type": "string", "x-cds-type": "AmountString" }, "otherCharges": { "description": "Optional array of charges that may be part of the invoice (for e.g., environmental charges for C&I consumers) (exclusive of GST).", "type": "array", "items": { "type": "object", "required": [ "amount", "description" ], "properties": { "type": { "description": "Type of charge. Assumed to be `OTHER` if absent.", "default": "OTHER", "type": "string", "enum": [ "ENVIRONMENTAL", "REGULATED", "NETWORK", "METERING", "RETAIL_SERVICE", "RCTI", "OTHER" ] }, "amount": { "description": "The aggregate total of charges for this item (exclusive of GST).", "type": "string", "x-cds-type": "AmountString" }, "description": { "description": "A free text description of the type of charge.", "type": "string" } } } }, "totalGst": { "description": "The total GST for all gas usage charges. If absent then zero is assumed.", "default": "0.00", "type": "string", "x-cds-type": "AmountString" } } }, "EnergyInvoiceElectricityUsageCharges": { "type": "object", "required": [ "totalUsageCharges", "totalGenerationCredits", "totalOnceOffCharges", "totalOnceOffDiscounts" ], "properties": { "totalUsageCharges": { "description": "The aggregate total of usage charges for the period covered by the invoice (exclusive of GST).", "type": "string", "x-cds-type": "AmountString" }, "totalGenerationCredits": { "description": "The aggregate total of generation credits for the period covered by the invoice (exclusive of GST).", "type": "string", "x-cds-type": "AmountString" }, "totalOnceOffCharges": { "description": "The aggregate total of any once off charges arising from electricity usage for the period covered by the invoice (exclusive of GST).", "type": "string", "x-cds-type": "AmountString" }, "totalOnceOffDiscounts": { "description": "The aggregate total of any once off discounts or credits arising from electricity usage for the period covered by the invoice (exclusive of GST).", "type": "string", "x-cds-type": "AmountString" }, "otherCharges": { "description": "Optional array of charges that may be part of the invoice (for e.g., environmental charges for C&I consumers) (exclusive of GST).", "type": "array", "items": { "type": "object", "required": [ "amount", "description" ], "properties": { "type": { "description": "Type of charge. Assumed to be `OTHER` if absent.", "default": "OTHER", "type": "string", "enum": [ "ENVIRONMENTAL", "REGULATED", "NETWORK", "METERING", "RETAIL_SERVICE", "RCTI", "OTHER" ] }, "amount": { "description": "The aggregate total of charges for this item (exclusive of GST).", "type": "string", "x-cds-type": "AmountString" }, "description": { "description": "A free text description of the type of charge.", "type": "string" } } } }, "totalGst": { "description": "The total GST for all electricity usage charges. If absent then zero is assumed.", "default": "0.00", "type": "string", "x-cds-type": "AmountString" } } }, "EnergyInvoiceAccountCharges": { "description": "Object contains account level charges and credits related to electricity usage.", "type": "object", "required": [ "totalCharges", "totalDiscounts" ], "properties": { "totalCharges": { "description": "The aggregate total of account level charges for the period covered by the invoice.", "type": "string", "x-cds-type": "AmountString" }, "totalDiscounts": { "description": "The aggregate total of account level discounts or credits for the period covered by the invoice.", "type": "string", "x-cds-type": "AmountString" }, "totalGst": { "description": "The total GST for all account level charges. If absent then zero is assumed.", "default": "0.00", "type": "string", "x-cds-type": "AmountString" } } }, "EnergyBillingTransactionV3": { "type": "object", "required": [ "accountId", "executionDateTime", "transactionUType" ], "x-conditional": [ "usage", "onceOff", "payment", "demand", "otherCharges" ], "properties": { "accountId": { "description": "Unique identifier for the account.", "allOf": [{ "$ref": "#/components/schemas/EnergyAccountId" }] }, "executionDateTime": { "description": "The date and time that the transaction occurred.", "type": "string", "x-cds-type": "DateTimeString" }, "gst": { "description": "The GST incurred in the transaction. Should not be included for credits or payments. If absent then zero is assumed.", "default": "0.00", "type": "string", "x-cds-type": "AmountString" }, "transactionUType": { "description": "Indicator of the type of transaction object present in this record.", "type": "string", "enum": [ "usage", "demand", "onceOff", "otherCharges", "payment" ] }, "usage": { "description": "Represents a usage charge or generation credit. Mandatory if _transactionUType_ is equal to `usage`.", "allOf": [ { "$ref": "#/components/schemas/EnergyBillingUsageTransactionV2" } ] }, "demand": { "description": "Represents a demand charge or generation credit. Mandatory if _transactionUType_ is equal to `demand`.", "allOf": [ { "$ref": "#/components/schemas/EnergyBillingDemandTransactionV3" } ] }, "onceOff": { "description": "Represents a once off charge or credit. Mandatory if _transactionUType_ is equal to `onceOff`.", "allOf": [ { "$ref": "#/components/schemas/EnergyBillingOnceOffTransaction" } ] }, "otherCharges": { "description": "Represents charge other than usage and once off. Mandatory if _transactionUType_ is equal to `otherCharges`.", "allOf": [ { "$ref": "#/components/schemas/EnergyBillingOtherTransaction" } ] }, "payment": { "description": "Represents a payment to the account. Mandatory if _transactionUType_ is equal to `payment`.", "allOf": [ { "$ref": "#/components/schemas/EnergyBillingPaymentTransaction" } ] } } }, "EnergyBillingUsageTransactionV2": { "type": "object", "required": [ "timeOfUseType", "startDate", "endDate", "usage", "amount" ], "properties": { "servicePointId": { "description": "Unique identifier for the service point.", "allOf": [{ "$ref": "#/components/schemas/EnergyServicePointId" }] }, "invoiceNumber": { "description": "The number of the invoice in which this transaction is included if it has been issued.", "type": "string" }, "timeOfUseType": { "description": "The time of use type that the transaction applies to.", "type": "string", "enum": [ "PEAK", "OFF_PEAK", "OFF_PEAK_DEMAND_CHARGE", "SHOULDER", "SHOULDER1", "SHOULDER2", "CONTROLLED_LOAD", "SOLAR", "AGGREGATE", "ALL_DAY" ] }, "description": { "description": "Optional description of the transaction that can be used for display purposes.", "type": "string" }, "isEstimate": { "description": "Flag indicating if the usage is estimated or actual. `true` indicates estimate. `false` or absent indicates actual.", "default": false, "type": "boolean" }, "startDate": { "description": "Date and time when the usage period starts.", "type": "string", "x-cds-type": "DateTimeString" }, "endDate": { "description": "Date and time when the usage period ends.", "type": "string", "x-cds-type": "DateTimeString" }, "measureUnit": { "type": "string", "description": "The measurement unit of rate. Assumed to be `KWH` if absent.", "default": "KWH", "allOf": [ { "$ref": "#/components/schemas/MeasureUnitEnum" } ] }, "usage": { "description": "The usage for the period in measure unit. A negative value indicates power generated.", "type": "number" }, "amount": { "description": "The amount charged or credited for this transaction prior to any adjustments being applied. A negative value indicates a credit.", "type": "string", "x-cds-type": "AmountString" }, "calculationFactors": { "description": "Additional calculation factors that inform the transaction.", "type": "array", "items": { "type": "object", "required": [ "value", "type" ], "properties": { "value": { "description": "The value of the calculation factor.", "type": "number" }, "type": { "description": "The type of the calculation factor.", "type": "string", "enum": [ "DLF", "MLF" ] } } } }, "adjustments": { "description": "Optional array of adjustments arising for this transaction.", "type": "array", "items": { "type": "object", "required": [ "amount", "description" ], "properties": { "amount": { "description": "The amount of the adjustment.", "type": "string", "x-cds-type": "AmountString" }, "description": { "description": "A free text description of the adjustment.", "type": "string" } } } } } }, "EnergyBillingDemandTransactionV3": { "type": "object", "required": [ "timeOfUseType", "startDate", "endDate", "rate", "amount" ], "properties": { "servicePointId": { "description": "Unique identifier for the service point.", "allOf": [{ "$ref": "#/components/schemas/EnergyServicePointId" }] }, "invoiceNumber": { "description": "The number of the invoice in which this transaction is included if it has been issued.", "type": "string" }, "timeOfUseType": { "description": "The time of use type that the transaction applies to.", "type": "string", "enum": [ "PEAK", "OFF_PEAK", "OFF_PEAK_DEMAND_CHARGE", "SHOULDER", "SHOULDER1", "SHOULDER2", "CONTROLLED_LOAD", "SOLAR", "AGGREGATE", "ALL_DAY", "EXCESS" ] }, "description": { "description": "Optional description of the transaction that can be used for display purposes.", "type": "string" }, "isEstimate": { "description": "Flag indicating if the usage is estimated or actual. `true` indicates estimate. `false` or absent indicates actual.", "default": false, "type": "boolean" }, "startDate": { "description": "Date and time when the demand period starts.", "type": "string", "x-cds-type": "DateTimeString" }, "endDate": { "description": "Date and time when the demand period ends.", "type": "string", "x-cds-type": "DateTimeString" }, "measureUnit": { "type": "string", "description": "The measurement unit of rate. Assumed to be `KVA` if absent.", "default": "KVA", "allOf": [ { "$ref": "#/components/schemas/MeasureUnitEnum" } ] }, "rate": { "description": "The rate for the demand charge in _measureUnit_. Assumed to be `KVA` if _measureUnit_ not provided. A negative value indicates power generated.", "type": "number" }, "amount": { "description": "The amount charged or credited for this transaction prior to any adjustments being applied. A negative value indicates a credit.", "type": "string", "x-cds-type": "AmountString" }, "calculationFactors": { "description": "Additional calculation factors that inform the transaction.", "type": "array", "items": { "type": "object", "required": [ "value", "type" ], "properties": { "value": { "description": "The value of the calculation factor.", "type": "number" }, "type": { "description": "The type of the calculation factor.", "type": "string", "enum": [ "DLF", "MLF" ] } } } }, "adjustments": { "description": "Optional array of adjustments arising for this transaction.", "type": "array", "items": { "type": "object", "required": [ "amount", "description" ], "properties": { "amount": { "description": "The amount of the adjustment.", "type": "string", "x-cds-type": "AmountString" }, "description": { "description": "A free text description of the adjustment.", "type": "string" } } } } } }, "MeasureUnitEnum": { "type": "string", "enum": [ "KWH", "KVA", "KVAR", "KVARH", "KW", "DAYS", "METER", "MONTH" ] }, "EnergyBillingOnceOffTransaction": { "type": "object", "required": [ "amount", "description" ], "properties": { "servicePointId": { "description": "Unique identifier for the service point.", "allOf": [{ "$ref": "#/components/schemas/EnergyServicePointId" }] }, "invoiceNumber": { "description": "The number of the invoice in which this transaction is included if it has been issued.", "type": "string" }, "amount": { "description": "The amount of the charge or credit. A positive value indicates a charge and a negative value indicates a credit.", "type": "string", "x-cds-type": "AmountString" }, "description": { "description": "A free text description of the item.", "type": "string" } } }, "EnergyBillingOtherTransaction": { "type": "object", "required": [ "amount", "description" ], "properties": { "servicePointId": { "description": "Unique identifier for the service point.", "allOf": [{ "$ref": "#/components/schemas/EnergyServicePointId" }] }, "invoiceNumber": { "description": "The number of the invoice in which this transaction is included if it has been issued.", "type": "string" }, "startDate": { "description": "Optional start date for the application of the charge.", "type": "string", "x-cds-type": "DateString" }, "endDate": { "description": "Optional end date for the application of the charge.", "type": "string", "x-cds-type": "DateString" }, "type": { "description": "Type of charge. Assumed to be `OTHER` if absent.", "default": "OTHER", "type": "string", "enum": [ "ENVIRONMENTAL", "REGULATED", "NETWORK", "METERING", "RETAIL_SERVICE", "RCTI", "OTHER" ] }, "amount": { "description": "The amount of the charge.", "type": "string", "x-cds-type": "AmountString" }, "description": { "description": "A free text description of the item.", "type": "string" }, "calculationFactors": { "description": "Additional calculation factors that inform the transaction.", "type": "array", "items": { "type": "object", "required": [ "value", "type" ], "properties": { "value": { "description": "The value of the calculation factor.", "type": "number" }, "type": { "description": "The type of the calculation factor.", "type": "string", "enum": [ "DLF", "MLF" ] } } } }, "adjustments": { "description": "Optional array of adjustments arising for this transaction.", "type": "array", "items": { "type": "object", "required": [ "amount", "description" ], "properties": { "amount": { "description": "The amount of the adjustment.", "type": "string", "x-cds-type": "AmountString" }, "description": { "description": "A free text description of the adjustment.", "type": "string" } } } } } }, "EnergyBillingPaymentTransaction": { "type": "object", "required": [ "amount", "method" ], "properties": { "amount": { "description": "The amount paid.", "type": "string", "x-cds-type": "AmountString" }, "method": { "description": "The method of payment.", "type": "string", "enum": [ "DIRECT_DEBIT", "CARD", "TRANSFER", "BPAY", "CASH", "CHEQUE", "OTHER" ] } } }, "CommonPhysicalAddress": { "required": [ "addressUType" ], "type": "object", "properties": { "addressUType": { "type": "string", "description": "The type of address object present.", "enum": [ "paf", "simple" ] }, "simple": { "$ref": "#/components/schemas/CommonSimpleAddress" }, "paf": { "$ref": "#/components/schemas/CommonPAFAddress" } }, "x-conditional": [ "simple", "paf" ] }, "CommonSimpleAddress": { "description": "Required if _addressUType_ is set to `simple`.", "required": [ "addressLine1", "city", "state" ], "type": "object", "properties": { "mailingName": { "type": "string", "description": "Name of the individual or business formatted for inclusion in an address used for physical mail." }, "addressLine1": { "type": "string", "description": "First line of the standard address object." }, "addressLine2": { "type": "string", "description": "Second line of the standard address object." }, "addressLine3": { "type": "string", "description": "Third line of the standard address object." }, "postcode": { "type": "string", "description": "Mandatory for Australian addresses." }, "city": { "type": "string", "description": "Name of the city or locality." }, "state": { "type": "string", "description": "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](https://auspost.com.au/content/dam/auspost_corp/media/documents/australia-post-data-guide.pdf) in the PAF file format. `NSW`, `QLD`, `VIC`, `NT`, `WA`, `SA`, `TAS`, `ACT`, `AAT`." }, "country": { "type": "string", "description": "A valid [ISO 3166 Alpha-3](https://www.iso.org/iso-3166-country-codes.html) country code. Australia (`AUS`) is assumed if country is not present.", "default": "AUS", "x-cds-type": "ExternalRef" } }, "x-conditional": [ "postcode" ] }, "CommonPAFAddress": { "description": "Australian address formatted according to the file format defined by the [PAF file format](https://auspost.com.au/content/dam/auspost_corp/media/documents/australia-post-data-guide.pdf). Required if _addressUType_ is set to `paf`.", "required": [ "localityName", "postcode", "state" ], "type": "object", "properties": { "dpid": { "type": "string", "description": "Unique identifier for an address as defined by Australia Post. Also known as Delivery Point Identifier." }, "thoroughfareNumber1": { "type": "integer", "description": "Thoroughfare number for a property (first number in a property ranged address).", "x-cds-type": "PositiveInteger" }, "thoroughfareNumber1Suffix": { "type": "string", "description": "Suffix for the thoroughfare number. Only relevant if _thoroughfareNumber1_ is populated." }, "thoroughfareNumber2": { "type": "integer", "description": "Second thoroughfare number (only used if the property has a ranged address e.g., 23-25).", "x-cds-type": "PositiveInteger" }, "thoroughfareNumber2Suffix": { "type": "string", "description": "Suffix for the second thoroughfare number. Only relevant if _thoroughfareNumber2_ is populated." }, "flatUnitType": { "type": "string", "description": "Type of flat or unit for the address." }, "flatUnitNumber": { "type": "string", "description": "Unit number (including suffix, if applicable)." }, "floorLevelType": { "type": "string", "description": "Type of floor or level for the address." }, "floorLevelNumber": { "type": "string", "description": "Floor or level number (including alpha characters)." }, "lotNumber": { "type": "string", "description": "Allotment number for the address." }, "buildingName1": { "type": "string", "description": "Building/Property name 1." }, "buildingName2": { "type": "string", "description": "Building/Property name 2." }, "streetName": { "type": "string", "description": "The name of the street." }, "streetType": { "type": "string", "description": "The street type. Valid enumeration defined by Australia Post PAF code file." }, "streetSuffix": { "type": "string", "description": "The street type suffix. Valid enumeration defined by Australia Post PAF code file." }, "postalDeliveryType": { "type": "string", "description": "Postal delivery type. (e.g., PO BOX). Valid enumeration defined by Australia Post PAF code file." }, "postalDeliveryNumber": { "type": "integer", "description": "Postal delivery number if the address is a postal delivery type.", "x-cds-type": "PositiveInteger" }, "postalDeliveryNumberPrefix": { "type": "string", "description": "Postal delivery number prefix related to the postal delivery number." }, "postalDeliveryNumberSuffix": { "type": "string", "description": "Postal delivery number suffix related to the postal delivery number." }, "localityName": { "type": "string", "description": "Full name of locality." }, "postcode": { "type": "string", "description": "Postcode for the locality." }, "state": { "type": "string", "description": "State in which the address belongs. Valid enumeration defined by Australia Post PAF code file [State Type Abbreviation](https://auspost.com.au/content/dam/auspost_corp/media/documents/australia-post-data-guide.pdf). `NSW`, `QLD`, `VIC`, `NT`, `WA`, `SA`, `TAS`, `ACT`, `AAT`." } } }, "RequestServicePointIdListV1": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "servicePointIds" ], "properties": { "servicePointIds": { "type": "array", "description": "Array of _servicePointId_ values to obtain data for.", "items": { "$ref": "#/components/schemas/EnergyServicePointId" } } } }, "meta": { "$ref": "#/components/schemas/Meta" } } }, "RequestAccountIdListV1": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "accountIds" ], "properties": { "accountIds": { "type": "array", "description": "Array of _accountId_ values to obtain data for.", "items": { "$ref": "#/components/schemas/EnergyAccountId" } } } }, "meta": { "$ref": "#/components/schemas/Meta" } } }, "EnergyPlanId": { "type": "string", "description": "The unique identifier for the Energy plan.", "x-cds-type": "ASCIIString" }, "EnergyServicePointId": { "type": "string", "description": "A unique identifier for an Energy service point, generated according to [CDR ID Permanence](#id-permanence) requirements.", "x-cds-type": "ASCIIString" }, "EnergyAccountId": { "type": "string", "description": "A unique identifier for an Energy account, generated according to [CDR ID Permanence](#id-permanence) requirements.", "x-cds-type": "ASCIIString" }, "Links": { "type": "object", "required": [ "self" ], "properties": { "self": { "type": "string", "description": "Fully qualified link that generated the current response document.", "x-cds-type": "URIString" } } }, "Meta": { "type": "object" }, "LinksPaginated": { "type": "object", "required": [ "self" ], "x-conditional": [ "first", "prev", "next", "last" ], "properties": { "self": { "type": "string", "description": "Fully qualified link that generated the current response document.", "x-cds-type": "URIString" }, "first": { "type": "string", "description": "URI to the first page of this set. Mandatory if this response is not the first page.", "x-cds-type": "URIString" }, "prev": { "type": "string", "description": "URI to the previous page of this set. Mandatory if this response is not the first page.", "x-cds-type": "URIString" }, "next": { "type": "string", "description": "URI to the next page of this set. Mandatory if this response is not the last page.", "x-cds-type": "URIString" }, "last": { "type": "string", "description": "URI to the last page of this set. Mandatory if this response is not the last page.", "x-cds-type": "URIString" } } }, "MetaPaginated": { "type": "object", "required": [ "totalPages", "totalRecords" ], "properties": { "totalRecords": { "type": "integer", "description": "The total number of records in the full set. See [pagination](#pagination).", "x-cds-type": "NaturalNumber" }, "totalPages": { "type": "integer", "description": "The total number of pages in the full set. See [pagination](#pagination).", "x-cds-type": "NaturalNumber" } } } } } }