From 08bdedfb53f5b43edeecf0de71e3028e9c3a54f0 Mon Sep 17 00:00:00 2001 From: CDR API Stream <52149325+CDR-API-Stream@users.noreply.github.com> Date: Wed, 22 Mar 2023 01:24:38 +0000 Subject: [PATCH] Release/1.22.1 (#297) * Standards Maintenance Issue 546: Updated DCR and Register swagger specifications to use Common Field Types * Added diff and release notes * Fixed redirect_uris array use of URIString in relation to maintenance comment: https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues/546#issuecomment-1291428306 * Updated code formatting and indenting * Added Enum common type usage * Updated DCR and Register specs based on community feedback to the Common Field Types implementation * Updated swaggers to remove format fields * Updated diff for the Register API changes * Fixed formatting * Updated Register APIs based on ACCC feedback * Base branch for v1.22.0 * Draft updates 1 DP 275 * Retain v1.21.0 delta statements * Rebuild * Fixed open-status reversal * Rebuild * Create release notes Add archive entry Add change log entry * Release notes * Add archived API versions * Add new field to the swagger Add FDO Update endpoint schedule * Add diff statements * Fix missing obselete link in Get Accounts * Fix obselete message bug * Fixed Issue with AccontDetail * Rebuild Add in Telco diff statement Add Telco release notes * Merge of 1.22.0 * Remove external refs on client IDs * Remove common string references * Review updates * Release notes * Rebuild Diff statement * Updates to x-v headers * reverted account scope * Updated other account scopes * Update extended security documentation * Rebuild * Engage Festive * Rebuild with FESTIVE ENGAGED * Fix additional TDIF links * Fix ACCC fonts * Fix minor defects picked up after publish Rebuild * - Update version to 1.22.1 - Remove diff statements - Add links for archive - Add draft release notes * Removed santa hat * Restored diff overview statement Removed last actual diff statement * Full rebuild * Add binding statement * Add diff and release notes * Fix diff typo * Fix FDOs Fix Obligation table Add release notes * Update * Fix the binding date for Get Energy Account Detail V2 Removed the TBC dates for v1.19.0 Release notes * Rebuild * Update end point version schedule links Release notes * Changed error model for energy to ResponseErrorListV2 Rebuild * Fixed typo Rebuild * Update release notes for 227 * Rebuild * Added release notes for Telco * Apply energy changes to SDH swagger also * Rebuild * Fix error model in Telco Fix release note types Rebuild * Update V2 error list (#267) * Fix Telco merge Rebuild * Rebuild * Fix publish date Rebuild --------- Co-authored-by: Mark Verstege <2514377+markverstege@users.noreply.github.com> Co-authored-by: James Bligh Co-authored-by: Kirkycdr Co-authored-by: James Bligh <40985476+JamesMBligh@users.noreply.github.com> Co-authored-by: kirkycdr <91938516+kirkycdr@users.noreply.github.com> --- docs/includes/archives | 5 + docs/includes/cds_energy | 170 +- docs/includes/cds_energy_sdh | 46 +- docs/includes/cds_telco | 2201 +++-- docs/includes/changelog | 6 + .../endpoint-version-schedule/index.html | 80 +- .../obsolete/get-account-detail-v1.html | 2 +- .../obsolete/get-account-detail-v2.html | 2 +- docs/includes/obsolete/get-accounts-v1.html | 2 +- .../obsolete/get-customer-detail-v1.html | 2 +- .../obsolete/get-data-holder-brands-v1.html | 2 +- .../get-data-recipient-statuses-v1.html | 2 +- .../obsolete/get-data-recipients-v2.html | 2 +- .../get-energy-account-detail-v1.html | 2 +- .../obsolete/get-energy-accounts-v1.html | 2 +- docs/includes/obsolete/get-metrics-v1.html | 2 +- docs/includes/obsolete/get-metrics-v2.html | 2 +- .../obsolete/get-payee-detail-v1.html | 2 +- docs/includes/obsolete/get-payees-v1.html | 2 +- .../obsolete/get-product-detail-v1.html | 2 +- .../obsolete/get-product-detail-v2.html | 2 +- .../obsolete/get-product-detail-v3.html | 2 +- docs/includes/obsolete/get-products-v1.html | 2 +- docs/includes/obsolete/get-products-v2.html | 2 +- .../get-software-product-statuses-v1.html | 2 +- .../get-software-statement-assertion-v1.html | 2 +- .../get-software-statement-assertion-v2.html | 2 +- .../releasenotes/releasenotes.1.0.1.html | 2 +- .../releasenotes/releasenotes.1.1.0.html | 2 +- .../releasenotes/releasenotes.1.1.1.html | 2 +- .../releasenotes/releasenotes.1.10.0.html | 2 +- .../releasenotes/releasenotes.1.11.0.html | 2 +- .../releasenotes/releasenotes.1.11.1.html | 2 +- .../releasenotes/releasenotes.1.12.0.html | 2 +- .../releasenotes/releasenotes.1.13.0.html | 2 +- .../releasenotes/releasenotes.1.14.0.html | 2 +- .../releasenotes/releasenotes.1.15.0.html | 2 +- .../releasenotes/releasenotes.1.16.0.html | 2 +- .../releasenotes/releasenotes.1.16.1.html | 2 +- .../releasenotes/releasenotes.1.17.0.html | 2 +- .../releasenotes/releasenotes.1.18.0.html | 2 +- .../releasenotes/releasenotes.1.19.0.html | 2 +- .../releasenotes/releasenotes.1.2.0.html | 2 +- .../releasenotes/releasenotes.1.20.0.html | 2 +- .../releasenotes/releasenotes.1.21.0.html | 2 +- .../releasenotes/releasenotes.1.22.0.html | 4 +- .../releasenotes/releasenotes.1.22.1.html | 340 + .../releasenotes/releasenotes.1.3.0.html | 2 +- .../releasenotes/releasenotes.1.3.1.html | 2 +- .../releasenotes/releasenotes.1.4.0.html | 2 +- .../releasenotes/releasenotes.1.5.0.html | 2 +- .../releasenotes/releasenotes.1.5.1.html | 2 +- .../releasenotes/releasenotes.1.6.0.html | 2 +- .../releasenotes/releasenotes.1.7.0.html | 2 +- .../releasenotes/releasenotes.1.8.0.html | 2 +- .../releasenotes/releasenotes.1.9.0.html | 2 +- docs/includes/swagger/cds_admin.json | 2 +- docs/includes/swagger/cds_admin.yaml | 2 +- docs/includes/swagger/cds_banking.json | 2 +- docs/includes/swagger/cds_banking.yaml | 2 +- docs/includes/swagger/cds_common.json | 2 +- docs/includes/swagger/cds_common.yaml | 2 +- docs/includes/swagger/cds_dcr.json | 2 +- docs/includes/swagger/cds_dcr.yaml | 2 +- docs/includes/swagger/cds_energy.json | 172 +- docs/includes/swagger/cds_energy.yaml | 166 +- docs/includes/swagger/cds_energy_sdh.json | 54 +- docs/includes/swagger/cds_energy_sdh.yaml | 54 +- docs/includes/swagger/cds_register.json | 2 +- docs/includes/swagger/cds_register.yaml | 2 +- docs/includes/swagger/cds_telco.json | 1365 +-- docs/includes/swagger/cds_telco.yaml | 2153 ++-- docs/index.html | 2606 ++--- slate/source/includes/_banking_apis.md.erb | 7 - slate/source/includes/_dcr_apis.md.erb | 4 - slate/source/includes/_energy_apis.md.erb | 16 + slate/source/includes/_energy_apis_sdh.md.erb | 12 + slate/source/includes/_register.md.erb | 8 - slate/source/includes/_security.md.erb | 5 - slate/source/includes/_telco_apis.md.erb | 8 +- slate/source/includes/archives.md | 1 + slate/source/includes/cds_energy.md | 170 +- slate/source/includes/cds_energy_sdh.md | 46 +- slate/source/includes/cds_telco.md | 1591 +-- slate/source/includes/changelog.md | 1 + .../includes/_energy-dh.md | 8 +- .../endpoint-version-schedule/index.html.md | 22 +- .../_endpoint_version_schedule.md | 18 +- slate/source/includes/introduction/_fdo.md | 34 +- slate/source/includes/introduction/_intro.md | 11 +- .../releasenotes/releasenotes.1.22.1.html.md | 69 + .../security/_authentication_flows.md | 13 - .../security/_client_registration.md.erb | 20 - slate/source/includes/security/_tokens.md | 7 - .../source/includes/standards/_versioning.md | 7 +- slate/source/includes/swagger/cds_admin.json | 2 +- slate/source/includes/swagger/cds_admin.yaml | 2 +- .../source/includes/swagger/cds_banking.json | 2 +- .../source/includes/swagger/cds_banking.yaml | 2 +- slate/source/includes/swagger/cds_common.json | 2 +- slate/source/includes/swagger/cds_common.yaml | 2 +- slate/source/includes/swagger/cds_dcr.json | 2 +- slate/source/includes/swagger/cds_dcr.yaml | 2 +- slate/source/includes/swagger/cds_energy.json | 172 +- slate/source/includes/swagger/cds_energy.yaml | 166 +- .../includes/swagger/cds_energy_sdh.json | 54 +- .../includes/swagger/cds_energy_sdh.yaml | 54 +- .../source/includes/swagger/cds_register.json | 2 +- .../source/includes/swagger/cds_register.yaml | 2 +- slate/source/includes/swagger/cds_telco.json | 1365 +-- slate/source/includes/swagger/cds_telco.yaml | 2153 ++-- slate/source/layouts/layout.erb | 2 +- slate/source/layouts/no_code_panel_layout.erb | 2 +- swagger-gen/api/cds_admin.json | 2 +- swagger-gen/api/cds_banking.json | 2 +- swagger-gen/api/cds_common.json | 2 +- swagger-gen/api/cds_dcr.json | 2 +- swagger-gen/api/cds_energy.json | 171 +- swagger-gen/api/cds_energy_sdh.json | 47 +- swagger-gen/api/cds_register.json | 2 +- swagger-gen/api/cds_telco.json | 8714 +++++++---------- swagger-gen/cds_energy.md | 170 +- swagger-gen/cds_energy_sdh.md | 46 +- swagger-gen/cds_telco.md | 1591 +-- 124 files changed, 11668 insertions(+), 14685 deletions(-) create mode 100644 docs/includes/releasenotes/releasenotes.1.22.1.html create mode 100644 slate/source/includes/releasenotes/releasenotes.1.22.1.html.md diff --git a/docs/includes/archives b/docs/includes/archives index 2e6a931a..18cdc691 100644 --- a/docs/includes/archives +++ b/docs/includes/archives @@ -9,6 +9,11 @@ +22/12/2022 +1.22.0 +Changes arising from Decision 271 (Maintenance iteration 13) + + 16/12/2022 1.21.0 Changes arising from Decision 282 diff --git a/docs/includes/cds_energy b/docs/includes/cds_energy index f5ddede4..bdc4fe47 100644 --- a/docs/includes/cds_energy +++ b/docs/includes/cds_energy @@ -249,19 +249,19 @@ x-min-v: string 400 Bad Request The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2 406 Not Acceptable The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2 422 Unprocessable Entity The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2

Response Headers

@@ -902,19 +902,19 @@ x-min-v: string 400 Bad Request The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2 404 Not Found The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2 406 Not Acceptable The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2

Response Headers

@@ -1140,19 +1140,19 @@ x-cds-client-headers: string 400 Bad Request The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2 406 Not Acceptable The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2 422 Unprocessable Entity The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2

Response Headers

@@ -1443,19 +1443,19 @@ x-cds-client-headers: string 400 Bad Request The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2 404 Not Found The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2 406 Not Acceptable The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2

Response Headers

@@ -1752,25 +1752,25 @@ x-cds-client-headers: string 400 Bad Request The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2 404 Not Found The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2 406 Not Acceptable The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2 422 Unprocessable Entity The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2

Response Headers

@@ -2067,19 +2067,19 @@ x-cds-client-headers: string 400 Bad Request The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2 406 Not Acceptable The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2 422 Unprocessable Entity The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2

Response Headers

@@ -2314,7 +2314,7 @@ x-cds-client-headers: string » meta body Meta -mandatory +optional none @@ -2411,19 +2411,19 @@ x-cds-client-headers: string 400 Bad Request The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2 406 Not Acceptable The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2 422 Unprocessable Entity The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2

Response Headers

@@ -2676,19 +2676,19 @@ x-cds-client-headers: string 400 Bad Request The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2 404 Not Found The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2 406 Not Acceptable The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2

Response Headers

@@ -2959,19 +2959,19 @@ x-cds-client-headers: string 400 Bad Request The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2 406 Not Acceptable The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2 422 Unprocessable Entity The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2

Response Headers

@@ -3185,7 +3185,7 @@ x-cds-client-headers: string » meta body Meta -mandatory +optional none @@ -3284,19 +3284,19 @@ x-cds-client-headers: string 400 Bad Request The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2 406 Not Acceptable The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2 422 Unprocessable Entity The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2

Response Headers

@@ -3565,19 +3565,19 @@ x-cds-client-headers: string 400 Bad Request The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2 406 Not Acceptable The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2 422 Unprocessable Entity The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2

Response Headers

@@ -4155,19 +4155,19 @@ x-cds-client-headers: string 400 Bad Request The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2 404 Not Found The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2 406 Not Acceptable The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2

Response Headers

@@ -4404,19 +4404,19 @@ x-cds-client-headers: string 400 Bad Request The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2 404 Not Found The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2 406 Not Acceptable The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2

Response Headers

@@ -4636,19 +4636,19 @@ x-cds-client-headers: string 400 Bad Request The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2 404 Not Found The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2 406 Not Acceptable The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2

Response Headers

@@ -4853,19 +4853,19 @@ x-cds-client-headers: string 400 Bad Request The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2 404 Not Found The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2 406 Not Acceptable The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2

Response Headers

@@ -5089,19 +5089,19 @@ x-cds-client-headers: string 400 Bad Request The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2 406 Not Acceptable The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2 422 Unprocessable Entity The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2

Response Headers

@@ -5315,7 +5315,7 @@ x-cds-client-headers: string » meta body Meta -mandatory +optional none @@ -5367,19 +5367,19 @@ x-cds-client-headers: string 400 Bad Request The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2 406 Not Acceptable The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2 422 Unprocessable Entity The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2

Response Headers

@@ -5675,25 +5675,25 @@ x-cds-client-headers: string 400 Bad Request The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2 404 Not Found The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2 406 Not Acceptable The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2 422 Unprocessable Entity The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2

Response Headers

@@ -5989,19 +5989,19 @@ x-cds-client-headers: string 400 Bad Request The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2 406 Not Acceptable The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2 422 Unprocessable Entity The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2

Response Headers

@@ -6229,7 +6229,7 @@ x-cds-client-headers: string » meta body Meta -mandatory +optional none @@ -6332,19 +6332,19 @@ x-cds-client-headers: string 400 Bad Request The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2 406 Not Acceptable The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2 422 Unprocessable Entity The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2

Response Headers

@@ -6669,25 +6669,25 @@ x-cds-client-headers: string 400 Bad Request The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2 404 Not Found The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2 406 Not Acceptable The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2 422 Unprocessable Entity The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2

Response Headers

@@ -7012,19 +7012,19 @@ x-cds-client-headers: string 400 Bad Request The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2 406 Not Acceptable The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2 422 Unprocessable Entity The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2

Response Headers

@@ -7252,7 +7252,7 @@ x-cds-client-headers: string » meta body Meta -mandatory +optional none @@ -7384,19 +7384,19 @@ x-cds-client-headers: string 400 Bad Request The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2 406 Not Acceptable The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2 422 Unprocessable Entity The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2

Response Headers

@@ -8540,7 +8540,7 @@ To perform this operation, you must be authenticated and authorised with the fol meta Meta -mandatory +optional none @@ -9029,7 +9029,7 @@ To perform this operation, you must be authenticated and authorised with the fol meta Meta -mandatory +optional none @@ -9105,7 +9105,7 @@ To perform this operation, you must be authenticated and authorised with the fol meta Meta -mandatory +optional none @@ -9168,7 +9168,7 @@ To perform this operation, you must be authenticated and authorised with the fol meta Meta -mandatory +optional none @@ -9288,7 +9288,7 @@ To perform this operation, you must be authenticated and authorised with the fol meta Meta -mandatory +optional none @@ -9544,9 +9544,9 @@ To perform this operation, you must be authenticated and authorised with the fol -

ErrorListResponse

+

ResponseErrorListV2

-

+

{
   "errors": [
     {
@@ -13354,7 +13354,7 @@ To perform this operation, you must be authenticated and authorised with the fol
 » party
 string
 mandatory
-The name of the party/orginsation related to this service point
+The name of the party/organisation related to this service point
 
 
 » role
diff --git a/docs/includes/cds_energy_sdh b/docs/includes/cds_energy_sdh
index cacfbba0..8334eaca 100644
--- a/docs/includes/cds_energy_sdh
+++ b/docs/includes/cds_energy_sdh
@@ -202,19 +202,19 @@ x-cds-arrangement: string
 400
 Bad Request
 The following error codes MUST be supported:

-ErrorListResponse
+ResponseErrorListV2
 
 
 406
 Not Acceptable
 The following error codes MUST be supported:

-ErrorListResponse
+ResponseErrorListV2
 
 
 422
 Unprocessable Entity
 The following error codes MUST be supported:

-ErrorListResponse
+ResponseErrorListV2
 
 
 
Response Headers

@@ -486,19 +486,19 @@ x-cds-arrangement: string
 400
 Bad Request
 The following error codes MUST be supported:

-ErrorListResponse
+ResponseErrorListV2
 
 
 404
 Not Found
 The following error codes MUST be supported:

-ErrorListResponse
+ResponseErrorListV2
 
 
 406
 Not Acceptable
 The following error codes MUST be supported:

-ErrorListResponse
+ResponseErrorListV2
 
 
 
Response Headers

@@ -776,25 +776,25 @@ x-cds-arrangement: string
 400
 Bad Request
 The following error codes MUST be supported:

-ErrorListResponse
+ResponseErrorListV2
 
 
 404
 Not Found
 The following error codes MUST be supported:

-ErrorListResponse
+ResponseErrorListV2
 
 
 406
 Not Acceptable
 The following error codes MUST be supported:

-ErrorListResponse
+ResponseErrorListV2
 
 
 422
 Unprocessable Entity
 The following error codes MUST be supported:

-ErrorListResponse
+ResponseErrorListV2
 
 
 
Response Headers

@@ -1114,19 +1114,19 @@ x-cds-arrangement: string
 400
 Bad Request
 The following error codes MUST be supported:

-ErrorListResponse
+ResponseErrorListV2
 
 
 406
 Not Acceptable
 The following error codes MUST be supported:

-ErrorListResponse
+ResponseErrorListV2
 
 
 422
 Unprocessable Entity
 The following error codes MUST be supported:

-ErrorListResponse
+ResponseErrorListV2
 
 
 
Response Headers

@@ -1360,19 +1360,19 @@ x-cds-arrangement: string
 400
 Bad Request
 The following error codes MUST be supported:

-ErrorListResponse
+ResponseErrorListV2
 
 
 404
 Not Found
 The following error codes MUST be supported:

-ErrorListResponse
+ResponseErrorListV2
 
 
 406
 Not Acceptable
 The following error codes MUST be supported:

-ErrorListResponse
+ResponseErrorListV2
 
 
 
Response Headers

@@ -1666,19 +1666,19 @@ x-cds-arrangement: string
 400
 Bad Request
 The following error codes MUST be supported:

-ErrorListResponse
+ResponseErrorListV2
 
 
 406
 Not Acceptable
 The following error codes MUST be supported:

-ErrorListResponse
+ResponseErrorListV2
 
 
 422
 Unprocessable Entity
 The following error codes MUST be supported:

-ErrorListResponse
+ResponseErrorListV2
 
 
 
Response Headers

@@ -2211,14 +2211,14 @@ This operation may only be called by an Energy Retailer using the information se
 
 meta
 Meta
-mandatory
+optional
 none
 
 
 
-
ErrorListResponse

+
ResponseErrorListV2

 
-

+

 
{
   "errors": [
     {
@@ -2688,7 +2688,7 @@ This operation may only be called by an Energy Retailer using the information se
 » party
 string
 mandatory
-The name of the party/orginsation related to this service point
+The name of the party/organisation related to this service point
 
 
 » role
diff --git a/docs/includes/cds_telco b/docs/includes/cds_telco
index 724d9548..4fd0b894 100644
--- a/docs/includes/cds_telco
+++ b/docs/includes/cds_telco
@@ -62,14 +62,14 @@
 query
 string
 optional
-Used to filter results on the type field.  Any one of the valid values for this field can be supplied. If absent, defaults to include all products. Valid values are ‘MOBILE’, ‘BROADBAND’
+Used to filter results on the type field. Any one of the valid values for this field can be supplied. If absent, defaults to include ALL products. Valid values are MOBILE service. BROADBAND fixed internet service or ALL
 
 
 billing-type
 query
 string
 optional
-Used to filter results on the billing-type field.  Any one of the valid values for this field can be supplied. If absent, defaults to include all billing types. Valid values are ‘PRE_PAID’, ‘POST_PAID’, 'UPFRONT_PAID', 'OTHER'
+Used to filter results on the billing-type field.  Any one of the valid values for this field can be supplied. If absent, defaults to include all billing types. Valid values are ‘PRE_PAID’, ‘POST_PAID’, 'UPFRONT_PAID', 'ALL'
 
 
 effective
@@ -137,6 +137,10 @@
 BROADBAND
 
 
+type
+ALL
+
+
 billing-type
 PRE_PAID
 
@@ -150,7 +154,7 @@
 
 
 billing-type
-OTHER
+ALL
 
 
 effective
@@ -198,7 +202,7 @@
             "name": "string",
             "description": "string",
             "period": "string",
-            "chargeAmount": "string"
+            "amount": "string"
           }
         ],
         "thirdPartyAgentId": "string",
@@ -247,19 +251,19 @@
 400
 Bad Request
 The following error codes MUST be supported:

-ErrorListResponse
+ResponseErrorListV2
 
 
 406
 Not Acceptable
 The following error codes MUST be supported:

-ErrorListResponse
+ResponseErrorListV2
 
 
 422
 Unprocessable Entity
 The following error codes MUST be supported:

-ErrorListResponse
+ResponseErrorListV2
 
 
 
Response Headers

@@ -279,27 +283,6 @@
 
 none
 
-
-400
-x-fapi-interaction-id
-string
-
-none
-
-
-406
-x-fapi-interaction-id
-string
-
-none
-
-
-422
-x-fapi-interaction-id
-string
-
-none
-
 
 
 

 
Responses

@@ -808,25 +749,25 @@ This operation does not require authentication
 400
 Bad Request
 The following error codes MUST be supported:

-ErrorListResponse
+ResponseErrorListV2
 
 
 404
 Not Found
 The following error codes MUST be supported:

-ErrorListResponse
+ResponseErrorListV2
 
 
 406
 Not Acceptable
 The following error codes MUST be supported:

-ErrorListResponse
+ResponseErrorListV2
 
 
 422
 Unprocessable Entity
 The following error codes MUST be supported:

-ErrorListResponse
+ResponseErrorListV2
 
 
 
Response Headers

@@ -1030,65 +971,71 @@ To perform this operation, you must be authenticated and authorised with the fol
 
200 Response

 
 
{
-  "accounts": [
-    {
-      "accountId": "string",
-      "services": [
-        {
-          "service": {
-            "serviceId": "string",
-            "displayName": "string",
-            "phoneNumber": "string",
-            "startDate": "string",
-            "endDate": "string",
-            "usage": {
-              "data": {
-                "upload": 0,
-                "download": 0,
-                "sessions": 0,
-                "amount": "string",
-                "roaming": {
+  "data": {
+    "accounts": [
+      {
+        "accountId": "string",
+        "services": [
+          {
+            "service": {
+              "serviceId": "string",
+              "displayName": "string",
+              "phoneNumber": "string",
+              "startDate": "string",
+              "endDate": "string",
+              "usage": {
+                "data": {
+                  "upload": 0,
                   "download": 0,
-                  "amount": "string"
-                }
-              },
-              "voice": {
-                "national": {
-                  "duration": "string",
-                  "number": 0,
-                  "amount": "string"
-                },
-                "international": {
-                  "duration": "string",
-                  "number": 0,
-                  "amount": "string"
+                  "sessions": 0,
+                  "amount": "string",
+                  "roaming": {
+                    "download": 0,
+                    "amount": "string"
+                  }
                 },
-                "roaming": {
-                  "duration": "string",
-                  "number": 0,
-                  "amount": "string"
-                }
-              },
-              "messaging": {
-                "sms": {
-                  "national": 0,
-                  "international": 0,
-                  "roaming": 0,
-                  "amount": "string"
+                "voice": {
+                  "national": {
+                    "duration": "string",
+                    "number": 0,
+                    "amount": "string"
+                  },
+                  "international": {
+                    "duration": "string",
+                    "number": 0,
+                    "amount": "string"
+                  },
+                  "roaming": {
+                    "duration": "string",
+                    "number": 0,
+                    "amount": "string"
+                  }
                 },
-                "mms": {
-                  "national": 0,
-                  "international": 0,
-                  "roaming": 0,
-                  "amount": "string"
+                "messaging": {
+                  "sms": {
+                    "national": 0,
+                    "international": 0,
+                    "roaming": 0,
+                    "amount": "string"
+                  },
+                  "mms": {
+                    "national": 0,
+                    "international": 0,
+                    "roaming": 0,
+                    "amount": "string"
+                  }
                 }
               }
             }
           }
-        }
-      ]
-    }
-  ]
+        ]
+      }
+    ]
+  },
+  "links": {
+    "self": "string"
+  },
+  "meta": {}
 }
 

 
Responses

@@ -1111,19 +1058,19 @@ To perform this operation, you must be authenticated and authorised with the fol
 400
 Bad Request
 The following error codes MUST be supported:

-ErrorListResponse
+ResponseErrorListV2
 
 
 406
 Not Acceptable
 The following error codes MUST be supported:

-ErrorListResponse
+ResponseErrorListV2
 
 
 422
 Unprocessable Entity
 The following error codes MUST be supported:

-ErrorListResponse
+ResponseErrorListV2
 
 
 
Response Headers

@@ -1257,20 +1204,6 @@ To perform this operation, you must be authenticated and authorised with the fol
 
 
 
-oldest-date
-query
-DateString
-optional
-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
-
-
-newest-date
-query
-DateString
-optional
-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
-
-
 page
 query
 PositiveInteger
@@ -1362,69 +1295,71 @@ To perform this operation, you must be authenticated and authorised with the fol
 
200 Response

 
 
{
-  "data": [
-    {
-      "serviceId": "string",
-      "displayName": "string",
-      "phoneNumber": "string",
-      "startDate": "string",
-      "endDate": "string",
-      "usage": {
-        "data": {
-          "upload": 0,
-          "download": 0,
-          "sessions": 0,
-          "amount": "string",
-          "roaming": {
-            "download": 0,
-            "amount": "string"
-          }
-        },
-        "voice": {
-          "national": {
-            "duration": "string",
-            "number": 0,
-            "amount": "string"
-          },
-          "international": {
-            "duration": "string",
-            "number": 0,
-            "amount": "string"
-          },
-          "roaming": {
-            "duration": "string",
-            "number": 0,
-            "amount": "string"
-          }
-        },
-        "messaging": {
-          "sms": {
-            "national": 0,
-            "international": 0,
-            "roaming": 0,
-            "amount": "string"
-          },
-          "mms": {
-            "national": 0,
-            "international": 0,
-            "roaming": 0,
-            "amount": "string"
-          }
-        }
-      }
-    }
-  ],
-  "links": {
-    "self": "string",
-    "first": "string",
-    "prev": "string",
-    "next": "string",
-    "last": "string"
-  },
-  "meta": {
-    "totalRecords": 0,
-    "totalPages": 0
-  }
+  "data": {
+    "accounts": [
+      {
+        "accountId": "string",
+        "services": [
+          {
+            "service": {
+              "serviceId": "string",
+              "displayName": "string",
+              "phoneNumber": "string",
+              "startDate": "string",
+              "endDate": "string",
+              "usage": {
+                "data": {
+                  "upload": 0,
+                  "download": 0,
+                  "sessions": 0,
+                  "amount": "string",
+                  "roaming": {
+                    "download": 0,
+                    "amount": "string"
+                  }
+                },
+                "voice": {
+                  "national": {
+                    "duration": "string",
+                    "number": 0,
+                    "amount": "string"
+                  },
+                  "international": {
+                    "duration": "string",
+                    "number": 0,
+                    "amount": "string"
+                  },
+                  "roaming": {
+                    "duration": "string",
+                    "number": 0,
+                    "amount": "string"
+                  }
+                },
+                "messaging": {
+                  "sms": {
+                    "national": 0,
+                    "international": 0,
+                    "roaming": 0,
+                    "amount": "string"
+                  },
+                  "mms": {
+                    "national": 0,
+                    "international": 0,
+                    "roaming": 0,
+                    "amount": "string"
+                  }
+                }
+              }
+            }
+          }
+        ]
+      }
+    ]
+  },
+  "links": {
+    "self": "string"
+  },
+  "meta": {}
 }
 

 
Responses

@@ -1441,25 +1376,25 @@ To perform this operation, you must be authenticated and authorised with the fol
 200
 OK
 Successful response
-TelcoServiceUsageListResponse
+TelcoUsageListResponse
 
 
 400
 Bad Request
 The following error codes MUST be supported:

-ErrorListResponse
+ResponseErrorListV2
 
 
 406
 Not Acceptable
 The following error codes MUST be supported:

-ErrorListResponse
+ResponseErrorListV2
 
 
 422
 Unprocessable Entity
 The following error codes MUST be supported:

-ErrorListResponse
+ResponseErrorListV2
 
 
 
Response Headers

@@ -1588,6 +1523,13 @@ To perform this operation, you must be authenticated and authorised with the fol
 Used to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed
 
 
+updated-since
+query
+DateString
+optional
+Only include accounts that have been updated after the specified date and time.  If absent defaults to include all plans
+
+
 page
 query
 PositiveInteger
@@ -1732,19 +1674,19 @@ To perform this operation, you must be authenticated and authorised with the fol
 400
 Bad Request
 The following error codes MUST be supported:

-ErrorListResponse
+ResponseErrorListV2
 
 
 406
 Not Acceptable
 The following error codes MUST be supported:

-ErrorListResponse
+ResponseErrorListV2
 
 
 422
 Unprocessable Entity
 The following error codes MUST be supported:

-ErrorListResponse
+ResponseErrorListV2
 
 
 
Response Headers

@@ -1870,7 +1812,7 @@ To perform this operation, you must be authenticated and authorised with the fol
 path
 string
 mandatory
-ID of a specific account to obtain data for.  This is a tokenised ID previously obtained from the Account List end point. In accordance with CDR ID permanence requirements
+ID of a specific account to obtain data for. This is a tokenised ID previously obtained from the Account List end point. In accordance with CDR ID permanence requirements
 
 
 x-v
@@ -1953,18 +1895,7 @@ To perform this operation, you must be authenticated and authorised with the fol
               "period": "string"
             }
           ]
-        },
-        "authorisedContacts": [
-          {
-            "firstName": "string",
-            "lastName": "string",
-            "middleNames": [
-              "string"
-            ],
-            "prefix": "string",
-            "suffix": "string"
-          }
-        ]
+        }
       }
     ]
   },
@@ -1994,19 +1925,19 @@ To perform this operation, you must be authenticated and authorised with the fol
 400
 Bad Request
 The following error codes MUST be supported:

-ErrorListResponse
+ResponseErrorListV2
 
 
 404
 Not Found
 The following error codes MUST be supported:

-ErrorListResponse
+ResponseErrorListV2
 
 
 406
 Not Acceptable
 The following error codes MUST be supported:

-ErrorListResponse
+ResponseErrorListV2
 
 
 
Response Headers

@@ -2134,7 +2065,7 @@ To perform this operation, you must be authenticated and authorised with the fol
 path
 string
 mandatory
-ID of a specific account to obtain data for.  This is a tokenised ID previously obtained from the Account List end point. In accordance with CDR ID permanence requirements
+ID of a specific account to obtain data for. This is a tokenised ID previously obtained from the Account List end point. In accordance with CDR ID permanence requirements
 
 
 x-v
@@ -2218,9 +2149,16 @@ To perform this operation, you must be authenticated and authorised with the fol
     ]
   },
   "links": {
-    "self": "string"
+    "self": "string",
+    "first": "string",
+    "prev": "string",
+    "next": "string",
+    "last": "string"
   },
-  "meta": {}
+  "meta": {
+    "totalRecords": 0,
+    "totalPages": 0
+  }
 }

Responses

@@ -2243,19 +2181,19 @@ To perform this operation, you must be authenticated and authorised with the fol 400 Bad Request The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2 404 Not Found The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2 406 Not Acceptable The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2

Response Headers

@@ -2379,7 +2317,7 @@ To perform this operation, you must be authenticated and authorised with the fol path string mandatory -ID of a specific account to obtain data for. This is a tokenised ID previously obtained from the Account List end point. In accordance with CDR ID permanence requirements +ID of a specific account to obtain data for. This is a tokenised ID previously obtained from the Account List end point. In accordance with CDR ID permanence requirements x-v @@ -2450,9 +2388,16 @@ To perform this operation, you must be authenticated and authorised with the fol ] }, "links": { - "self": "string" + "self": "string", + "first": "string", + "prev": "string", + "next": "string", + "last": "string" }, - "meta": {} + "meta": { + "totalRecords": 0, + "totalPages": 0 + } }

Responses

@@ -2475,19 +2420,19 @@ To perform this operation, you must be authenticated and authorised with the fol 400 Bad Request The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2 404 Not Found The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2 406 Not Acceptable The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2

Response Headers

