Skip to main content

List Billing Transactions

The purpose of this endpoint is to deliver billing transaction information related to a specific Principal (principalId) and, optionally, a set of Account(s) (accountIds).

This Data Adapter endpoint is used to deliver the responses for the following Consumer Data Standards endpoint:

Data Adapter API​

List Energy Account Billing Transactions​

Loading...

Β 


Consumer Data Standards Associations​

Get Billing for Energy Account​

Loading...

Β 

CDR Error Mapping​

TitleStatus CodeAdapter URN - Error CodeDetailCDR Status CodeCDR URN - Error Code
Invalid Field400urn:au-cds:error:cds-all:Field/Invalid

Applies when the value of required path parameter, i.e. principalId is an invalid type or the value violates the field's constraints.
Invalid format supplied for accountIds.

500urn:au-cds:error:cds-all:GeneralError/Unexpected
Invalid Header400urn:au-cds:error:cds-all:Header/Invalid

Applies when a HTTP Header is provided but the value provided is an invalid type or violates the field type constraints as defined in the Consumer Data Standards.
x-fapi-interaction-id - If supplied, it must be a Universal Unique Identifier (UUID) and compliant with RFC4122. If not supplied, a compliant value is autogenerated.
Invalid format supplied for
x-fapi-interaction-id.

500urn:au-cds:error:cds-all:GeneralError/Unexpected
Invalid Date400urn:au-cds:error:cds-all:Field/InvalidDateTime

Applies when the value of the parameter oldest-date or newest-date is of an invalid type.
An invalid date is provided.

500urn:au-cds:error:cds-all:GeneralError/Unexpected
Invalid Page Size400urn:au-cds:error:cds-all:Field/InvalidPageSizeApplies when the value of the parameter page is an invalid type or violates ANY of the field's constraints.500urn:au-cds:error:cds-all:GeneralError/Unexpected
Missing Required Field400urn:au-cds:error:cds-all: Field/Missing

Applies when the required query parameter is not supplied in the request. The request is missing a mandatory field required for the API.

500urn:au-cds:error:cds-all:GeneralError/Unexpected
Expected Error400urn:au-cds:error:cds-all:GeneralError/ExpectedThis status code indicates that the Expected Error has encountered.500urn:au-cds:error:cds-all:GeneralError/Unexpected
Invalid Resource404urn:au-cds:error:cds-all:Resource/InvalidThe requested resource identifier is permanently unavailable.404urn:au-cds:error:cds-all:Resource/Invalid
Invalid Page422urn:au-cds:error:cds-all: Field/InvalidPage

Applies when the value of the parameter page violates ANY of the field's constraints.
The page being requested is out of range.

422urn:au-cds:error:cds-all: Field/InvalidPage
Legal Block451urn:dio:error:cds-all:Resource/LegalBlockThis status code indicates that the server is denying access to the resource as a consequence of a legal demand.422urn:au-cds:error:cds-all:Resource/Unavailable
Ineligible Block451urn:dio:error:cds-all:Resource/IneligibleBlockThis status code indicates that the Customer is ineligible for CDR Data Sharing.422urn:au-cds:error:cds-all:Resource/Invalid
Call Center Block451urn:dio:error:cds-all:Resource/CallCenterBlockThis status code indicates that the consumer should call the Call Center for further information.422urn:au-cds:error:cds-all:Resource/Invalid
Internal Server Error500urn:au-cds:error:cds-all:GeneralError/UnexpectedThis status code indicates that the server encountered an internal error or misconfiguration.500urn:au-cds:error:cds-all:GeneralError/Unexpected

Get Bulk Billing​

Loading...

Β 

CDR Error Mapping​

TitleStatus CodeAdapter URN - Error CodeDetailCDR Status CodeCDR URN - Error Code
Invalid Field400urn:au-cds:error:cds-all:Field/Invalid

Applies when the value of required path parameter, i.e. principalId is an invalid type or the value violates the field's constraints.
Invalid format supplied for accountIds.

500urn:au-cds:error:cds-all:GeneralError/Unexpected
Invalid Header400urn:au-cds:error:cds-all:Header/Invalid

