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 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
-
@@ -415,7 +398,7 @@ This operation does not require authentication
"name" : "string" ,
"description" : "string" ,
"period" : "string" ,
- "chargeAmount" : "string"
+ "amount" : "string"
}
],
"thirdPartyAgentId" : "string" ,
@@ -517,19 +500,19 @@ 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
@@ -549,27 +532,6 @@ This operation does not require authentication
none
-
-400
-x-fapi-interaction-id
-string
-none
-
-
-404
-x-fapi-interaction-id
-string
-none
-
-
-406
-x-fapi-interaction-id
-string
-none
-
@@ -645,7 +607,7 @@ This operation does not require authentication
path
string
mandatory
-ID of the specific service requested such as a mobile MSISDN , FNN or internet service e.g NBN AVC Service ID . This is a tokenised ID returned from the account. In accordance with CDR ID permanence requirements
+ID of the specific service requested. E.g. a mobile MSISDN , FNN or internet service e.g NBN AVC Service ID . This is a tokenised ID returned from the account. In accordance with CDR ID permanence requirements
oldest-date
@@ -662,20 +624,6 @@ This operation does not require authentication
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 optional
-Page of results to request (standard pagination)
-
-
-page-size
-query
-PositiveInteger optional
-Page size to request. Default is 25 (standard pagination)
-
-
x-v
header
string
@@ -776,16 +724,9 @@ This operation does not require authentication
}
},
"links" : {
- "self" : "string" ,
- "first" : "string" ,
- "prev" : "string" ,
- "next" : "string" ,
- "last" : "string"
+ "self" : "string"
},
- "meta" : {
- "totalRecords" : 0 ,
- "totalPages" : 0
- }
+ "meta" : {}
}
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
@@ -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
@@ -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 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
@@ -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 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
+
+
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
-
-
-
-and
-
-
-
-Name
-Type
-Required
-Description
-
-
-
-» anonymous
-TelcoAccount mandatory
-The array of plans containing services and associated plan details
-
-
-
-and
-
-
-
-Name
-Type
-Required
-Description
-
-
-
-» anonymous
-TelcoAccountDetail mandatory
-The array of plans containing services and associated plan details
-
-
-
-continued
-
-
-
-Name
-Type
-Required
-Description
-
-
links
Links ]
},
"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
links
-Links LinksPaginated mandatory
none
meta
-Meta MetaPaginated mandatory
none
@@ -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
links
-Links LinksPaginated mandatory
none
meta
-Meta MetaPaginated mandatory
none
@@ -6407,7 +6279,7 @@ To perform this operation, you must be authenticated and authorised with the fol
data
-TelcoBalanceListResponseBalances TelcoBalanceListResponseData mandatory
none
@@ -6622,9 +6494,35 @@ To perform this operation, you must be authenticated and authorised with the fol
-ErrorListResponse
+
+
+
+{
+ "urn" : "string"
+ }
+
+ Additional data for customised error codes
+Properties
+
+
+Name
+Type
+Required
+Description
+
+
+
+urn
+string
+conditional
+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.
+
+
+
+ResponseErrorListV2
-
+
{
"errors" : [
{
@@ -6638,7 +6536,7 @@ To perform this operation, you must be authenticated and authorised with the fol
]
}
- Properties
+ Properties
Name
@@ -6649,10 +6547,34 @@ To perform this operation, you must be authenticated and authorised with the fol
errors
-[ErrorListResponsErrors ]
+[object]
mandatory
none
+
+» code
+string
+mandatory
+The code of the error encountered. Where the error is specific to the respondent, an application-specific error code, expressed as a string value. If the error is application-specific, the URN code that the specific error extends must be provided in the meta object. Otherwise, the value is the error code URN.
+
+
+» title
+string
+mandatory
+A short, human-readable summary of the problem that MUST NOT change from occurrence to occurrence of the problem represented by the error code.
+
+
+» detail
+string
+mandatory
+A human-readable explanation specific to this occurrence of the problem.
+
+
+» meta
+MetaError optional
+Additional 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
Name
@@ -6746,7 +6668,7 @@ To perform this operation, you must be authenticated and authorised with the fol
type
string
mandatory
-The type of product
+The type of product. MOBILE service or BROADBAND fixed internet service
purpose
@@ -6764,7 +6686,7 @@ To perform this operation, you must be authenticated and authorised with the fol
contract
TelcoContract conditional
-Summary of the contract details. Required if a contract is required
+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
bundle
@@ -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
Name
@@ -6891,7 +6813,7 @@ To perform this operation, you must be authenticated and authorised with the fol
description
string
optional
-Description if the contract
+Description of the contract
duration
@@ -6914,7 +6836,7 @@ To perform this operation, you must be authenticated and authorised with the fol
"serviceId" : "string"
}
- Properties
+Properties
Name
@@ -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
services
[TelcoAccountUsageServices ]
-optional
+mandatory
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
Name
@@ -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
-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
-
-
-Name
+ "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
+Type
+Required
+Description
+
+
+
+anonymous TelcoAccountBase mandatory
+none
+
+
+
+and
+
+
+
+Name
+Type
+Required
+Description
+
+
+
+anonymous TelcoAccount mandatory
+The array of plans containing services and associated plan details
+
+
+
+and
+
+
+
+Name
+Type
+Required
+Description
+
+
+
+anonymous TelcoAccountDetail mandatory
+The 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
+
+
+Name
Type
Required
Description
@@ -7383,7 +7399,7 @@ To perform this operation, you must be authenticated and authorised with the fol
]
}
- Properties
+Properties
Name
@@ -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
+
+
+TelcoUsageListResponseData
+
+
{
"accounts" : [
{
@@ -9055,7 +9171,7 @@ To perform this operation, you must be authenticated and authorised with the fol
]
}
- Properties
+Properties
Name
@@ -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
accounts
-[TelcoAccountResponse ]
+[TelcoAccountResponseData ]
mandatory
Array of accounts
@@ -9156,7 +9272,7 @@ To perform this operation, you must be authenticated and authorised with the fol
]
}
- Properties
+Properties
Name
@@ -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
-TelcoBalanceListResponseBalances
+TelcoBalanceListResponseData
-
+
{
"balances" : [
{
@@ -9286,7 +9402,7 @@ To perform this operation, you must be authenticated and authorised with the fol
]
}
- Properties
+Properties
Name
@@ -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
-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
+
+
+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
+
+
+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
Name
@@ -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
-Type
-Required
-Description
-
-
-
-transactions
-[TelcoBillingTransaction ]
-mandatory
-Array of transactions sorted by date and time in descending order
-
-
-
-
-
-
-{
- "urn" : "string"
- }
-
- Additional data for customised error codes
-Properties
-
-
-Name
-Type
-Required
-Description
-
-
-
-urn
-string
-conditional
-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.
-
-
-
-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
Name
@@ -9615,28 +9921,10 @@ To perform this operation, you must be authenticated and authorised with the fol
-code
-string
-mandatory
-The code of the error encountered. Where the error is specific to the respondent, an application-specific error code, expressed as a string value. If the error is application-specific, the URN code that the specific error extends must be provided in the meta object. Otherwise, the value is the error code URN.
-
-
-title
-string
-mandatory
-A short, human-readable summary of the problem that MUST NOT change from occurrence to occurrence of the problem represented by the error code.
-
-
-detail
-string
+transactions
+[TelcoBillingTransaction ]
mandatory
-A human-readable explanation specific to this occurrence of the problem.
-
-
-meta
-ErrorListResponseMeta optional
-Additional data for customised error codes
+Array 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
Name
@@ -9678,7 +9966,7 @@ To perform this operation, you must be authenticated and authorised with the fol
The duration that occurs on a pricing schedule indicates the frequency. Formatted according to ISO 8601 Durations (excludes recurrence syntax)
-chargeAmount
+amount
AmountString mandatory
The amount charged for the duration period
@@ -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
Name
@@ -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
-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
Name
@@ -10428,13 +10716,13 @@ To perform this operation, you must be authenticated and authorised with the fol
type
string
-optional
-The type of the plan
+mandatory
+The type of the plan. The type of plan. A MOBILE service or BROADBAND fixed internet service
billingType
string
-optional
+mandatory
The billing type of then plan
@@ -10446,7 +10734,7 @@ To perform this operation, you must be authenticated and authorised with the fol
planOverview
TelcoAccountPlanOverview conditional
+mandatory
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
Name
@@ -10517,30 +10805,32 @@ To perform this operation, you must be authenticated and authorised with the fol
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
Name
@@ -10550,7 +10840,13 @@ To perform this operation, you must be authenticated and authorised with the fol
-charges
+planDetail
+object
+mandatory
+none
+
+
+» charges
[TelcoProductDetailMeteringCharges ]
mandatory
Charges for metering included in the plan
@@ -10570,7 +10866,7 @@ To perform this operation, you must be authenticated and authorised with the fol
"suffix" : "string"
}
- Properties
+Properties
Name
@@ -10611,84 +10907,6 @@ To perform this operation, you must be authenticated and authorised with the fol
-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
-
-
-Name
-Type
-Required
-Description
-
-
-
-nickname
-string
-optional
-Optional display name for the plan provided by the customer to help differentiate multiple plans
-
-
-serviceIds
-[string]
-mandatory
-The 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
-
-
-planOverview
-TelcoAccountPlanOverview conditional
-Mandatory if openStatus is OPEN
-
-
-planDetail
-TelcoAccountDetailPlanDetail conditional
-Detail on the plan applicable to this account. Mandatory if openStatus is OPEN
-
-
-authorisedContacts
-[TelcoAccountDetailAuthorisedContacts ]
-optional
-An 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
Name
@@ -10743,12 +10952,48 @@ To perform this operation, you must be authenticated and authorised with the fol
plans
-[TelcoAccountDetailPlans ]
+[allOf]
mandatory
The array of plans containing services and associated plan details
+allOf
+
+
+
+Name
+Type
+Required
+Description
+
+
+
+» anonymous
+TelcoAccountPlan mandatory
+none
+
+
+
+and
+
+
+
+Name
+Type
+Required
+Description
+
+
+
+» anonymous
+TelcoAccountPlanDetail mandatory
+Detail 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
Name
@@ -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 @@
+22/03/2023
+1.22.1
+Patch release including updates to draft Telco standards
+See release notes for details.
+
+
22/12/2022
1.22.0
Changes arising from Decision 271 (Maintenance iteration 13)
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 @@
-
+
Obligation Dates Schedule
@@ -273,73 +273,23 @@ Obligation Dates Schedule
Legacy FDO 01/07/2021
-1
-
-
-Legacy FDO 31/07/2021
-1
-
-
-Legacy FDO 31/10/2021
-1
-
-
-Legacy FDO 01/11/2021
-2
-
-
-Legacy FDO 01/02/2022
-2
-
-
-Y22 #1 31/03/2022
-1
-
-
-Legacy FDO 01/07/2022
-2
-
-
-Y22 #2 04/07/2022
+16/09/2022
1
Legacy FDO 31/07/2022
-4
-
-
-Legacy FDO 30/07/2022
-6
-
-
-Y22 #3 31/08/2022
-2
-
-
-Legacy FDO 16/09/2022
+01/10/2022
1
Legacy FDO 01/10/2022
+01/11/2022
1
Y22 #4 15/11/2022
-1
+3
Legacy FDO Obligation Dates Schedule
Y23 #1 14/04/2023
-1
+3
Y23 #2 08/05/2023
-0
+15/05/2023
+1
Y23 #3 10/07/2023
-1
+3
Y23 #4 Obligation Dates Schedule
Y24 #1 11/03/2024
-0
+2
Y24 #2 Energy APIs
2022-11-15
2023-04-14
2021-10-29, V1.14.0
-TBC, V1.19.0
+2022-09-13, V1.19.0
Energy APIs
@@ -818,7 +768,7 @@ Energy APIs
V2
2023-04-14
N/A
-TBC, V1.19.0
+2022-09-13, V1.19.0
N/A
@@ -830,7 +780,7 @@ Energy APIs
2022-11-15
2023-04-14
2021-10-29, V1.14.0
-TBC, V1.19.0
+2022-09-13, V1.19.0
Energy APIs
@@ -838,9 +788,9 @@ Energy APIs
/energy/accounts/{accountId}GET V2
-2022-04-14
+2023-04-14
N/A
-TBC, V1.19.0
+2022-09-13, V1.19.0
N/A
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 @@
-
+
+ 