@@ -2611,7 +2556,7 @@ To perform this operation, you must be authenticated and authorised with the fol path string mandatory -ID of a specific account to obtain data for. This is a tokenised ID previously obtained from the Account List end point. In accordance with CDR ID permanence requirements +ID of a specific account to obtain data for. This is a tokenised ID previously obtained from the Account List end point. In accordance with CDR ID permanence requirements x-v @@ -2752,19 +2697,19 @@ To perform this operation, you must be authenticated and authorised with the fol 400 Bad Request The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2 404 Not Found The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2 406 Not Acceptable The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2

Response Headers

@@ -3050,19 +2995,19 @@ To perform this operation, you must be authenticated and authorised with the fol 400 Bad Request The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2 406 Not Acceptable The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2 422 Unprocessable Entity The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2

Response Headers

@@ -3390,19 +3335,19 @@ To perform this operation, you must be authenticated and authorised with the fol 400 Bad Request The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2 406 Not Acceptable The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2 422 Unprocessable Entity The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2

Response Headers

@@ -3526,35 +3471,7 @@ To perform this operation, you must be authenticated and authorised with the fol path string mandatory -ID of a specific account to obtain data for. This is a tokenised ID previously obtained from the Account List end point. In accordance with CDR ID permanence requirements - - -newest-date -query -DateString -optional -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 - - -oldest-date -query -DateString -optional -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 - - -page -query -PositiveInteger -optional -Page of results to request (standard pagination) - - -page-size -query -PositiveInteger -optional -Page size to request. Default is 25 (standard pagination) +ID of a specific account to obtain data for. This is a tokenised ID previously obtained from the Account List end point. In accordance with CDR ID permanence requirements x-v @@ -3606,89 +3523,95 @@ To perform this operation, you must be authenticated and authorised with the fol

200 Response

{
-  "invoices": [
-    {
-      "accountId": "string",
-      "invoiceNumber": "string",
-      "issueDate": "string",
-      "dueDate": "string",
-      "period": {
-        "startDate": "string",
-        "endDate": "string"
-      },
-      "invoiceAmount": "string",
-      "gstAmount": "string",
-      "payOnTimeDiscount": {
-        "discountAmount": "string",
+  "data": {
+    "invoices": [
+      {
+        "accountId": "string",
+        "invoiceNumber": "string",
+        "issueDate": "string",
+        "dueDate": "string",
+        "period": {
+          "startDate": "string",
+          "endDate": "string"
+        },
+        "invoiceAmount": "string",
         "gstAmount": "string",
-        "date": "string"
-      },
-      "balanceAtIssue": "string",
-      "services": [
-        "string"
-      ],
-      "accountCharges": {
-        "totalUsageCharges": "string",
-        "totalOnceOffCharges": "string",
-        "totalDiscounts": "string",
-        "otherCharges": {
-          "amount": "string",
-          "description": "string",
-          "type": "SERVICE"
+        "payOnTimeDiscount": {
+          "discountAmount": "string",
+          "gstAmount": "string",
+          "date": "string"
         },
-        "totalGst": "string"
-      },
-      "accountUsage": {
-        "data": {
-          "upload": 0,
-          "download": 0,
-          "sessions": 0,
-          "amount": "string",
-          "roaming": {
-            "download": 0,
-            "amount": "string"
-          }
+        "balanceAtIssue": "string",
+        "services": [
+          "string"
+        ],
+        "accountCharges": {
+          "totalUsageCharges": "string",
+          "totalOnceOffCharges": "string",
+          "totalDiscounts": "string",
+          "otherCharges": {
+            "amount": "string",
+            "description": "string",
+            "type": "SERVICE"
+          },
+          "totalGst": "string"
         },
-        "voice": {
-          "national": {
-            "duration": "string",
-            "number": 0,
-            "amount": "string"
+        "accountUsage": {
+          "data": {
+            "upload": 0,
+            "download": 0,
+            "sessions": 0,
+            "amount": "string",
+            "roaming": {
+              "download": 0,
+              "amount": "string"
+            }
           },
-          "international": {
-            "duration": "string",
-            "number": 0,
-            "amount": "string"
+          "voice": {
+            "national": {
+              "duration": "string",
+              "number": 0,
+              "amount": "string"
+            },
+            "international": {
+              "duration": "string",
+              "number": 0,
+              "amount": "string"
+            },
+            "roaming": {
+              "duration": "string",
+              "number": 0,
+              "amount": "string"
+            }
           },
-          "roaming": {
-            "duration": "string",
-            "number": 0,
-            "amount": "string"
+          "messaging": {
+            "sms": {
+              "national": 0,
+              "international": 0,
+              "roaming": 0,
+              "amount": "string"
+            },
+            "mms": {
+              "national": 0,
+              "international": 0,
+              "roaming": 0,
+              "amount": "string"
+            }
           }
         },
-        "messaging": {
-          "sms": {
-            "national": 0,
-            "international": 0,
-            "roaming": 0,
-            "amount": "string"
-          },
-          "mms": {
-            "national": 0,
-            "international": 0,
-            "roaming": 0,
-            "amount": "string"
-          }
-        }
-      },
-      "paymentStatus": "PAID"
-    }
-  ]
-}
-
-

Responses

- - + "paymentStatus": "PAID" + } + ] + }, + "links": { + "self": "string" + }, + "meta": {} +} + +

Responses

+ +
@@ -3700,31 +3623,31 @@ To perform this operation, you must be authenticated and authorised with the fol - + - + - + - + - +
Status Meaning200 OK Successful responseTelcoInvoiceListResponseTelcoInvoiceResponse
400 Bad Request The following error codes MUST be supported:
ErrorListResponseResponseErrorListV2
404 Not Found The following error codes MUST be supported:
ErrorListResponseResponseErrorListV2
406 Not Acceptable The following error codes MUST be supported:
ErrorListResponseResponseErrorListV2
422 Unprocessable Entity The following error codes MUST be supported:
ErrorListResponseResponseErrorListV2

Response Headers

@@ -3928,84 +3851,97 @@ To perform this operation, you must be authenticated and authorised with the fol

200 Response

{
-  "invoices": [
-    {
-      "accountId": "string",
-      "invoiceNumber": "string",
-      "issueDate": "string",
-      "dueDate": "string",
-      "period": {
-        "startDate": "string",
-        "endDate": "string"
-      },
-      "invoiceAmount": "string",
-      "gstAmount": "string",
-      "payOnTimeDiscount": {
-        "discountAmount": "string",
+  "data": {
+    "invoices": [
+      {
+        "accountId": "string",
+        "invoiceNumber": "string",
+        "issueDate": "string",
+        "dueDate": "string",
+        "period": {
+          "startDate": "string",
+          "endDate": "string"
+        },
+        "invoiceAmount": "string",
         "gstAmount": "string",
-        "date": "string"
-      },
-      "balanceAtIssue": "string",
-      "services": [
-        "string"
-      ],
-      "accountCharges": {
-        "totalUsageCharges": "string",
-        "totalOnceOffCharges": "string",
-        "totalDiscounts": "string",
-        "otherCharges": {
-          "amount": "string",
-          "description": "string",
-          "type": "SERVICE"
+        "payOnTimeDiscount": {
+          "discountAmount": "string",
+          "gstAmount": "string",
+          "date": "string"
         },
-        "totalGst": "string"
-      },
-      "accountUsage": {
-        "data": {
-          "upload": 0,
-          "download": 0,
-          "sessions": 0,
-          "amount": "string",
-          "roaming": {
-            "download": 0,
-            "amount": "string"
-          }
+        "balanceAtIssue": "string",
+        "services": [
+          "string"
+        ],
+        "accountCharges": {
+          "totalUsageCharges": "string",
+          "totalOnceOffCharges": "string",
+          "totalDiscounts": "string",
+          "otherCharges": {
+            "amount": "string",
+            "description": "string",
+            "type": "SERVICE"
+          },
+          "totalGst": "string"
         },
-        "voice": {
-          "national": {
-            "duration": "string",
-            "number": 0,
-            "amount": "string"
+        "accountUsage": {
+          "data": {
+            "upload": 0,
+            "download": 0,
+            "sessions": 0,
+            "amount": "string",
+            "roaming": {
+              "download": 0,
+              "amount": "string"
+            }
           },
-          "international": {
-            "duration": "string",
-            "number": 0,
-            "amount": "string"
+          "voice": {
+            "national": {
+              "duration": "string",
+              "number": 0,
+              "amount": "string"
+            },
+            "international": {
+              "duration": "string",
+              "number": 0,
+              "amount": "string"
+            },
+            "roaming": {
+              "duration": "string",
+              "number": 0,
+              "amount": "string"
+            }
           },
-          "roaming": {
-            "duration": "string",
-            "number": 0,
-            "amount": "string"
+          "messaging": {
+            "sms": {
+              "national": 0,
+              "international": 0,
+              "roaming": 0,
+              "amount": "string"
+            },
+            "mms": {
+              "national": 0,
+              "international": 0,
+              "roaming": 0,
+              "amount": "string"
+            }
           }
         },
-        "messaging": {
-          "sms": {
-            "national": 0,
-            "international": 0,
-            "roaming": 0,
-            "amount": "string"
-          },
-          "mms": {
-            "national": 0,
-            "international": 0,
-            "roaming": 0,
-            "amount": "string"
-          }
-        }
-      },
-      "paymentStatus": "PAID"
-    }
-  ]
+        "paymentStatus": "PAID"
+      }
+    ]
+  },
+  "links": {
+    "self": "string",
+    "first": "string",
+    "prev": "string",
+    "next": "string",
+    "last": "string"
+  },
+  "meta": {
+    "totalRecords": 0,
+    "totalPages": 0
+  }
 }

Responses

@@ -4028,19 +3964,19 @@ To perform this operation, you must be authenticated and authorised with the fol 400 Bad Request The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2 406 Not Acceptable The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2 422 Unprocessable Entity The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2

Response Headers

@@ -4279,84 +4215,97 @@ To perform this operation, you must be authenticated and authorised with the fol

200 Response

{
-  "invoices": [
-    {
-      "accountId": "string",
-      "invoiceNumber": "string",
-      "issueDate": "string",
-      "dueDate": "string",
-      "period": {
-        "startDate": "string",
-        "endDate": "string"
-      },
-      "invoiceAmount": "string",
-      "gstAmount": "string",
-      "payOnTimeDiscount": {
-        "discountAmount": "string",
+  "data": {
+    "invoices": [
+      {
+        "accountId": "string",
+        "invoiceNumber": "string",
+        "issueDate": "string",
+        "dueDate": "string",
+        "period": {
+          "startDate": "string",
+          "endDate": "string"
+        },
+        "invoiceAmount": "string",
         "gstAmount": "string",
-        "date": "string"
-      },
-      "balanceAtIssue": "string",
-      "services": [
-        "string"
-      ],
-      "accountCharges": {
-        "totalUsageCharges": "string",
-        "totalOnceOffCharges": "string",
-        "totalDiscounts": "string",
-        "otherCharges": {
-          "amount": "string",
-          "description": "string",
-          "type": "SERVICE"
+        "payOnTimeDiscount": {
+          "discountAmount": "string",
+          "gstAmount": "string",
+          "date": "string"
         },
-        "totalGst": "string"
-      },
-      "accountUsage": {
-        "data": {
-          "upload": 0,
-          "download": 0,
-          "sessions": 0,
-          "amount": "string",
-          "roaming": {
-            "download": 0,
-            "amount": "string"
-          }
+        "balanceAtIssue": "string",
+        "services": [
+          "string"
+        ],
+        "accountCharges": {
+          "totalUsageCharges": "string",
+          "totalOnceOffCharges": "string",
+          "totalDiscounts": "string",
+          "otherCharges": {
+            "amount": "string",
+            "description": "string",
+            "type": "SERVICE"
+          },
+          "totalGst": "string"
         },
-        "voice": {
-          "national": {
-            "duration": "string",
-            "number": 0,
-            "amount": "string"
+        "accountUsage": {
+          "data": {
+            "upload": 0,
+            "download": 0,
+            "sessions": 0,
+            "amount": "string",
+            "roaming": {
+              "download": 0,
+              "amount": "string"
+            }
           },
-          "international": {
-            "duration": "string",
-            "number": 0,
-            "amount": "string"
+          "voice": {
+            "national": {
+              "duration": "string",
+              "number": 0,
+              "amount": "string"
+            },
+            "international": {
+              "duration": "string",
+              "number": 0,
+              "amount": "string"
+            },
+            "roaming": {
+              "duration": "string",
+              "number": 0,
+              "amount": "string"
+            }
           },
-          "roaming": {
-            "duration": "string",
-            "number": 0,
-            "amount": "string"
+          "messaging": {
+            "sms": {
+              "national": 0,
+              "international": 0,
+              "roaming": 0,
+              "amount": "string"
+            },
+            "mms": {
+              "national": 0,
+              "international": 0,
+              "roaming": 0,
+              "amount": "string"
+            }
           }
         },
-        "messaging": {
-          "sms": {
-            "national": 0,
-            "international": 0,
-            "roaming": 0,
-            "amount": "string"
-          },
-          "mms": {
-            "national": 0,
-            "international": 0,
-            "roaming": 0,
-            "amount": "string"
-          }
-        }
-      },
-      "paymentStatus": "PAID"
-    }
-  ]
+        "paymentStatus": "PAID"
+      }
+    ]
+  },
+  "links": {
+    "self": "string",
+    "first": "string",
+    "prev": "string",
+    "next": "string",
+    "last": "string"
+  },
+  "meta": {
+    "totalRecords": 0,
+    "totalPages": 0
+  }
 }

Responses

@@ -4379,19 +4328,19 @@ To perform this operation, you must be authenticated and authorised with the fol 400 Bad Request The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2 406 Not Acceptable The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2 422 Unprocessable Entity The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2

Response Headers

@@ -4515,7 +4464,7 @@ To perform this operation, you must be authenticated and authorised with the fol path string mandatory -ID of a specific account to obtain data for. This is a tokenised ID previously obtained from the Account List end point. In accordance with CDR ID permanence requirements +ID of a specific account to obtain data for. This is a tokenised ID previously obtained from the Account List end point. In accordance with CDR ID permanence requirements newest-time @@ -4677,25 +4626,25 @@ To perform this operation, you must be authenticated and authorised with the fol 400 Bad Request The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2 404 Not Found The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2 406 Not Acceptable The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2 422 Unprocessable Entity The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2

Response Headers

@@ -4981,19 +4930,19 @@ To perform this operation, you must be authenticated and authorised with the fol 400 Bad Request The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2 406 Not Acceptable The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2 422 Unprocessable Entity The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2

Response Headers

@@ -5314,19 +5263,19 @@ To perform this operation, you must be authenticated and authorised with the fol 400 Bad Request The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2 406 Not Acceptable The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2 422 Unprocessable Entity The following error codes MUST be supported:
-ErrorListResponse +ResponseErrorListV2

Response Headers

@@ -5415,7 +5364,7 @@ To perform this operation, you must be authenticated and authorised with the fol "name": "string", "description": "string", "period": "string", - "chargeAmount": "string" + "amount": "string" } ], "thirdPartyAgentId": "string", @@ -5501,7 +5450,7 @@ To perform this operation, you must be authenticated and authorised with the fol "name": "string", "description": "string", "period": "string", - "chargeAmount": "string" + "amount": "string" } ], "thirdPartyAgentId": "string", @@ -5722,16 +5671,9 @@ To perform this operation, you must be authenticated and authorised with the fol ] }, "links": { - "self": "string", - "first": "string", - "prev": "string", - "next": "string", - "last": "string" + "self": "string" }, - "meta": { - "totalRecords": 0, - "totalPages": 0 - } + "meta": {} }

Properties

@@ -5751,13 +5693,13 @@ To perform this operation, you must be authenticated and authorised with the fol links -LinksPaginated +Links mandatory none meta -MetaPaginated +Meta mandatory none @@ -5818,16 +5760,9 @@ To perform this operation, you must be authenticated and authorised with the fol } }, "links": { - "self": "string", - "first": "string", - "prev": "string", - "next": "string", - "last": "string" + "self": "string" }, - "meta": { - "totalRecords": 0, - "totalPages": 0 - } + "meta": {} }

Properties

@@ -5847,13 +5782,13 @@ To perform this operation, you must be authenticated and authorised with the fol links -LinksPaginated +Links mandatory none meta -MetaPaginated +Meta mandatory none @@ -6066,18 +6001,7 @@ To perform this operation, you must be authenticated and authorised with the fol "period": "string" } ] - }, - "authorisedContacts": [ - { - "firstName": "string", - "lastName": "string", - "middleNames": [ - "string" - ], - "prefix": "string", - "suffix": "string" - } - ] + } } ] }, @@ -6098,76 +6022,10 @@ To perform this operation, you must be authenticated and authorised with the fol data -any -mandatory -none - - - -

allOf

- - - - - - - - - - - - + -
NameTypeRequiredDescription
» anonymousTelcoAccountBaseTelcoAccountDetailResponseData mandatory none
- -

and

- - - - - - - - - - - - - - - -
NameTypeRequiredDescription
» anonymousTelcoAccountmandatoryThe array of plans containing services and associated plan details
- -

and

- - - - - - - - - - - - - - - -
NameTypeRequiredDescription
» anonymousTelcoAccountDetailmandatoryThe array of plans containing services and associated plan details
- -

continued

- - - - - - - - - @@ -6218,9 +6076,16 @@ To perform this operation, you must be authenticated and authorised with the fol ] }, "links": { - "self": "string" + "self": "string", + "first": "string", + "prev": "string", + "next": "string", + "last": "string" }, - "meta": {} + "meta": { + "totalRecords": 0, + "totalPages": 0 + } }

Properties

@@ -6240,13 +6105,13 @@ To perform this operation, you must be authenticated and authorised with the fol - + - + @@ -6275,9 +6140,16 @@ To perform this operation, you must be authenticated and authorised with the fol ] }, "links": { - "self": "string" + "self": "string", + "first": "string", + "prev": "string", + "next": "string", + "last": "string" }, - "meta": {} + "meta": { + "totalRecords": 0, + "totalPages": 0 + } }

Properties

@@ -6297,13 +6169,13 @@ To perform this operation, you must be authenticated and authorised with the fol - + - + @@ -6407,7 +6279,7 @@ To perform this operation, you must be authenticated and authorised with the fol - + @@ -6622,9 +6494,35 @@ To perform this operation, you must be authenticated and authorised with the fol
NameTypeRequiredDescription
links Links
linksLinksLinksPaginated mandatory none
metaMetaMetaPaginated mandatory none
linksLinksLinksPaginated mandatory none
metaMetaMetaPaginated mandatory none
dataTelcoBalanceListResponseBalancesTelcoBalanceListResponseData mandatory none
-

ErrorListResponse

+

MetaError

+ +

+
{
+  "urn": "string"
+}
+
+
+

Additional data for customised error codes

+

Properties

+ + + + + + + + + + + + + + +
NameTypeRequiredDescription
urnstringconditionalThe 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.
+ +

ResponseErrorListV2

-

+

{
   "errors": [
     {
@@ -6638,7 +6536,7 @@ To perform this operation, you must be authenticated and authorised with the fol
   ]
 }
 
-

Properties

+

Properties

@@ -6649,10 +6547,34 @@ To perform this operation, you must be authenticated and authorised with the fol - + + + + + + + + + + + + + + + + + + + + + + + + +
Name
errors[ErrorListResponsErrors][object] mandatory none
» codestringmandatoryThe 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.
» titlestringmandatoryA short, human-readable summary of the problem that MUST NOT change from occurrence to occurrence of the problem represented by the error code.
» detailstringmandatoryA human-readable explanation specific to this occurrence of the problem.
» metaMetaErroroptionalAdditional data for customised error codes

TelcoProduct

@@ -6682,7 +6604,7 @@ To perform this operation, you must be authenticated and authorised with the fol "name": "string", "description": "string", "period": "string", - "chargeAmount": "string" + "amount": "string" } ], "thirdPartyAgentId": "string", @@ -6697,7 +6619,7 @@ To perform this operation, you must be authenticated and authorised with the fol } } -

Properties

+

Properties

@@ -6746,7 +6668,7 @@ To perform this operation, you must be authenticated and authorised with the fol - + @@ -6764,7 +6686,7 @@ To perform this operation, you must be authenticated and authorised with the fol - + @@ -6871,8 +6793,8 @@ To perform this operation, you must be authenticated and authorised with the fol } -

Summary of the contract details. Required if a contract is required

-

Properties

+

Summary of the contract details. Mandatory if the billing type is POST_PAID and a contract agreement is required with the service provider for the plan

+

Properties

Nametype string mandatoryThe type of productThe type of product. MOBILE service or BROADBAND fixed internet service
purposecontract TelcoContract conditionalSummary of the contract details. Required if a contract is requiredSummary of the contract details. Mandatory if the billing type is POST_PAID and a contract agreement is required with the service provider for the plan
bundle
@@ -6891,7 +6813,7 @@ To perform this operation, you must be authenticated and authorised with the fol - + @@ -6914,7 +6836,7 @@ To perform this operation, you must be authenticated and authorised with the fol "serviceId": "string" } -

Properties

+

Properties

Namedescription string optionalDescription if the contractDescription of the contract
duration
@@ -6992,7 +6914,7 @@ To perform this operation, you must be authenticated and authorised with the fol ] } -

Properties

+

Properties

Name
@@ -7010,7 +6932,7 @@ To perform this operation, you must be authenticated and authorised with the fol - +
Name
services [TelcoAccountUsageServices]optionalmandatory List of services that are part of the account
@@ -7069,7 +6991,7 @@ To perform this operation, you must be authenticated and authorised with the fol } } -

Properties

+

Properties

@@ -7129,7 +7051,7 @@ To perform this operation, you must be authenticated and authorised with the fol "openStatus": "CLOSED" } -

Properties

+

Properties

Name
@@ -7198,9 +7120,9 @@ To perform this operation, you must be authenticated and authorised with the fol
Name
-

TelcoAccountResponse

+

TelcoAccountResponseData

-

+

{
   "accountId": "string",
   "accountNumber": "string",
@@ -7226,7 +7148,7 @@ To perform this operation, you must be authenticated and authorised with the fol
   ]
 }
 
-

Properties

+

Properties

allOf

@@ -7263,41 +7185,135 @@ To perform this operation, you must be authenticated and authorised with the fol
-

TelcoPaymentSchedule

+

TelcoAccountDetailResponseData

-

+

{
-  "amount": "string",
-  "paymentScheduleUType": "cardDebit",
-  "cardDebit": {
-    "cardScheme": "VISA",
-    "paymentFrequency": "string",
-    "calculationType": "STATIC"
-  },
-  "directDebit": {
-    "isTokenised": true,
-    "bsb": "string",
-    "accountNumber": "string",
-    "paymentFrequency": "string",
-    "calculationType": "STATIC"
-  },
-  "digitalWallet": {
-    "name": "string",
-    "identifier": "string",
-    "type": "EMAIL",
-    "provider": "PAYPAL_AU",
-    "paymentFrequency": "string",
-    "calculationType": "STATIC"
-  },
-  "manualPayment": {
-    "billFrequency": "string"
-  }
-}
-
-

Properties

- - - + "accountId": "string", + "accountNumber": "string", + "displayName": "string", + "creationDate": "string", + "lastUpdated": "string", + "brand": "string", + "openStatus": "CLOSED", + "plans": [ + { + "nickname": "string", + "type": "MOBILE", + "billingType": "PRE_PAID", + "serviceIds": [ + "string" + ], + "planOverview": { + "displayName": "string", + "startDate": "string", + "endDate": "string" + }, + "planDetail": { + "charges": [ + { + "displayName": "string", + "description": "string", + "minimumValue": "string", + "maximumValue": "string", + "period": "string" + } + ] + } + } + ] +} + +

Properties

+

allOf

+ +
Name
+ + + + + + + + + + + + + +
NameTypeRequiredDescription
anonymousTelcoAccountBasemandatorynone
+ +

and

+ + + + + + + + + + + + + + + +
NameTypeRequiredDescription
anonymousTelcoAccountmandatoryThe array of plans containing services and associated plan details
+ +

and

+ + + + + + + + + + + + + + + +
NameTypeRequiredDescription
anonymousTelcoAccountDetailmandatoryThe array of plans containing services and associated plan details
+ +

TelcoPaymentSchedule

+ +

+
{
+  "amount": "string",
+  "paymentScheduleUType": "cardDebit",
+  "cardDebit": {
+    "cardScheme": "VISA",
+    "paymentFrequency": "string",
+    "calculationType": "STATIC"
+  },
+  "directDebit": {
+    "isTokenised": true,
+    "bsb": "string",
+    "accountNumber": "string",
+    "paymentFrequency": "string",
+    "calculationType": "STATIC"
+  },
+  "digitalWallet": {
+    "name": "string",
+    "identifier": "string",
+    "type": "EMAIL",
+    "provider": "PAYPAL_AU",
+    "paymentFrequency": "string",
+    "calculationType": "STATIC"
+  },
+  "manualPayment": {
+    "billFrequency": "string"
+  }
+}
+
+

Properties

+ + + @@ -7383,7 +7399,7 @@ To perform this operation, you must be authenticated and authorised with the fol ] } -

Properties

+

Properties

Name Type Required Description
@@ -7562,7 +7578,7 @@ To perform this operation, you must be authenticated and authorised with the fol "paymentStatus": "PAID" } -

Properties

+

Properties

Name
@@ -7720,7 +7736,7 @@ To perform this operation, you must be authenticated and authorised with the fol

Object containing usage summary

-

Properties

+

Properties

Name
@@ -7766,7 +7782,7 @@ To perform this operation, you must be authenticated and authorised with the fol

Object contain charges and credits related to usage

-

Properties

+

Properties

Name
@@ -7856,7 +7872,7 @@ To perform this operation, you must be authenticated and authorised with the fol } } -

Properties

+

Properties

Name
@@ -7957,7 +7973,7 @@ To perform this operation, you must be authenticated and authorised with the fol ] } -

Properties

+

Properties

Name
@@ -8020,7 +8036,7 @@ To perform this operation, you must be authenticated and authorised with the fol "description": "string" } -

Properties

+

Properties

Name
@@ -8074,7 +8090,7 @@ To perform this operation, you must be authenticated and authorised with the fol ] } -

Properties

+

Properties

Name
@@ -8169,7 +8185,7 @@ To perform this operation, you must be authenticated and authorised with the fol "method": "DIRECT_DEBIT" } -

Properties

+

Properties

Name
@@ -8301,7 +8317,7 @@ To perform this operation, you must be authenticated and authorised with the fol

Object containing account service usage summary

-

Properties

+

Properties

Name
@@ -8383,7 +8399,7 @@ To perform this operation, you must be authenticated and authorised with the fol

Telco balances for a service

-

Properties

+

Properties

Name
@@ -8437,7 +8453,7 @@ To perform this operation, you must be authenticated and authorised with the fol

Plan type for this feature. METERED: A plan is charged by usage for the feature. UNMETERED: A plan with no limits for a feature. LIMITED: Where plan limit inclusions apply. UNSUPPORTED: Feature is not supported

-

Properties

+

Properties

Name
@@ -8519,7 +8535,7 @@ To perform this operation, you must be authenticated and authorised with the fol } } -

Properties

+

Properties

Name
@@ -8580,7 +8596,7 @@ To perform this operation, you must be authenticated and authorised with the fol

Required if addressUType is set to simple

-

Properties

+

Properties

Name
@@ -8669,7 +8685,7 @@ To perform this operation, you must be authenticated and authorised with the fol

Australian address formatted according to the file format defined by the PAF file format. Required if addressUType is set to paf

-

Properties

+

Properties

Name
@@ -8819,7 +8835,7 @@ To perform this operation, you must be authenticated and authorised with the fol "self": "string" } -

Properties

+

Properties

Name
@@ -8841,7 +8857,7 @@ To perform this operation, you must be authenticated and authorised with the fol 

{}
 
-

Properties

+

Properties

None

LinksPaginated

@@ -8855,7 +8871,7 @@ To perform this operation, you must be authenticated and authorised with the fol "last": "string" } -

Properties

+

Properties

Name
@@ -8904,7 +8920,7 @@ To perform this operation, you must be authenticated and authorised with the fol "totalPages": 0 } -

Properties

+

Properties

Name
@@ -8956,7 +8972,7 @@ To perform this operation, you must be authenticated and authorised with the fol "name": "string", "description": "string", "period": "string", - "chargeAmount": "string" + "amount": "string" } ], "thirdPartyAgentId": "string", @@ -8973,7 +8989,7 @@ To perform this operation, you must be authenticated and authorised with the fol ] } -

Properties

+

Properties

Name
@@ -8993,6 +9009,106 @@ To perform this operation, you must be authenticated and authorised with the fol

TelcoUsageListResponse

+
{
+  "data": {
+    "accounts": [
+      {
+        "accountId": "string",
+        "services": [
+          {
+            "service": {
+              "serviceId": "string",
+              "displayName": "string",
+              "phoneNumber": "string",
+              "startDate": "string",
+              "endDate": "string",
+              "usage": {
+                "data": {
+                  "upload": 0,
+                  "download": 0,
+                  "sessions": 0,
+                  "amount": "string",
+                  "roaming": {
+                    "download": 0,
+                    "amount": "string"
+                  }
+                },
+                "voice": {
+                  "national": {
+                    "duration": "string",
+                    "number": 0,
+                    "amount": "string"
+                  },
+                  "international": {
+                    "duration": "string",
+                    "number": 0,
+                    "amount": "string"
+                  },
+                  "roaming": {
+                    "duration": "string",
+                    "number": 0,
+                    "amount": "string"
+                  }
+                },
+                "messaging": {
+                  "sms": {
+                    "national": 0,
+                    "international": 0,
+                    "roaming": 0,
+                    "amount": "string"
+                  },
+                  "mms": {
+                    "national": 0,
+                    "international": 0,
+                    "roaming": 0,
+                    "amount": "string"
+                  }
+                }
+              }
+            }
+          }
+        ]
+      }
+    ]
+  },
+  "links": {
+    "self": "string"
+  },
+  "meta": {}
+}
+
+

Properties

+
Name
+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
dataTelcoUsageListResponseDatamandatorynone
linksLinksmandatorynone
metaMetamandatorynone
+ +

TelcoUsageListResponseData

+ +

{
   "accounts": [
     {
@@ -9055,7 +9171,7 @@ To perform this operation, you must be authenticated and authorised with the fol
   ]
 }
 
-

Properties

+

Properties

@@ -9104,7 +9220,7 @@ To perform this operation, you must be authenticated and authorised with the fol ] } -

Properties

+

Properties

Name
@@ -9115,7 +9231,7 @@ To perform this operation, you must be authenticated and authorised with the fol - + @@ -9156,7 +9272,7 @@ To perform this operation, you must be authenticated and authorised with the fol ] } -

Properties

+

Properties

Name
accounts[TelcoAccountResponse][TelcoAccountResponseData] mandatory Array of accounts
@@ -9195,7 +9311,7 @@ To perform this operation, you must be authenticated and authorised with the fol ] } -

Properties

+

Properties

Name
@@ -9212,9 +9328,9 @@ To perform this operation, you must be authenticated and authorised with the fol
Name
-

TelcoBalanceListResponseBalances

+

TelcoBalanceListResponseData

-

+

{
   "balances": [
     {
@@ -9286,7 +9402,7 @@ To perform this operation, you must be authenticated and authorised with the fol
   ]
 }
 
-

Properties

+

Properties

@@ -9373,7 +9489,7 @@ To perform this operation, you must be authenticated and authorised with the fol } } -

Properties

+

Properties

Name
@@ -9396,13 +9512,258 @@ To perform this operation, you must be authenticated and authorised with the fol
Name
-

TelcoInvoiceListResponse

+

TelcoInvoiceResponse

-

+