Applies when a HTTP Header is provided but the value provided is an invalid type or violates the field type constraints as defined in the Consumer Data Standards.
x-fapi-interaction-id - If supplied, it must be a Universal Unique Identifier (UUID) and compliant with RFC4122. If not supplied, a compliant value is autogenerated.
Invalid format supplied for
x-fapi-interaction-id.

500urn:au-cds:error:cds-all:GeneralError/Unexpected
Invalid Date400urn:au-cds:error:cds-all:Field/InvalidDateTime

Applies when the value of the parameter oldest-date or newest-date is of an invalid type.
An invalid date is provided.

500urn:au-cds:error:cds-all:GeneralError/Unexpected
Invalid Page Size400urn:au-cds:error:cds-all:Field/InvalidPageSizeApplies when the value of the parameter page is an invalid type or violates ANY of the field's constraints.500urn:au-cds:error:cds-all:GeneralError/Unexpected
Missing Required Field400urn:au-cds:error:cds-all: Field/Missing

Applies when the required query parameter is not supplied in the request. The request is missing a mandatory field required for the API.

500urn:au-cds:error:cds-all:GeneralError/Unexpected
Expected Error400urn:au-cds:error:cds-all:GeneralError/ExpectedThis status code indicates that the Expected Error has encountered.500urn:au-cds:error:cds-all:GeneralError/Unexpected
Invalid Resource404urn:au-cds:error:cds-all:Resource/InvalidThe requested resource identifier is permanently unavailable.404urn:au-cds:error:cds-all:Resource/Invalid
Invalid Page422urn:au-cds:error:cds-all: Field/InvalidPage

Applies when the value of the parameter page violates ANY of the field's constraints.
The page being requested is out of range.

422urn:au-cds:error:cds-all: Field/InvalidPage
Legal Block451urn:dio:error:cds-all:Resource/LegalBlockThis status code indicates that the server is denying access to the resource as a consequence of a legal demand.422urn:au-cds:error:cds-all:Resource/Unavailable
Ineligible Block451urn:dio:error:cds-all:Resource/IneligibleBlockThis status code indicates that the Customer is ineligible for CDR Data Sharing.422urn:au-cds:error:cds-all:Resource/Invalid
Call Center Block451urn:dio:error:cds-all:Resource/CallCenterBlockThis status code indicates that the consumer should call the Call Center for further information.422urn:au-cds:error:cds-all:Resource/Invalid
Internal Server Error500urn:au-cds:error:cds-all:GeneralError/UnexpectedThis status code indicates that the server encountered an internal error or misconfiguration.500urn:au-cds:error:cds-all:GeneralError/Unexpected

Get Billing for Specific Energy Accounts​

Loading...

Β 

CDR Error Mapping​

TitleStatus CodeAdapter URN - Error CodeDetailCDR Status CodeCDR URN - Error Code
Invalid Field400urn:au-cds:error:cds-all:Field/Invalid

Applies when the value of required path parameter, i.e. principalId is an invalid type or the value violates the field's constraints.
Invalid format supplied for accountIds.

500urn:au-cds:error:cds-all:GeneralError/Unexpected
Invalid Header400urn:au-cds:error:cds-all:Header/Invalid

Applies when a HTTP Header is provided but the value provided is an invalid type or violates the field type constraints as defined in the Consumer Data Standards.
x-fapi-interaction-id - If supplied, it must be a Universal Unique Identifier (UUID) and compliant with RFC4122. If not supplied, a compliant value is autogenerated.
Invalid format supplied for
x-fapi-interaction-id.

500urn:au-cds:error:cds-all:GeneralError/Unexpected
Invalid Date400urn:au-cds:error:cds-all:Field/InvalidDateTime

Applies when the value of the parameter oldest-date or newest-date is of an invalid type.
An invalid date is provided.

500urn:au-cds:error:cds-all:GeneralError/Unexpected
Invalid Page Size400urn:au-cds:error:cds-all:Field/InvalidPageSizeApplies when the value of the parameter page is an invalid type or violates ANY of the field's constraints.500urn:au-cds:error:cds-all:GeneralError/Unexpected
Missing Required Field400urn:au-cds:error:cds-all: Field/Missing

Applies when the required query parameter is not supplied in the request. The request is missing a mandatory field required for the API.

