Skip to main content

Get Agreed Payment Schedule

The purpose of this endpoint is to deliver Payment Schedules related to a specific Principal (principalId) and Account (accountId) retrieved from List Energy Accounts.

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

Data Adapter API​

Get Energy Account Agreed Payment Schedule​

Loading...

Β 


Consumer Data Standards Associations​

Get Energy Account Payment Schedule​

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
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
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

Β 


Supplemental Fields​

No supplemental fields are specified.

Endpoint Specific Guidance​

  • We allow for multiple payment schedules to be provided for an account with only the first currently provided via CDR, see request for clarification which we suspect will result in a change to a (potentially empty) array of results.