{
-  "invoices": [
-    {
-      "accountId": "string",
+  "data": {
+    "invoices": [
+      {
+        "accountId": "string",
+        "invoiceNumber": "string",
+        "issueDate": "string",
+        "dueDate": "string",
+        "period": {
+          "startDate": "string",
+          "endDate": "string"
+        },
+        "invoiceAmount": "string",
+        "gstAmount": "string",
+        "payOnTimeDiscount": {
+          "discountAmount": "string",
+          "gstAmount": "string",
+          "date": "string"
+        },
+        "balanceAtIssue": "string",
+        "services": [
+          "string"
+        ],
+        "accountCharges": {
+          "totalUsageCharges": "string",
+          "totalOnceOffCharges": "string",
+          "totalDiscounts": "string",
+          "otherCharges": {
+            "amount": "string",
+            "description": "string",
+            "type": "SERVICE"
+          },
+          "totalGst": "string"
+        },
+        "accountUsage": {
+          "data": {
+            "upload": 0,
+            "download": 0,
+            "sessions": 0,
+            "amount": "string",
+            "roaming": {
+              "download": 0,
+              "amount": "string"
+            }
+          },
+          "voice": {
+            "national": {
+              "duration": "string",
+              "number": 0,
+              "amount": "string"
+            },
+            "international": {
+              "duration": "string",
+              "number": 0,
+              "amount": "string"
+            },
+            "roaming": {
+              "duration": "string",
+              "number": 0,
+              "amount": "string"
+            }
+          },
+          "messaging": {
+            "sms": {
+              "national": 0,
+              "international": 0,
+              "roaming": 0,
+              "amount": "string"
+            },
+            "mms": {
+              "national": 0,
+              "international": 0,
+              "roaming": 0,
+              "amount": "string"
+            }
+          }
+        },
+        "paymentStatus": "PAID"
+      }
+    ]
+  },
+  "links": {
+    "self": "string"
+  },
+  "meta": {}
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
dataTelcoInvoiceListResponseDatamandatorynone
linksLinksmandatorynone
metaMetamandatorynone
+ +

TelcoInvoiceListResponse

+ +

+
{
+  "data": {
+    "invoices": [
+      {
+        "accountId": "string",
+        "invoiceNumber": "string",
+        "issueDate": "string",
+        "dueDate": "string",
+        "period": {
+          "startDate": "string",
+          "endDate": "string"
+        },
+        "invoiceAmount": "string",
+        "gstAmount": "string",
+        "payOnTimeDiscount": {
+          "discountAmount": "string",
+          "gstAmount": "string",
+          "date": "string"
+        },
+        "balanceAtIssue": "string",
+        "services": [
+          "string"
+        ],
+        "accountCharges": {
+          "totalUsageCharges": "string",
+          "totalOnceOffCharges": "string",
+          "totalDiscounts": "string",
+          "otherCharges": {
+            "amount": "string",
+            "description": "string",
+            "type": "SERVICE"
+          },
+          "totalGst": "string"
+        },
+        "accountUsage": {
+          "data": {
+            "upload": 0,
+            "download": 0,
+            "sessions": 0,
+            "amount": "string",
+            "roaming": {
+              "download": 0,
+              "amount": "string"
+            }
+          },
+          "voice": {
+            "national": {
+              "duration": "string",
+              "number": 0,
+              "amount": "string"
+            },
+            "international": {
+              "duration": "string",
+              "number": 0,
+              "amount": "string"
+            },
+            "roaming": {
+              "duration": "string",
+              "number": 0,
+              "amount": "string"
+            }
+          },
+          "messaging": {
+            "sms": {
+              "national": 0,
+              "international": 0,
+              "roaming": 0,
+              "amount": "string"
+            },
+            "mms": {
+              "national": 0,
+              "international": 0,
+              "roaming": 0,
+              "amount": "string"
+            }
+          }
+        },
+        "paymentStatus": "PAID"
+      }
+    ]
+  },
+  "links": {
+    "self": "string",
+    "first": "string",
+    "prev": "string",
+    "next": "string",
+    "last": "string"
+  },
+  "meta": {
+    "totalRecords": 0,
+    "totalPages": 0
+  }
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
dataTelcoInvoiceListResponseDatamandatorynone
linksLinksPaginatedmandatorynone
metaMetaPaginatedmandatorynone
+ +

TelcoInvoiceListResponseData

+ +

+
{
+  "invoices": [
+    {
+      "accountId": "string",
       "invoiceNumber": "string",
       "issueDate": "string",
       "dueDate": "string",
@@ -9480,7 +9841,7 @@ To perform this operation, you must be authenticated and authorised with the fol
   ]
 }
 
-

Properties

+

Properties

@@ -9532,80 +9893,25 @@ To perform this operation, you must be authenticated and authorised with the fol "invoiceNumber": "string", "startDate": "string", "endDate": "string", - "type": "SERVICE", - "amount": "string", - "description": "string", - "adjustments": [ - { - "amount": "string", - "description": "string" - } - ] - }, - "payment": { - "amount": "string", - "method": "DIRECT_DEBIT" - } - } - ] -} - -

Properties

-
Name
- - - - - - - - - - - - - -
NameTypeRequiredDescription
transactions[TelcoBillingTransaction]mandatoryArray of transactions sorted by date and time in descending order
- -

ErrorListResponseMeta

- -

-
{
-  "urn": "string"
-}
-
-
-

Additional data for customised error codes

-

Properties

- - - - - - - - - - - - - - -
NameTypeRequiredDescription
urnstringconditionalThe 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.
- -

ErrorListResponsErrors

- -

-
{
-  "code": "string",
-  "title": "string",
-  "detail": "string",
-  "meta": {
-    "urn": "string"
-  }
+        "type": "SERVICE",
+        "amount": "string",
+        "description": "string",
+        "adjustments": [
+          {
+            "amount": "string",
+            "description": "string"
+          }
+        ]
+      },
+      "payment": {
+        "amount": "string",
+        "method": "DIRECT_DEBIT"
+      }
+    }
+  ]
 }
 
-

Properties

+

Properties

@@ -9615,28 +9921,10 @@ To perform this operation, you must be authenticated and authorised with the fol - - - - - - - - - - - - - - + + - - - - - - - +
Name
codestringmandatoryThe 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.
titlestringmandatoryA short, human-readable summary of the problem that MUST NOT change from occurrence to occurrence of the problem represented by the error code.
detailstringtransactions[TelcoBillingTransaction] mandatoryA human-readable explanation specific to this occurrence of the problem.
metaErrorListResponseMetaoptionalAdditional data for customised error codesArray of transactions sorted by date and time in descending order
@@ -9647,10 +9935,10 @@ To perform this operation, you must be authenticated and authorised with the fol "name": "string", "description": "string", "period": "string", - "chargeAmount": "string" + "amount": "string" } -

Properties

+

Properties

@@ -9678,7 +9966,7 @@ To perform this operation, you must be authenticated and authorised with the fol - + @@ -9698,7 +9986,7 @@ To perform this operation, you must be authenticated and authorised with the fol

Object that contains links to additional information on specific topics

-

Properties

+

Properties

NameThe duration that occurs on a pricing schedule indicates the frequency. Formatted according to ISO 8601 Durations (excludes recurrence syntax)
chargeAmountamount AmountString mandatory The amount charged for the duration period
@@ -9750,7 +10038,7 @@ To perform this operation, you must be authenticated and authorised with the fol "period": "string" } -

Properties

+

Properties

Name
@@ -9800,7 +10088,7 @@ To perform this operation, you must be authenticated and authorised with the fol "category": "DATA" } -

Properties

+

Properties

Name
@@ -9893,7 +10181,7 @@ To perform this operation, you must be authenticated and authorised with the fol ] } -

Properties

+

Properties

Name
@@ -9943,7 +10231,7 @@ To perform this operation, you must be authenticated and authorised with the fol ] } -

Properties

+

Properties

Name
@@ -9986,7 +10274,7 @@ To perform this operation, you must be authenticated and authorised with the fol "description": "string" } -

Properties

+

Properties

Name
@@ -10017,7 +10305,7 @@ To perform this operation, you must be authenticated and authorised with the fol "description": "string" } -

Properties

+

Properties

Name
@@ -10055,7 +10343,7 @@ To perform this operation, you must be authenticated and authorised with the fol ] } -

Properties

+

Properties

Name
@@ -10098,7 +10386,7 @@ To perform this operation, you must be authenticated and authorised with the fol "description": "string" } -

Properties

+

Properties

Name
@@ -10136,7 +10424,7 @@ To perform this operation, you must be authenticated and authorised with the fol ] } -

Properties

+

Properties

Name
@@ -10239,7 +10527,7 @@ To perform this operation, you must be authenticated and authorised with the fol ] } -

Properties

+

Properties

Name
@@ -10336,7 +10624,7 @@ To perform this operation, you must be authenticated and authorised with the fol } } -

Properties

+

Properties

Name
@@ -10364,7 +10652,7 @@ To perform this operation, you must be authenticated and authorised with the fol

Mandatory if openStatus is OPEN

-

Properties

+

Properties

Name
@@ -10393,9 +10681,9 @@ To perform this operation, you must be authenticated and authorised with the fol
Name
-

TelcoAccountPlans

+

TelcoAccountPlan

-

+

{
   "nickname": "string",
   "type": "MOBILE",
@@ -10410,7 +10698,7 @@ To perform this operation, you must be authenticated and authorised with the fol
   }
 }
 
-

Properties

+

Properties

@@ -10428,13 +10716,13 @@ To perform this operation, you must be authenticated and authorised with the fol - - + + - + @@ -10446,7 +10734,7 @@ To perform this operation, you must be authenticated and authorised with the fol - +
Name
type stringoptionalThe type of the planmandatoryThe type of the plan. The type of plan. A MOBILE service or BROADBAND fixed internet service
billingType stringoptionalmandatory The billing type of then plan
planOverview TelcoAccountPlanOverviewconditionalmandatory Mandatory if openStatus is OPEN
@@ -10506,7 +10794,7 @@ To perform this operation, you must be authenticated and authorised with the fol

The array of plans containing services and associated plan details

-

Properties

+

Properties

@@ -10517,30 +10805,32 @@ To perform this operation, you must be authenticated and authorised with the fol - +
Name
plans[TelcoAccountPlans][TelcoAccountPlan] mandatory The array of plans containing service and associated plan details
-

TelcoAccountDetailPlanDetail

+

TelcoAccountPlanDetail

-

+

{
-  "charges": [
-    {
-      "displayName": "string",
-      "description": "string",
-      "minimumValue": "string",
-      "maximumValue": "string",
-      "period": "string"
-    }
-  ]
+  "planDetail": {
+    "charges": [
+      {
+        "displayName": "string",
+        "description": "string",
+        "minimumValue": "string",
+        "maximumValue": "string",
+        "period": "string"
+      }
+    ]
+  }
 }

Detail on the plan applicable to this account. Mandatory if openStatus is OPEN

-

Properties

+

Properties

@@ -10550,7 +10840,13 @@ To perform this operation, you must be authenticated and authorised with the fol - + + + + + + + @@ -10570,7 +10866,7 @@ To perform this operation, you must be authenticated and authorised with the fol "suffix": "string" } -

Properties

+

Properties

Name
chargesplanDetailobjectmandatorynone
» charges [TelcoProductDetailMeteringCharges] mandatory Charges for metering included in the plan
@@ -10611,84 +10907,6 @@ To perform this operation, you must be authenticated and authorised with the fol
Name
-

TelcoAccountDetailPlans

- -

-
{
-  "nickname": "string",
-  "serviceIds": [
-    "string"
-  ],
-  "planOverview": {
-    "displayName": "string",
-    "startDate": "string",
-    "endDate": "string"
-  },
-  "planDetail": {
-    "charges": [
-      {
-        "displayName": "string",
-        "description": "string",
-        "minimumValue": "string",
-        "maximumValue": "string",
-        "period": "string"
-      }
-    ]
-  },
-  "authorisedContacts": [
-    {
-      "firstName": "string",
-      "lastName": "string",
-      "middleNames": [
-        "string"
-      ],
-      "prefix": "string",
-      "suffix": "string"
-    }
-  ]
-}
-
-

Properties

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeRequiredDescription
nicknamestringoptionalOptional display name for the plan provided by the customer to help differentiate multiple plans
serviceIds[string]mandatoryThe serviceId representing a unique service identifier such as a mobile MSISDN, FNN or internet service e.g NBN AVC Service ID. In accordance with CDR ID permanence requirement
planOverviewTelcoAccountPlanOverviewconditionalMandatory if openStatus is OPEN
planDetailTelcoAccountDetailPlanDetailconditionalDetail on the plan applicable to this account. Mandatory if openStatus is OPEN
authorisedContacts[TelcoAccountDetailAuthorisedContacts]optionalAn array of additional contacts that are authorised to act on this account
-

TelcoAccountDetail

@@ -10696,6 +10914,8 @@ To perform this operation, you must be authenticated and authorised with the fol "plans": [ { "nickname": "string", + "type": "MOBILE", + "billingType": "PRE_PAID", "serviceIds": [ "string" ], @@ -10714,25 +10934,14 @@ To perform this operation, you must be authenticated and authorised with the fol "period": "string" } ] - }, - "authorisedContacts": [ - { - "firstName": "string", - "lastName": "string", - "middleNames": [ - "string" - ], - "prefix": "string", - "suffix": "string" - } - ] + } } ] }

The array of plans containing services and associated plan details

-

Properties

+

Properties

@@ -10743,12 +10952,48 @@ To perform this operation, you must be authenticated and authorised with the fol - +
Name
plans[TelcoAccountDetailPlans][allOf] mandatory The array of plans containing services and associated plan details
+

allOf

+ + + + + + + + + + + + + + + +
NameTypeRequiredDescription
» anonymousTelcoAccountPlanmandatorynone
+ +

and

+ + + + + + + + + + + + + + + +
NameTypeRequiredDescription
» anonymousTelcoAccountPlanDetailmandatoryDetail on the plan applicable to this account. Mandatory if openStatus is OPEN
+

TelcoPaymentScheduleCardDebit

@@ -10760,7 +11005,7 @@ To perform this operation, you must be authenticated and authorised with the fol

Represents a regular credit card payment schedule. Mandatory if paymentScheduleUType is set to cardDebit

-

Properties

+

Properties

@@ -10846,7 +11091,7 @@ To perform this operation, you must be authenticated and authorised with the fol

Represents a regular direct debit from a specified bank account. Mandatory if paymentScheduleUType is set to directDebit

-

Properties

+

Properties

Name
@@ -10921,7 +11166,7 @@ To perform this operation, you must be authenticated and authorised with the fol

Represents a regular payment from a digital wallet. Mandatory if paymentScheduleUType is set to digitalWallet

-

Properties

+

Properties

Name
@@ -11017,7 +11262,7 @@ To perform this operation, you must be authenticated and authorised with the fol

Represents a manual payment schedule where the customer pays in response to a delivered statement. Mandatory if paymentScheduleUType is set to manualPayment

-

Properties

+

Properties

Name
@@ -11044,7 +11289,7 @@ To perform this operation, you must be authenticated and authorised with the fol

Object containing the start and end date for the period covered by the invoice. Mandatory if any usage based charges are included in the invoice

-

Properties

+

Properties

Name
@@ -11078,7 +11323,7 @@ To perform this operation, you must be authenticated and authorised with the fol

A discount for on time payment

-

Properties

+

Properties

Name
@@ -11117,7 +11362,7 @@ To perform this operation, you must be authenticated and authorised with the fol

Roaming Data Usage

-

Properties

+

Properties

Name
@@ -11156,7 +11401,7 @@ To perform this operation, you must be authenticated and authorised with the fol

Summary of data usage

-

Properties

+

Properties

Name
@@ -11208,7 +11453,7 @@ To perform this operation, you must be authenticated and authorised with the fol

National voice calls

-

Properties

+

Properties

Name
@@ -11248,7 +11493,7 @@ To perform this operation, you must be authenticated and authorised with the fol

International voice calls. Requied if international calling is supported

-

Properties

+

Properties

Name
@@ -11288,7 +11533,7 @@ To perform this operation, you must be authenticated and authorised with the fol

Roaming voice calls, Required if roaming is supported

-

Properties

+

Properties

Name
@@ -11340,7 +11585,7 @@ To perform this operation, you must be authenticated and authorised with the fol

Summary of voice calls. Required if voice calls are included in product plan

-

Properties

+

Properties

Name
@@ -11381,7 +11626,7 @@ To perform this operation, you must be authenticated and authorised with the fol

Summary of SMS usage

-

Properties

+

Properties

Name
@@ -11428,7 +11673,7 @@ To perform this operation, you must be authenticated and authorised with the fol

Summary of MMS usage

-

Properties

+

Properties

Name
@@ -11483,7 +11728,7 @@ To perform this operation, you must be authenticated and authorised with the fol

Summary of messaging. Required if messaging services is included in the product plan

-

Properties

+

Properties

Name
@@ -11517,7 +11762,7 @@ To perform this operation, you must be authenticated and authorised with the fol

Optional array of charges that may be part of the invoice (for example services fees) (exclusive of GST)

-

Properties

+

Properties

Name
@@ -11598,7 +11843,7 @@ To perform this operation, you must be authenticated and authorised with the fol "description": "string" } -

Properties

+

Properties

Name
@@ -11632,7 +11877,7 @@ To perform this operation, you must be authenticated and authorised with the fol

Balance of data roaming charges. Required unless planType is UNSUPPORTED

-

Properties

+

Properties

Name
@@ -11679,7 +11924,7 @@ To perform this operation, you must be authenticated and authorised with the fol

Summary of data balances

-

Properties

+

Properties

Name
@@ -11738,7 +11983,7 @@ To perform this operation, you must be authenticated and authorised with the fol

National voice calls

-

Properties

+

Properties

Name
@@ -11785,7 +12030,7 @@ To perform this operation, you must be authenticated and authorised with the fol

International voice calls

-

Properties

+

Properties

Name
@@ -11832,7 +12077,7 @@ To perform this operation, you must be authenticated and authorised with the fol

Roaming voice calls

-

Properties

+

Properties

Name
@@ -11894,7 +12139,7 @@ To perform this operation, you must be authenticated and authorised with the fol

Summary of voice balances. Required if voice calls are included in product plan

-

Properties

+

Properties

Name
@@ -11942,7 +12187,7 @@ To perform this operation, you must be authenticated and authorised with the fol

Summary of SMS Balance. Required if the service plan supports SMS messaging

-

Properties

+

Properties

Name
@@ -11996,7 +12241,7 @@ To perform this operation, you must be authenticated and authorised with the fol

Summary of MMS Balance. Required if the service plan supports MMS messaging

-

Properties

+

Properties

Name
@@ -12060,7 +12305,7 @@ To perform this operation, you must be authenticated and authorised with the fol

Summary of messaging. Required if messaging services is included in the product plan

-

Properties

+

Properties

Name
@@ -12147,7 +12392,7 @@ To perform this operation, you must be authenticated and authorised with the fol

A summary of Service balances

-

Properties

+

Properties

Name
diff --git a/docs/includes/changelog b/docs/includes/changelog index 6c955a6b..5e8607a1 100644 --- a/docs/includes/changelog +++ b/docs/includes/changelog @@ -10,6 +10,12 @@ + + + + + + diff --git a/docs/includes/endpoint-version-schedule/index.html b/docs/includes/endpoint-version-schedule/index.html index faab8f9b..5ded25a2 100644 --- a/docs/includes/endpoint-version-schedule/index.html +++ b/docs/includes/endpoint-version-schedule/index.html @@ -210,7 +210,7 @@
- +
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - - - - - - - - - - - - - - - - + - + - + @@ -359,17 +309,17 @@

Obligation Dates Schedule

- + - - + + - + @@ -384,7 +334,7 @@

Obligation Dates Schedule

- + @@ -808,7 +758,7 @@

Energy APIs

- + @@ -818,7 +768,7 @@

Energy APIs

- + @@ -830,7 +780,7 @@

Energy APIs

- + @@ -838,9 +788,9 @@

Energy APIs

- + - + diff --git a/docs/includes/obsolete/get-account-detail-v1.html b/docs/includes/obsolete/get-account-detail-v1.html index ae652ca6..46d42bc1 100644 --- a/docs/includes/obsolete/get-account-detail-v1.html +++ b/docs/includes/obsolete/get-account-detail-v1.html @@ -210,7 +210,7 @@
- +
  • Get Account Detail V1 diff --git a/docs/includes/obsolete/get-account-detail-v2.html b/docs/includes/obsolete/get-account-detail-v2.html index 93512be9..2541f5d8 100644 --- a/docs/includes/obsolete/get-account-detail-v2.html +++ b/docs/includes/obsolete/get-account-detail-v2.html @@ -210,7 +210,7 @@
    - +
    • Get Account Detail V2 diff --git a/docs/includes/obsolete/get-accounts-v1.html b/docs/includes/obsolete/get-accounts-v1.html index bae8c79f..4d793d38 100644 --- a/docs/includes/obsolete/get-accounts-v1.html +++ b/docs/includes/obsolete/get-accounts-v1.html @@ -210,7 +210,7 @@
      - +
      • Get Accounts V1 diff --git a/docs/includes/obsolete/get-customer-detail-v1.html b/docs/includes/obsolete/get-customer-detail-v1.html index bce6f35f..d7ed68de 100644 --- a/docs/includes/obsolete/get-customer-detail-v1.html +++ b/docs/includes/obsolete/get-customer-detail-v1.html @@ -210,7 +210,7 @@
        - +
        • Get Customer Detail V1 diff --git a/docs/includes/obsolete/get-data-holder-brands-v1.html b/docs/includes/obsolete/get-data-holder-brands-v1.html index fa252c4b..4b6543e8 100644 --- a/docs/includes/obsolete/get-data-holder-brands-v1.html +++ b/docs/includes/obsolete/get-data-holder-brands-v1.html @@ -210,7 +210,7 @@
          - +
          • Get Data Holder Brands V1 diff --git a/docs/includes/obsolete/get-data-recipient-statuses-v1.html b/docs/includes/obsolete/get-data-recipient-statuses-v1.html index f8b53052..cec485bd 100644 --- a/docs/includes/obsolete/get-data-recipient-statuses-v1.html +++ b/docs/includes/obsolete/get-data-recipient-statuses-v1.html @@ -210,7 +210,7 @@
            - +
            • Get Data Recipient Statuses V1 diff --git a/docs/includes/obsolete/get-data-recipients-v2.html b/docs/includes/obsolete/get-data-recipients-v2.html index 161e37aa..78457d8a 100644 --- a/docs/includes/obsolete/get-data-recipients-v2.html +++ b/docs/includes/obsolete/get-data-recipients-v2.html @@ -210,7 +210,7 @@
              - +
              • Get Data Recipients V2 diff --git a/docs/includes/obsolete/get-energy-account-detail-v1.html b/docs/includes/obsolete/get-energy-account-detail-v1.html index 48ca5931..93ab1c86 100644 --- a/docs/includes/obsolete/get-energy-account-detail-v1.html +++ b/docs/includes/obsolete/get-energy-account-detail-v1.html @@ -210,7 +210,7 @@
                - +
                • Get Energy Account Detail V1 diff --git a/docs/includes/obsolete/get-energy-accounts-v1.html b/docs/includes/obsolete/get-energy-accounts-v1.html index a5223978..2037a27e 100644 --- a/docs/includes/obsolete/get-energy-accounts-v1.html +++ b/docs/includes/obsolete/get-energy-accounts-v1.html @@ -210,7 +210,7 @@
                  - +
                  • Get Energy Accounts V1 diff --git a/docs/includes/obsolete/get-metrics-v1.html b/docs/includes/obsolete/get-metrics-v1.html index 7650db70..414df648 100644 --- a/docs/includes/obsolete/get-metrics-v1.html +++ b/docs/includes/obsolete/get-metrics-v1.html @@ -210,7 +210,7 @@
                    - +
                    • Get Metrics V1 diff --git a/docs/includes/obsolete/get-metrics-v2.html b/docs/includes/obsolete/get-metrics-v2.html index 4bc6bad1..6956e72b 100644 --- a/docs/includes/obsolete/get-metrics-v2.html +++ b/docs/includes/obsolete/get-metrics-v2.html @@ -210,7 +210,7 @@
                      - +
                      • Get Metrics V2 diff --git a/docs/includes/obsolete/get-payee-detail-v1.html b/docs/includes/obsolete/get-payee-detail-v1.html index d05e681f..7c2e5037 100644 --- a/docs/includes/obsolete/get-payee-detail-v1.html +++ b/docs/includes/obsolete/get-payee-detail-v1.html @@ -210,7 +210,7 @@
                        - +
                        • Get Payee Detail V1 diff --git a/docs/includes/obsolete/get-payees-v1.html b/docs/includes/obsolete/get-payees-v1.html index b102c636..83dcf411 100644 --- a/docs/includes/obsolete/get-payees-v1.html +++ b/docs/includes/obsolete/get-payees-v1.html @@ -210,7 +210,7 @@
                          - +
                          • Get Payees V1 diff --git a/docs/includes/obsolete/get-product-detail-v1.html b/docs/includes/obsolete/get-product-detail-v1.html index 1cb6b29c..34f37f5e 100644 --- a/docs/includes/obsolete/get-product-detail-v1.html +++ b/docs/includes/obsolete/get-product-detail-v1.html @@ -210,7 +210,7 @@
                            - +
                            • Get Product Detail V1 diff --git a/docs/includes/obsolete/get-product-detail-v2.html b/docs/includes/obsolete/get-product-detail-v2.html index d297fc1a..137b218e 100644 --- a/docs/includes/obsolete/get-product-detail-v2.html +++ b/docs/includes/obsolete/get-product-detail-v2.html @@ -210,7 +210,7 @@
                              - +
                              • Get Product Detail V2 diff --git a/docs/includes/obsolete/get-product-detail-v3.html b/docs/includes/obsolete/get-product-detail-v3.html index baaf7df7..1872120c 100644 --- a/docs/includes/obsolete/get-product-detail-v3.html +++ b/docs/includes/obsolete/get-product-detail-v3.html @@ -210,7 +210,7 @@
                                - +
                                • Get Product Detail V3 diff --git a/docs/includes/obsolete/get-products-v1.html b/docs/includes/obsolete/get-products-v1.html index c4d9a8ef..08c17b9b 100644 --- a/docs/includes/obsolete/get-products-v1.html +++ b/docs/includes/obsolete/get-products-v1.html @@ -210,7 +210,7 @@
                                  - +
                                  • Get Products V1 diff --git a/docs/includes/obsolete/get-products-v2.html b/docs/includes/obsolete/get-products-v2.html index 75867ddc..96e3ddac 100644 --- a/docs/includes/obsolete/get-products-v2.html +++ b/docs/includes/obsolete/get-products-v2.html @@ -210,7 +210,7 @@
                                    - +
                                    • Get Products V2 diff --git a/docs/includes/obsolete/get-software-product-statuses-v1.html b/docs/includes/obsolete/get-software-product-statuses-v1.html index 02e8bb26..7c394c62 100644 --- a/docs/includes/obsolete/get-software-product-statuses-v1.html +++ b/docs/includes/obsolete/get-software-product-statuses-v1.html @@ -210,7 +210,7 @@
                                      - +
                                      • Get Software Products Statuses V1 diff --git a/docs/includes/obsolete/get-software-statement-assertion-v1.html b/docs/includes/obsolete/get-software-statement-assertion-v1.html index 804fa6ec..62d75d7a 100644 --- a/docs/includes/obsolete/get-software-statement-assertion-v1.html +++ b/docs/includes/obsolete/get-software-statement-assertion-v1.html @@ -210,7 +210,7 @@
                                        - +
                                        • Get Software Statement Assertion (SSA) V1 diff --git a/docs/includes/obsolete/get-software-statement-assertion-v2.html b/docs/includes/obsolete/get-software-statement-assertion-v2.html index 6c79eef3..f2812606 100644 --- a/docs/includes/obsolete/get-software-statement-assertion-v2.html +++ b/docs/includes/obsolete/get-software-statement-assertion-v2.html @@ -210,7 +210,7 @@
                                          - +
                                          • Get Software Statement Assertion (SSA) V2 diff --git a/docs/includes/releasenotes/releasenotes.1.0.1.html b/docs/includes/releasenotes/releasenotes.1.0.1.html index 9af3a131..497316f0 100644 --- a/docs/includes/releasenotes/releasenotes.1.0.1.html +++ b/docs/includes/releasenotes/releasenotes.1.0.1.html @@ -210,7 +210,7 @@
                                            - +
                                            • V1.0.1 Release Notes diff --git a/docs/includes/releasenotes/releasenotes.1.1.0.html b/docs/includes/releasenotes/releasenotes.1.1.0.html index 0ac4f617..8213c521 100644 --- a/docs/includes/releasenotes/releasenotes.1.1.0.html +++ b/docs/includes/releasenotes/releasenotes.1.1.0.html @@ -210,7 +210,7 @@
                                              - +
                                              • V1.1.0 Release Notes diff --git a/docs/includes/releasenotes/releasenotes.1.1.1.html b/docs/includes/releasenotes/releasenotes.1.1.1.html index dbadc2d5..b66731f0 100644 --- a/docs/includes/releasenotes/releasenotes.1.1.1.html +++ b/docs/includes/releasenotes/releasenotes.1.1.1.html @@ -210,7 +210,7 @@
                                                - +
                                                • V1.1.1 Release Notes diff --git a/docs/includes/releasenotes/releasenotes.1.10.0.html b/docs/includes/releasenotes/releasenotes.1.10.0.html index d1fa816b..abb428d3 100644 --- a/docs/includes/releasenotes/releasenotes.1.10.0.html +++ b/docs/includes/releasenotes/releasenotes.1.10.0.html @@ -210,7 +210,7 @@
                                                  - +
                                                  • V1.10.0 Release Notes diff --git a/docs/includes/releasenotes/releasenotes.1.11.0.html b/docs/includes/releasenotes/releasenotes.1.11.0.html index 53d03d2e..24fe9ee4 100644 --- a/docs/includes/releasenotes/releasenotes.1.11.0.html +++ b/docs/includes/releasenotes/releasenotes.1.11.0.html @@ -210,7 +210,7 @@
                                                    - +
                                                    • V1.11.0 Release Notes diff --git a/docs/includes/releasenotes/releasenotes.1.11.1.html b/docs/includes/releasenotes/releasenotes.1.11.1.html index 0e55e564..efcdaf35 100644 --- a/docs/includes/releasenotes/releasenotes.1.11.1.html +++ b/docs/includes/releasenotes/releasenotes.1.11.1.html @@ -210,7 +210,7 @@
                                                      - +
                                                      • V1.11.1 Release Notes diff --git a/docs/includes/releasenotes/releasenotes.1.12.0.html b/docs/includes/releasenotes/releasenotes.1.12.0.html index c15fa6d0..98ac3f69 100644 --- a/docs/includes/releasenotes/releasenotes.1.12.0.html +++ b/docs/includes/releasenotes/releasenotes.1.12.0.html @@ -210,7 +210,7 @@
                                                        - +
                                                        • V1.12.0 Release Notes diff --git a/docs/includes/releasenotes/releasenotes.1.13.0.html b/docs/includes/releasenotes/releasenotes.1.13.0.html index da67635b..73d0c3e2 100644 --- a/docs/includes/releasenotes/releasenotes.1.13.0.html +++ b/docs/includes/releasenotes/releasenotes.1.13.0.html @@ -210,7 +210,7 @@
                                                          - +
                                                          • V1.13.0 Release Notes diff --git a/docs/includes/releasenotes/releasenotes.1.14.0.html b/docs/includes/releasenotes/releasenotes.1.14.0.html index ddc175ea..51c1dbab 100644 --- a/docs/includes/releasenotes/releasenotes.1.14.0.html +++ b/docs/includes/releasenotes/releasenotes.1.14.0.html @@ -210,7 +210,7 @@
                                                            - +
                                                            • V1.14.0 Release Notes diff --git a/docs/includes/releasenotes/releasenotes.1.15.0.html b/docs/includes/releasenotes/releasenotes.1.15.0.html index ba9618d7..397a1e5d 100644 --- a/docs/includes/releasenotes/releasenotes.1.15.0.html +++ b/docs/includes/releasenotes/releasenotes.1.15.0.html @@ -210,7 +210,7 @@
                                                              - +
                                                              • V1.15.0 Release Notes diff --git a/docs/includes/releasenotes/releasenotes.1.16.0.html b/docs/includes/releasenotes/releasenotes.1.16.0.html index 548f07ac..61a75542 100644 --- a/docs/includes/releasenotes/releasenotes.1.16.0.html +++ b/docs/includes/releasenotes/releasenotes.1.16.0.html @@ -210,7 +210,7 @@
                                                                - +
                                                                • V1.16.0 Release Notes diff --git a/docs/includes/releasenotes/releasenotes.1.16.1.html b/docs/includes/releasenotes/releasenotes.1.16.1.html index efc32451..8d2804e9 100644 --- a/docs/includes/releasenotes/releasenotes.1.16.1.html +++ b/docs/includes/releasenotes/releasenotes.1.16.1.html @@ -210,7 +210,7 @@
                                                                  - +
                                                                  • V1.16.1 Release Notes diff --git a/docs/includes/releasenotes/releasenotes.1.17.0.html b/docs/includes/releasenotes/releasenotes.1.17.0.html index c4754f4f..fb1da398 100644 --- a/docs/includes/releasenotes/releasenotes.1.17.0.html +++ b/docs/includes/releasenotes/releasenotes.1.17.0.html @@ -210,7 +210,7 @@
                                                                    - +
                                                                    • V1.17.0 Release Notes diff --git a/docs/includes/releasenotes/releasenotes.1.18.0.html b/docs/includes/releasenotes/releasenotes.1.18.0.html index 5c8b217f..7d45f22d 100644 --- a/docs/includes/releasenotes/releasenotes.1.18.0.html +++ b/docs/includes/releasenotes/releasenotes.1.18.0.html @@ -210,7 +210,7 @@
                                                                      - +
                                                                      • V1.18.0 Release Notes diff --git a/docs/includes/releasenotes/releasenotes.1.19.0.html b/docs/includes/releasenotes/releasenotes.1.19.0.html index b1261e0c..567ec0e5 100644 --- a/docs/includes/releasenotes/releasenotes.1.19.0.html +++ b/docs/includes/releasenotes/releasenotes.1.19.0.html @@ -210,7 +210,7 @@
                                                                        - +
                                                                        • V1.19.0 Release Notes diff --git a/docs/includes/releasenotes/releasenotes.1.2.0.html b/docs/includes/releasenotes/releasenotes.1.2.0.html index 61088438..139037cc 100644 --- a/docs/includes/releasenotes/releasenotes.1.2.0.html +++ b/docs/includes/releasenotes/releasenotes.1.2.0.html @@ -210,7 +210,7 @@
                                                                          - +
                                                                          • V1.2.0 Release Notes diff --git a/docs/includes/releasenotes/releasenotes.1.20.0.html b/docs/includes/releasenotes/releasenotes.1.20.0.html index 7030a70f..ca4938f0 100644 --- a/docs/includes/releasenotes/releasenotes.1.20.0.html +++ b/docs/includes/releasenotes/releasenotes.1.20.0.html @@ -210,7 +210,7 @@
                                                                            - +
                                                                            • V1.20.0 Release Notes diff --git a/docs/includes/releasenotes/releasenotes.1.21.0.html b/docs/includes/releasenotes/releasenotes.1.21.0.html index 80279cef..a76d8454 100644 --- a/docs/includes/releasenotes/releasenotes.1.21.0.html +++ b/docs/includes/releasenotes/releasenotes.1.21.0.html @@ -210,7 +210,7 @@
                                                                              - +
                                                                              • V1.21.0 Release Notes diff --git a/docs/includes/releasenotes/releasenotes.1.22.0.html b/docs/includes/releasenotes/releasenotes.1.22.0.html index aaae9f19..7465a4f0 100644 --- a/docs/includes/releasenotes/releasenotes.1.22.0.html +++ b/docs/includes/releasenotes/releasenotes.1.22.0.html @@ -210,7 +210,7 @@
                                                                                - +
                                                                                • V1.22.0 Release Notes @@ -248,7 +248,7 @@

                                                                                  V1.22.0 Release Notes

                                                                                  Release notes for version v1.22.0 of the CDR Standards.

                                                                                  Changes Made

                                                                                  Change Requests

                                                                                  -

                                                                                  This release addresses the following minor defects raised on Standards Staging:

                                                                                  +

                                                                                  This release addresses the following minor defects raised on Standards Staging:

                                                                                  • Fix for a missing font in styles
                                                                                    • diff --git a/docs/includes/releasenotes/releasenotes.1.22.1.html b/docs/includes/releasenotes/releasenotes.1.22.1.html new file mode 100644 index 00000000..366ada38 --- /dev/null +++ b/docs/includes/releasenotes/releasenotes.1.22.1.html @@ -0,0 +1,340 @@ + + + + + + + + Consumer Data Standards - v1.22.1 Release Notes + + + + + + + + + + + + NAV + Navbar + + +
                                                                                    + + + +
                                                                                    +
                                                                                    +
                                                                                    +

                                                                                    V1.22.1 Release Notes

                                                                                    +

                                                                                    Release notes for version v1.22.1 of the CDR Standards.

                                                                                    +

                                                                                    Changes Made

                                                                                    Change Requests

                                                                                    +

                                                                                    This release addresses the following minor defects raised on Standards Staging:

                                                                                    + +
                                                                                      +
                                                                                    • Issue 257: Notice for the Binding Data Standard
                                                                                      • +
                                                                                    • Issue 255: Maintenance of obligation date tables
                                                                                      • +
                                                                                    • Issue 254: Get Energy Account Detail V2 - Fix binding date
                                                                                      • +
                                                                                    • Issue 245: Get Energy APIs: meta object should not be mandatory
                                                                                      • +
                                                                                    • Issue 227: Spelling of "organisation" in description of EnergyServicePointDetail.party
                                                                                      • +
                                                                                    • Issue 226: Standardise use of ResponseErrorListV2 for Energy APIs
                                                                                      • +
                                                                                    • Issue 193: Incorrect link to Endpoint Version Schedule in Standards
                                                                                      • +
                                                                                    • Issue 152: Get Meta objects to be optional in energy requests
                                                                                      • +
                                                                                    +

                                                                                    Decision Proposals

                                                                                    +

                                                                                    This release is a patch release and does not include any changes arising from a decision of the Chair

                                                                                    +

                                                                                    Introduction

                                                                                    +