500urn:au-cds:error:cds-all:GeneralError/Unexpected
Expected Error400urn:au-cds:error:cds-all:GeneralError/ExpectedThis status code indicates that the Expected Error has encountered.500urn:au-cds:error:cds-all:GeneralError/Unexpected
Invalid Resource404urn:au-cds:error:cds-all:Resource/InvalidThe requested resource identifier is permanently unavailable.404urn:au-cds:error:cds-all:Resource/Invalid
Invalid Page422urn:au-cds:error:cds-all: Field/InvalidPage

Applies when the value of the parameter page violates ANY of the field's constraints.
The page being requested is out of range.

422urn:au-cds:error:cds-all: Field/InvalidPage
Legal Block451urn:dio:error:cds-all:Resource/LegalBlockThis status code indicates that the server is denying access to the resource as a consequence of a legal demand.422urn:au-cds:error:cds-all:Resource/Unavailable
Ineligible Block451urn:dio:error:cds-all:Resource/IneligibleBlockThis status code indicates that the Customer is ineligible for CDR Data Sharing.422urn:au-cds:error:cds-all:Resource/Invalid
Call Center Block451urn:dio:error:cds-all:Resource/CallCenterBlockThis status code indicates that the consumer should call the Call Center for further information.422urn:au-cds:error:cds-all:Resource/Invalid
Internal Server Error500urn:au-cds:error:cds-all:GeneralError/UnexpectedThis status code indicates that the server encountered an internal error or misconfiguration.500urn:au-cds:error:cds-all:GeneralError/Unexpected

Data Adapter version to CDR version mapping​

Note

The V0 Data Adapter response for ListBillingTransactions is no longer supported and will be removed from the specification in a future release

Data Adapter VersionCDR VersionNotes
ListBillingTransactions V2GetBilling V3This is a 1:1 mapping. No transformation required.
ListBillingTransactions V2GetBilling V2Further information on this transformation, see below.
ListBillingTransactions V2GetBilling V1See ListBillingTransactions V1 -> GetBilling V1 and ListBillingTransactions V2 -> GetBilling V2 transformations.
ListBillingTransactions V1GetBilling V3Further information on this transformation, see below.
ListBillingTransactions V1GetBilling V2This is a 1:1 mapping. No transformation required.
ListBillingTransactions V1GetBilling V1By dropping ALL_DAY from the usage response and ALL_DAY and EXCESS from the demand response. For further details on this transformation, see below.

Transformation Details​

ListBillingTransactions V1 -> GetBilling V3​

GetBilling V3 introduces an optional demand.measureUnit field.

If this field is of importance to your business, you should consider implementing V2 of the adapter endpoint. Otherwise, HaaS will map this though as null in the CDR response and the ADR client will assume a measurement unit of "KVA".

ListBillingTransactions V2 -> GetBilling V2​

The downgrade logic for this scenario will be to omit demand.measureUnit from the CDR response and the ADR client will assume a measurement unit of "KVA".

ListBillingTransactions V1 -> GetBilling V1​

ListBillingTransactions: Downgrading from GetBillingForAccount V2 to V1

In GetBillingForAccountV2, there are additional enum values for the timeOfUseType field that falls under usageand demand. The table below displays the additional values (in bold) for V2.

usageDemand
PEAKPEAK
OFF_PEAKOFF_PEAK
OFF_PEAK_DEMAND_CHARGEOFF_PEAK_DEMAND_CHARGE
SHOULDERSHOULDER
SHOULDER1SHOULDER1
SHOULDER2SHOULDER2
CONTROLLED_LOADCONTROLLED_LOAD
SOLARSOLAR
AGGREGATEAGGREGATE
ALL_DAYALL_DAY
EXCESS

Biza will follow these rules when handling the downgrade:

  1. If the transactionV2 type is usage, and transaction.usage.timeOfUseType is ALL_DAY, it will be removed from the response as transactionV1 does not support ALL_DAY.
  2. If the transactionV2 type is demand, and transaction.demand.timeOfUseType is ALL_DAY or EXCESS, it will be removed from the response as transactionV1 does not support ALL_DAY or EXCESS.

Β 


Supplemental Fields​

No supplemental fields are specified.

Endpoint Specific Guidance​

  • The Data Adapter call is made with an accountIds filter at all times as this endpoint is not used prior to an arrangement being established.