Name
22/03/20231.22.1Patch release including updates to draft Telco standardsSee release notes for details.
22/12/2022 1.22.0 Changes arising from Decision 271 (Maintenance iteration 13)
Legacy FDO01/07/20211
Legacy FDO31/07/20211
Legacy FDO31/10/20211
Legacy FDO01/11/20212
Legacy FDO01/02/20222
Y22 #131/03/20221
Legacy FDO01/07/20222
Y22 #204/07/202216/09/2022 1
Legacy FDO31/07/20224
Legacy FDO30/07/20226
Y22 #331/08/20222
Legacy FDO16/09/202201/10/2022 1
Legacy FDO01/10/202201/11/2022 1
Y22 #4 15/11/202213
Legacy FDO
Y23 #1 14/04/202313
Y23 #208/05/2023015/05/20231
Y23 #3 10/07/202313
Y23 #4
Y24 #1 11/03/202402
Y24 #2 2022-11-15 2023-04-14 2021-10-29, V1.14.0TBC, V1.19.02022-09-13, V1.19.0
Energy APIs V2 2023-04-14 N/ATBC, V1.19.02022-09-13, V1.19.0 N/A
2022-11-15 2023-04-14 2021-10-29, V1.14.0TBC, V1.19.02022-09-13, V1.19.0
Energy APIs /energy/accounts/{accountId} GET V22022-04-142023-04-14 N/ATBC, V1.19.02022-09-13, V1.19.0 N/A
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ChangeDescriptionLink
Binding StatementAdded binding statement to the Introduction sectionIntroduction
Align Obligation DatesCorrections to the future dated obligations tableFDOs
Align Obligation DatesCorrections to the obligation dates tableObligations Table
Fix Binding DateCorrect the binding date for Get Energy Account Detail V2 in the end point scheduleEnd Point Version Schedule
Fix End Point Schedule LinkCorrect the link for the end point version scheduleEnd Point Version Section
+

High Level Standards

+

No changes

+

API End Points

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
ChangeDescriptionLink
Updated Telco DraftChanges arising from ongoing consultation on the Telco standards have been incorporatedTelco APIs
Meta Objects OptionalMade the meta object in requests and non-list responses optional for energy APIs to align with decisionsEnergy APIs
Error List ModelAlign the version of the energy error list with the banking sectorEnergy APIs
TypoFixed typo of 'organisation'Energy APIs
+

Information Security Profile

+

No changes

+

Consumer Experience

+

No changes

+

Known Issues

+

No changes

+ + + + + diff --git a/docs/includes/releasenotes/releasenotes.1.3.0.html b/docs/includes/releasenotes/releasenotes.1.3.0.html index 62e5dfeb..8c006289 100644 --- a/docs/includes/releasenotes/releasenotes.1.3.0.html +++ b/docs/includes/releasenotes/releasenotes.1.3.0.html @@ -210,7 +210,7 @@
- +
  • V1.3.0 Release Notes diff --git a/docs/includes/releasenotes/releasenotes.1.3.1.html b/docs/includes/releasenotes/releasenotes.1.3.1.html index 744f2c31..f0913c5c 100644 --- a/docs/includes/releasenotes/releasenotes.1.3.1.html +++ b/docs/includes/releasenotes/releasenotes.1.3.1.html @@ -210,7 +210,7 @@
    - +
    • V1.3.1 Release Notes diff --git a/docs/includes/releasenotes/releasenotes.1.4.0.html b/docs/includes/releasenotes/releasenotes.1.4.0.html index 28470e30..40710f39 100644 --- a/docs/includes/releasenotes/releasenotes.1.4.0.html +++ b/docs/includes/releasenotes/releasenotes.1.4.0.html @@ -210,7 +210,7 @@
      - +
      • V1.4.0 Release Notes diff --git a/docs/includes/releasenotes/releasenotes.1.5.0.html b/docs/includes/releasenotes/releasenotes.1.5.0.html index 19b88072..ce095d06 100644 --- a/docs/includes/releasenotes/releasenotes.1.5.0.html +++ b/docs/includes/releasenotes/releasenotes.1.5.0.html @@ -210,7 +210,7 @@
        - +
        • V1.5.0 Release Notes diff --git a/docs/includes/releasenotes/releasenotes.1.5.1.html b/docs/includes/releasenotes/releasenotes.1.5.1.html index 373a9c52..b63e546b 100644 --- a/docs/includes/releasenotes/releasenotes.1.5.1.html +++ b/docs/includes/releasenotes/releasenotes.1.5.1.html @@ -210,7 +210,7 @@
          - +
          • V1.5.1 Release Notes diff --git a/docs/includes/releasenotes/releasenotes.1.6.0.html b/docs/includes/releasenotes/releasenotes.1.6.0.html index 6d1f3007..d58e21bb 100644 --- a/docs/includes/releasenotes/releasenotes.1.6.0.html +++ b/docs/includes/releasenotes/releasenotes.1.6.0.html @@ -210,7 +210,7 @@
            - +
            • V1.6.0 Release Notes diff --git a/docs/includes/releasenotes/releasenotes.1.7.0.html b/docs/includes/releasenotes/releasenotes.1.7.0.html index bd4c4578..f7efd6a8 100644 --- a/docs/includes/releasenotes/releasenotes.1.7.0.html +++ b/docs/includes/releasenotes/releasenotes.1.7.0.html @@ -210,7 +210,7 @@
              - +
              • V1.7.0 Release Notes diff --git a/docs/includes/releasenotes/releasenotes.1.8.0.html b/docs/includes/releasenotes/releasenotes.1.8.0.html index d45b51a7..0e7e7ad7 100644 --- a/docs/includes/releasenotes/releasenotes.1.8.0.html +++ b/docs/includes/releasenotes/releasenotes.1.8.0.html @@ -210,7 +210,7 @@
                - +
                • V1.8.0 Release Notes diff --git a/docs/includes/releasenotes/releasenotes.1.9.0.html b/docs/includes/releasenotes/releasenotes.1.9.0.html index 70708a1b..e731ce72 100644 --- a/docs/includes/releasenotes/releasenotes.1.9.0.html +++ b/docs/includes/releasenotes/releasenotes.1.9.0.html @@ -210,7 +210,7 @@
                  - +
                  • V1.9.0 Release Notes diff --git a/docs/includes/swagger/cds_admin.json b/docs/includes/swagger/cds_admin.json index 760ef8ee..3b39911c 100644 --- a/docs/includes/swagger/cds_admin.json +++ b/docs/includes/swagger/cds_admin.json @@ -12,7 +12,7 @@ "url" : "https://opensource.org/licenses/MIT" }, "title" : "CDR Admin API", - "version" : "1.22.0" + "version" : "1.22.1" }, "servers" : [ { "url" : "https://data.holder.com.au/cds-au/v1" diff --git a/docs/includes/swagger/cds_admin.yaml b/docs/includes/swagger/cds_admin.yaml index bcd11ac0..52bda618 100644 --- a/docs/includes/swagger/cds_admin.yaml +++ b/docs/includes/swagger/cds_admin.yaml @@ -11,7 +11,7 @@ info: name: MIT License url: https://opensource.org/licenses/MIT title: CDR Admin API - version: 1.22.0 + version: 1.22.1 servers: - url: https://data.holder.com.au/cds-au/v1 paths: diff --git a/docs/includes/swagger/cds_banking.json b/docs/includes/swagger/cds_banking.json index ad16c463..a1042dcb 100644 --- a/docs/includes/swagger/cds_banking.json +++ b/docs/includes/swagger/cds_banking.json @@ -12,7 +12,7 @@ "url" : "https://opensource.org/licenses/MIT" }, "title" : "CDR Banking API", - "version" : "1.22.0" + "version" : "1.22.1" }, "servers" : [ { "url" : "https://data.holder.com.au/cds-au/v1" diff --git a/docs/includes/swagger/cds_banking.yaml b/docs/includes/swagger/cds_banking.yaml index 3a40f6e4..79a2b23f 100644 --- a/docs/includes/swagger/cds_banking.yaml +++ b/docs/includes/swagger/cds_banking.yaml @@ -11,7 +11,7 @@ info: name: MIT License url: https://opensource.org/licenses/MIT title: CDR Banking API - version: 1.22.0 + version: 1.22.1 servers: - url: https://data.holder.com.au/cds-au/v1 paths: diff --git a/docs/includes/swagger/cds_common.json b/docs/includes/swagger/cds_common.json index abc9ee0c..3c027993 100644 --- a/docs/includes/swagger/cds_common.json +++ b/docs/includes/swagger/cds_common.json @@ -12,7 +12,7 @@ "url" : "https://opensource.org/licenses/MIT" }, "title" : "CDR Common API", - "version" : "1.22.0" + "version" : "1.22.1" }, "servers" : [ { "url" : "https://data.holder.com.au/cds-au/v1" diff --git a/docs/includes/swagger/cds_common.yaml b/docs/includes/swagger/cds_common.yaml index de6cc284..a14c6af0 100644 --- a/docs/includes/swagger/cds_common.yaml +++ b/docs/includes/swagger/cds_common.yaml @@ -11,7 +11,7 @@ info: name: MIT License url: https://opensource.org/licenses/MIT title: CDR Common API - version: 1.22.0 + version: 1.22.1 servers: - url: https://data.holder.com.au/cds-au/v1 paths: diff --git a/docs/includes/swagger/cds_dcr.json b/docs/includes/swagger/cds_dcr.json index 5baf5a03..b2d2496a 100644 --- a/docs/includes/swagger/cds_dcr.json +++ b/docs/includes/swagger/cds_dcr.json @@ -3,7 +3,7 @@ "info" : { "description" : "This specification defines the APIs for Data Holders exposing Dynamic Client Registration endpoints.", "title" : "CDR Dynamic Client Registration API", - "version" : "1.22.0" + "version" : "1.22.1" }, "servers" : [ { "url" : "https://data.holder.com.au/" diff --git a/docs/includes/swagger/cds_dcr.yaml b/docs/includes/swagger/cds_dcr.yaml index 362f84f6..4f6f49cf 100644 --- a/docs/includes/swagger/cds_dcr.yaml +++ b/docs/includes/swagger/cds_dcr.yaml @@ -3,7 +3,7 @@ info: description: This specification defines the APIs for Data Holders exposing Dynamic Client Registration endpoints. title: CDR Dynamic Client Registration API - version: 1.22.0 + version: 1.22.1 servers: - url: https://data.holder.com.au/ paths: diff --git a/docs/includes/swagger/cds_energy.json b/docs/includes/swagger/cds_energy.json index 3b4c3a7d..004d787e 100644 --- a/docs/includes/swagger/cds_energy.json +++ b/docs/includes/swagger/cds_energy.json @@ -3,7 +3,7 @@ "info" : { "description" : "Consumer Data Right end points and payloads for the Energy sector", "title" : "CDR Energy API", - "version" : "1.22.0" + "version" : "1.22.1" }, "servers" : [ { "url" : "/" @@ -138,7 +138,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -158,7 +158,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -178,7 +178,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -260,7 +260,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -280,7 +280,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -300,7 +300,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -445,7 +445,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -465,7 +465,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -485,7 +485,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -619,7 +619,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -639,7 +639,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -659,7 +659,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -849,7 +849,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -869,7 +869,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -889,7 +889,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -909,7 +909,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -1089,7 +1089,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -1109,7 +1109,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -1129,7 +1129,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -1310,7 +1310,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -1330,7 +1330,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -1350,7 +1350,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -1484,7 +1484,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -1504,7 +1504,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -1524,7 +1524,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -1670,7 +1670,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -1690,7 +1690,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -1710,7 +1710,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -1857,7 +1857,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -1877,7 +1877,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -1897,7 +1897,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -2055,7 +2055,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -2075,7 +2075,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -2095,7 +2095,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -2229,7 +2229,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -2249,7 +2249,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -2269,7 +2269,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -2403,7 +2403,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -2423,7 +2423,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -2443,7 +2443,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -2577,7 +2577,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -2597,7 +2597,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -2617,7 +2617,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -2751,7 +2751,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -2771,7 +2771,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -2791,7 +2791,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -2937,7 +2937,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -2957,7 +2957,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -2977,7 +2977,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -3124,7 +3124,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -3144,7 +3144,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -3164,7 +3164,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -3342,7 +3342,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -3362,7 +3362,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -3382,7 +3382,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -3402,7 +3402,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -3570,7 +3570,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -3590,7 +3590,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -3610,7 +3610,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -3779,7 +3779,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -3799,7 +3799,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -3819,7 +3819,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -3997,7 +3997,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -4017,7 +4017,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -4037,7 +4037,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -4057,7 +4057,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -4225,7 +4225,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -4245,7 +4245,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -4265,7 +4265,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -4434,7 +4434,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -4454,7 +4454,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -4474,7 +4474,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -4737,7 +4737,7 @@ "$ref" : "#/components/schemas/Meta" } }, - "required" : [ "data", "meta" ], + "required" : [ "data" ], "type" : "object" } } @@ -4767,7 +4767,7 @@ "$ref" : "#/components/schemas/Meta" } }, - "required" : [ "data", "meta" ], + "required" : [ "data" ], "type" : "object" } } @@ -5285,7 +5285,7 @@ "$ref" : "#/components/schemas/Meta" } }, - "required" : [ "data", "links", "meta" ], + "required" : [ "data", "links" ], "type" : "object" }, "EnergyAccountListResponseV2" : { @@ -5315,7 +5315,7 @@ "$ref" : "#/components/schemas/Meta" } }, - "required" : [ "data", "links", "meta" ], + "required" : [ "data", "links" ], "type" : "object" }, "EnergyPaymentScheduleResponse" : { @@ -5330,7 +5330,7 @@ "$ref" : "#/components/schemas/Meta" } }, - "required" : [ "data", "links", "meta" ], + "required" : [ "data", "links" ], "type" : "object" }, "EnergyConcessionsResponse" : { @@ -5345,7 +5345,7 @@ "$ref" : "#/components/schemas/Meta" } }, - "required" : [ "data", "links", "meta" ], + "required" : [ "data", "links" ], "type" : "object" }, "EnergyBalanceListResponse" : { @@ -5375,7 +5375,7 @@ "$ref" : "#/components/schemas/Meta" } }, - "required" : [ "data", "links", "meta" ], + "required" : [ "data", "links" ], "type" : "object" }, "EnergyInvoiceListResponse" : { @@ -5408,11 +5408,11 @@ "required" : [ "data", "links", "meta" ], "type" : "object" }, - "ErrorListResponse" : { + "ResponseErrorListV2" : { "properties" : { "errors" : { "items" : { - "$ref" : "#/components/schemas/ErrorListResponse_errors" + "$ref" : "#/components/schemas/ResponseErrorListV2_errors" }, "type" : "array" } @@ -7430,7 +7430,7 @@ "required" : [ "transactions" ], "type" : "object" }, - "ErrorListResponse_meta" : { + "ResponseErrorListV2_meta" : { "description" : "Additional data for customised error codes", "properties" : { "urn" : { @@ -7441,7 +7441,7 @@ "type" : "object", "x-conditional" : [ "urn" ] }, - "ErrorListResponse_errors" : { + "ResponseErrorListV2_errors" : { "properties" : { "code" : { "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.", @@ -7456,7 +7456,7 @@ "type" : "string" }, "meta" : { - "$ref" : "#/components/schemas/ErrorListResponse_meta" + "$ref" : "#/components/schemas/ResponseErrorListV2_meta" } }, "required" : [ "code", "detail", "title" ], @@ -7656,7 +7656,7 @@ "EnergyServicePointDetail_relatedParticipants" : { "properties" : { "party" : { - "description" : "The name of the party/orginsation related to this service point", + "description" : "The name of the party/organisation related to this service point", "type" : "string" }, "role" : { diff --git a/docs/includes/swagger/cds_energy.yaml b/docs/includes/swagger/cds_energy.yaml index bfc3a9d5..13a82331 100644 --- a/docs/includes/swagger/cds_energy.yaml +++ b/docs/includes/swagger/cds_energy.yaml @@ -2,7 +2,7 @@ openapi: 3.0.3 info: description: Consumer Data Right end points and payloads for the Energy sector title: CDR Energy API - version: 1.22.0 + version: 1.22.1 servers: - url: / paths: @@ -144,7 +144,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                    • [400 - Invalid Field](#error-400-field-invalid)
                    • [400 - Invalid Page Size](#error-400-field-invalid-page-size)
                    • [400 - Invalid Version](#error-400-header-invalid-version)
                    @@ -163,7 +163,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                    • [406 - Unsupported Version](#error-406-header-unsupported-version)
                    headers: @@ -181,7 +181,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                    • [422 - Invalid Page](#error-422-field-invalid-page)
                    headers: @@ -259,7 +259,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                    • [400 - Invalid Field](#error-400-field-invalid)
                    • [400 - Invalid Version](#error-400-header-invalid-version)
                    headers: @@ -277,7 +277,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                    • [404 - Invalid Resource](#error-404-resource-invalid)
                    headers: @@ -295,7 +295,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                    • [406 - Unsupported Version](#error-406-header-unsupported-version)
                    headers: @@ -440,7 +440,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                    • [400 - Invalid Field](#error-400-field-invalid)
                    • [400 - Invalid Page Size](#error-400-field-invalid-page-size)
                    • [400 - Invalid Version](#error-400-header-invalid-version)
                    @@ -459,7 +459,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                    • [406 - Unsupported Version](#error-406-header-unsupported-version)
                    headers: @@ -477,7 +477,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                    • [422 - Invalid Page](#error-422-field-invalid-page)
                    headers: @@ -616,7 +616,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                    • [400 - Invalid Field](#error-400-field-invalid)
                    • [400 - Invalid Version](#error-400-header-invalid-version)
                    headers: @@ -634,7 +634,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                    • [404 - Unavailable Service Point](#error-404-unavailable-service-point)
                    • [404 - Invalid Service Point](#error-404-invalid-service-point)
                    @@ -653,7 +653,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                    • [406 - Unsupported Version](#error-406-header-unsupported-version)
                    headers: @@ -846,7 +846,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                    • [400 - Invalid Field](#error-400-field-invalid)
                    • [400 - Invalid Page Size](#error-400-field-invalid-page-size)
                    • [400 - Invalid Version](#error-400-header-invalid-version)
                    @@ -865,7 +865,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                    • [404 - Unavailable Service Point](#error-404-unavailable-service-point)
                    • [404 - Invalid Service Point](#error-404-invalid-service-point)
                    @@ -884,7 +884,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                    • [406 - Unsupported Version](#error-406-header-unsupported-version)
                    headers: @@ -902,7 +902,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                    • [422 - Invalid Page](#error-422-field-invalid-page)
                    headers: @@ -1084,7 +1084,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                    • [400 - Invalid Field](#error-400-field-invalid)
                    • [400 - Invalid Page Size](#error-400-field-invalid-page-size)
                    • [400 - Invalid Version](#error-400-header-invalid-version)
                    @@ -1103,7 +1103,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                    • [406 - Unsupported Version](#error-406-header-unsupported-version)
                    headers: @@ -1121,7 +1121,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                    • [422 - Invalid Page](#error-422-field-invalid-page)
                    headers: @@ -1305,7 +1305,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                    • [400 - Invalid Field](#error-400-field-invalid)
                    • [400 - Invalid Page Size](#error-400-field-invalid-page-size)
                    • [400 - Invalid Version](#error-400-header-invalid-version)
                    @@ -1324,7 +1324,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                    • [406 - Unsupported Version](#error-406-header-unsupported-version)
                    headers: @@ -1342,7 +1342,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                    • [422 - Invalid Page](#error-422-field-invalid-page)
                    • [422 - Unavailable Service Point](#error-422-unavailable-service-point)
                    • [422 - Invalid @@ -1482,7 +1482,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                      • [400 - Invalid Field](#error-400-field-invalid)
                      • [400 - Invalid Version](#error-400-header-invalid-version)
                      headers: @@ -1500,7 +1500,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                      • [404 - Unavailable Service Point](#error-404-unavailable-service-point)
                      • [404 - Invalid Service Point](#error-404-invalid-service-point)
                      @@ -1519,7 +1519,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                      • [406 - Unsupported Version](#error-406-header-unsupported-version)
                      headers: @@ -1665,7 +1665,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                      • [400 - Invalid Field](#error-400-field-invalid)
                      • [400 - Invalid Page Size](#error-400-field-invalid-page-size)
                      • [400 - Invalid Version](#error-400-header-invalid-version)
                      @@ -1684,7 +1684,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                      • [406 - Unsupported Version](#error-406-header-unsupported-version)
                      headers: @@ -1702,7 +1702,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                      • [422 - Invalid Page](#error-422-field-invalid-page)
                      headers: @@ -1849,7 +1849,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                      • [400 - Invalid Field](#error-400-field-invalid)
                      • [400 - Invalid Page Size](#error-400-field-invalid-page-size)
                      • [400 - Invalid Version](#error-400-header-invalid-version)
                      @@ -1868,7 +1868,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                      • [406 - Unsupported Version](#error-406-header-unsupported-version)
                      headers: @@ -1886,7 +1886,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                      • [422 - Invalid Page](#error-422-field-invalid-page)
                      • [422 - Unavailable Service Point](#error-422-unavailable-service-point)
                      • [422 - Invalid @@ -2051,7 +2051,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                        • [400 - Invalid Field](#error-400-field-invalid)
                        • [400 - Invalid Page Size](#error-400-field-invalid-page-size)
                        • [400 - Invalid Version](#error-400-header-invalid-version)
                        @@ -2070,7 +2070,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                        • [406 - Unsupported Version](#error-406-header-unsupported-version)
                        headers: @@ -2088,7 +2088,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                        • [422 - Invalid Page](#error-422-field-invalid-page)
                        headers: @@ -2228,7 +2228,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                        • [400 - Invalid Field](#error-400-field-invalid)
                        • [400 - Invalid Version](#error-400-header-invalid-version)
                        headers: @@ -2246,7 +2246,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                        • [404 - Unavailable Energy Account](#error-404-unavailable-energy-account)
                        • [404 - Invalid Energy Account](#error-404-invalid-energy-account)
                        @@ -2265,7 +2265,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                        • [406 - Unsupported Version](#error-406-header-unsupported-version)
                        headers: @@ -2414,7 +2414,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                        • [400 - Invalid Field](#error-400-field-invalid)
                        • [400 - Invalid Version](#error-400-header-invalid-version)
                        headers: @@ -2432,7 +2432,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                        • [404 - Unavailable Energy Account](#error-404-unavailable-energy-account)
                        • [404 - Invalid Energy Account](#error-404-invalid-energy-account)
                        @@ -2451,7 +2451,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                        • [406 - Unsupported Version](#error-406-header-unsupported-version)
                        headers: @@ -2589,7 +2589,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                        • [400 - Invalid Field](#error-400-field-invalid)
                        • [400 - Invalid Version](#error-400-header-invalid-version)
                        headers: @@ -2607,7 +2607,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                        • [404 - Unavailable Energy Account](#error-404-unavailable-energy-account)
                        • [404 - Invalid Energy Account](#error-404-invalid-energy-account)
                        @@ -2626,7 +2626,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                        • [406 - Unsupported Version](#error-406-header-unsupported-version)
                        headers: @@ -2763,7 +2763,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                        • [400 - Invalid Field](#error-400-field-invalid)
                        • [400 - Invalid Version](#error-400-header-invalid-version)
                        headers: @@ -2781,7 +2781,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                        • [404 - Unavailable Energy Account](#error-404-unavailable-energy-account)
                        • [404 - Invalid Energy Account](#error-404-invalid-energy-account)
                        @@ -2800,7 +2800,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                        • [406 - Unsupported Version](#error-406-header-unsupported-version)
                        headers: @@ -2946,7 +2946,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                        • [400 - Invalid Field](#error-400-field-invalid)
                        • [400 - Invalid Page Size](#error-400-field-invalid-page-size)
                        • [400 - Invalid Version](#error-400-header-invalid-version)
                        @@ -2965,7 +2965,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                        • [406 - Unsupported Version](#error-406-header-unsupported-version)
                        headers: @@ -2983,7 +2983,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                        • [422 - Invalid Page](#error-422-field-invalid-page)
                        headers: @@ -3130,7 +3130,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                        • [400 - Invalid Field](#error-400-field-invalid)
                        • [400 - Invalid Page Size](#error-400-field-invalid-page-size)
                        • [400 - Invalid Version](#error-400-header-invalid-version)
                        @@ -3149,7 +3149,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                        • [406 - Unsupported Version](#error-406-header-unsupported-version)
                        headers: @@ -3167,7 +3167,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                        • [422 - Invalid Page](#error-422-field-invalid-page)
                        • [422 - Unavailable Energy Account](#error-422-unavailable-energy-account)
                        • [422 - @@ -3346,7 +3346,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                          • [400 - Invalid Field](#error-400-field-invalid)
                          • [400 - Invalid Page Size](#error-400-field-invalid-page-size)
                          • [400 - Invalid Version](#error-400-header-invalid-version)
                          @@ -3365,7 +3365,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                          • [404 - Unavailable Energy Account](#error-404-unavailable-energy-account)
                          • [404 - Invalid Energy Account](#error-404-invalid-energy-account)
                          @@ -3384,7 +3384,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                          • [406 - Unsupported Version](#error-406-header-unsupported-version)
                          headers: @@ -3402,7 +3402,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                          • [422 - Invalid Page](#error-422-field-invalid-page)
                          headers: @@ -3570,7 +3570,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                          • [400 - Invalid Field](#error-400-field-invalid)
                          • [400 - Invalid Page Size](#error-400-field-invalid-page-size)
                          • [400 - Invalid Version](#error-400-header-invalid-version)
                          @@ -3589,7 +3589,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                          • [406 - Unsupported Version](#error-406-header-unsupported-version)
                          headers: @@ -3607,7 +3607,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                          • [422 - Invalid Page](#error-422-field-invalid-page)
                          headers: @@ -3776,7 +3776,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                          • [400 - Invalid Field](#error-400-field-invalid)
                          • [400 - Invalid Page Size](#error-400-field-invalid-page-size)
                          • [400 - Invalid Version](#error-400-header-invalid-version)
                          @@ -3795,7 +3795,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                          • [406 - Unsupported Version](#error-406-header-unsupported-version)
                          headers: @@ -3813,7 +3813,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                          • [422 - Invalid Page](#error-422-field-invalid-page)
                          • [422 - Unavailable Energy Account](#error-422-unavailable-energy-account)
                          • [422 - @@ -3992,7 +3992,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                            • [400 - Invalid Field](#error-400-field-invalid)
                            • [400 - Invalid Page Size](#error-400-field-invalid-page-size)
                            • [400 - Invalid Version](#error-400-header-invalid-version)
                            @@ -4011,7 +4011,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                            • [404 - Unavailable Energy Account](#error-404-unavailable-energy-account)
                            • [404 - Invalid Energy Account](#error-404-invalid-energy-account)
                            @@ -4030,7 +4030,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                            • [406 - Unsupported Version](#error-406-header-unsupported-version)
                            headers: @@ -4048,7 +4048,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                            • [422 - Invalid Page](#error-422-field-invalid-page)
                            headers: @@ -4216,7 +4216,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                            • [400 - Invalid Field](#error-400-field-invalid)
                            • [400 - Invalid Page Size](#error-400-field-invalid-page-size)
                            • [400 - Invalid Version](#error-400-header-invalid-version)
                            @@ -4235,7 +4235,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                            • [406 - Unsupported Version](#error-406-header-unsupported-version)
                            headers: @@ -4253,7 +4253,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                            • [422 - Invalid Page](#error-422-field-invalid-page)
                            headers: @@ -4422,7 +4422,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                            • [400 - Invalid Field](#error-400-field-invalid)
                            • [400 - Invalid Page Size](#error-400-field-invalid-page-size)
                            • [400 - Invalid Version](#error-400-header-invalid-version)
                            @@ -4441,7 +4441,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                            • [406 - Unsupported Version](#error-406-header-unsupported-version)
                            headers: @@ -4459,7 +4459,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                            • [422 - Invalid Page](#error-422-field-invalid-page)
                            • [422 - Unavailable Energy Account](#error-422-unavailable-energy-account)
                            • [422 - @@ -4727,7 +4727,6 @@ components: $ref: '#/components/schemas/Meta' required: - data - - meta type: object description: Request payload containing list of specific Service Points to obtain data for @@ -4751,7 +4750,6 @@ components: $ref: '#/components/schemas/Meta' required: - data - - meta type: object description: Request payload containing list of specific Accounts to obtain data for @@ -5712,7 +5710,6 @@ components: required: - data - links - - meta type: object EnergyAccountListResponseV2: example: @@ -5756,7 +5753,6 @@ components: required: - data - links - - meta type: object EnergyPaymentScheduleResponse: example: @@ -5817,7 +5813,6 @@ components: required: - data - links - - meta type: object EnergyConcessionsResponse: example: @@ -5860,7 +5855,6 @@ components: required: - data - links - - meta type: object EnergyBalanceListResponse: example: @@ -5908,7 +5902,6 @@ components: required: - data - links - - meta type: object EnergyInvoiceListResponse: example: @@ -6198,11 +6191,11 @@ components: - links - meta type: object - ErrorListResponse: + ResponseErrorListV2: properties: errors: items: - $ref: '#/components/schemas/ErrorListResponse_errors' + $ref: '#/components/schemas/ResponseErrorListV2_errors' type: array required: - errors @@ -10547,7 +10540,7 @@ components: required: - transactions type: object - ErrorListResponse_meta: + ResponseErrorListV2_meta: description: Additional data for customised error codes properties: urn: @@ -10558,7 +10551,7 @@ components: type: object x-conditional: - urn - ErrorListResponse_errors: + ResponseErrorListV2_errors: properties: code: description: The code of the error encountered. Where the error is specific @@ -10577,7 +10570,7 @@ components: the problem. type: string meta: - $ref: '#/components/schemas/ErrorListResponse_meta' + $ref: '#/components/schemas/ResponseErrorListV2_meta' required: - code - detail @@ -10811,7 +10804,8 @@ components: party: party properties: party: - description: The name of the party/orginsation related to this service point + description: The name of the party/organisation related to this service + point type: string role: description: 'The role performed by this participant in relation to the diff --git a/docs/includes/swagger/cds_energy_sdh.json b/docs/includes/swagger/cds_energy_sdh.json index 44b57b89..c3d85056 100644 --- a/docs/includes/swagger/cds_energy_sdh.json +++ b/docs/includes/swagger/cds_energy_sdh.json @@ -3,7 +3,7 @@ "info" : { "description" : "Consumer Data Right end points and payloads for Secondary Data Holder for the Energy sector", "title" : "CDR Energy Secondary Data Holder API", - "version" : "1.22.0" + "version" : "1.22.1" }, "servers" : [ { "url" : "/" @@ -112,7 +112,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -132,7 +132,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -152,7 +152,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -263,7 +263,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -283,7 +283,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -303,7 +303,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -470,7 +470,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -490,7 +490,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -510,7 +510,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -530,7 +530,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -690,7 +690,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -710,7 +710,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -730,7 +730,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -841,7 +841,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -861,7 +861,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -881,7 +881,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -1007,7 +1007,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -1027,7 +1027,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -1047,7 +1047,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, @@ -1461,14 +1461,14 @@ "$ref" : "#/components/schemas/Meta" } }, - "required" : [ "data", "links", "meta" ], + "required" : [ "data", "links" ], "type" : "object" }, - "ErrorListResponse" : { + "ResponseErrorListV2" : { "properties" : { "errors" : { "items" : { - "$ref" : "#/components/schemas/ErrorListResponse_errors" + "$ref" : "#/components/schemas/ResponseErrorListV2_errors" }, "type" : "array" } @@ -1946,7 +1946,7 @@ "required" : [ "derRecords" ], "type" : "object" }, - "ErrorListResponse_meta" : { + "ResponseErrorListV2_meta" : { "description" : "Additional data for customised error codes", "properties" : { "urn" : { @@ -1957,7 +1957,7 @@ "type" : "object", "x-conditional" : [ "urn" ] }, - "ErrorListResponse_errors" : { + "ResponseErrorListV2_errors" : { "properties" : { "code" : { "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.", @@ -1972,7 +1972,7 @@ "type" : "string" }, "meta" : { - "$ref" : "#/components/schemas/ErrorListResponse_meta" + "$ref" : "#/components/schemas/ResponseErrorListV2_meta" } }, "required" : [ "code", "detail", "title" ], @@ -2014,7 +2014,7 @@ "EnergyServicePointDetail_relatedParticipants" : { "properties" : { "party" : { - "description" : "The name of the party/orginsation related to this service point", + "description" : "The name of the party/organisation related to this service point", "type" : "string" }, "role" : { diff --git a/docs/includes/swagger/cds_energy_sdh.yaml b/docs/includes/swagger/cds_energy_sdh.yaml index dd78fb9b..9af9a0a5 100644 --- a/docs/includes/swagger/cds_energy_sdh.yaml +++ b/docs/includes/swagger/cds_energy_sdh.yaml @@ -3,7 +3,7 @@ info: description: Consumer Data Right end points and payloads for Secondary Data Holder for the Energy sector title: CDR Energy Secondary Data Holder API - version: 1.22.0 + version: 1.22.1 servers: - url: / paths: @@ -114,7 +114,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                              • [400 - Invalid Field](#error-400-field-invalid)
                              • [400 - Invalid Page Size](#error-400-field-invalid-page-size)
                              • [400 - Invalid Version](#error-400-header-invalid-version)
                              @@ -133,7 +133,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                              • [406 - Unsupported Version](#error-406-header-unsupported-version)
                              headers: @@ -151,7 +151,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                              • [422 - Invalid Page](#error-422-field-invalid-page)
                              headers: @@ -268,7 +268,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                              • [400 - Invalid Field](#error-400-field-invalid)
                              • [400 - Invalid Version](#error-400-header-invalid-version)
                              headers: @@ -286,7 +286,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                              • [404 - Unavailable Service Point](#error-404-unavailable-service-point)
                              • [404 - Invalid Service Point](#error-404-invalid-service-point)
                              @@ -305,7 +305,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                              • [406 - Unsupported Version](#error-406-header-unsupported-version)
                              headers: @@ -476,7 +476,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                              • [400 - Invalid Field](#error-400-field-invalid)
                              • [400 - Invalid Page Size](#error-400-field-invalid-page-size)
                              • [400 - Invalid Version](#error-400-header-invalid-version)
                              @@ -495,7 +495,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                              • [404 - Unavailable Service Point](#error-404-unavailable-service-point)
                              • [404 - Invalid Service Point](#error-404-invalid-service-point)
                              @@ -514,7 +514,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                              • [406 - Unsupported Version](#error-406-header-unsupported-version)
                              headers: @@ -532,7 +532,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                              • [422 - Invalid Page](#error-422-field-invalid-page)
                              headers: @@ -695,7 +695,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                              • [400 - Invalid Field](#error-400-field-invalid)
                              • [400 - Invalid Page Size](#error-400-field-invalid-page-size)
                              • [400 - Invalid Version](#error-400-header-invalid-version)
                              @@ -714,7 +714,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                              • [406 - Unsupported Version](#error-406-header-unsupported-version)
                              headers: @@ -732,7 +732,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                              • [422 - Invalid Page](#error-422-field-invalid-page)
                              • [422 - Unavailable Service Point](#error-422-unavailable-service-point)
                              • [422 - Invalid @@ -850,7 +850,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                                • [400 - Invalid Field](#error-400-field-invalid)
                                • [400 - Invalid Version](#error-400-header-invalid-version)
                                headers: @@ -868,7 +868,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                                • [404 - Unavailable Service Point](#error-404-unavailable-service-point)
                                • [404 - Invalid Service Point](#error-404-invalid-service-point)
                                @@ -887,7 +887,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                                • [406 - Unsupported Version](#error-406-header-unsupported-version)
                                headers: @@ -1013,7 +1013,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                                • [400 - Invalid Field](#error-400-field-invalid)
                                • [400 - Invalid Page Size](#error-400-field-invalid-page-size)
                                • [400 - Invalid Version](#error-400-header-invalid-version)
                                @@ -1032,7 +1032,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                                • [406 - Unsupported Version](#error-406-header-unsupported-version)
                                headers: @@ -1050,7 +1050,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                                • [422 - Invalid Page](#error-422-field-invalid-page)
                                • [422 - Unavailable Service Point](#error-422-unavailable-service-point)
                                • [422 - Invalid @@ -1895,13 +1895,12 @@ components: required: - data - links - - meta type: object - ErrorListResponse: + ResponseErrorListV2: properties: errors: items: - $ref: '#/components/schemas/ErrorListResponse_errors' + $ref: '#/components/schemas/ResponseErrorListV2_errors' type: array required: - errors @@ -2990,7 +2989,7 @@ components: required: - derRecords type: object - ErrorListResponse_meta: + ResponseErrorListV2_meta: description: Additional data for customised error codes properties: urn: @@ -3001,7 +3000,7 @@ components: type: object x-conditional: - urn - ErrorListResponse_errors: + ResponseErrorListV2_errors: properties: code: description: The code of the error encountered. Where the error is specific @@ -3020,7 +3019,7 @@ components: the problem. type: string meta: - $ref: '#/components/schemas/ErrorListResponse_meta' + $ref: '#/components/schemas/ResponseErrorListV2_meta' required: - code - detail @@ -3083,7 +3082,8 @@ components: party: party properties: party: - description: The name of the party/orginsation related to this service point + description: The name of the party/organisation related to this service + point type: string role: description: 'The role performed by this participant in relation to the diff --git a/docs/includes/swagger/cds_register.json b/docs/includes/swagger/cds_register.json index 19feed09..40e49716 100644 --- a/docs/includes/swagger/cds_register.json +++ b/docs/includes/swagger/cds_register.json @@ -2,7 +2,7 @@ "openapi" : "3.0.3", "info" : { "title" : "CDR Participant Discovery API", - "version" : "1.22.0" + "version" : "1.22.1" }, "servers" : [ { "url" : "https:///" diff --git a/docs/includes/swagger/cds_register.yaml b/docs/includes/swagger/cds_register.yaml index c7af6407..0b1cbd07 100644 --- a/docs/includes/swagger/cds_register.yaml +++ b/docs/includes/swagger/cds_register.yaml @@ -1,7 +1,7 @@ openapi: 3.0.3 info: title: CDR Participant Discovery API - version: 1.22.0 + version: 1.22.1 servers: - url: https:/// paths: diff --git a/docs/includes/swagger/cds_telco.json b/docs/includes/swagger/cds_telco.json index a486f86f..b0e1358c 100644 --- a/docs/includes/swagger/cds_telco.json +++ b/docs/includes/swagger/cds_telco.json @@ -12,7 +12,7 @@ "url" : "https://opensource.org/licenses/MIT" }, "title" : "CDR Telco API", - "version" : "1.22.0" + "version" : "1.22.1" }, "servers" : [ { "url" : "https://data.holder.com.au/cds-au/v1" @@ -23,26 +23,25 @@ "description" : "Obtain a list of telco products that are currently offered to the market.\n\nNote that the results returned by this end point are expected to be ordered in descending order according to `lastUpdated`.", "operationId" : "listProducts", "parameters" : [ { - "description" : "Used to filter results on the type field. Any one of the valid values for this field can be supplied. If absent, defaults to include all products. Valid values are ‘MOBILE’, ‘BROADBAND’", + "description" : "Used to filter results on the type field. Any one of the valid values for this field can be supplied. If absent, defaults to include ALL products. Valid values are [MOBILE](https://www.legislation.gov.au/Details/C2022C00170/Html/Volume_1#_Toc95898745) service. BROADBAND fixed internet service or ALL", "explode" : true, "in" : "query", "name" : "type", "required" : false, "schema" : { - "default" : "MOBILE", - "enum" : [ "MOBILE", "BROADBAND" ], + "default" : "ALL", + "enum" : [ "MOBILE", "BROADBAND", "ALL" ], "type" : "string" }, "style" : "form" }, { - "description" : "Used to filter results on the billing-type field. Any one of the valid values for this field can be supplied. If absent, defaults to include all billing types. Valid values are ‘PRE_PAID’, ‘POST_PAID’, 'UPFRONT_PAID', 'OTHER'", + "description" : "Used to filter results on the billing-type field. Any one of the valid values for this field can be supplied. If absent, defaults to include all billing types. Valid values are ‘PRE_PAID’, ‘POST_PAID’, 'UPFRONT_PAID', 'ALL'", "explode" : true, "in" : "query", "name" : "billing-type", "required" : false, "schema" : { - "default" : "PRE_PAID", - "enum" : [ "PRE_PAID", "POST_PAID", "UPFRONT_PAID", "OTHER" ], + "enum" : [ "PRE_PAID", "POST_PAID", "UPFRONT_PAID", "ALL" ], "type" : "string" }, "style" : "form" @@ -134,12 +133,7 @@ "description" : "Successful response", "headers" : { "x-v" : { - "explode" : false, - "schema" : { - "description" : "The [version](#response-headers) of the API end point that the data holder has responded with.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-v" } } }, @@ -147,61 +141,31 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, - "description" : "The following error codes MUST be supported:
                                  • [400 - Invalid Field](#error-400-field-invalid)
                                  • [400 - Invalid Page Size](#error-400-field-invalid-page-size)
                                  • [400 - Invalid Version](#error-400-header-invalid-version)
                                  ", - "headers" : { - "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" - } - } + "description" : "The following error codes MUST be supported:
                                  • [400 - Invalid Field](#error-400-field-invalid)
                                  • [400 - Invalid Page Size](#error-400-field-invalid-page-size)
                                  • [400 - Invalid Version](#error-400-header-invalid-version)
                                  " }, "406" : { "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, - "description" : "The following error codes MUST be supported:
                                  • [406 - Unsupported Version](#error-406-header-unsupported-version)
                                  ", - "headers" : { - "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" - } - } + "description" : "The following error codes MUST be supported:
                                  • [406 - Unsupported Version](#error-406-header-unsupported-version)
                                  " }, "422" : { "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, - "description" : "The following error codes MUST be supported:
                                  • [422 - Invalid Page](#error-422-field-invalid-page)
                                  ", - "headers" : { - "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" - } - } + "description" : "The following error codes MUST be supported:
                                  • [422 - Invalid Page](#error-422-field-invalid-page)
                                  " } }, "summary" : "Get Telco Products", @@ -256,12 +220,7 @@ "description" : "Successful response", "headers" : { "x-v" : { - "explode" : false, - "schema" : { - "description" : "The [version](#response-headers) of the API end point that the data holder has responded with.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-v" } } }, @@ -269,61 +228,31 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, - "description" : "The following error codes MUST be supported:
                                  • [400 - Invalid Field](#error-400-field-invalid)
                                  • [400 - Invalid Version](#error-400-header-invalid-version)
                                  ", - "headers" : { - "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" - } - } + "description" : "The following error codes MUST be supported:
                                  • [400 - Invalid Field](#error-400-field-invalid)
                                  • [400 - Invalid Version](#error-400-header-invalid-version)
                                  " }, "404" : { "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, - "description" : "The following error codes MUST be supported:
                                  • [404 - Invalid Resource](#error-404-resource-invalid)
                                  ", - "headers" : { - "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" - } - } + "description" : "The following error codes MUST be supported:
                                  • [404 - Invalid Resource](#error-404-resource-invalid)
                                  " }, "406" : { "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, - "description" : "The following error codes MUST be supported:
                                  • [406 - Unsupported Version](#error-406-header-unsupported-version)
                                  ", - "headers" : { - "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" - } - } + "description" : "The following error codes MUST be supported:
                                  • [406 - Unsupported Version](#error-406-header-unsupported-version)
                                  " } }, "summary" : "Get Telco Product Detail", @@ -336,7 +265,7 @@ "description" : "Obtain a usage data from a particular service Id", "operationId" : "getUsageForService", "parameters" : [ { - "description" : "ID of the specific service requested such as a mobile [MSISDN](https://www.etsi.org/deliver/etsi_gts/03/0303/05.00.00_60/gsmts_0303v050000p.pdf), [FNN](https://www.nbnco.com.au/content/dam/nbnco2/documents/sfaa-wba2-dictionary_FTTN-launch.pdf) or internet service e.g [NBN AVC Service ID](https://www.nbnco.com.au/content/dam/nbnco2/documents/sfaa-wba2-dictionary_FTTN-launch.pdf). This is a tokenised ID returned from the account. In accordance with [CDR ID permanence](#id-permanence) requirements", + "description" : "ID of the specific service requested. E.g. a mobile [MSISDN](https://www.etsi.org/deliver/etsi_gts/03/0303/05.00.00_60/gsmts_0303v050000p.pdf), [FNN](https://www.nbnco.com.au/content/dam/nbnco2/documents/sfaa-wba2-dictionary_FTTN-launch.pdf) or internet service e.g [NBN AVC Service ID](https://www.nbnco.com.au/content/dam/nbnco2/documents/sfaa-wba2-dictionary_FTTN-launch.pdf). This is a tokenised ID returned from the account. In accordance with [CDR ID permanence](#id-permanence) requirements", "explode" : false, "in" : "path", "name" : "serviceId", @@ -367,28 +296,6 @@ }, "style" : "form", "x-cds-type" : "DateString" - }, { - "description" : "Page of results to request (standard pagination)", - "explode" : true, - "in" : "query", - "name" : "page", - "required" : false, - "schema" : { - "type" : "integer" - }, - "style" : "form", - "x-cds-type" : "PositiveInteger" - }, { - "description" : "Page size to request. Default is 25 (standard pagination)", - "explode" : true, - "in" : "query", - "name" : "page-size", - "required" : false, - "schema" : { - "type" : "integer" - }, - "style" : "form", - "x-cds-type" : "PositiveInteger" }, { "description" : "Version of the API end point requested by the client. Must be set to a positive integer. The data holder 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 data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)", "explode" : false, @@ -465,20 +372,10 @@ "description" : "Successful response", "headers" : { "x-v" : { - "explode" : false, - "schema" : { - "description" : "The [version](#response-headers) of the API end point that the data holder has responded with.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-v" }, "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-fapi-interaction-id" } } }, @@ -486,19 +383,14 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes MUST be supported:
                                  • [400 - Invalid Field](#error-400-field-invalid)
                                  • [400 - Invalid Page Size](#error-400-field-invalid-page-size)
                                  • [400 - Invalid Version](#error-400-header-invalid-version)
                                  ", "headers" : { "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-fapi-interaction-id" } } }, @@ -506,19 +398,14 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes MUST be supported:
                                  • [404 - Unavailable Service Point](#error-404-unavailable-service-point)
                                  • [404 - Invalid Service Point](#error-404-invalid-service-point)
                                  ", "headers" : { "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-fapi-interaction-id" } } }, @@ -526,19 +413,14 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes MUST be supported:
                                  • [406 - Unsupported Version](#error-406-header-unsupported-version)
                                  ", "headers" : { "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-fapi-interaction-id" } } }, @@ -546,19 +428,14 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes MUST be supported:
                                  • [422 - Invalid Page](#error-422-field-invalid-page)
                                  ", "headers" : { "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-fapi-interaction-id" } } } @@ -693,20 +570,10 @@ "description" : "Successful response", "headers" : { "x-v" : { - "explode" : false, - "schema" : { - "description" : "The [version](#response-headers) of the API end point that the data holder has responded with.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-v" }, "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-fapi-interaction-id" } } }, @@ -714,19 +581,14 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes MUST be supported:
                                  • [400 - Invalid Field](#error-400-field-invalid)
                                  • [400 - Invalid Page Size](#error-400-field-invalid-page-size)
                                  • [400 - Invalid Version](#error-400-header-invalid-version)
                                  ", "headers" : { "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-fapi-interaction-id" } } }, @@ -734,19 +596,14 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes MUST be supported:
                                  • [406 - Unsupported Version](#error-406-header-unsupported-version)
                                  ", "headers" : { "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-fapi-interaction-id" } } }, @@ -754,19 +611,14 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes MUST be supported:
                                  • [422 - Invalid Page](#error-422-field-invalid-page)
                                  ", "headers" : { "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-fapi-interaction-id" } } } @@ -780,28 +632,6 @@ "description" : "Obtain usage data for a specific service", "operationId" : "listUsageForService", "parameters" : [ { - "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", - "explode" : true, - "in" : "query", - "name" : "oldest-date", - "required" : false, - "schema" : { - "type" : "string" - }, - "style" : "form", - "x-cds-type" : "DateString" - }, { - "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", - "explode" : true, - "in" : "query", - "name" : "newest-date", - "required" : false, - "schema" : { - "type" : "string" - }, - "style" : "form", - "x-cds-type" : "DateString" - }, { "description" : "Page of results to request (standard pagination)", "explode" : true, "in" : "query", @@ -895,27 +725,17 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/TelcoServiceUsageListResponse" + "$ref" : "#/components/schemas/TelcoUsageListResponse" } } }, "description" : "Successful response", "headers" : { "x-v" : { - "explode" : false, - "schema" : { - "description" : "The [version](#response-headers) of the API end point that the data holder has responded with.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-v" }, "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-fapi-interaction-id" } } }, @@ -923,19 +743,14 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes MUST be supported:
                                  • [400 - Invalid Field](#error-400-field-invalid)
                                  • [400 - Invalid Page Size](#error-400-field-invalid-page-size)
                                  • [400 - Invalid Version](#error-400-header-invalid-version)
                                  ", "headers" : { "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-fapi-interaction-id" } } }, @@ -943,19 +758,14 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes MUST be supported:
                                  • [406 - Unsupported Version](#error-406-header-unsupported-version)
                                  ", "headers" : { "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-fapi-interaction-id" } } }, @@ -963,19 +773,14 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes MUST be supported:
                                  • [422 - Invalid Page](#error-422-field-invalid-page)
                                  • [422 - Unavailable Service Point](#error-422-unavailable-service-point)
                                  • [422 - Invalid Service Point](#error-422-invalid-service-point)
                                  ", "headers" : { "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-fapi-interaction-id" } } } @@ -1002,6 +807,17 @@ "type" : "string" }, "style" : "form" + }, { + "description" : "Only include accounts that have been updated after the specified date and time. If absent defaults to include all plans", + "explode" : true, + "in" : "query", + "name" : "updated-since", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "form", + "x-cds-type" : "DateString" }, { "description" : "Page of results to request (standard pagination)", "explode" : true, @@ -1100,20 +916,10 @@ "description" : "Successful response", "headers" : { "x-v" : { - "explode" : false, - "schema" : { - "description" : "The [version](#response-headers) of the API end point that the data holder has responded with.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-v" }, "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-fapi-interaction-id" } } }, @@ -1121,19 +927,14 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes MUST be supported:
                                  • [400 - Invalid Field](#error-400-field-invalid)
                                  • [400 - Invalid Page Size](#error-400-field-invalid-page-size)
                                  • [400 - Invalid Version](#error-400-header-invalid-version)
                                  ", "headers" : { "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-fapi-interaction-id" } } }, @@ -1141,19 +942,14 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes MUST be supported:
                                  • [406 - Unsupported Version](#error-406-header-unsupported-version)
                                  ", "headers" : { "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-fapi-interaction-id" } } }, @@ -1161,19 +957,14 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes MUST be supported:
                                  • [422 - Invalid Page](#error-422-field-invalid-page)
                                  ", "headers" : { "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-fapi-interaction-id" } } } @@ -1189,7 +980,7 @@ "description" : "Obtain detailed information for a specific telco account\n\nOther Versions: [v1](includes/obsolete/get-telco-account-detail-v1.html)", "operationId" : "getAccount", "parameters" : [ { - "description" : "ID of a specific account to obtain data for. This is a tokenised ID previously obtained from the Account List end point. In accordance with [CDR ID permanence](#id-permanence) requirements", + "description" : "ID of a specific account to obtain data for. This is a tokenised ID previously obtained from the Account List end point. In accordance with [CDR ID permanence](#id-permanence) requirements", "explode" : false, "in" : "path", "name" : "accountId", @@ -1274,20 +1065,10 @@ "description" : "Successful response", "headers" : { "x-v" : { - "explode" : false, - "schema" : { - "description" : "The [version](#response-headers) of the API end point that the data holder has responded with.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-v" }, "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-fapi-interaction-id" } } }, @@ -1295,19 +1076,14 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes MUST be supported:
                                  • [400 - Invalid Field](#error-400-field-invalid)
                                  • [400 - Invalid Version](#error-400-header-invalid-version)
                                  ", "headers" : { "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-fapi-interaction-id" } } }, @@ -1315,19 +1091,14 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes MUST be supported:
                                  • [404 - Unavailable Telco Account](#error-404-unavailable-telco-account)
                                  • [404 - Invalid Telco Account](#error-404-invalid-telco-account)
                                  ", "headers" : { "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-fapi-interaction-id" } } }, @@ -1335,19 +1106,14 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes MUST be supported:
                                  • [406 - Unsupported Version](#error-406-header-unsupported-version)
                                  ", "headers" : { "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-fapi-interaction-id" } } } @@ -1363,7 +1129,7 @@ "description" : "Obtain the agreed payment schedule and details, if any, for a specific telco account. \n\nSome general notes about this end point:\n\n
                                  • This API describes how the consumer has elected to pay for their account
                                  • Payments initiated by the consumer are classified as manual payments. The billing frequency is captured for manual payments. The consumer may choose to pay on a different schedule/frequency. The payment method and frequency is not captured for manual payments
                                  • Payments that can be initiated by the retailer, based on a consumer's preferences and permission, include payments based on a direct debit, card debit or digital wallet setup. Each of these requires a payment frequency to be provided along with other relevant fields
                                  • Information about payment plans related to debt repayments or arrangements due to hardship is not captured within this API
                                  ", "operationId" : "getPaymentSchedule", "parameters" : [ { - "description" : "ID of a specific account to obtain data for. This is a tokenised ID previously obtained from the Account List end point. In accordance with [CDR ID permanence](#id-permanence) requirements", + "description" : "ID of a specific account to obtain data for. This is a tokenised ID previously obtained from the Account List end point. In accordance with [CDR ID permanence](#id-permanence) requirements", "explode" : false, "in" : "path", "name" : "accountId", @@ -1448,20 +1214,10 @@ "description" : "Successful response", "headers" : { "x-v" : { - "explode" : false, - "schema" : { - "description" : "The [version](#response-headers) of the API end point that the data holder has responded with.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-v" }, "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-fapi-interaction-id" } } }, @@ -1469,19 +1225,14 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes MUST be supported:
                                  • [400 - Invalid Field](#error-400-field-invalid)
                                  • [400 - Invalid Version](#error-400-header-invalid-version)
                                  ", "headers" : { "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-fapi-interaction-id" } } }, @@ -1489,19 +1240,14 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes MUST be supported:
                                  • [404 - Unavailable Telco Account](#error-404-unavailable-telco-account)
                                  • [404 - Invalid Telco Account](#error-404-invalid-telco-account)
                                  ", "headers" : { "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-fapi-interaction-id" } } }, @@ -1509,19 +1255,14 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes MUST be supported:
                                  • [406 - Unsupported Version](#error-406-header-unsupported-version)
                                  ", "headers" : { "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-fapi-interaction-id" } } } @@ -1537,7 +1278,7 @@ "description" : "Obtain the details of any concessions or arrangements applied to a specific telco account", "operationId" : "getConcessions", "parameters" : [ { - "description" : "ID of a specific account to obtain data for. This is a tokenised ID previously obtained from the Account List end point. In accordance with [CDR ID permanence](#id-permanence) requirements", + "description" : "ID of a specific account to obtain data for. This is a tokenised ID previously obtained from the Account List end point. In accordance with [CDR ID permanence](#id-permanence) requirements", "explode" : false, "in" : "path", "name" : "accountId", @@ -1622,20 +1363,10 @@ "description" : "Successful response", "headers" : { "x-v" : { - "explode" : false, - "schema" : { - "description" : "The [version](#response-headers) of the API end point that the data holder has responded with.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-v" }, "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-fapi-interaction-id" } } }, @@ -1643,19 +1374,14 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes MUST be supported:
                                  • [400 - Invalid Field](#error-400-field-invalid)
                                  • [400 - Invalid Version](#error-400-header-invalid-version)
                                  ", "headers" : { "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-fapi-interaction-id" } } }, @@ -1663,19 +1389,14 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes MUST be supported:
                                  • [404 - Unavailable Telco Account](#error-404-unavailable-telco-account)
                                  • [404 - Invalid Telco Account](#error-404-invalid-telco-account)
                                  ", "headers" : { "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-fapi-interaction-id" } } }, @@ -1683,19 +1404,14 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes MUST be supported:
                                  • [406 - Unsupported Version](#error-406-header-unsupported-version)
                                  ", "headers" : { "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-fapi-interaction-id" } } } @@ -1711,7 +1427,7 @@ "description" : "Obtain the current balance for a specific account", "operationId" : "getBalanceForAccount", "parameters" : [ { - "description" : "ID of a specific account to obtain data for. This is a tokenised ID previously obtained from the Account List end point. In accordance with [CDR ID permanence](#id-permanence) requirements", + "description" : "ID of a specific account to obtain data for. This is a tokenised ID previously obtained from the Account List end point. In accordance with [CDR ID permanence](#id-permanence) requirements", "explode" : false, "in" : "path", "name" : "accountId", @@ -1796,20 +1512,10 @@ "description" : "Successful response", "headers" : { "x-v" : { - "explode" : false, - "schema" : { - "description" : "The [version](#response-headers) of the API end point that the data holder has responded with.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-v" }, "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-fapi-interaction-id" } } }, @@ -1817,19 +1523,14 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes MUST be supported:
                                  • [400 - Invalid Field](#error-400-field-invalid)
                                  • [400 - Invalid Version](#error-400-header-invalid-version)
                                  ", "headers" : { "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-fapi-interaction-id" } } }, @@ -1837,19 +1538,14 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes MUST be supported:
                                  • [404 - Unavailable Telco Account](#error-404-unavailable-telco-account)
                                  • [404 - Invalid Telco Account](#error-404-invalid-telco-account)
                                  ", "headers" : { "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-fapi-interaction-id" } } }, @@ -1857,19 +1553,14 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes MUST be supported:
                                  • [406 - Unsupported Version](#error-406-header-unsupported-version)
                                  ", "headers" : { "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-fapi-interaction-id" } } } @@ -1982,20 +1673,10 @@ "description" : "Successful response", "headers" : { "x-v" : { - "explode" : false, - "schema" : { - "description" : "The [version](#response-headers) of the API end point that the data holder has responded with.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-v" }, "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-fapi-interaction-id" } } }, @@ -2003,19 +1684,14 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes MUST be supported:
                                  • [400 - Invalid Field](#error-400-field-invalid)
                                  • [400 - Invalid Page Size](#error-400-field-invalid-page-size)
                                  • [400 - Invalid Version](#error-400-header-invalid-version)
                                  ", "headers" : { "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-fapi-interaction-id" } } }, @@ -2023,19 +1699,14 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes MUST be supported:
                                  • [406 - Unsupported Version](#error-406-header-unsupported-version)
                                  ", "headers" : { "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-fapi-interaction-id" } } }, @@ -2043,19 +1714,14 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes MUST be supported:
                                  • [422 - Invalid Page](#error-422-field-invalid-page)
                                  ", "headers" : { "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-fapi-interaction-id" } } } @@ -2169,20 +1835,10 @@ "description" : "Successful response", "headers" : { "x-v" : { - "explode" : false, - "schema" : { - "description" : "The [version](#response-headers) of the API end point that the data holder has responded with.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-v" }, "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-fapi-interaction-id" } } }, @@ -2190,19 +1846,14 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes MUST be supported:
                                  • [400 - Invalid Field](#error-400-field-invalid)
                                  • [400 - Invalid Page Size](#error-400-field-invalid-page-size)
                                  • [400 - Invalid Version](#error-400-header-invalid-version)
                                  ", "headers" : { "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-fapi-interaction-id" } } }, @@ -2210,19 +1861,14 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes MUST be supported:
                                  • [406 - Unsupported Version](#error-406-header-unsupported-version)
                                  ", "headers" : { "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-fapi-interaction-id" } } }, @@ -2230,19 +1876,14 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes MUST be supported:
                                  • [422 - Invalid Page](#error-422-field-invalid-page)
                                  • [422 - Unavailable Telco Account](#error-422-unavailable-telco-account)
                                  • [422 - Invalid Telco Account](#error-422-invalid-telco-account)
                                  ", "headers" : { "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-fapi-interaction-id" } } } @@ -2258,7 +1899,7 @@ "description" : "Obtain the invoices for a specific account", "operationId" : "getInvoicesForAccount", "parameters" : [ { - "description" : "ID of a specific account to obtain data for. This is a tokenised ID previously obtained from the Account List end point. In accordance with [CDR ID permanence](#id-permanence) requirements", + "description" : "ID of a specific account to obtain data for. This is a tokenised ID previously obtained from the Account List end point. In accordance with [CDR ID permanence](#id-permanence) requirements", "explode" : false, "in" : "path", "name" : "accountId", @@ -2267,50 +1908,6 @@ "type" : "string" }, "style" : "simple" - }, { - "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", - "explode" : true, - "in" : "query", - "name" : "newest-date", - "required" : false, - "schema" : { - "type" : "string" - }, - "style" : "form", - "x-cds-type" : "DateString" - }, { - "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", - "explode" : true, - "in" : "query", - "name" : "oldest-date", - "required" : false, - "schema" : { - "type" : "string" - }, - "style" : "form", - "x-cds-type" : "DateString" - }, { - "description" : "Page of results to request (standard pagination)", - "explode" : true, - "in" : "query", - "name" : "page", - "required" : false, - "schema" : { - "type" : "integer" - }, - "style" : "form", - "x-cds-type" : "PositiveInteger" - }, { - "description" : "Page size to request. Default is 25 (standard pagination)", - "explode" : true, - "in" : "query", - "name" : "page-size", - "required" : false, - "schema" : { - "type" : "integer" - }, - "style" : "form", - "x-cds-type" : "PositiveInteger" }, { "description" : "Version of the API end point requested by the client. Must be set to a positive integer. The data holder 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 data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)", "explode" : false, @@ -2380,27 +1977,17 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/TelcoInvoiceListResponse" + "$ref" : "#/components/schemas/TelcoInvoiceResponse" } } }, "description" : "Successful response", "headers" : { "x-v" : { - "explode" : false, - "schema" : { - "description" : "The [version](#response-headers) of the API end point that the data holder has responded with.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-v" }, "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-fapi-interaction-id" } } }, @@ -2408,19 +1995,14 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes MUST be supported:
                                  • [400 - Invalid Field](#error-400-field-invalid)
                                  • [400 - Invalid Page Size](#error-400-field-invalid-page-size)
                                  • [400 - Invalid Version](#error-400-header-invalid-version)
                                  ", "headers" : { "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-fapi-interaction-id" } } }, @@ -2428,19 +2010,14 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes MUST be supported:
                                  • [404 - Unavailable Telco Account](#error-404-unavailable-telco-account)
                                  • [404 - Invalid Telco Account](#error-404-invalid-telco-account)
                                  ", "headers" : { "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-fapi-interaction-id" } } }, @@ -2448,19 +2025,14 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes MUST be supported:
                                  • [406 - Unsupported Version](#error-406-header-unsupported-version)
                                  ", "headers" : { "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-fapi-interaction-id" } } }, @@ -2468,19 +2040,14 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes MUST be supported:
                                  • [422 - Invalid Page](#error-422-field-invalid-page)
                                  ", "headers" : { "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-fapi-interaction-id" } } } @@ -2615,20 +2182,10 @@ "description" : "Successful response", "headers" : { "x-v" : { - "explode" : false, - "schema" : { - "description" : "The [version](#response-headers) of the API end point that the data holder has responded with.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-v" }, "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-fapi-interaction-id" } } }, @@ -2636,19 +2193,14 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes MUST be supported:
                                  • [400 - Invalid Field](#error-400-field-invalid)
                                  • [400 - Invalid Page Size](#error-400-field-invalid-page-size)
                                  • [400 - Invalid Version](#error-400-header-invalid-version)
                                  ", "headers" : { "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-fapi-interaction-id" } } }, @@ -2656,19 +2208,14 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes MUST be supported:
                                  • [406 - Unsupported Version](#error-406-header-unsupported-version)
                                  ", "headers" : { "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-fapi-interaction-id" } } }, @@ -2676,19 +2223,14 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes MUST be supported:
                                  • [422 - Invalid Page](#error-422-field-invalid-page)
                                  ", "headers" : { "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-fapi-interaction-id" } } } @@ -2824,20 +2366,10 @@ "description" : "Successful response", "headers" : { "x-v" : { - "explode" : false, - "schema" : { - "description" : "The [version](#response-headers) of the API end point that the data holder has responded with.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-v" }, "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-fapi-interaction-id" } } }, @@ -2845,19 +2377,14 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes MUST be supported:
                                  • [400 - Invalid Field](#error-400-field-invalid)
                                  • [400 - Invalid Page Size](#error-400-field-invalid-page-size)
                                  • [400 - Invalid Version](#error-400-header-invalid-version)
                                  ", "headers" : { "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-fapi-interaction-id" } } }, @@ -2865,19 +2392,14 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes MUST be supported:
                                  • [406 - Unsupported Version](#error-406-header-unsupported-version)
                                  ", "headers" : { "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-fapi-interaction-id" } } }, @@ -2885,19 +2407,14 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes MUST be supported:
                                  • [422 - Invalid Page](#error-422-field-invalid-page)
                                  • [422 - Unavailable Telco Account](#error-422-unavailable-telco-account)
                                  • [422 - Invalid Telco Account](#error-422-invalid-telco-account)
                                  ", "headers" : { "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-fapi-interaction-id" } } } @@ -2913,7 +2430,7 @@ "description" : "Obtain the billing transactions for a specific account", "operationId" : "getTransactionsForAccount", "parameters" : [ { - "description" : "ID of a specific account to obtain data for. This is a tokenised ID previously obtained from the Account List end point. In accordance with [CDR ID permanence](#id-permanence) requirements", + "description" : "ID of a specific account to obtain data for. This is a tokenised ID previously obtained from the Account List end point. In accordance with [CDR ID permanence](#id-permanence) requirements", "explode" : false, "in" : "path", "name" : "accountId", @@ -3042,20 +2559,10 @@ "description" : "Successful response", "headers" : { "x-v" : { - "explode" : false, - "schema" : { - "description" : "The [version](#response-headers) of the API end point that the data holder has responded with.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-v" }, "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-fapi-interaction-id" } } }, @@ -3063,19 +2570,14 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes MUST be supported:
                                  • [400 - Invalid Field](#error-400-field-invalid)
                                  • [400 - Invalid Page Size](#error-400-field-invalid-page-size)
                                  • [400 - Invalid Version](#error-400-header-invalid-version)
                                  ", "headers" : { "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-fapi-interaction-id" } } }, @@ -3083,19 +2585,14 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes MUST be supported:
                                  • [404 - Unavailable Telco Account](#error-404-unavailable-telco-account)
                                  • [404 - Invalid Telco Account](#error-404-invalid-telco-account)
                                  ", "headers" : { "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-fapi-interaction-id" } } }, @@ -3103,19 +2600,14 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes MUST be supported:
                                  • [406 - Unsupported Version](#error-406-header-unsupported-version)
                                  ", "headers" : { "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-fapi-interaction-id" } } }, @@ -3123,19 +2615,14 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes MUST be supported:
                                  • [422 - Invalid Page](#error-422-field-invalid-page)
                                  ", "headers" : { "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-fapi-interaction-id" } } } @@ -3270,20 +2757,10 @@ "description" : "Successful response", "headers" : { "x-v" : { - "explode" : false, - "schema" : { - "description" : "The [version](#response-headers) of the API end point that the data holder has responded with.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-v" }, "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-fapi-interaction-id" } } }, @@ -3291,19 +2768,14 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes MUST be supported:
                                  • [400 - Invalid Field](#error-400-field-invalid)
                                  • [400 - Invalid Page Size](#error-400-field-invalid-page-size)
                                  • [400 - Invalid Version](#error-400-header-invalid-version)
                                  ", "headers" : { "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-fapi-interaction-id" } } }, @@ -3311,19 +2783,14 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes MUST be supported:
                                  • [406 - Unsupported Version](#error-406-header-unsupported-version)
                                  ", "headers" : { "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-fapi-interaction-id" } } }, @@ -3331,19 +2798,14 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes MUST be supported:
                                  • [422 - Invalid Page](#error-422-field-invalid-page)
                                  ", "headers" : { "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-fapi-interaction-id" } } } @@ -3479,20 +2941,10 @@ "description" : "Successful response", "headers" : { "x-v" : { - "explode" : false, - "schema" : { - "description" : "The [version](#response-headers) of the API end point that the data holder has responded with.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-v" }, "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-fapi-interaction-id" } } }, @@ -3500,19 +2952,14 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes MUST be supported:
                                  • [400 - Invalid Field](#error-400-field-invalid)
                                  • [400 - Invalid Page Size](#error-400-field-invalid-page-size)
                                  • [400 - Invalid Version](#error-400-header-invalid-version)
                                  ", "headers" : { "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-fapi-interaction-id" } } }, @@ -3520,19 +2967,14 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes MUST be supported:
                                  • [406 - Unsupported Version](#error-406-header-unsupported-version)
                                  ", "headers" : { "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-fapi-interaction-id" } } }, @@ -3540,19 +2982,14 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ErrorListResponse" + "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes MUST be supported:
                                  • [422 - Invalid Page](#error-422-field-invalid-page)
                                  • [422 - Unavailable Telco Account](#error-422-unavailable-telco-account)
                                  • [422 - Invalid Telco Account](#error-422-invalid-telco-account)
                                  ", "headers" : { "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-fapi-interaction-id" } } } @@ -3565,6 +3002,24 @@ } }, "components" : { + "headers" : { + "x-v" : { + "explode" : false, + "schema" : { + "description" : "The [version](#response-headers) of the API end point that the data holder has responded with.", + "type" : "string" + }, + "style" : "simple" + }, + "x-fapi-interaction-id" : { + "explode" : false, + "schema" : { + "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.", + "type" : "string" + }, + "style" : "simple" + } + }, "parameters" : { "serviceId" : { "description" : "ID of the specific service requested. E.g. a mobile [MSISDN](https://www.etsi.org/deliver/etsi_gts/03/0303/05.00.00_60/gsmts_0303v050000p.pdf), [FNN](https://www.nbnco.com.au/content/dam/nbnco2/documents/sfaa-wba2-dictionary_FTTN-launch.pdf) or internet service e.g [NBN AVC Service ID](https://www.nbnco.com.au/content/dam/nbnco2/documents/sfaa-wba2-dictionary_FTTN-launch.pdf). This is a tokenised ID returned from the account. In accordance with [CDR ID permanence](#id-permanence) requirements", @@ -3588,17 +3043,6 @@ }, "style" : "simple" }, - "accountIds" : { - "description" : "A seperated array of account IDs of specific accounts to obtain data for. This is a tokenised ID previously obtained from the Account List end point. In accordance with [CDR ID permanence](#id-permanence) requirements", - "explode" : false, - "in" : "path", - "name" : "accountIds", - "required" : true, - "schema" : { - "type" : "string" - }, - "style" : "simple" - }, "open-status" : { "description" : "Used to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed", "explode" : true, @@ -3828,12 +3272,7 @@ "description" : "Successful response", "headers" : { "x-v" : { - "explode" : false, - "schema" : { - "description" : "The [version](#response-headers) of the API end point that the data holder has responded with.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-v" } } }, @@ -3848,12 +3287,7 @@ "description" : "Successful response", "headers" : { "x-v" : { - "explode" : false, - "schema" : { - "description" : "The [version](#response-headers) of the API end point that the data holder has responded with.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-v" } } }, @@ -3868,20 +3302,10 @@ "description" : "Successful response", "headers" : { "x-v" : { - "explode" : false, - "schema" : { - "description" : "The [version](#response-headers) of the API end point that the data holder has responded with.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-v" }, "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-fapi-interaction-id" } } }, @@ -3896,20 +3320,10 @@ "description" : "Successful response", "headers" : { "x-v" : { - "explode" : false, - "schema" : { - "description" : "The [version](#response-headers) of the API end point that the data holder has responded with.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-v" }, "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-fapi-interaction-id" } } }, @@ -3924,20 +3338,10 @@ "description" : "Successful response", "headers" : { "x-v" : { - "explode" : false, - "schema" : { - "description" : "The [version](#response-headers) of the API end point that the data holder has responded with.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-v" }, "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-fapi-interaction-id" } } }, @@ -3952,20 +3356,10 @@ "description" : "Successful response", "headers" : { "x-v" : { - "explode" : false, - "schema" : { - "description" : "The [version](#response-headers) of the API end point that the data holder has responded with.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-v" }, "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-fapi-interaction-id" } } }, @@ -3980,20 +3374,10 @@ "description" : "Successful response", "headers" : { "x-v" : { - "explode" : false, - "schema" : { - "description" : "The [version](#response-headers) of the API end point that the data holder has responded with.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-v" }, "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-fapi-interaction-id" } } }, @@ -4008,20 +3392,7 @@ "description" : "Successful response", "headers" : { "x-v" : { - "explode" : false, - "schema" : { - "description" : "The [version](#response-headers) of the API end point that the data holder has responded with.", - "type" : "string" - }, - "style" : "simple" - }, - "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-v" } } }, @@ -4036,20 +3407,7 @@ "description" : "Successful response", "headers" : { "x-v" : { - "explode" : false, - "schema" : { - "description" : "The [version](#response-headers) of the API end point that the data holder has responded with.", - "type" : "string" - }, - "style" : "simple" - }, - "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-v" } } }, @@ -4064,20 +3422,7 @@ "description" : "Successful response", "headers" : { "x-v" : { - "explode" : false, - "schema" : { - "description" : "The [version](#response-headers) of the API end point that the data holder has responded with.", - "type" : "string" - }, - "style" : "simple" - }, - "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-v" } } }, @@ -4092,20 +3437,7 @@ "description" : "Successful response", "headers" : { "x-v" : { - "explode" : false, - "schema" : { - "description" : "The [version](#response-headers) of the API end point that the data holder has responded with.", - "type" : "string" - }, - "style" : "simple" - }, - "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-v" } } }, @@ -4120,20 +3452,10 @@ "description" : "Successful response", "headers" : { "x-v" : { - "explode" : false, - "schema" : { - "description" : "The [version](#response-headers) of the API end point that the data holder has responded with.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-v" }, "x-fapi-interaction-id" : { - "explode" : false, - "schema" : { - "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.", - "type" : "string" - }, - "style" : "simple" + "$ref" : "#/components/headers/x-fapi-interaction-id" } } } @@ -4179,10 +3501,10 @@ "$ref" : "#/components/schemas/TelcoAccountUsage" }, "links" : { - "$ref" : "#/components/schemas/LinksPaginated" + "$ref" : "#/components/schemas/Links" }, "meta" : { - "$ref" : "#/components/schemas/MetaPaginated" + "$ref" : "#/components/schemas/Meta" } }, "required" : [ "data", "links", "meta" ], @@ -4194,10 +3516,10 @@ "$ref" : "#/components/schemas/TelcoServiceUsage" }, "links" : { - "$ref" : "#/components/schemas/LinksPaginated" + "$ref" : "#/components/schemas/Links" }, "meta" : { - "$ref" : "#/components/schemas/MetaPaginated" + "$ref" : "#/components/schemas/Meta" } }, "required" : [ "data", "links", "meta" ], @@ -4239,13 +3561,7 @@ "TelcoAccountDetailResponse" : { "properties" : { "data" : { - "allOf" : [ { - "$ref" : "#/components/schemas/TelcoAccountBase" - }, { - "$ref" : "#/components/schemas/TelcoAccount" - }, { - "$ref" : "#/components/schemas/TelcoAccountDetail" - } ] + "$ref" : "#/components/schemas/TelcoAccountDetailResponseData" }, "links" : { "$ref" : "#/components/schemas/Links" @@ -4263,10 +3579,10 @@ "$ref" : "#/components/schemas/TelcoPaymentScheduleResponseData" }, "links" : { - "$ref" : "#/components/schemas/Links" + "$ref" : "#/components/schemas/LinksPaginated" }, "meta" : { - "$ref" : "#/components/schemas/Meta" + "$ref" : "#/components/schemas/MetaPaginated" } }, "required" : [ "data", "links", "meta" ], @@ -4278,10 +3594,10 @@ "$ref" : "#/components/schemas/TelcoConcessionsResponseData" }, "links" : { - "$ref" : "#/components/schemas/Links" + "$ref" : "#/components/schemas/LinksPaginated" }, "meta" : { - "$ref" : "#/components/schemas/Meta" + "$ref" : "#/components/schemas/MetaPaginated" } }, "required" : [ "data", "links", "meta" ], @@ -4290,7 +3606,7 @@ "TelcoBalanceListResponse" : { "properties" : { "data" : { - "$ref" : "#/components/schemas/TelcoBalanceListResponseBalances" + "$ref" : "#/components/schemas/TelcoBalanceListResponseData" }, "links" : { "$ref" : "#/components/schemas/LinksPaginated" @@ -4332,11 +3648,22 @@ "required" : [ "data", "links", "meta" ], "type" : "object" }, - "ErrorListResponse" : { + "MetaError" : { + "description" : "Additional data for customised error codes", + "properties" : { + "urn" : { + "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.", + "type" : "string" + } + }, + "type" : "object", + "x-conditional" : [ "urn" ] + }, + "ResponseErrorListV2" : { "properties" : { "errors" : { "items" : { - "$ref" : "#/components/schemas/ErrorListResponsErrors" + "$ref" : "#/components/schemas/ResponseErrorListV2_errors" }, "type" : "array" } @@ -4377,12 +3704,12 @@ }, "type" : { "default" : "MOBILE", - "description" : "The type of product", + "description" : "The type of product. [MOBILE](https://www.legislation.gov.au/Details/C2022C00170/Html/Volume_1#_Toc95898745) service or BROADBAND fixed internet service", "enum" : [ "MOBILE", "BROADBAND" ], "type" : "string" }, "purpose" : { - "default" : "ALL", + "default" : "PERSONAL", "description" : "The purpose type of the product. If absent, then the value PERSONAL is assumed", "enum" : [ "PERSONAL", "BUSINESS", "ALL" ], "type" : "string" @@ -4437,14 +3764,14 @@ "x-conditional" : [ "contract" ] }, "TelcoContract" : { - "description" : "Summary of the contract details. Required if a contract is required", + "description" : "Summary of the contract details. Mandatory if the billing type is POST_PAID and a contract agreement is required with the service provider for the plan", "properties" : { "name" : { "description" : "Name of the contract", "type" : "string" }, "description" : { - "description" : "Description if the contract", + "description" : "Description of the contract", "type" : "string" }, "duration" : { @@ -4484,9 +3811,8 @@ "type" : "array" } }, - "required" : [ "accountId" ], - "type" : "object", - "x-conditional" : [ ] + "required" : [ "accountId", "services" ], + "type" : "object" }, "TelcoServiceUsage" : { "properties" : { @@ -4559,11 +3885,20 @@ "type" : "object", "x-conditional" : [ "accountNumber" ] }, - "TelcoAccountResponse" : { + "TelcoAccountResponseData" : { + "allOf" : [ { + "$ref" : "#/components/schemas/TelcoAccountBase" + }, { + "$ref" : "#/components/schemas/TelcoAccount" + } ] + }, + "TelcoAccountDetailResponseData" : { "allOf" : [ { "$ref" : "#/components/schemas/TelcoAccountBase" }, { "$ref" : "#/components/schemas/TelcoAccount" + }, { + "$ref" : "#/components/schemas/TelcoAccountDetail" } ] }, "TelcoPaymentSchedule" : { @@ -4887,6 +4222,7 @@ "x-cds-type" : "DateString" }, "type" : { + "default" : "OTHER", "description" : "Type of charge. Assumed to be OTHER if absent", "enum" : [ "SERVICE", "NETWORK", "EQUIPMENT", "METERING", "OTHER" ], "type" : "string" @@ -4941,8 +4277,7 @@ } }, "required" : [ "services" ], - "type" : "object", - "x-conditional" : [ "services" ] + "type" : "object" }, "TelcoServiceBalance" : { "description" : "Telco balances for a service", @@ -5216,6 +4551,21 @@ "type" : "object" }, "TelcoUsageListResponse" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/TelcoUsageListResponseData" + }, + "links" : { + "$ref" : "#/components/schemas/Links" + }, + "meta" : { + "$ref" : "#/components/schemas/Meta" + } + }, + "required" : [ "data", "links", "meta" ], + "type" : "object" + }, + "TelcoUsageListResponseData" : { "properties" : { "accounts" : { "description" : "Array of usage on accounts", @@ -5233,7 +4583,7 @@ "accounts" : { "description" : "Array of accounts", "items" : { - "$ref" : "#/components/schemas/TelcoAccountResponse" + "$ref" : "#/components/schemas/TelcoAccountResponseData" }, "type" : "array" } @@ -5267,7 +4617,7 @@ "required" : [ "concessions" ], "type" : "object" }, - "TelcoBalanceListResponseBalances" : { + "TelcoBalanceListResponseData" : { "properties" : { "balances" : { "description" : "Array of account balances", @@ -5293,7 +4643,37 @@ "required" : [ "accountId, balance" ], "type" : "object" }, + "TelcoInvoiceResponse" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/TelcoInvoiceListResponseData" + }, + "links" : { + "$ref" : "#/components/schemas/Links" + }, + "meta" : { + "$ref" : "#/components/schemas/Meta" + } + }, + "required" : [ "data", "links", "meta" ], + "type" : "object" + }, "TelcoInvoiceListResponse" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/TelcoInvoiceListResponseData" + }, + "links" : { + "$ref" : "#/components/schemas/LinksPaginated" + }, + "meta" : { + "$ref" : "#/components/schemas/MetaPaginated" + } + }, + "required" : [ "data", "links", "meta" ], + "type" : "object" + }, + "TelcoInvoiceListResponseData" : { "properties" : { "invoices" : { "description" : "Array of invoices sorted by issue date in descending order", @@ -5319,38 +4699,6 @@ "required" : [ "transactions" ], "type" : "object" }, - "ErrorListResponseMeta" : { - "description" : "Additional data for customised error codes", - "properties" : { - "urn" : { - "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.", - "type" : "string" - } - }, - "type" : "object", - "x-conditional" : [ "urn" ] - }, - "ErrorListResponsErrors" : { - "properties" : { - "code" : { - "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.", - "type" : "string" - }, - "title" : { - "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.", - "type" : "string" - }, - "detail" : { - "description" : "A human-readable explanation specific to this occurrence of the problem.", - "type" : "string" - }, - "meta" : { - "$ref" : "#/components/schemas/ErrorListResponseMeta" - } - }, - "required" : [ "code", "detail", "title" ], - "type" : "object" - }, "TelcoProductPricing" : { "properties" : { "name" : { @@ -5366,13 +4714,13 @@ "type" : "string", "x-cds-type" : "ExternalRef" }, - "chargeAmount" : { + "amount" : { "description" : "The amount charged for the duration period", "type" : "string", "x-cds-type" : "AmountString" } }, - "required" : [ "chargeAmount", "description", "name" ], + "required" : [ "amount", "description", "name" ], "type" : "object" }, "TelcoAdditionalInformation" : { @@ -5670,7 +5018,7 @@ "required" : [ "startDate" ], "type" : "object" }, - "TelcoAccountPlans" : { + "TelcoAccountPlan" : { "properties" : { "nickname" : { "description" : "Optional display name for the plan provided by the customer to help differentiate multiple plans", @@ -5678,7 +5026,7 @@ }, "type" : { "default" : "MOBILE", - "description" : "The type of the plan", + "description" : "The type of the plan. The type of plan. A [MOBILE](https://www.legislation.gov.au/Details/C2022C00170/Html/Volume_1#_Toc95898745) service or BROADBAND fixed internet service", "enum" : [ "MOBILE", "BROADBAND" ], "type" : "string" }, @@ -5699,9 +5047,8 @@ "$ref" : "#/components/schemas/TelcoAccountPlanOverview" } }, - "required" : [ "serviceIds" ], - "type" : "object", - "x-conditional" : [ "planOverview" ] + "required" : [ "billingType", "planOverview", "serviceIds", "type" ], + "type" : "object" }, "TelcoAccount" : { "description" : "The array of plans containing services and associated plan details", @@ -5709,29 +5056,23 @@ "plans" : { "description" : "The array of plans containing service and associated plan details", "items" : { - "$ref" : "#/components/schemas/TelcoAccountPlans" + "$ref" : "#/components/schemas/TelcoAccountPlan" }, "type" : "array" } }, "required" : [ "plans" ], - "type" : "object", - "x-conditional" : [ "planOverview" ] + "type" : "object" }, - "TelcoAccountDetailPlanDetail" : { + "TelcoAccountPlanDetail" : { "description" : "Detail on the plan applicable to this account. Mandatory if openStatus is OPEN", "properties" : { - "charges" : { - "description" : "Charges for metering included in the plan", - "items" : { - "$ref" : "#/components/schemas/TelcoProductDetailMeteringCharges" - }, - "type" : "array" + "planDetail" : { + "$ref" : "#/components/schemas/TelcoAccountPlanDetail_planDetail" } }, - "required" : [ "charges" ], - "type" : "object", - "x-conditional" : [ ] + "required" : [ "planDetail" ], + "type" : "object" }, "TelcoAccountDetailAuthorisedContacts" : { "properties" : { @@ -5762,51 +5103,24 @@ "required" : [ "lastName" ], "type" : "object" }, - "TelcoAccountDetailPlans" : { - "properties" : { - "nickname" : { - "description" : "Optional display name for the plan provided by the customer to help differentiate multiple plans", - "type" : "string" - }, - "serviceIds" : { - "description" : "The serviceId representing a unique service identifier such as a mobile [MSISDN](https://www.etsi.org/deliver/etsi_gts/03/0303/05.00.00_60/gsmts_0303v050000p.pdf), [FNN](https://www.nbnco.com.au/content/dam/nbnco2/documents/sfaa-wba2-dictionary_FTTN-launch.pdf) or internet service e.g [NBN AVC Service ID](https://www.nbnco.com.au/content/dam/nbnco2/documents/sfaa-wba2-dictionary_FTTN-launch.pdf). In accordance with [CDR ID permanence](#id-permanence) requirement", - "items" : { - "type" : "string" - }, - "type" : "array" - }, - "planOverview" : { - "$ref" : "#/components/schemas/TelcoAccountPlanOverview" - }, - "planDetail" : { - "$ref" : "#/components/schemas/TelcoAccountDetailPlanDetail" - }, - "authorisedContacts" : { - "description" : "An array of additional contacts that are authorised to act on this account", - "items" : { - "$ref" : "#/components/schemas/TelcoAccountDetailAuthorisedContacts" - }, - "type" : "array" - } - }, - "required" : [ "serviceIds" ], - "type" : "object", - "x-conditional" : [ "planOverview", "planDetail" ] - }, "TelcoAccountDetail" : { "description" : "The array of plans containing services and associated plan details", "properties" : { "plans" : { "description" : "The array of plans containing services and associated plan details", "items" : { - "$ref" : "#/components/schemas/TelcoAccountDetailPlans" + "allOf" : [ { + "$ref" : "#/components/schemas/TelcoAccountPlan" + }, { + "$ref" : "#/components/schemas/TelcoAccountPlanDetail" + } ] }, + "required" : [ "planDetail", "planOverview" ], "type" : "array" } }, "required" : [ "plans" ], - "type" : "object", - "x-conditional" : [ "planOverview, planDetail" ] + "type" : "object" }, "TelcoPaymentScheduleCardDebit" : { "description" : "Represents a regular credit card payment schedule. Mandatory if paymentScheduleUType is set to cardDebit", @@ -6014,8 +5328,7 @@ } }, "required" : [ "amount", "duration", "number" ], - "type" : "object", - "x-conditional" : [ ] + "type" : "object" }, "TelcoUsageVoiceInternational" : { "description" : "International voice calls. Requied if international calling is supported", @@ -6037,8 +5350,7 @@ } }, "required" : [ "amount", "duration", "number" ], - "type" : "object", - "x-conditional" : [ ] + "type" : "object" }, "TelcoUsageVoiceRoaming" : { "description" : "Roaming voice calls, Required if roaming is supported", @@ -6060,8 +5372,7 @@ } }, "required" : [ "amount", "duration", "number" ], - "type" : "object", - "x-conditional" : [ ] + "type" : "object" }, "TelcoUsageVoice" : { "description" : "Summary of voice calls. Required if voice calls are included in product plan", @@ -6431,6 +5742,40 @@ }, "type" : "object", "x-conditional" : [ "data", "voice", "messaging" ] + }, + "ResponseErrorListV2_errors" : { + "properties" : { + "code" : { + "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.", + "type" : "string" + }, + "title" : { + "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.", + "type" : "string" + }, + "detail" : { + "description" : "A human-readable explanation specific to this occurrence of the problem.", + "type" : "string" + }, + "meta" : { + "$ref" : "#/components/schemas/MetaError" + } + }, + "required" : [ "code", "detail", "title" ], + "type" : "object" + }, + "TelcoAccountPlanDetail_planDetail" : { + "properties" : { + "charges" : { + "description" : "Charges for metering included in the plan", + "items" : { + "$ref" : "#/components/schemas/TelcoProductDetailMeteringCharges" + }, + "type" : "array" + } + }, + "required" : [ "charges" ], + "type" : "object" } } } diff --git a/docs/includes/swagger/cds_telco.yaml b/docs/includes/swagger/cds_telco.yaml index 05869f17..71983504 100644 --- a/docs/includes/swagger/cds_telco.yaml +++ b/docs/includes/swagger/cds_telco.yaml @@ -11,7 +11,7 @@ info: name: MIT License url: https://opensource.org/licenses/MIT title: CDR Telco API - version: 1.22.0 + version: 1.22.1 servers: - url: https://data.holder.com.au/cds-au/v1 paths: @@ -23,35 +23,36 @@ paths: Note that the results returned by this end point are expected to be ordered in descending order according to `lastUpdated`. operationId: listProducts parameters: - - description: Used to filter results on the type field. Any one of the valid - values for this field can be supplied. If absent, defaults to include all - products. Valid values are ‘MOBILE’, ‘BROADBAND’ + - description: Used to filter results on the type field. Any one of the valid + values for this field can be supplied. If absent, defaults to include ALL + products. Valid values are [MOBILE](https://www.legislation.gov.au/Details/C2022C00170/Html/Volume_1#_Toc95898745) + service. BROADBAND fixed internet service or ALL explode: true in: query name: type required: false schema: - default: MOBILE + default: ALL enum: - MOBILE - BROADBAND + - ALL type: string style: form - description: Used to filter results on the billing-type field. Any one of the valid values for this field can be supplied. If absent, defaults to include all billing types. Valid values are ‘PRE_PAID’, ‘POST_PAID’, 'UPFRONT_PAID', - 'OTHER' + 'ALL' explode: true in: query name: billing-type required: false schema: - default: PRE_PAID enum: - PRE_PAID - POST_PAID - UPFRONT_PAID - - OTHER + - ALL type: string style: form - description: Allows for the filtering of productd based on whether the current @@ -143,67 +144,29 @@ paths: description: Successful response headers: x-v: - explode: false - schema: - description: The [version](#response-headers) of the API end point - that the data holder has responded with. - type: string - style: simple + $ref: '#/components/headers/x-v' "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                                  • [400 - Invalid Field](#error-400-field-invalid)
                                  • [400 - Invalid Page Size](#error-400-field-invalid-page-size)
                                  • [400 - Invalid Version](#error-400-header-invalid-version)
                                  - headers: - x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple "406": content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                                  • [406 - Unsupported Version](#error-406-header-unsupported-version)
                                  - headers: - x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple "422": content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                                  • [422 - Invalid Page](#error-422-field-invalid-page)
                                  - headers: - x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple summary: Get Telco Products tags: - Telco @@ -258,66 +221,28 @@ paths: description: Successful response headers: x-v: - explode: false - schema: - description: The [version](#response-headers) of the API end point - that the data holder has responded with. - type: string - style: simple + $ref: '#/components/headers/x-v' "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                                  • [400 - Invalid Field](#error-400-field-invalid)
                                  • [400 - Invalid Version](#error-400-header-invalid-version)
                                  - headers: - x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                                  • [404 - Invalid Resource](#error-404-resource-invalid)
                                  - headers: - x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple "406": content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                                  • [406 - Unsupported Version](#error-406-header-unsupported-version)
                                  - headers: - x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple summary: Get Telco Product Detail tags: - Telco @@ -328,11 +253,11 @@ paths: description: Obtain a usage data from a particular service Id operationId: getUsageForService parameters: - - description: ID of the specific service requested such as a mobile [MSISDN](https://www.etsi.org/deliver/etsi_gts/03/0303/05.00.00_60/gsmts_0303v050000p.pdf), + - description: ID of the specific service requested. E.g. a mobile [MSISDN](https://www.etsi.org/deliver/etsi_gts/03/0303/05.00.00_60/gsmts_0303v050000p.pdf), [FNN](https://www.nbnco.com.au/content/dam/nbnco2/documents/sfaa-wba2-dictionary_FTTN-launch.pdf) - or internet service e.g [NBN AVC Service ID](https://www.nbnco.com.au/content/dam/nbnco2/documents/sfaa-wba2-dictionary_FTTN-launch.pdf). This - is a tokenised ID returned from the account. In accordance with [CDR ID - permanence](#id-permanence) requirements + or internet service e.g [NBN AVC Service ID](https://www.nbnco.com.au/content/dam/nbnco2/documents/sfaa-wba2-dictionary_FTTN-launch.pdf). + This is a tokenised ID returned from the account. In accordance with [CDR + ID permanence](#id-permanence) requirements explode: false in: path name: serviceId @@ -362,24 +287,6 @@ paths: type: string style: form x-cds-type: DateString - - description: Page of results to request (standard pagination) - explode: true - in: query - name: page - required: false - schema: - type: integer - style: form - x-cds-type: PositiveInteger - - description: Page size to request. Default is 25 (standard pagination) - explode: true - in: query - name: page-size - required: false - schema: - type: integer - style: form - x-cds-type: PositiveInteger - description: Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). @@ -462,96 +369,51 @@ paths: description: Successful response headers: x-v: - explode: false - schema: - description: The [version](#response-headers) of the API end point - that the data holder has responded with. - type: string - style: simple + $ref: '#/components/headers/x-v' x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple + $ref: '#/components/headers/x-fapi-interaction-id' "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                                  • [400 - Invalid Field](#error-400-field-invalid)
                                  • [400 - Invalid Page Size](#error-400-field-invalid-page-size)
                                  • [400 - Invalid Version](#error-400-header-invalid-version)
                                  headers: x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple + $ref: '#/components/headers/x-fapi-interaction-id' "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                                  • [404 - Unavailable Service Point](#error-404-unavailable-service-point)
                                  • [404 - Invalid Service Point](#error-404-invalid-service-point)
                                  headers: x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple + $ref: '#/components/headers/x-fapi-interaction-id' "406": content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                                  • [406 - Unsupported Version](#error-406-header-unsupported-version)
                                  headers: x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple + $ref: '#/components/headers/x-fapi-interaction-id' "422": content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                                  • [422 - Invalid Page](#error-422-field-invalid-page)
                                  headers: x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple + $ref: '#/components/headers/x-fapi-interaction-id' summary: Get Usage For Telco Service tags: - Telco @@ -687,77 +549,40 @@ paths: description: Successful response headers: x-v: - explode: false - schema: - description: The [version](#response-headers) of the API end point - that the data holder has responded with. - type: string - style: simple + $ref: '#/components/headers/x-v' x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple + $ref: '#/components/headers/x-fapi-interaction-id' "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                                  • [400 - Invalid Field](#error-400-field-invalid)
                                  • [400 - Invalid Page Size](#error-400-field-invalid-page-size)
                                  • [400 - Invalid Version](#error-400-header-invalid-version)
                                  headers: x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple + $ref: '#/components/headers/x-fapi-interaction-id' "406": content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                                  • [406 - Unsupported Version](#error-406-header-unsupported-version)
                                  headers: x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple + $ref: '#/components/headers/x-fapi-interaction-id' "422": content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                                  • [422 - Invalid Page](#error-422-field-invalid-page)
                                  headers: x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple + $ref: '#/components/headers/x-fapi-interaction-id' summary: Get Usage tags: - Telco @@ -770,28 +595,6 @@ paths: description: Obtain usage data for a specific service operationId: listUsageForService parameters: - - 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 - explode: true - in: query - name: oldest-date - required: false - schema: - type: string - style: form - x-cds-type: DateString - - 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 - explode: true - in: query - name: newest-date - required: false - schema: - type: string - style: form - x-cds-type: DateString - description: Page of results to request (standard pagination) explode: true in: query @@ -890,83 +693,46 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TelcoServiceUsageListResponse' + $ref: '#/components/schemas/TelcoUsageListResponse' description: Successful response headers: x-v: - explode: false - schema: - description: The [version](#response-headers) of the API end point - that the data holder has responded with. - type: string - style: simple + $ref: '#/components/headers/x-v' x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple + $ref: '#/components/headers/x-fapi-interaction-id' "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                                  • [400 - Invalid Field](#error-400-field-invalid)
                                  • [400 - Invalid Page Size](#error-400-field-invalid-page-size)
                                  • [400 - Invalid Version](#error-400-header-invalid-version)
                                  headers: x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple + $ref: '#/components/headers/x-fapi-interaction-id' "406": content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                                  • [406 - Unsupported Version](#error-406-header-unsupported-version)
                                  headers: x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple + $ref: '#/components/headers/x-fapi-interaction-id' "422": content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                                  • [422 - Invalid Page](#error-422-field-invalid-page)
                                  • [422 - Unavailable Service Point](#error-422-unavailable-service-point)
                                  • [422 - Invalid Service Point](#error-422-invalid-service-point)
                                  headers: x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple + $ref: '#/components/headers/x-fapi-interaction-id' summary: Get Usage For Specific Telco Service tags: - Telco @@ -996,6 +762,16 @@ paths: - OPEN type: string style: form + - description: Only include accounts that have been updated after the specified + date and time. If absent defaults to include all plans + explode: true + in: query + name: updated-since + required: false + schema: + type: string + style: form + x-cds-type: DateString - description: Page of results to request (standard pagination) explode: true in: query @@ -1096,77 +872,40 @@ paths: description: Successful response headers: x-v: - explode: false - schema: - description: The [version](#response-headers) of the API end point - that the data holder has responded with. - type: string - style: simple + $ref: '#/components/headers/x-v' x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple + $ref: '#/components/headers/x-fapi-interaction-id' "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                                  • [400 - Invalid Field](#error-400-field-invalid)
                                  • [400 - Invalid Page Size](#error-400-field-invalid-page-size)
                                  • [400 - Invalid Version](#error-400-header-invalid-version)
                                  headers: x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple + $ref: '#/components/headers/x-fapi-interaction-id' "406": content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                                  • [406 - Unsupported Version](#error-406-header-unsupported-version)
                                  headers: x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple + $ref: '#/components/headers/x-fapi-interaction-id' "422": content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                                  • [422 - Invalid Page](#error-422-field-invalid-page)
                                  headers: x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple + $ref: '#/components/headers/x-fapi-interaction-id' summary: Get Telco Accounts tags: - Telco @@ -1182,7 +921,7 @@ paths: Other Versions: [v1](includes/obsolete/get-telco-account-detail-v1.html) operationId: getAccount parameters: - - description: ID of a specific account to obtain data for. This is a tokenised + - description: ID of a specific account to obtain data for. This is a tokenised ID previously obtained from the Account List end point. In accordance with [CDR ID permanence](#id-permanence) requirements explode: false @@ -1274,77 +1013,40 @@ paths: description: Successful response headers: x-v: - explode: false - schema: - description: The [version](#response-headers) of the API end point - that the data holder has responded with. - type: string - style: simple + $ref: '#/components/headers/x-v' x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple + $ref: '#/components/headers/x-fapi-interaction-id' "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                                  • [400 - Invalid Field](#error-400-field-invalid)
                                  • [400 - Invalid Version](#error-400-header-invalid-version)
                                  headers: x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple + $ref: '#/components/headers/x-fapi-interaction-id' "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                                  • [404 - Unavailable Telco Account](#error-404-unavailable-telco-account)
                                  • [404 - Invalid Telco Account](#error-404-invalid-telco-account)
                                  headers: x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple + $ref: '#/components/headers/x-fapi-interaction-id' "406": content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                                  • [406 - Unsupported Version](#error-406-header-unsupported-version)
                                  headers: x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple + $ref: '#/components/headers/x-fapi-interaction-id' summary: Get Telco Account Detail tags: - Telco @@ -1369,7 +1071,7 @@ paths: \ within this API
                                " operationId: getPaymentSchedule parameters: - - description: ID of a specific account to obtain data for. This is a tokenised + - description: ID of a specific account to obtain data for. This is a tokenised ID previously obtained from the Account List end point. In accordance with [CDR ID permanence](#id-permanence) requirements explode: false @@ -1461,77 +1163,40 @@ paths: description: Successful response headers: x-v: - explode: false - schema: - description: The [version](#response-headers) of the API end point - that the data holder has responded with. - type: string - style: simple + $ref: '#/components/headers/x-v' x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple + $ref: '#/components/headers/x-fapi-interaction-id' "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                                • [400 - Invalid Field](#error-400-field-invalid)
                                • [400 - Invalid Version](#error-400-header-invalid-version)
                                headers: x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple + $ref: '#/components/headers/x-fapi-interaction-id' "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                                • [404 - Unavailable Telco Account](#error-404-unavailable-telco-account)
                                • [404 - Invalid Telco Account](#error-404-invalid-telco-account)
                                headers: x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple + $ref: '#/components/headers/x-fapi-interaction-id' "406": content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                                • [406 - Unsupported Version](#error-406-header-unsupported-version)
                                headers: x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple + $ref: '#/components/headers/x-fapi-interaction-id' summary: Get Telco Agreed Payment Schedule tags: - Telco @@ -1545,7 +1210,7 @@ paths: a specific telco account operationId: getConcessions parameters: - - description: ID of a specific account to obtain data for. This is a tokenised + - description: ID of a specific account to obtain data for. This is a tokenised ID previously obtained from the Account List end point. In accordance with [CDR ID permanence](#id-permanence) requirements explode: false @@ -1637,77 +1302,40 @@ paths: description: Successful response headers: x-v: - explode: false - schema: - description: The [version](#response-headers) of the API end point - that the data holder has responded with. - type: string - style: simple + $ref: '#/components/headers/x-v' x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple + $ref: '#/components/headers/x-fapi-interaction-id' "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                                • [400 - Invalid Field](#error-400-field-invalid)
                                • [400 - Invalid Version](#error-400-header-invalid-version)
                                headers: x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple + $ref: '#/components/headers/x-fapi-interaction-id' "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                                • [404 - Unavailable Telco Account](#error-404-unavailable-telco-account)
                                • [404 - Invalid Telco Account](#error-404-invalid-telco-account)
                                headers: x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple + $ref: '#/components/headers/x-fapi-interaction-id' "406": content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                                • [406 - Unsupported Version](#error-406-header-unsupported-version)
                                headers: x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple + $ref: '#/components/headers/x-fapi-interaction-id' summary: Get Telco Concessions tags: - Telco @@ -1720,7 +1348,7 @@ paths: description: Obtain the current balance for a specific account operationId: getBalanceForAccount parameters: - - description: ID of a specific account to obtain data for. This is a tokenised + - description: ID of a specific account to obtain data for. This is a tokenised ID previously obtained from the Account List end point. In accordance with [CDR ID permanence](#id-permanence) requirements explode: false @@ -1812,77 +1440,40 @@ paths: description: Successful response headers: x-v: - explode: false - schema: - description: The [version](#response-headers) of the API end point - that the data holder has responded with. - type: string - style: simple + $ref: '#/components/headers/x-v' x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple + $ref: '#/components/headers/x-fapi-interaction-id' "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                                • [400 - Invalid Field](#error-400-field-invalid)
                                • [400 - Invalid Version](#error-400-header-invalid-version)
                                headers: x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple + $ref: '#/components/headers/x-fapi-interaction-id' "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                                • [404 - Unavailable Telco Account](#error-404-unavailable-telco-account)
                                • [404 - Invalid Telco Account](#error-404-invalid-telco-account)
                                headers: x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple + $ref: '#/components/headers/x-fapi-interaction-id' "406": content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                                • [406 - Unsupported Version](#error-406-header-unsupported-version)
                                headers: x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple + $ref: '#/components/headers/x-fapi-interaction-id' summary: Get Balance For Telco Account tags: - Telco @@ -1996,77 +1587,40 @@ paths: description: Successful response headers: x-v: - explode: false - schema: - description: The [version](#response-headers) of the API end point - that the data holder has responded with. - type: string - style: simple + $ref: '#/components/headers/x-v' x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple + $ref: '#/components/headers/x-fapi-interaction-id' "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                                • [400 - Invalid Field](#error-400-field-invalid)
                                • [400 - Invalid Page Size](#error-400-field-invalid-page-size)
                                • [400 - Invalid Version](#error-400-header-invalid-version)
                                headers: x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple + $ref: '#/components/headers/x-fapi-interaction-id' "406": content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                                • [406 - Unsupported Version](#error-406-header-unsupported-version)
                                headers: x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple + $ref: '#/components/headers/x-fapi-interaction-id' "422": content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                                • [422 - Invalid Page](#error-422-field-invalid-page)
                                headers: x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple + $ref: '#/components/headers/x-fapi-interaction-id' summary: Get Bulk Telco Balances tags: - Telco @@ -2181,79 +1735,42 @@ paths: description: Successful response headers: x-v: - explode: false - schema: - description: The [version](#response-headers) of the API end point - that the data holder has responded with. - type: string - style: simple + $ref: '#/components/headers/x-v' x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple + $ref: '#/components/headers/x-fapi-interaction-id' "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                                • [400 - Invalid Field](#error-400-field-invalid)
                                • [400 - Invalid Page Size](#error-400-field-invalid-page-size)
                                • [400 - Invalid Version](#error-400-header-invalid-version)
                                headers: x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple + $ref: '#/components/headers/x-fapi-interaction-id' "406": content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                                • [406 - Unsupported Version](#error-406-header-unsupported-version)
                                headers: x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple + $ref: '#/components/headers/x-fapi-interaction-id' "422": content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                                • [422 - Invalid Page](#error-422-field-invalid-page)
                                • [422 - Unavailable Telco Account](#error-422-unavailable-telco-account)
                                • [422 - Invalid Telco Account](#error-422-invalid-telco-account)
                                headers: x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple + $ref: '#/components/headers/x-fapi-interaction-id' summary: Get Balances For Specific Telco Accounts tags: - Telco @@ -2267,7 +1784,7 @@ paths: description: Obtain the invoices for a specific account operationId: getInvoicesForAccount parameters: - - description: ID of a specific account to obtain data for. This is a tokenised + - description: ID of a specific account to obtain data for. This is a tokenised ID previously obtained from the Account List end point. In accordance with [CDR ID permanence](#id-permanence) requirements explode: false @@ -2277,46 +1794,6 @@ paths: schema: type: string style: simple - - 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 - explode: true - in: query - name: newest-date - required: false - schema: - type: string - style: form - x-cds-type: DateString - - 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 - explode: true - in: query - name: oldest-date - required: false - schema: - type: string - style: form - x-cds-type: DateString - - description: Page of results to request (standard pagination) - explode: true - in: query - name: page - required: false - schema: - type: integer - style: form - x-cds-type: PositiveInteger - - description: Page size to request. Default is 25 (standard pagination) - explode: true - in: query - name: page-size - required: false - schema: - type: integer - style: form - x-cds-type: PositiveInteger - description: Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). @@ -2395,100 +1872,55 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TelcoInvoiceListResponse' + $ref: '#/components/schemas/TelcoInvoiceResponse' description: Successful response headers: x-v: - explode: false - schema: - description: The [version](#response-headers) of the API end point - that the data holder has responded with. - type: string - style: simple + $ref: '#/components/headers/x-v' x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple + $ref: '#/components/headers/x-fapi-interaction-id' "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                                • [400 - Invalid Field](#error-400-field-invalid)
                                • [400 - Invalid Page Size](#error-400-field-invalid-page-size)
                                • [400 - Invalid Version](#error-400-header-invalid-version)
                                headers: x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple + $ref: '#/components/headers/x-fapi-interaction-id' "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                                • [404 - Unavailable Telco Account](#error-404-unavailable-telco-account)
                                • [404 - Invalid Telco Account](#error-404-invalid-telco-account)
                                headers: x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple + $ref: '#/components/headers/x-fapi-interaction-id' "406": content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                                • [406 - Unsupported Version](#error-406-header-unsupported-version)
                                headers: x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple + $ref: '#/components/headers/x-fapi-interaction-id' "422": content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                                • [422 - Invalid Page](#error-422-field-invalid-page)
                                headers: x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple + $ref: '#/components/headers/x-fapi-interaction-id' summary: Get Invoices For Telco Account tags: - Telco @@ -2624,77 +2056,40 @@ paths: description: Successful response headers: x-v: - explode: false - schema: - description: The [version](#response-headers) of the API end point - that the data holder has responded with. - type: string - style: simple + $ref: '#/components/headers/x-v' x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple + $ref: '#/components/headers/x-fapi-interaction-id' "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                                • [400 - Invalid Field](#error-400-field-invalid)
                                • [400 - Invalid Page Size](#error-400-field-invalid-page-size)
                                • [400 - Invalid Version](#error-400-header-invalid-version)
                                headers: x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple + $ref: '#/components/headers/x-fapi-interaction-id' "406": content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                                • [406 - Unsupported Version](#error-406-header-unsupported-version)
                                headers: x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple + $ref: '#/components/headers/x-fapi-interaction-id' "422": content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                                • [422 - Invalid Page](#error-422-field-invalid-page)
                                headers: x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple + $ref: '#/components/headers/x-fapi-interaction-id' summary: Get Telco Invoices tags: - Telco @@ -2831,79 +2226,42 @@ paths: description: Successful response headers: x-v: - explode: false - schema: - description: The [version](#response-headers) of the API end point - that the data holder has responded with. - type: string - style: simple + $ref: '#/components/headers/x-v' x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple + $ref: '#/components/headers/x-fapi-interaction-id' "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                                • [400 - Invalid Field](#error-400-field-invalid)
                                • [400 - Invalid Page Size](#error-400-field-invalid-page-size)
                                • [400 - Invalid Version](#error-400-header-invalid-version)
                                headers: x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple + $ref: '#/components/headers/x-fapi-interaction-id' "406": content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                                • [406 - Unsupported Version](#error-406-header-unsupported-version)
                                headers: x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple + $ref: '#/components/headers/x-fapi-interaction-id' "422": content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                                • [422 - Invalid Page](#error-422-field-invalid-page)
                                • [422 - Unavailable Telco Account](#error-422-unavailable-telco-account)
                                • [422 - Invalid Telco Account](#error-422-invalid-telco-account)
                                headers: x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple + $ref: '#/components/headers/x-fapi-interaction-id' summary: Get Invoices For Specific Telco Accounts tags: - Telco @@ -2917,7 +2275,7 @@ paths: description: Obtain the billing transactions for a specific account operationId: getTransactionsForAccount parameters: - - description: ID of a specific account to obtain data for. This is a tokenised + - description: ID of a specific account to obtain data for. This is a tokenised ID previously obtained from the Account List end point. In accordance with [CDR ID permanence](#id-permanence) requirements explode: false @@ -3049,96 +2407,51 @@ paths: description: Successful response headers: x-v: - explode: false - schema: - description: The [version](#response-headers) of the API end point - that the data holder has responded with. - type: string - style: simple + $ref: '#/components/headers/x-v' x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple + $ref: '#/components/headers/x-fapi-interaction-id' "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                                • [400 - Invalid Field](#error-400-field-invalid)
                                • [400 - Invalid Page Size](#error-400-field-invalid-page-size)
                                • [400 - Invalid Version](#error-400-header-invalid-version)
                                headers: x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple + $ref: '#/components/headers/x-fapi-interaction-id' "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                                • [404 - Unavailable Telco Account](#error-404-unavailable-telco-account)
                                • [404 - Invalid Telco Account](#error-404-invalid-telco-account)
                                headers: x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple + $ref: '#/components/headers/x-fapi-interaction-id' "406": content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                                • [406 - Unsupported Version](#error-406-header-unsupported-version)
                                headers: x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple + $ref: '#/components/headers/x-fapi-interaction-id' "422": content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                                • [422 - Invalid Page](#error-422-field-invalid-page)
                                headers: x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple + $ref: '#/components/headers/x-fapi-interaction-id' summary: Get Transactions For Telco Account tags: - Telco @@ -3274,77 +2587,40 @@ paths: description: Successful response headers: x-v: - explode: false - schema: - description: The [version](#response-headers) of the API end point - that the data holder has responded with. - type: string - style: simple + $ref: '#/components/headers/x-v' x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple + $ref: '#/components/headers/x-fapi-interaction-id' "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                                • [400 - Invalid Field](#error-400-field-invalid)
                                • [400 - Invalid Page Size](#error-400-field-invalid-page-size)
                                • [400 - Invalid Version](#error-400-header-invalid-version)
                                headers: x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple + $ref: '#/components/headers/x-fapi-interaction-id' "406": content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                                • [406 - Unsupported Version](#error-406-header-unsupported-version)
                                headers: x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple + $ref: '#/components/headers/x-fapi-interaction-id' "422": content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                                • [422 - Invalid Page](#error-422-field-invalid-page)
                                headers: x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple + $ref: '#/components/headers/x-fapi-interaction-id' summary: Get Telco Transactions tags: - Telco @@ -3481,79 +2757,42 @@ paths: description: Successful response headers: x-v: - explode: false - schema: - description: The [version](#response-headers) of the API end point - that the data holder has responded with. - type: string - style: simple + $ref: '#/components/headers/x-v' x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple + $ref: '#/components/headers/x-fapi-interaction-id' "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                                • [400 - Invalid Field](#error-400-field-invalid)
                                • [400 - Invalid Page Size](#error-400-field-invalid-page-size)
                                • [400 - Invalid Version](#error-400-header-invalid-version)
                                headers: x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple + $ref: '#/components/headers/x-fapi-interaction-id' "406": content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                                • [406 - Unsupported Version](#error-406-header-unsupported-version)
                                headers: x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple + $ref: '#/components/headers/x-fapi-interaction-id' "422": content: application/json: schema: - $ref: '#/components/schemas/ErrorListResponse' + $ref: '#/components/schemas/ResponseErrorListV2' description: The following error codes MUST be supported:
                                • [422 - Invalid Page](#error-422-field-invalid-page)
                                • [422 - Unavailable Telco Account](#error-422-unavailable-telco-account)
                                • [422 - Invalid Telco Account](#error-422-invalid-telco-account)
                                headers: x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple + $ref: '#/components/headers/x-fapi-interaction-id' summary: Get Transactions For Specific Telco Accounts tags: - Telco @@ -3563,6 +2802,23 @@ paths: - telco:billing:read x-version: "1" components: + headers: + x-v: + explode: false + schema: + description: The [version](#response-headers) of the API end point that the + data holder has responded with. + type: string + style: simple + x-fapi-interaction-id: + explode: false + schema: + 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. + type: string + style: simple parameters: serviceId: description: ID of the specific service requested. E.g. a mobile [MSISDN](https://www.etsi.org/deliver/etsi_gts/03/0303/05.00.00_60/gsmts_0303v050000p.pdf), @@ -3588,17 +2844,6 @@ components: schema: type: string style: simple - accountIds: - description: A seperated array of account IDs of specific accounts to obtain - data for. This is a tokenised ID previously obtained from the Account List - end point. In accordance with [CDR ID permanence](#id-permanence) requirements - explode: false - in: path - name: accountIds - required: true - schema: - type: string - style: simple open-status: description: Used to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed @@ -3824,12 +3069,7 @@ components: description: Successful response headers: x-v: - explode: false - schema: - description: The [version](#response-headers) of the API end point that - the data holder has responded with. - type: string - style: simple + $ref: '#/components/headers/x-v' planDetail: content: application/json: @@ -3838,12 +3078,7 @@ components: description: Successful response headers: x-v: - explode: false - schema: - description: The [version](#response-headers) of the API end point that - the data holder has responded with. - type: string - style: simple + $ref: '#/components/headers/x-v' usage: content: application/json: @@ -3852,22 +3087,9 @@ components: description: Successful response headers: x-v: - explode: false - schema: - description: The [version](#response-headers) of the API end point that - the data holder has responded with. - type: string - style: simple + $ref: '#/components/headers/x-v' x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple + $ref: '#/components/headers/x-fapi-interaction-id' usageList: content: application/json: @@ -3876,22 +3098,9 @@ components: description: Successful response headers: x-v: - explode: false - schema: - description: The [version](#response-headers) of the API end point that - the data holder has responded with. - type: string - style: simple + $ref: '#/components/headers/x-v' x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple + $ref: '#/components/headers/x-fapi-interaction-id' accountList: content: application/json: @@ -3900,22 +3109,9 @@ components: description: Successful response headers: x-v: - explode: false - schema: - description: The [version](#response-headers) of the API end point that - the data holder has responded with. - type: string - style: simple + $ref: '#/components/headers/x-v' x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple + $ref: '#/components/headers/x-fapi-interaction-id' accountDetail: content: application/json: @@ -3924,22 +3120,9 @@ components: description: Successful response headers: x-v: - explode: false - schema: - description: The [version](#response-headers) of the API end point that - the data holder has responded with. - type: string - style: simple + $ref: '#/components/headers/x-v' x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple + $ref: '#/components/headers/x-fapi-interaction-id' accountPaymentScheduleDetail: content: application/json: @@ -3948,22 +3131,9 @@ components: description: Successful response headers: x-v: - explode: false - schema: - description: The [version](#response-headers) of the API end point that - the data holder has responded with. - type: string - style: simple + $ref: '#/components/headers/x-v' x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple + $ref: '#/components/headers/x-fapi-interaction-id' accountConcessionsDetail: content: application/json: @@ -3972,22 +3142,7 @@ components: description: Successful response headers: x-v: - explode: false - schema: - description: The [version](#response-headers) of the API end point that - the data holder has responded with. - type: string - style: simple - x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple + $ref: '#/components/headers/x-v' balanceList: content: application/json: @@ -3996,22 +3151,7 @@ components: description: Successful response headers: x-v: - explode: false - schema: - description: The [version](#response-headers) of the API end point that - the data holder has responded with. - type: string - style: simple - x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple + $ref: '#/components/headers/x-v' balanceDetail: content: application/json: @@ -4020,46 +3160,16 @@ components: description: Successful response headers: x-v: - explode: false - schema: - description: The [version](#response-headers) of the API end point that - the data holder has responded with. - type: string - style: simple - x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple - invoiceList: - content: - application/json: + $ref: '#/components/headers/x-v' + invoiceList: + content: + application/json: schema: $ref: '#/components/schemas/TelcoInvoiceListResponse' description: Successful response headers: x-v: - explode: false - schema: - description: The [version](#response-headers) of the API end point that - the data holder has responded with. - type: string - style: simple - x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple + $ref: '#/components/headers/x-v' transactionList: content: application/json: @@ -4068,22 +3178,9 @@ components: description: Successful response headers: x-v: - explode: false - schema: - description: The [version](#response-headers) of the API end point that - the data holder has responded with. - type: string - style: simple + $ref: '#/components/headers/x-v' x-fapi-interaction-id: - explode: false - schema: - 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. - type: string - style: simple + $ref: '#/components/headers/x-fapi-interaction-id' schemas: TelcoProductListResponse: example: @@ -4097,7 +3194,7 @@ components: overviewUri: overviewUri brandName: brandName productId: productId - purpose: ALL + purpose: PERSONAL displayName: displayName contract: duration: 0.8008281904610115 @@ -4117,13 +3214,13 @@ components: brand: brand pricing: - period: period + amount: amount name: name description: description - chargeAmount: chargeAmount - period: period + amount: amount name: name description: description - chargeAmount: chargeAmount - additionalInformation: eligibilityUri: eligibilityUri bundleUri: bundleUri @@ -4132,7 +3229,7 @@ components: overviewUri: overviewUri brandName: brandName productId: productId - purpose: ALL + purpose: PERSONAL displayName: displayName contract: duration: 0.8008281904610115 @@ -4152,13 +3249,13 @@ components: brand: brand pricing: - period: period + amount: amount name: name description: description - chargeAmount: chargeAmount - period: period + amount: amount name: name description: description - chargeAmount: chargeAmount meta: totalRecords: 6 totalPages: 1 @@ -4204,9 +3301,9 @@ components: data: $ref: '#/components/schemas/TelcoAccountUsage' links: - $ref: '#/components/schemas/LinksPaginated' + $ref: '#/components/schemas/Links' meta: - $ref: '#/components/schemas/MetaPaginated' + type: object required: - data - links @@ -4253,115 +3350,22 @@ components: international: 3.616076749251911 serviceId: serviceId startDate: startDate - meta: - totalRecords: 6 - totalPages: 1 + meta: '{}' links: - next: next - last: last - prev: prev self: self - first: first properties: data: $ref: '#/components/schemas/TelcoServiceUsage' links: - $ref: '#/components/schemas/LinksPaginated' + $ref: '#/components/schemas/Links' meta: - $ref: '#/components/schemas/MetaPaginated' + type: object required: - data - links - meta type: object TelcoServiceUsageListResponse: - example: - data: - - phoneNumber: phoneNumber - endDate: endDate - displayName: displayName - usage: - voice: - roaming: - duration: duration - number: 7.061401241503109 - amount: amount - national: - duration: duration - number: 5.637376656633329 - amount: amount - international: - duration: duration - number: 2.3021358869347655 - amount: amount - data: - download: 6.027456183070403 - sessions: 1.4658129805029452 - amount: amount - roaming: - download: 5.962133916683182 - amount: amount - upload: 0.8008281904610115 - messaging: - mms: - amount: amount - roaming: 1.2315135367772556 - national: 4.145608029883936 - international: 7.386281948385884 - sms: - amount: amount - roaming: 2.027123023002322 - national: 9.301444243932576 - international: 3.616076749251911 - serviceId: serviceId - startDate: startDate - - phoneNumber: phoneNumber - endDate: endDate - displayName: displayName - usage: - voice: - roaming: - duration: duration - number: 7.061401241503109 - amount: amount - national: - duration: duration - number: 5.637376656633329 - amount: amount - international: - duration: duration - number: 2.3021358869347655 - amount: amount - data: - download: 6.027456183070403 - sessions: 1.4658129805029452 - amount: amount - roaming: - download: 5.962133916683182 - amount: amount - upload: 0.8008281904610115 - messaging: - mms: - amount: amount - roaming: 1.2315135367772556 - national: 4.145608029883936 - international: 7.386281948385884 - sms: - amount: amount - roaming: 2.027123023002322 - national: 9.301444243932576 - international: 3.616076749251911 - serviceId: serviceId - startDate: startDate - meta: - totalRecords: 6 - totalPages: 1 - links: - next: next - last: last - prev: prev - self: self - first: first properties: data: items: @@ -4405,16 +3409,12 @@ components: type: object TelcoAccountDetailResponse: example: - data: "" meta: '{}' links: self: self properties: data: - allOf: - - $ref: '#/components/schemas/TelcoAccountBase' - - $ref: '#/components/schemas/TelcoAccount' - - $ref: '#/components/schemas/TelcoAccountDetail' + $ref: '#/components/schemas/TelcoAccountDetailResponseData' links: $ref: '#/components/schemas/Links' meta: @@ -4470,16 +3470,22 @@ components: paymentFrequency: paymentFrequency isTokenised: true paymentScheduleUType: cardDebit - meta: '{}' + meta: + totalRecords: 6 + totalPages: 1 links: + next: next + last: last + prev: prev self: self + first: first properties: data: $ref: '#/components/schemas/TelcoPaymentScheduleResponseData' links: - $ref: '#/components/schemas/Links' + $ref: '#/components/schemas/LinksPaginated' meta: - type: object + $ref: '#/components/schemas/MetaPaginated' required: - data - links @@ -4513,16 +3519,22 @@ components: type: CONCESSION discountFrequency: discountFrequency startDate: startDate - meta: '{}' + meta: + totalRecords: 6 + totalPages: 1 links: + next: next + last: last + prev: prev self: self + first: first properties: data: $ref: '#/components/schemas/TelcoConcessionsResponseData' links: - $ref: '#/components/schemas/Links' + $ref: '#/components/schemas/LinksPaginated' meta: - type: object + $ref: '#/components/schemas/MetaPaginated' required: - data - links @@ -4553,7 +3565,7 @@ components: first: first properties: data: - $ref: '#/components/schemas/TelcoBalanceListResponseBalances' + $ref: '#/components/schemas/TelcoBalanceListResponseData' links: $ref: '#/components/schemas/LinksPaginated' meta: @@ -4605,7 +3617,7 @@ components: invoiceNumber: invoiceNumber description: description serviceId: serviceId - type: SERVICE + type: OTHER startDate: startDate gst: gst payment: @@ -4642,7 +3654,7 @@ components: invoiceNumber: invoiceNumber description: description serviceId: serviceId - type: SERVICE + type: OTHER startDate: startDate gst: gst payment: @@ -4683,11 +3695,22 @@ components: - links - meta type: object - ErrorListResponse: + MetaError: + description: Additional data for customised error codes + properties: + urn: + 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. + type: string + type: object + x-conditional: + - urn + ResponseErrorListV2: properties: errors: items: - $ref: '#/components/schemas/ErrorListResponsErrors' + $ref: '#/components/schemas/ResponseErrorListV2_errors' type: array required: - errors @@ -4704,7 +3727,7 @@ components: overviewUri: overviewUri brandName: brandName productId: productId - purpose: ALL + purpose: PERSONAL displayName: displayName contract: duration: 0.8008281904610115 @@ -4724,13 +3747,13 @@ components: brand: brand pricing: - period: period + amount: amount name: name description: description - chargeAmount: chargeAmount - period: period + amount: amount name: name description: description - chargeAmount: chargeAmount properties: productId: description: The ID of the specific product @@ -4760,13 +3783,14 @@ components: type: string type: default: MOBILE - description: The type of product + description: The type of product. [MOBILE](https://www.legislation.gov.au/Details/C2022C00170/Html/Volume_1#_Toc95898745) + service or BROADBAND fixed internet service enum: - MOBILE - BROADBAND type: string purpose: - default: ALL + default: PERSONAL description: The purpose type of the product. If absent, then the value PERSONAL is assumed enum: @@ -4827,7 +3851,9 @@ components: x-conditional: - contract TelcoContract: - description: Summary of the contract details. Required if a contract is required + description: Summary of the contract details. Mandatory if the billing type + is POST_PAID and a contract agreement is required with the service provider + for the plan example: duration: 0.8008281904610115 contractUri: contractUri @@ -4838,7 +3864,7 @@ components: description: Name of the contract type: string description: - description: Description if the contract + description: Description of the contract type: string duration: description: Minimum contract duration in months @@ -4957,8 +3983,8 @@ components: type: array required: - accountId + - services type: object - x-conditional: [] TelcoServiceUsage: example: phoneNumber: phoneNumber @@ -5069,10 +4095,15 @@ components: type: object x-conditional: - accountNumber - TelcoAccountResponse: + TelcoAccountResponseData: + allOf: + - $ref: '#/components/schemas/TelcoAccountBase' + - $ref: '#/components/schemas/TelcoAccount' + TelcoAccountDetailResponseData: allOf: - $ref: '#/components/schemas/TelcoAccountBase' - $ref: '#/components/schemas/TelcoAccount' + - $ref: '#/components/schemas/TelcoAccountDetail' TelcoPaymentSchedule: example: manualPayment: @@ -5432,7 +4463,7 @@ components: invoiceNumber: invoiceNumber description: description serviceId: serviceId - type: SERVICE + type: OTHER startDate: startDate gst: gst payment: @@ -5586,7 +4617,7 @@ components: invoiceNumber: invoiceNumber description: description serviceId: serviceId - type: SERVICE + type: OTHER startDate: startDate properties: serviceId: @@ -5609,6 +4640,7 @@ components: type: string x-cds-type: DateString type: + default: OTHER description: Type of charge. Assumed to be OTHER if absent enum: - SERVICE @@ -5674,8 +4706,6 @@ components: required: - services type: object - x-conditional: - - services TelcoServiceBalance: description: Telco balances for a service properties: @@ -5948,7 +4978,7 @@ components: overviewUri: overviewUri brandName: brandName productId: productId - purpose: ALL + purpose: PERSONAL displayName: displayName contract: duration: 0.8008281904610115 @@ -5968,13 +4998,13 @@ components: brand: brand pricing: - period: period + amount: amount name: name description: description - chargeAmount: chargeAmount - period: period + amount: amount name: name description: description - chargeAmount: chargeAmount - additionalInformation: eligibilityUri: eligibilityUri bundleUri: bundleUri @@ -5983,7 +5013,7 @@ components: overviewUri: overviewUri brandName: brandName productId: productId - purpose: ALL + purpose: PERSONAL displayName: displayName contract: duration: 0.8008281904610115 @@ -6003,13 +5033,13 @@ components: brand: brand pricing: - period: period + amount: amount name: name description: description - chargeAmount: chargeAmount - period: period + amount: amount name: name description: description - chargeAmount: chargeAmount properties: plans: description: Array of Products @@ -6020,6 +5050,185 @@ components: - plans type: object TelcoUsageListResponse: + example: + data: + accounts: + - accountId: accountId + services: + - service: + phoneNumber: phoneNumber + endDate: endDate + displayName: displayName + usage: + voice: + roaming: + duration: duration + number: 7.061401241503109 + amount: amount + national: + duration: duration + number: 5.637376656633329 + amount: amount + international: + duration: duration + number: 2.3021358869347655 + amount: amount + data: + download: 6.027456183070403 + sessions: 1.4658129805029452 + amount: amount + roaming: + download: 5.962133916683182 + amount: amount + upload: 0.8008281904610115 + messaging: + mms: + amount: amount + roaming: 1.2315135367772556 + national: 4.145608029883936 + international: 7.386281948385884 + sms: + amount: amount + roaming: 2.027123023002322 + national: 9.301444243932576 + international: 3.616076749251911 + serviceId: serviceId + startDate: startDate + - service: + phoneNumber: phoneNumber + endDate: endDate + displayName: displayName + usage: + voice: + roaming: + duration: duration + number: 7.061401241503109 + amount: amount + national: + duration: duration + number: 5.637376656633329 + amount: amount + international: + duration: duration + number: 2.3021358869347655 + amount: amount + data: + download: 6.027456183070403 + sessions: 1.4658129805029452 + amount: amount + roaming: + download: 5.962133916683182 + amount: amount + upload: 0.8008281904610115 + messaging: + mms: + amount: amount + roaming: 1.2315135367772556 + national: 4.145608029883936 + international: 7.386281948385884 + sms: + amount: amount + roaming: 2.027123023002322 + national: 9.301444243932576 + international: 3.616076749251911 + serviceId: serviceId + startDate: startDate + - accountId: accountId + services: + - service: + phoneNumber: phoneNumber + endDate: endDate + displayName: displayName + usage: + voice: + roaming: + duration: duration + number: 7.061401241503109 + amount: amount + national: + duration: duration + number: 5.637376656633329 + amount: amount + international: + duration: duration + number: 2.3021358869347655 + amount: amount + data: + download: 6.027456183070403 + sessions: 1.4658129805029452 + amount: amount + roaming: + download: 5.962133916683182 + amount: amount + upload: 0.8008281904610115 + messaging: + mms: + amount: amount + roaming: 1.2315135367772556 + national: 4.145608029883936 + international: 7.386281948385884 + sms: + amount: amount + roaming: 2.027123023002322 + national: 9.301444243932576 + international: 3.616076749251911 + serviceId: serviceId + startDate: startDate + - service: + phoneNumber: phoneNumber + endDate: endDate + displayName: displayName + usage: + voice: + roaming: + duration: duration + number: 7.061401241503109 + amount: amount + national: + duration: duration + number: 5.637376656633329 + amount: amount + international: + duration: duration + number: 2.3021358869347655 + amount: amount + data: + download: 6.027456183070403 + sessions: 1.4658129805029452 + amount: amount + roaming: + download: 5.962133916683182 + amount: amount + upload: 0.8008281904610115 + messaging: + mms: + amount: amount + roaming: 1.2315135367772556 + national: 4.145608029883936 + international: 7.386281948385884 + sms: + amount: amount + roaming: 2.027123023002322 + national: 9.301444243932576 + international: 3.616076749251911 + serviceId: serviceId + startDate: startDate + meta: '{}' + links: + self: self + properties: + data: + $ref: '#/components/schemas/TelcoUsageListResponseData' + links: + $ref: '#/components/schemas/Links' + meta: + type: object + required: + - data + - links + - meta + type: object + TelcoUsageListResponseData: example: accounts: - accountId: accountId @@ -6200,7 +5409,7 @@ components: accounts: description: Array of accounts items: - $ref: '#/components/schemas/TelcoAccountResponse' + $ref: '#/components/schemas/TelcoAccountResponseData' type: array required: - accounts @@ -6295,7 +5504,7 @@ components: required: - concessions type: object - TelcoBalanceListResponseBalances: + TelcoBalanceListResponseData: example: balances: - accountId: accountId @@ -6334,7 +5543,291 @@ components: required: - accountId, balance type: object + TelcoInvoiceResponse: + example: + data: + invoices: + - gstAmount: gstAmount + period: + endDate: endDate + startDate: startDate + accountCharges: + totalGst: totalGst + otherCharges: + amount: amount + description: description + type: SERVICE + totalUsageCharges: totalUsageCharges + totalDiscounts: totalDiscounts + totalOnceOffCharges: totalOnceOffCharges + dueDate: dueDate + invoiceAmount: invoiceAmount + services: + - services + - services + balanceAtIssue: balanceAtIssue + accountId: accountId + accountUsage: + voice: + roaming: + duration: duration + number: 7.061401241503109 + amount: amount + national: + duration: duration + number: 5.637376656633329 + amount: amount + international: + duration: duration + number: 2.3021358869347655 + amount: amount + data: + download: 6.027456183070403 + sessions: 1.4658129805029452 + amount: amount + roaming: + download: 5.962133916683182 + amount: amount + upload: 0.8008281904610115 + messaging: + mms: + amount: amount + roaming: 1.2315135367772556 + national: 4.145608029883936 + international: 7.386281948385884 + sms: + amount: amount + roaming: 2.027123023002322 + national: 9.301444243932576 + international: 3.616076749251911 + invoiceNumber: invoiceNumber + issueDate: issueDate + payOnTimeDiscount: + date: date + gstAmount: gstAmount + discountAmount: discountAmount + paymentStatus: NOT_PAID + - gstAmount: gstAmount + period: + endDate: endDate + startDate: startDate + accountCharges: + totalGst: totalGst + otherCharges: + amount: amount + description: description + type: SERVICE + totalUsageCharges: totalUsageCharges + totalDiscounts: totalDiscounts + totalOnceOffCharges: totalOnceOffCharges + dueDate: dueDate + invoiceAmount: invoiceAmount + services: + - services + - services + balanceAtIssue: balanceAtIssue + accountId: accountId + accountUsage: + voice: + roaming: + duration: duration + number: 7.061401241503109 + amount: amount + national: + duration: duration + number: 5.637376656633329 + amount: amount + international: + duration: duration + number: 2.3021358869347655 + amount: amount + data: + download: 6.027456183070403 + sessions: 1.4658129805029452 + amount: amount + roaming: + download: 5.962133916683182 + amount: amount + upload: 0.8008281904610115 + messaging: + mms: + amount: amount + roaming: 1.2315135367772556 + national: 4.145608029883936 + international: 7.386281948385884 + sms: + amount: amount + roaming: 2.027123023002322 + national: 9.301444243932576 + international: 3.616076749251911 + invoiceNumber: invoiceNumber + issueDate: issueDate + payOnTimeDiscount: + date: date + gstAmount: gstAmount + discountAmount: discountAmount + paymentStatus: NOT_PAID + meta: '{}' + links: + self: self + properties: + data: + $ref: '#/components/schemas/TelcoInvoiceListResponseData' + links: + $ref: '#/components/schemas/Links' + meta: + type: object + required: + - data + - links + - meta + type: object TelcoInvoiceListResponse: + example: + data: + invoices: + - gstAmount: gstAmount + period: + endDate: endDate + startDate: startDate + accountCharges: + totalGst: totalGst + otherCharges: + amount: amount + description: description + type: SERVICE + totalUsageCharges: totalUsageCharges + totalDiscounts: totalDiscounts + totalOnceOffCharges: totalOnceOffCharges + dueDate: dueDate + invoiceAmount: invoiceAmount + services: + - services + - services + balanceAtIssue: balanceAtIssue + accountId: accountId + accountUsage: + voice: + roaming: + duration: duration + number: 7.061401241503109 + amount: amount + national: + duration: duration + number: 5.637376656633329 + amount: amount + international: + duration: duration + number: 2.3021358869347655 + amount: amount + data: + download: 6.027456183070403 + sessions: 1.4658129805029452 + amount: amount + roaming: + download: 5.962133916683182 + amount: amount + upload: 0.8008281904610115 + messaging: + mms: + amount: amount + roaming: 1.2315135367772556 + national: 4.145608029883936 + international: 7.386281948385884 + sms: + amount: amount + roaming: 2.027123023002322 + national: 9.301444243932576 + international: 3.616076749251911 + invoiceNumber: invoiceNumber + issueDate: issueDate + payOnTimeDiscount: + date: date + gstAmount: gstAmount + discountAmount: discountAmount + paymentStatus: NOT_PAID + - gstAmount: gstAmount + period: + endDate: endDate + startDate: startDate + accountCharges: + totalGst: totalGst + otherCharges: + amount: amount + description: description + type: SERVICE + totalUsageCharges: totalUsageCharges + totalDiscounts: totalDiscounts + totalOnceOffCharges: totalOnceOffCharges + dueDate: dueDate + invoiceAmount: invoiceAmount + services: + - services + - services + balanceAtIssue: balanceAtIssue + accountId: accountId + accountUsage: + voice: + roaming: + duration: duration + number: 7.061401241503109 + amount: amount + national: + duration: duration + number: 5.637376656633329 + amount: amount + international: + duration: duration + number: 2.3021358869347655 + amount: amount + data: + download: 6.027456183070403 + sessions: 1.4658129805029452 + amount: amount + roaming: + download: 5.962133916683182 + amount: amount + upload: 0.8008281904610115 + messaging: + mms: + amount: amount + roaming: 1.2315135367772556 + national: 4.145608029883936 + international: 7.386281948385884 + sms: + amount: amount + roaming: 2.027123023002322 + national: 9.301444243932576 + international: 3.616076749251911 + invoiceNumber: invoiceNumber + issueDate: issueDate + payOnTimeDiscount: + date: date + gstAmount: gstAmount + discountAmount: discountAmount + paymentStatus: NOT_PAID + meta: + totalRecords: 6 + totalPages: 1 + links: + next: next + last: last + prev: prev + self: self + first: first + properties: + data: + $ref: '#/components/schemas/TelcoInvoiceListResponseData' + links: + $ref: '#/components/schemas/LinksPaginated' + meta: + $ref: '#/components/schemas/MetaPaginated' + required: + - data + - links + - meta + type: object + TelcoInvoiceListResponseData: example: invoices: - gstAmount: gstAmount @@ -6486,7 +5979,7 @@ components: invoiceNumber: invoiceNumber description: description serviceId: serviceId - type: SERVICE + type: OTHER startDate: startDate gst: gst payment: @@ -6523,7 +6016,7 @@ components: invoiceNumber: invoiceNumber description: description serviceId: serviceId - type: SERVICE + type: OTHER startDate: startDate gst: gst payment: @@ -6553,48 +6046,12 @@ components: required: - transactions type: object - ErrorListResponseMeta: - description: Additional data for customised error codes - properties: - urn: - 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. - type: string - type: object - x-conditional: - - urn - ErrorListResponsErrors: - properties: - code: - 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. - type: string - title: - 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. - type: string - detail: - description: A human-readable explanation specific to this occurrence of - the problem. - type: string - meta: - $ref: '#/components/schemas/ErrorListResponseMeta' - required: - - code - - detail - - title - type: object TelcoProductPricing: example: period: period + amount: amount name: name description: description - chargeAmount: chargeAmount properties: name: description: The display name of the pricing @@ -6608,12 +6065,12 @@ components: (excludes recurrence syntax) type: string x-cds-type: ExternalRef - chargeAmount: + amount: description: The amount charged for the duration period type: string x-cds-type: AmountString required: - - chargeAmount + - amount - description - name type: object @@ -6906,7 +6363,7 @@ components: required: - startDate type: object - TelcoAccountPlans: + TelcoAccountPlan: properties: nickname: description: Optional display name for the plan provided by the customer @@ -6914,7 +6371,8 @@ components: type: string type: default: MOBILE - description: The type of the plan + description: The type of the plan. The type of plan. A [MOBILE](https://www.legislation.gov.au/Details/C2022C00170/Html/Volume_1#_Toc95898745) + service or BROADBAND fixed internet service enum: - MOBILE - BROADBAND @@ -6940,36 +6398,31 @@ components: planOverview: $ref: '#/components/schemas/TelcoAccountPlanOverview' required: + - billingType + - planOverview - serviceIds + - type type: object - x-conditional: - - planOverview TelcoAccount: description: The array of plans containing services and associated plan details properties: plans: description: The array of plans containing service and associated plan details items: - $ref: '#/components/schemas/TelcoAccountPlans' + $ref: '#/components/schemas/TelcoAccountPlan' type: array required: - plans type: object - x-conditional: - - planOverview - TelcoAccountDetailPlanDetail: + TelcoAccountPlanDetail: description: Detail on the plan applicable to this account. Mandatory if openStatus is OPEN properties: - charges: - description: Charges for metering included in the plan - items: - $ref: '#/components/schemas/TelcoProductDetailMeteringCharges' - type: array + planDetail: + $ref: '#/components/schemas/TelcoAccountPlanDetail_planDetail' required: - - charges + - planDetail type: object - x-conditional: [] TelcoAccountDetailAuthorisedContacts: properties: firstName: @@ -6995,37 +6448,6 @@ components: required: - lastName type: object - TelcoAccountDetailPlans: - properties: - nickname: - description: Optional display name for the plan provided by the customer - to help differentiate multiple plans - type: string - serviceIds: - description: The serviceId representing a unique service identifier such - as a mobile [MSISDN](https://www.etsi.org/deliver/etsi_gts/03/0303/05.00.00_60/gsmts_0303v050000p.pdf), - [FNN](https://www.nbnco.com.au/content/dam/nbnco2/documents/sfaa-wba2-dictionary_FTTN-launch.pdf) - or internet service e.g [NBN AVC Service ID](https://www.nbnco.com.au/content/dam/nbnco2/documents/sfaa-wba2-dictionary_FTTN-launch.pdf). - In accordance with [CDR ID permanence](#id-permanence) requirement - items: - type: string - type: array - planOverview: - $ref: '#/components/schemas/TelcoAccountPlanOverview' - planDetail: - $ref: '#/components/schemas/TelcoAccountDetailPlanDetail' - authorisedContacts: - description: An array of additional contacts that are authorised to act - on this account - items: - $ref: '#/components/schemas/TelcoAccountDetailAuthorisedContacts' - type: array - required: - - serviceIds - type: object - x-conditional: - - planOverview - - planDetail TelcoAccountDetail: description: The array of plans containing services and associated plan details properties: @@ -7033,13 +6455,16 @@ components: description: The array of plans containing services and associated plan details items: - $ref: '#/components/schemas/TelcoAccountDetailPlans' + allOf: + - $ref: '#/components/schemas/TelcoAccountPlan' + - $ref: '#/components/schemas/TelcoAccountPlanDetail' + required: + - planDetail + - planOverview type: array required: - plans type: object - x-conditional: - - planOverview, planDetail TelcoPaymentScheduleCardDebit: description: Represents a regular credit card payment schedule. Mandatory if paymentScheduleUType is set to cardDebit @@ -7327,7 +6752,6 @@ components: - duration - number type: object - x-conditional: [] TelcoUsageVoiceInternational: description: International voice calls. Requied if international calling is supported @@ -7354,7 +6778,6 @@ components: - duration - number type: object - x-conditional: [] TelcoUsageVoiceRoaming: description: Roaming voice calls, Required if roaming is supported example: @@ -7380,7 +6803,6 @@ components: - duration - number type: object - x-conditional: [] TelcoUsageVoice: description: Summary of voice calls. Required if voice calls are included in product plan @@ -7803,3 +7225,38 @@ components: - data - voice - messaging + ResponseErrorListV2_errors: + properties: + code: + 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. + type: string + title: + 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. + type: string + detail: + description: A human-readable explanation specific to this occurrence of + the problem. + type: string + meta: + $ref: '#/components/schemas/MetaError' + required: + - code + - detail + - title + type: object + TelcoAccountPlanDetail_planDetail: + properties: + charges: + description: Charges for metering included in the plan + items: + $ref: '#/components/schemas/TelcoProductDetailMeteringCharges' + type: array + required: + - charges + type: object diff --git a/docs/index.html b/docs/index.html index 24b30454..e469d934 100644 --- a/docs/index.html +++ b/docs/index.html @@ -210,7 +210,7 @@
                                - +
                                Non-normative Examples Version Delta @@ -999,7 +999,7 @@ EnergyBillingListResponse
                              • - ErrorListResponse + ResponseErrorListV2
                              • EnergyPlan @@ -1217,7 +1217,10 @@ TelcoTransactionListResponse
                              • - ErrorListResponse + MetaError +
                                • +
                              • + ResponseErrorListV2
                              • TelcoProduct @@ -1238,7 +1241,10 @@ TelcoAccountBase
                              • - TelcoAccountResponse + TelcoAccountResponseData +
                                • +
                              • + TelcoAccountDetailResponseData
                              • TelcoPaymentSchedule @@ -1306,6 +1312,9 @@
                              • TelcoUsageListResponse
                                • +
                              • + TelcoUsageListResponseData +
                              • TelcoAccountListResponseData
                                • @@ -1316,22 +1325,22 @@ TelcoConcessionsResponseData
                              • - TelcoBalanceListResponseBalances + TelcoBalanceListResponseData
                              • TelcoBalanceResponseData
                              • - TelcoInvoiceListResponse + TelcoInvoiceResponse
                              • - TelcoTransactionListResponseData + TelcoInvoiceListResponse
                              • - ErrorListResponseMeta + TelcoInvoiceListResponseData
                              • - ErrorListResponsErrors + TelcoTransactionListResponseData
                              • TelcoProductPricing @@ -1376,20 +1385,17 @@ TelcoAccountPlanOverview
                              • - TelcoAccountPlans + TelcoAccountPlan
                              • TelcoAccount
                              • - TelcoAccountDetailPlanDetail + TelcoAccountPlanDetail
                              • TelcoAccountDetailAuthorisedContacts
                                • -
                              • - TelcoAccountDetailPlans -
                              • TelcoAccountDetail
                                • @@ -1675,7 +1681,7 @@ EnergyDerDetailResponse
                              • - ErrorListResponse + ResponseErrorListV2
                              • EnergyServicePoint @@ -1746,15 +1752,11 @@

                                Introduction

                                The Version Delta tab can be used to see in context changes between this version of the standards and the immediately previous version of the standards.
-
 This text is an example of a new addition to the standards:
 + New text added here
-
-This text is an example of text removed from the standards:
+This text is an example of text removed from the standards:
 - Old text removed
-
-Note: changes to request and response payloads are listed at the beginning of the relevant API section due to the documentation being auto generated from OpenAPI specification files.
-
+Note: changes to request and response payloads are listed at the beginning of the relevant API section due to the documentation being auto generated from OpenAPI specification files.
 Additional note for v1.22.0: For this version only the delta statements from v1.21.0 have been retained in v1.22.0 as the release dates between the two versions were close together.  The affected delta statements will be noted as being associated with v1.21.0
                                @@ -1771,9 +1773,14 @@

                                Introduction

                              • where the standards are specified as binding standards as required by the Consumer Data Right rules for the purposes of s56FA of the legislation, they apply as under contract between a data holder and an accredited data recipient. The legal effect of binding standards as between data holders and accredited data recipients is fully set out in s56FD and s56FE of the legislation.
                              +
                              + Added binding statement in response to legal advice
+
                              + +

                              Some of these standards will be binding data standards under the Competition and Consumer (Consumer Data Right) Data Standards (No. 1) 2023. See that instrument here. In summary, provisions of these standards (as they exist from time to time) that impose obligations or prohibitions on CDR entities are binding data standards. Provisions included in these standards merely by way of guidance are not binding data standards.

                              +

                              Version

                              -

                              These standards represent version 1.22.0 of the high level standards. See the versioning section for more information on how versions are managed in the standard.

                              +

                              These standards represent version 1.22.1 of the high level standards. See the versioning section for more information on how versions are managed in the standard.

                              Interpretation

                              @@ -1785,10 +1792,11 @@

                              Future Dated Obligations

                              The table below highlights these areas of the standards.

                              -
                              **v1.21.0 Change**
-Updated obligation dates for FAPI 1.0 Phase 3
-+ Added obligation dates for FAPI 1.0 Phase 4
-Updated Get Energy Accounts V2 and Get Energy Account Detail V2 obligation dates in line with the change to FY23 #3 obligation mileston
+
                              Removed obligations more than six months in the past
+
+Reordered FDO entries by applicable date
+
+Corrected some typos
 
                              
 
 
@@ -1799,96 +1807,6 @@ 
                              Future Dated Obligations
                              
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -1904,9 +1822,14 @@ 
                              Future Dated Obligations
                              
-
-
-
+
+
+
+
+
+
+
+
@@ -1944,21 +1867,6 @@ 
                              Future Dated Obligations
                              
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -1974,6 +1882,11 @@ 
                              Future Dated Obligations
                              
+
+
+
+
+
@@ -2052,9 +1965,19 @@ 
                              Register Dependency Schedule
                              The actual release dates for the Register APIs are expected to occur prior to these dates and are not defined by the Standards.
                              
 
-
                              Endpoint Version Schedule
                              
+
                              Endpoint Version Schedule
                              Updated the obligation dates schedule to have correct
+numbers for each date
 
-
                              A table-view of all endpoint versioning is available here.
                              
+Removed entries in the obligation dates schedule older
+than six months
+
+Corrected the year of the obligation date for Get
+Energy Account Detail V2
+
+Corrected link to go directly to the end point version
+schedule
+
                              
+
                              A table-view of all endpoint versioning is available here.
                              Normative References
                              
 
@@ -2432,14 +2355,15 @@ 
                              End Point Versioning
                              Each end point will have multiple versions independent of other end points.  A specific end point version will be requested by a client using a HTTP header. This header will be supported by all end points under the API standards.  See the section on HTTP Headers for more information on how versions are requested and supplied under the standards.
                              
 
-
                              A table-view of all endpoint versioning is available here.
                              
+
                              Corrected link to go directly to the end point version
+schedule
+
                              
+
                              A table-view of all endpoint versioning is available here.
                              URI Structure
                              
-
 
                              
 
                              Some example URIs that meet this standard are:  
                              
 
                              
-
 
                              1. https://www.bank.com.au/api/cds-au/v1/banking/accounts  
 2. https://www.bank.com.au/api/cds-au/v1/banking/accounts/abc123/transactions/?x=y#bar  
 3. https://www.bank.com.au/complex/uri/taxonomy/cds-au/v1/banking/products?page=2  
@@ -4581,9 +4505,7 @@ 
                              Withdrawal Standards
                              
 
                              
 
 
 
                              Standard Error CodesData Recipients and Data Holders MAY implement the standard error codes from July 1st 2021July 1st 2021
                              Get Metrics V2Version 2 of this end point MUST be made available by affected data holders by the end of July 2021July 31st 2021
                              Get Metrics V1Data holders MAY obsolete version 1 of this end point from October 31st 2021. Data Holders who go live with consumer data sharing from July 1st 2021 MAY go live with only Get Metrics v2 support. The CDR Register MUST upgrade their implementation to use version 2 by this timeOctober 31st 2021
                              Amending ConsentData Holders MUST implement the following standards from November 1st 2021 when a CDR consumer is invited to amend a current authorisation as per rule 4.22A and the ADR has supplied a cdr_arrangement_idNovember 1st 2021
                              CX Standards: Unavailable AccountsData Holders MAY implement the following data standards effective from 1 November 2021:
                              • Unavailable Accounts: No accounts can be shown
                              • Unavailable Accounts: Authorisation not permitted
                              • Unavailable Accounts: Request sharing rights
                              		November 1st 2021
                              CX Standards: WithdrawalsData Holders MUST implement the following data standards effective from 1 February 2022:
                              • Withdrawal: Secondary User Instruction
                              		February 1st 2022
                              Standard Error CodesData Recipients and Data Holders MUST implement the standard error codes from February 1st 2022February 1st 2022
                              Data Recipient CDR Arrangement EndpointFrom March 31st 2022, Data Recipients MUST support "CDR Arrangement JWT" method and "CDR Arrangement Form Parameter" method. 
                              Data Recipients SHOULD support the "CDR Arrangement JWT" method before March 31st 2022                              		March 31st 2022
                              Profile Scope Data LanguageFor new and amended consents and authorisations only, CDR participants SHOULD comply with the following standards from 1 February 2022, but MUST comply by 1 July 2022:
                              • Technical Standards: Revised Claims
                              • CX Standards: Profile Scope - Data Language Standards
                              Note: These standards changes do not apply to existing consents and authorisations unless they are amended on or following the compliance dates.                              		July 1st 2022
                              CX Standards: Joint AccountsData holders MUST implement the following data standards from 1 July 2022:
                              • Notifications: Alternative notification schedules for joint accounts
                              • Notifications: Joint account alerts
                              • Authorisation: Pending status
                              • Withdrawal: Joint accounts
                              		July 1st 2022
                              Information Security profileFAPI 1.0 adoption is introduced across three phases.
                              Phase 1: Voluntary FAPI 1.0 support & hygiene enhancements includes, amongst other changes:
                              • Enforces requirements for authorisation code, token and request object use
                              • Data Holders MAY support of FAPI 1.0 Final
                              • Data Holders MAY support of Authorization Code Flow (including [PKCE] and [JARM]) in conjunction with Hybrid Flow
                              		July 4th 2022
                              Get Payee Detail V2Version 2 of this end point MUST be made available by affected data holders by July 31st 2022July 31st 2022
                              Data Recipient CDR Arrangement EndpointFrom July 31st 2022, Data Holders MUST revoke consent using "CDR Arrangement JWT" method. 
                              Data Holders SHOULD use the "CDR Arrangement JWT" method from March 31st 2022                              		July 31st 2022
                              Get Payees V2Version 2 of this end point MUST be made available by affected data holders by July 31st 2022July 31st 2022
                              Self-Signed JWT Client AuthenticationUntil July 31st 2022, Data Recipients MUST accept the Resource Path for the endpoint and the <RecipientBaseURI> as a valid audience value. From July 31st 2022, Data Holders MUST use an audience value matching the Resource Path for the endpoint and the Data Recipient MUST verify the audience matches the Resource Path for the endpoint.July 31st 2022
                              Get Payees V1Data holders MAY obsolete version 1 of this end point from August 31st 2022.  Data recipients MUST upgrade their implementations to use version 2 by this timeAugust 31st 2022
                              Get Payee Detail V1Data holders MAY obsolete version 1 of this end point from August 31st 2022.  Data recipients MUST upgrade their implementations to use version 2 by this timeAugust 31st 2022
                              Information Security profileFAPI 1.0 adoption is introduced across three phases.
                              Phase 2: FAPI 1.0 Final (Baseline & Advanced) includes, amongst other changes:
                              • Enforces additional requirements for authorisation code, token and request object use
                              • Enforces PAR-only authorisation request data submission
                              • Refresh token cycling is not permitted
                              • Data Holders and Data Recipients MUST support FAPI 1.0 Final including [RFC9126], [RFC7636] and [JARM]
                              • Data Holders SHOULD support of Authorization Code Flow in conjunction with Hybrid Flow
                              		September 16th 2022
                              
 Get Metrics V3
 Version 3 of this end point MUST be made available by affected data holders by October 1st 2022
 October 1st 2022
 November 15th 2022
 
                              
 
                              Registration ValidationData Holders MUST ignore unsupported authorisation scopes presented in the SSA for the creation and update of client registrations from August 31st 2022August 31st 2022Get Energy Accounts V1
                              • Data Holders MAY go-live on November 15 2022 with v1 of this end point
                              • Data Holders MAY decommission v1 of this end point as soon v2 is supported
                              		November 15th 2022
                              Get Energy Account Detail V1
                              • Data Holders MAY go-live on November 15 2022 with v1 of this end point
                              • Data Holders MAY decommission v1 of this end point as soon v2 is supported
                              		November 15th 2022
 
                              
 
                              
 Get Account Detail V2
 February 28th 2023
 
                              
 
                              Get Energy Accounts V1
                              • Data Holders MAY go-live on November 15 2022 with v1 of this endopint
                              • Data Holders MAY decommission v1 of this endopint as soon v2 is supported
                              		November 15th 2022
                              Get Energy Account Detail V1
                              • Data Holders MAY go-live on November 15 2022 with v1 of this endopint
                              • Data Holders MAY decommission v1 of this endopint as soon v2 is supported
                              		November 15th 2022
                              Error Codes: Secondary Data Holder flag
                              • Data Holders MAY implement the isSecondaryDataHolderError field on November 15 2022
                              • Affected Data Holders MUST implement isSecondaryDataHolderError field by May 15 2023
                              		May 15th 2023
                              
 Get Energy Accounts V2
 Data Holder MUST implement v2 of this endpoint by April 14th 2023
 April 14th 2023
 April 14th 2023
 
                              
 
                              Error Codes: Secondary Data Holder flag
                              • Data Holders MAY implement the isSecondaryDataHolderError field on November 15 2022
                              • Affected Data Holders MUST implement isSecondaryDataHolderError field by May 15 2023
                              		May 15th 2023
                              
 Information Security profile
 FAPI 1.0 adoption is introduced across four phases.
                              Phase 4: Retire Hybrid Flow:
                              • Data Holders MAY retire Hybrid Flow
                              		
 July 10th 2023
 
 
 
 
 
 
 
 
                              
 
                              
 
                              
-
                              Security Profile
                              **v1.21.0 Change**
-Where “OIDC Authorization Code Flow” is referenced, change to be “Authorization Code Flow”.
-
                              
+
                              Security Profile
                              
 
                              Overview
                              
 
 
                              Until September 16th 2022
                              
@@ -4739,11 +4661,7 @@ 
                              Authentication Flows
                              
 
 
                              No other flows are currently supported.
                              
 
-
                              Baseline Security Provisions
                              **v1.21.0 Change**
-Moved baseline requirements applicable to both he OIDC Hybrid Flow and Authorization Code Flow outside of the OIDC Hybrid Flow section
-Updated obligation dates
-Require Data Holders to support both OIDC Hybrid Flow and Authorization Code Flow for a 3 month period. OIDC Hybrid Flow may be retired after July 10th 2023
-
                              Data Holders
                              
+
                              Baseline Security Provisions
                              Data Holders
                              
 
                              The request_uri parameter is only supported if the Data Holder supports PAR.
                              
 
 
                              In addition, the following statements are applicable to both the OIDC Hybrid Flow and Authorization Code Flow:
                              
@@ -4833,17 +4751,17 @@ 
                              OIDC Hybrid Flow
                              
 
 
                              
 
-
                              Authorization Code Flow
                              **v1.21.0 Change**
-+ Added requriements in relation to authorisation response encryption
-- Removed legacy July 4th 2022 requirements
-
                              
+
                              Authorization Code Flow
                              
+
 
                              The following statements are applicable for this flow:
                              
 
 
+
 
                              Data Holders
                              
+
 
                              Data Holders MUST support [JARM] in accordance with [FAPI-1.0-Advanced] section 5.2.2.2.
                              
 
 
                              
@@ -4859,7 +4777,9 @@ 
                              Data Holders
                              
 
                            • Data Holders MAY advertise they do not support authorisation response encryption: either by omitting these values from their OpenID Provider Metadata, or by presenting an empty array for the supported parameters.
                              • 
 
                            • If the Data Holder supports authorisation response encryption and the authorization_encrypted_response_alg is omitted from the registration request, the Data Holder MAY require response encryption by returning a client registration response with the chosen “authorization_encrypted_response_alg” value.
                              •
                            +

                            Data Recipient Software Products

                            +

                            Data Recipients MUST support [JARM] in accordance with [FAPI-1.0-Advanced] section 5.2.3.2.

                            In addition,

                            @@ -4874,7 +4794,9 @@

                            Data Recipient Software Products

                            Additional requirements and guidelines for the authentication flows are contained in the Consumer Experience section.

                            +

                            Client Authentication

                            +

                            This section outlines how participants in the CDR regime will authenticate clients seeking access to end points.

                            Note that, while [MTLS] is utilised for transaction security and as a Holder of Key mechanism, the PKI Mutual TLS OAuth Client Authentication Method SHALL NOT be supported as the mechanism for client authentication.

                            @@ -4891,10 +4813,13 @@

                            Client Authentication

                          • Data Holders and the CDR Register MUST authenticate Data Recipient Software Products using the Private Key JWT Client Authentication method.

                          • Data Recipient Software Products MUST authenticate Data Holders and the CDR Register using the Self-signed JWT Client Authentication method.

                          +

                          Private Key JWT Client Authentication

                          +

                          Private Key JWT Client Authentication Non-Normative Example - CDR Register calls the Data Holder's token end point to obtain an Access Token for the purposes of calling the Data Holder's Get Metrics endpoint.

                          + 
                          POST /token HTTP/1.1
 Host: www.holder.com.au
 Content-Type: application/x-www-form-urlencoded
@@ -4920,6 +4845,7 @@ 
                          Private Key JWT Client Authentica
   "jti": "37747cd1-c105-4569-9f75-4adf28b73e31"
 }
                          +

                          Authorisation Servers supporting private_key_jwt Client Authentication of clients MUST support the following requirements:

                            @@ -4946,10 +4872,13 @@

                            Private Key JWT Client Authentica
                          • scope - OPTIONAL. The requested scope as described in Section 3.3 of [RFC6749].

                        +

                        Self-signed JWT Client Authentication

                        +

                        Self-signed JWT Client Authentication Non-Normative Example - CDR Register calls the Data holder's Get Metrics end point using self-signed JWT Client Authentication (note that the “aud” claim represents the AdminBaseUri as defined in CDR Register Participant Endpoints).

                        + 
                        GET https://admin.data.holder.com.au/cds-au/v1/admin/metrics HTTP:/1.1
 Host: admin.data.holder.com.au
 x-v: string
@@ -4971,6 +4900,7 @@ 
                        Self-signed JWT Client Authentica
    "jti":"32358102-a44f-43cc-ad7c-42443d01507a"
 }
                        +

                        Data Recipient Software Products and Data Holders supporting the self-signed JWT authentication of clients using a signed JWT MUST do so according to the following requirements:

                          @@ -4989,6 +4919,7 @@

                          Self-signed JWT Client Authentica

                        Note: In accordance with jti requirements, self-signed JWTs are one-time use only. The authenticating server MUST reject JWTs reuse.

                        +

                        CDR Register calling Data Holders

                        Data Holders MUST support either Private Key JWT Client Authentication or Self-signed JWT Client Authentication of the CDR Register.

                        @@ -5232,8 +5163,7 @@

                        SSA Definition

                        cdr:registration" } -
                        + Added statement: Get Software Statement Assertion API v1 & v2 has the scope claim explicitly defined.
-
                        +

                        The SSA will conform to the requirements of [DCR] with the following clarifications:

                        @@ -5479,10 +5409,7 @@

                        Registration Request using JWT

                        The client registration request MUST contain the following claims in the JWT payload unless designated as Optional:

                        -
                        **v1.21.0 Change**
-+ Added JARM parameters
-Updated ID Token encryption parameter descriptions
-
                        +
                        @@ -5586,9 +5513,7 @@

                        Registration Request using JWT

                        Claim Software statement assertion issued by the CDR Register
                        -

                        ID Token Algorithm Selection Considerations

                        **v1.21.0 Change**
-Updated the section to make clear these requirements must be applied for OIDC Hybrid Flow
-
                        +

                        ID Token Algorithm Selection Considerations

                        When requiring ID Token encryption, the following requirements are applicable.

                        Participants MUST support, at a minimum, the following ID Token algorithms:

                        @@ -5614,9 +5539,7 @@

                        ID Token Algorithm Selectio

                        Data Recipients MUST support all the algorithms used in the ecosystem to ensure they can communicate with all Data Holders.

                        ID Token algorithm considerations remain relevant where the OIDC Hybrid Flow is leveraged as defined in the Consumer Data Standards and in accordance with sections 5.1.1, 5.2.2.1, and 5.2.3.1 of [FAPI-1.0-Advanced].

                        -

                        JARM Response Encryption Considerations

                        **v1.21.0 Change**
-+ Added JARM response encryption considerations
-
                        +

                        JARM Response Encryption Considerations

                        If Data Holders support authorisation response encryption, they MUST support, at a minimum, one of each of the following alg and enc algorithms:

                        @@ -6206,10 +6129,6 @@

                        Tokens

                        ID Token

                        "auth_time": 1311280969, "acr": "urn:cds.au:cdr:2" } -
                        **v1.21.0 Change**
-Updated heading levels to be consistent
-Moved hashing requirements underneath OIDC Hybrid Flow
-Clarified ID Token encryption requirements apply only to the OIDC Hybrid Flow

                        ID Tokens are specified in section 2 of the [OIDC] standard.

                        Baseline ID Token requirements

                        @@ -7700,8 +7619,7 @@

                        DCR APIs

                        DCR OpenAPI Specification (JSON)
                        DCR OpenAPI Specification (YAML)

                        -
                        Updated DCR field types to use Common Field Types
-
                        +

                        Register Data Recipient oAuth Client

                        @@ -8923,12 +8841,7 @@

                        Enumerated Values

                        Register APIs

                        The following section provides an overview of the Register APIs for Data Holders and Data Recipients to collect participant metadata. These endpoints are exposed by the Register and consumed by Data Holders and Data Recipients.

                        -
                        Updated Register API field types to use Common Field Types
 
-Modified the x-v request header descriptions that are optional
-to specify the default version that will be assumed if the header
-is absent
-