NAV Navbar
Non-normative Examples Version Delta

Telco APIs

This specification defines the APIs for Data Holders exposing Telecommunications endpoints.

Telco OpenAPI Specification (JSON)
Telco OpenAPI Specification (YAML)

Get Telco Products

Code samples

GET https://data.holder.com.au/cds-au/v1/telco/products HTTP/1.1
Host: data.holder.com.au
Accept: application/json
x-v: string
x-min-v: string

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'x-v':'string',
  'x-min-v':'string'

};

fetch('https://data.holder.com.au/cds-au/v1/telco/products',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /telco/products

Obtain a list of telco products that are currently offered to the market.

Note that the results returned by this end point are expected to be ordered in descending order according to lastUpdated.

Endpoint Version

Version 1

Parameters

Name In Type Required Description
type 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 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', 'ALL'
effective query string optional Allows for the filtering of productd based on whether the current time is within the period of time defined as effective by the effectiveFrom and effectiveTo fields. Valid values are ‘CURRENT’, ‘FUTURE’ and ‘ALL’. If absent defaults to 'CURRENT'
updated-since query DateTimeString optional Only include products that have been updated after the specified date and time. If absent defaults to include all plans
brand query string optional Used to filter results on the brand field. If absent, defaults to include all products. For service providers that operate a number of mobile and internet brands
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 mandatory 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 and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v 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
x-min-v header string optional Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

Enumerated Values

Parameter Value
type MOBILE
type BROADBAND
type ALL
billing-type PRE_PAID
billing-type POST_PAID
billing-type UPFRONT_PAID
billing-type ALL
effective CURRENT
effective FUTURE
effective ALL

Example responses

200 Response

{
  "data": {
    "plans": [
      {
        "productId": "string",
        "effectiveFrom": "string",
        "effectiveTo": "string",
        "lastUpdated": "string",
        "displayName": "string",
        "description": "string",
        "type": "MOBILE",
        "purpose": "PERSONAL",
        "billingType": "PRE_PAID",
        "contract": {
          "name": "string",
          "description": "string",
          "duration": 0,
          "contractUri": "string"
        },
        "bundle": true,
        "brand": "string",
        "brandName": "string",
        "pricing": [
          {
            "name": "string",
            "description": "string",
            "period": "string",
            "amount": "string"
          }
        ],
        "thirdPartyAgentId": "string",
        "thirdPartyAgentName": "string",
        "applicationUri": "string",
        "additionalInformation": {
          "overviewUri": "string",
          "termsUri": "string",
          "eligibilityUri": "string",
          "pricingUri": "string",
          "bundleUri": "string"
        }
      }
    ]
  },
  "links": {
    "self": "string",
    "first": "string",
    "prev": "string",
    "next": "string",
    "last": "string"
  },
  "meta": {
    "totalRecords": 0,
    "totalPages": 0
  }
}

Responses

Status Meaning Description Schema
200 OK Successful response TelcoProductListResponse
400 Bad Request The following error codes MUST be supported:
ResponseErrorListV2
406 Not Acceptable The following error codes MUST be supported:
ResponseErrorListV2
422 Unprocessable Entity The following error codes MUST be supported:
ResponseErrorListV2

Response Headers

Status Header Type Format Description
200 x-v string none

Get Telco Product Detail

Code samples

GET https://data.holder.com.au/cds-au/v1/telco/products/{productId} HTTP/1.1
Host: data.holder.com.au
Accept: application/json
x-v: string
x-min-v: string

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'x-v':'string',
  'x-min-v':'string'

};

fetch('https://data.holder.com.au/cds-au/v1/telco/products/{productId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /telco/products/{productId}

Obtain detailed information on a single telco prouct offered openly to the market

Endpoint Version

Version 1

Parameters

Name In Type Required Description
productId path string mandatory ID of the specific product requested
x-v header string mandatory 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 and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v 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
x-min-v header string optional Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

Example responses

200 Response

{
  "data": {
    "productId": "string",
    "effectiveFrom": "string",
    "effectiveTo": "string",
    "lastUpdated": "string",
    "displayName": "string",
    "description": "string",
    "type": "MOBILE",
    "purpose": "PERSONAL",
    "billingType": "PRE_PAID",
    "contract": {
      "name": "string",
      "description": "string",
      "duration": 0,
      "contractUri": "string"
    },
    "bundle": true,
    "brand": "string",
    "brandName": "string",
    "pricing": [
      {
        "name": "string",
        "description": "string",
        "period": "string",
        "amount": "string"
      }
    ],
    "thirdPartyAgentId": "string",
    "thirdPartyAgentName": "string",
    "applicationUri": "string",
    "additionalInformation": {
      "overviewUri": "string",
      "termsUri": "string",
      "eligibilityUri": "string",
      "pricingUri": "string",
      "bundleUri": "string"
    },
    "meteringCharges": [
      {
        "displayName": "string",
        "description": "string",
        "minimumValue": "string",
        "maximumValue": "string",
        "period": "string"
      }
    ],
    "bundles": [
      {
        "displayName": "string",
        "description": "string",
        "bundleUri": "string",
        "features": [
          {
            "displayName": "string",
            "description": "string",
            "category": "DATA"
          }
        ]
      }
    ],
    "plans": [
      {
        "displayName": "string",
        "description": "string",
        "planUri": "string",
        "features": [
          {
            "displayName": "string",
            "description": "string"
          }
        ]
      }
    ],
    "discounts": [
      {
        "displayName": "string",
        "description": "string",
        "discountUri": "string",
        "features": [
          {
            "displayName": "string",
            "description": "string"
          }
        ]
      }
    ],
    "incentives": [
      {
        "displayName": "string",
        "description": "string",
        "incentiveUri": "string",
        "features": [
          {
            "displayName": "string",
            "description": "string"
          }
        ]
      }
    ]
  },
  "links": {
    "self": "string"
  },
  "meta": {}
}

Responses

Status Meaning Description Schema
200 OK Successful response TelcoProductResponse
400 Bad Request The following error codes MUST be supported:
ResponseErrorListV2
404 Not Found The following error codes MUST be supported:
ResponseErrorListV2
406 Not Acceptable The following error codes MUST be supported:
ResponseErrorListV2

Response Headers

Status Header Type Format Description
200 x-v string none

Get Usage For Telco Service

Code samples

GET https://data.holder.com.au/cds-au/v1/telco/accounts/{serviceId}/usage HTTP/1.1
Host: data.holder.com.au
Accept: application/json
x-v: string
x-min-v: string
x-fapi-interaction-id: string
x-fapi-auth-date: string
x-fapi-customer-ip-address: string
x-cds-client-headers: string

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'x-v':'string',
  'x-min-v':'string',
  'x-fapi-interaction-id':'string',
  'x-fapi-auth-date':'string',
  'x-fapi-customer-ip-address':'string',
  'x-cds-client-headers':'string'

};

fetch('https://data.holder.com.au/cds-au/v1/telco/accounts/{serviceId}/usage',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /telco/accounts/{serviceId}/usage

Obtain a usage data from a particular service Id

Endpoint Version

Version 1

Parameters

Name In Type Required Description
serviceId path string mandatory 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 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
x-v header string mandatory 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 and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v 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
x-min-v header string optional Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
x-fapi-interaction-id header string optional An [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] UUID value is required to be provided in the response header to track the interaction.
x-fapi-auth-date header string conditional The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.
x-fapi-customer-ip-address header string optional The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.
x-cds-client-headers header Base64 conditional The customer's original standard http headers Base64 encoded, including the original User Agent header, if the customer is currently logged in to the data recipient. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.

Example responses

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"
  },
  "meta": {}
}

Responses

Status Meaning Description Schema
200 OK Successful response TelcoServiceUsageResponse
400 Bad Request The following error codes MUST be supported:
ResponseErrorListV2
404 Not Found The following error codes MUST be supported:
ResponseErrorListV2
406 Not Acceptable The following error codes MUST be supported:
ResponseErrorListV2
422 Unprocessable Entity The following error codes MUST be supported:
ResponseErrorListV2

Response Headers

Status Header Type Format Description
200 x-v string none
200 x-fapi-interaction-id string none
400 x-fapi-interaction-id string none
404 x-fapi-interaction-id string none
406 x-fapi-interaction-id string none
422 x-fapi-interaction-id string none

Get Usage

Code samples

GET https://data.holder.com.au/cds-au/v1/telco/accounts/usage HTTP/1.1
Host: data.holder.com.au
Accept: application/json
x-v: string
x-min-v: string
x-fapi-interaction-id: string
x-fapi-auth-date: string
x-fapi-customer-ip-address: string
x-cds-client-headers: string

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'x-v':'string',
  'x-min-v':'string',
  'x-fapi-interaction-id':'string',
  'x-fapi-auth-date':'string',
  'x-fapi-customer-ip-address':'string',
  'x-cds-client-headers':'string'

};

fetch('https://data.holder.com.au/cds-au/v1/telco/accounts/usage',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /telco/accounts/usage

Obtain usage data for all services associated with the customer

Endpoint Version

Version 1

Parameters

Name In Type Required Description
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 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 mandatory 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 and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v 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
x-min-v header string optional Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
x-fapi-interaction-id header string optional An [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] UUID value is required to be provided in the response header to track the interaction.
x-fapi-auth-date header string conditional The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.
x-fapi-customer-ip-address header string optional The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.
x-cds-client-headers header Base64 conditional The customer's original standard http headers Base64 encoded, including the original User Agent header, if the customer is currently logged in to the data recipient. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.

Example responses

200 Response

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

Status Meaning Description Schema
200 OK Successful response TelcoUsageListResponse
400 Bad Request The following error codes MUST be supported:
ResponseErrorListV2
406 Not Acceptable The following error codes MUST be supported:
ResponseErrorListV2
422 Unprocessable Entity The following error codes MUST be supported:
ResponseErrorListV2

Response Headers

Status Header Type Format Description
200 x-v string none
200 x-fapi-interaction-id string none
400 x-fapi-interaction-id string none
406 x-fapi-interaction-id string none
422 x-fapi-interaction-id string none

Get Usage For Specific Telco Service

Code samples

POST https://data.holder.com.au/cds-au/v1/telco/accounts/usage HTTP/1.1
Host: data.holder.com.au
Content-Type: application/json
Accept: application/json
x-v: string
x-min-v: string
x-fapi-interaction-id: string
x-fapi-auth-date: string
x-fapi-customer-ip-address: string
x-cds-client-headers: string

const fetch = require('node-fetch');
const inputBody = '{
  "data": {
    "serviceIds": [
      "string"
    ]
  },
  "meta": {}
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'x-v':'string',
  'x-min-v':'string',
  'x-fapi-interaction-id':'string',
  'x-fapi-auth-date':'string',
  'x-fapi-customer-ip-address':'string',
  'x-cds-client-headers':'string'

};

fetch('https://data.holder.com.au/cds-au/v1/telco/accounts/usage',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /telco/accounts/usage

Obtain usage data for a specific service

Body parameter

{
  "data": {
    "serviceIds": [
      "string"
    ]
  },
  "meta": {}
}

Endpoint Version

Version 1

Parameters

Name In Type Required Description
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 mandatory 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 and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v 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
x-min-v header string optional Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
x-fapi-interaction-id header string optional An [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] UUID value is required to be provided in the response header to track the interaction.
x-fapi-auth-date header string conditional The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.
x-fapi-customer-ip-address header string optional The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.
x-cds-client-headers header Base64 conditional The customer's original standard http headers Base64 encoded, including the original User Agent header, if the customer is currently logged in to the data recipient. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.
body body serviceIdList mandatory Request payload containing list of specific Service Points to obtain data for
» data body object mandatory none
»» serviceIds body [string] mandatory Array of specific serviceIds to obtain data for. E.g. a mobile MSISDN, FNN or internet service e.g NBN AVC Service ID. In accordance with CDR ID permanence requirements
» meta body Meta mandatory none

Example responses

200 Response

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

Status Meaning Description Schema
200 OK Successful response TelcoUsageListResponse
400 Bad Request The following error codes MUST be supported:
ResponseErrorListV2
406 Not Acceptable The following error codes MUST be supported:
ResponseErrorListV2
422 Unprocessable Entity The following error codes MUST be supported:
ResponseErrorListV2

Response Headers

Status Header Type Format Description
200 x-v string none
200 x-fapi-interaction-id string none
400 x-fapi-interaction-id string none
406 x-fapi-interaction-id string none
422 x-fapi-interaction-id string none

Get Telco Accounts

Code samples

GET https://data.holder.com.au/cds-au/v1/telco/accounts HTTP/1.1
Host: data.holder.com.au
Accept: application/json
x-v: string
x-min-v: string
x-fapi-interaction-id: string
x-fapi-auth-date: string
x-fapi-customer-ip-address: string
x-cds-client-headers: string

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'x-v':'string',
  'x-min-v':'string',
  'x-fapi-interaction-id':'string',
  'x-fapi-auth-date':'string',
  'x-fapi-customer-ip-address':'string',
  'x-cds-client-headers':'string'

};

fetch('https://data.holder.com.au/cds-au/v1/telco/accounts',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /telco/accounts

Obtain the list of telco accounts available under the authorised consent

Endpoint Version

Version 1

Parameters

Name In Type Required Description
open-status query string optional 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 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 mandatory 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 and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v 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
x-min-v header string optional Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
x-fapi-interaction-id header string optional An [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] UUID value is required to be provided in the response header to track the interaction.
x-fapi-auth-date header string conditional The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.
x-fapi-customer-ip-address header string optional The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.
x-cds-client-headers header Base64 conditional The customer's original standard http headers Base64 encoded, including the original User Agent header, if the customer is currently logged in to the data recipient. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.

Enumerated Values

Parameter Value
open-status ALL
open-status CLOSED
open-status OPEN

Example responses

200 Response

{
  "data": {
    "accounts": [
      {
        "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"
            }
          }
        ]
      }
    ]
  },
  "links": {
    "self": "string",
    "first": "string",
    "prev": "string",
    "next": "string",
    "last": "string"
  },
  "meta": {
    "totalRecords": 0,
    "totalPages": 0
  }
}

Responses

Status Meaning Description Schema
200 OK Successful response TelcoAccountListResponse
400 Bad Request The following error codes MUST be supported:
ResponseErrorListV2
406 Not Acceptable The following error codes MUST be supported:
ResponseErrorListV2
422 Unprocessable Entity The following error codes MUST be supported:
ResponseErrorListV2

Response Headers

Status Header Type Format Description
200 x-v string none
200 x-fapi-interaction-id string none
400 x-fapi-interaction-id string none
406 x-fapi-interaction-id string none
422 x-fapi-interaction-id string none

Get Telco Account Detail

Code samples

GET https://data.holder.com.au/cds-au/v1/telco/accounts/{accountId} HTTP/1.1
Host: data.holder.com.au
Accept: application/json
x-v: string
x-min-v: string
x-fapi-interaction-id: string
x-fapi-auth-date: string
x-fapi-customer-ip-address: string
x-cds-client-headers: string

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'x-v':'string',
  'x-min-v':'string',
  'x-fapi-interaction-id':'string',
  'x-fapi-auth-date':'string',
  'x-fapi-customer-ip-address':'string',
  'x-cds-client-headers':'string'

};

fetch('https://data.holder.com.au/cds-au/v1/telco/accounts/{accountId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /telco/accounts/{accountId}

Obtain detailed information for a specific telco account

Endpoint Version

Version 1

Parameters

Name In Type Required Description
accountId 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
x-v header string mandatory 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 and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v 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
x-min-v header string optional Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
x-fapi-interaction-id header string optional An [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] UUID value is required to be provided in the response header to track the interaction.
x-fapi-auth-date header string conditional The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.
x-fapi-customer-ip-address header string optional The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.
x-cds-client-headers header Base64 conditional The customer's original standard http headers Base64 encoded, including the original User Agent header, if the customer is currently logged in to the data recipient. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.

Example responses

200 Response

{
  "data": {
    "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"
            }
          ]
        }
      }
    ]
  },
  "links": {
    "self": "string"
  },
  "meta": {}
}

Responses

Status Meaning Description Schema
200 OK Successful response TelcoAccountDetailResponse
400 Bad Request The following error codes MUST be supported:
ResponseErrorListV2
404 Not Found The following error codes MUST be supported:
ResponseErrorListV2
406 Not Acceptable The following error codes MUST be supported:
ResponseErrorListV2

Response Headers

Status Header Type Format Description
200 x-v string none
200 x-fapi-interaction-id string none
400 x-fapi-interaction-id string none
404 x-fapi-interaction-id string none
406 x-fapi-interaction-id string none

Get Telco Agreed Payment Schedule

Code samples

GET https://data.holder.com.au/cds-au/v1/telco/accounts/{accountId}/payment-schedule HTTP/1.1
Host: data.holder.com.au
Accept: application/json
x-v: string
x-min-v: string
x-fapi-interaction-id: string
x-fapi-auth-date: string
x-fapi-customer-ip-address: string
x-cds-client-headers: string

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'x-v':'string',
  'x-min-v':'string',
  'x-fapi-interaction-id':'string',
  'x-fapi-auth-date':'string',
  'x-fapi-customer-ip-address':'string',
  'x-cds-client-headers':'string'

};

fetch('https://data.holder.com.au/cds-au/v1/telco/accounts/{accountId}/payment-schedule',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /telco/accounts/{accountId}/payment-schedule

Obtain the agreed payment schedule and details, if any, for a specific telco account.

Some general notes about this end point:

Endpoint Version

Version 1

Parameters

Name In Type Required Description
accountId 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
x-v header string mandatory 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 and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v 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
x-min-v header string optional Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
x-fapi-interaction-id header string optional An [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] UUID value is required to be provided in the response header to track the interaction.
x-fapi-auth-date header string conditional The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.
x-fapi-customer-ip-address header string optional The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.
x-cds-client-headers header Base64 conditional The customer's original standard http headers Base64 encoded, including the original User Agent header, if the customer is currently logged in to the data recipient. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.

Example responses

200 Response

{
  "data": {
    "paymentSchedules": [
      {
        "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"
        }
      }
    ]
  },
  "links": {
    "self": "string",
    "first": "string",
    "prev": "string",
    "next": "string",
    "last": "string"
  },
  "meta": {
    "totalRecords": 0,
    "totalPages": 0
  }
}

Responses

Status Meaning Description Schema
200 OK Successful response TelcoPaymentScheduleResponse
400 Bad Request The following error codes MUST be supported:
ResponseErrorListV2
404 Not Found The following error codes MUST be supported:
ResponseErrorListV2
406 Not Acceptable The following error codes MUST be supported:
ResponseErrorListV2

Response Headers

Status Header Type Format Description
200 x-v string none
200 x-fapi-interaction-id string none
400 x-fapi-interaction-id string none
404 x-fapi-interaction-id string none
406 x-fapi-interaction-id string none

Get Telco Concessions

Code samples

GET https://data.holder.com.au/cds-au/v1/telco/accounts/{accountId}/concessions HTTP/1.1
Host: data.holder.com.au
Accept: application/json
x-v: string
x-min-v: string
x-fapi-interaction-id: string
x-fapi-auth-date: string
x-fapi-customer-ip-address: string
x-cds-client-headers: string

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'x-v':'string',
  'x-min-v':'string',
  'x-fapi-interaction-id':'string',
  'x-fapi-auth-date':'string',
  'x-fapi-customer-ip-address':'string',
  'x-cds-client-headers':'string'

};

fetch('https://data.holder.com.au/cds-au/v1/telco/accounts/{accountId}/concessions',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /telco/accounts/{accountId}/concessions

Obtain the details of any concessions or arrangements applied to a specific telco account

Endpoint Version

Version 1

Parameters

Name In Type Required Description
accountId 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
x-v header string mandatory 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 and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v 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
x-min-v header string optional Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
x-fapi-interaction-id header string optional An [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] UUID value is required to be provided in the response header to track the interaction.
x-fapi-auth-date header string conditional The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.
x-fapi-customer-ip-address header string optional The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.
x-cds-client-headers header Base64 conditional The customer's original standard http headers Base64 encoded, including the original User Agent header, if the customer is currently logged in to the data recipient. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.

Example responses

200 Response

{
  "data": {
    "concessions": [
      {
        "type": "CONCESSION",
        "displayName": "string",
        "additionalInfo": "string",
        "additionalInfoUri": "string",
        "startDate": "string",
        "endDate": "string",
        "discountFrequency": "string",
        "amount": "string",
        "percentage": "string",
        "appliedTo": [
          "INVOICE"
        ]
      }
    ]
  },
  "links": {
    "self": "string",
    "first": "string",
    "prev": "string",
    "next": "string",
    "last": "string"
  },
  "meta": {
    "totalRecords": 0,
    "totalPages": 0
  }
}

Responses

Status Meaning Description Schema
200 OK Successful response TelcoConcessionsResponse
400 Bad Request The following error codes MUST be supported:
ResponseErrorListV2
404 Not Found The following error codes MUST be supported:
ResponseErrorListV2
406 Not Acceptable The following error codes MUST be supported:
ResponseErrorListV2

Response Headers

Status Header Type Format Description
200 x-v string none
200 x-fapi-interaction-id string none
400 x-fapi-interaction-id string none
404 x-fapi-interaction-id string none
406 x-fapi-interaction-id string none

Get Balance For Telco Account

Code samples

GET https://data.holder.com.au/cds-au/v1/telco/accounts/{accountId}/balance HTTP/1.1
Host: data.holder.com.au
Accept: application/json
x-v: string
x-min-v: string
x-fapi-interaction-id: string
x-fapi-auth-date: string
x-fapi-customer-ip-address: string
x-cds-client-headers: string

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'x-v':'string',
  'x-min-v':'string',
  'x-fapi-interaction-id':'string',
  'x-fapi-auth-date':'string',
  'x-fapi-customer-ip-address':'string',
  'x-cds-client-headers':'string'

};

fetch('https://data.holder.com.au/cds-au/v1/telco/accounts/{accountId}/balance',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /telco/accounts/{accountId}/balance

Obtain the current balance for a specific account

Endpoint Version

Version 1

Parameters

Name In Type Required Description
accountId 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
x-v header string mandatory 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 and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v 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
x-min-v header string optional Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
x-fapi-interaction-id header string optional An [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] UUID value is required to be provided in the response header to track the interaction.
x-fapi-auth-date header string conditional The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.
x-fapi-customer-ip-address header string optional The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.
x-cds-client-headers header Base64 conditional The customer's original standard http headers Base64 encoded, including the original User Agent header, if the customer is currently logged in to the data recipient. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.

Example responses

200 Response

{
  "data": {
    "services": [
      {
        "serviceId": "string",
        "displayName": "string",
        "phoneNumber": "string",
        "startDate": "string",
        "endDate": "string",
        "balance": {
          "data": {
            "planType": "METERED",
            "description": "string",
            "upload": 0,
            "download": 0,
            "amount": "string",
            "roaming": {
              "description": "string",
              "download": 0,
              "amount": "string"
            }
          },
          "voice": {
            "planType": "METERED",
            "national": {
              "description": "string",
              "duration": "string",
              "number": 0,
              "amount": "string"
            },
            "international": {
              "description": "string",
              "duration": "string",
              "number": 0,
              "amount": "string"
            },
            "roaming": {
              "description": "string",
              "duration": "string",
              "number": 0,
              "amount": "string"
            }
          },
          "messaging": {
            "planType": "METERED",
            "sms": {
              "description": "string",
              "national": 0,
              "international": 0,
              "roaming": 0,
              "amount": "string"
            },
            "mms": {
              "description": "string",
              "national": 0,
              "international": 0,
              "roaming": 0,
              "amount": "string"
            }
          }
        }
      }
    ]
  },
  "links": {
    "self": "string"
  },
  "meta": {}
}

Responses

Status Meaning Description Schema
200 OK Successful response TelcoBalanceResponse
400 Bad Request The following error codes MUST be supported:
ResponseErrorListV2
404 Not Found The following error codes MUST be supported:
ResponseErrorListV2
406 Not Acceptable The following error codes MUST be supported:
ResponseErrorListV2

Response Headers

Status Header Type Format Description
200 x-v string none
200 x-fapi-interaction-id string none
400 x-fapi-interaction-id string none
404 x-fapi-interaction-id string none
406 x-fapi-interaction-id string none

Get Bulk Telco Balances

Code samples

GET https://data.holder.com.au/cds-au/v1/telco/accounts/balance HTTP/1.1
Host: data.holder.com.au
Accept: application/json
x-v: string
x-min-v: string
x-fapi-interaction-id: string
x-fapi-auth-date: string
x-fapi-customer-ip-address: string
x-cds-client-headers: string

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'x-v':'string',
  'x-min-v':'string',
  'x-fapi-interaction-id':'string',
  'x-fapi-auth-date':'string',
  'x-fapi-customer-ip-address':'string',
  'x-cds-client-headers':'string'

};

fetch('https://data.holder.com.au/cds-au/v1/telco/accounts/balance',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /telco/accounts/balance

Obtain the current balance for all accounts

Endpoint Version

Version 1

Parameters

Name In Type Required Description
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 mandatory 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 and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v 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
x-min-v header string optional Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
x-fapi-interaction-id header string optional An [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] UUID value is required to be provided in the response header to track the interaction.
x-fapi-auth-date header string conditional The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.
x-fapi-customer-ip-address header string optional The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.
x-cds-client-headers header Base64 conditional The customer's original standard http headers Base64 encoded, including the original User Agent header, if the customer is currently logged in to the data recipient. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.

Example responses

200 Response

{
  "data": {
    "balances": [
      {
        "accountId": "string",
        "balance": {
          "services": [
            {
              "serviceId": "string",
              "displayName": "string",
              "phoneNumber": "string",
              "startDate": "string",
              "endDate": "string",
              "balance": {
                "data": {
                  "planType": "METERED",
                  "description": "string",
                  "upload": 0,
                  "download": 0,
                  "amount": "string",
                  "roaming": {
                    "description": "string",
                    "download": 0,
                    "amount": "string"
                  }
                },
                "voice": {
                  "planType": "METERED",
                  "national": {
                    "description": "string",
                    "duration": "string",
                    "number": 0,
                    "amount": "string"
                  },
                  "international": {
                    "description": "string",
                    "duration": "string",
                    "number": 0,
                    "amount": "string"
                  },
                  "roaming": {
                    "description": "string",
                    "duration": "string",
                    "number": 0,
                    "amount": "string"
                  }
                },
                "messaging": {
                  "planType": "METERED",
                  "sms": {
                    "description": "string",
                    "national": 0,
                    "international": 0,
                    "roaming": 0,
                    "amount": "string"
                  },
                  "mms": {
                    "description": "string",
                    "national": 0,
                    "international": 0,
                    "roaming": 0,
                    "amount": "string"
                  }
                }
              }
            }
          ]
        }
      }
    ]
  },
  "links": {
    "self": "string",
    "first": "string",
    "prev": "string",
    "next": "string",
    "last": "string"
  },
  "meta": {
    "totalRecords": 0,
    "totalPages": 0
  }
}

Responses

Status Meaning Description Schema
200 OK Successful response TelcoBalanceListResponse
400 Bad Request The following error codes MUST be supported:
ResponseErrorListV2
406 Not Acceptable The following error codes MUST be supported:
ResponseErrorListV2
422 Unprocessable Entity The following error codes MUST be supported:
ResponseErrorListV2

Response Headers

Status Header Type Format Description
200 x-v string none
200 x-fapi-interaction-id string none
400 x-fapi-interaction-id string none
406 x-fapi-interaction-id string none
422 x-fapi-interaction-id string none

Get Balances For Specific Telco Accounts

Code samples

POST https://data.holder.com.au/cds-au/v1/telco/accounts/balance HTTP/1.1
Host: data.holder.com.au
Content-Type: application/json
Accept: application/json
x-v: string
x-min-v: string
x-fapi-interaction-id: string
x-fapi-auth-date: string
x-fapi-customer-ip-address: string
x-cds-client-headers: string

const fetch = require('node-fetch');
const inputBody = '{
  "data": {
    "accountIds": [
      "string"
    ]
  },
  "meta": {}
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'x-v':'string',
  'x-min-v':'string',
  'x-fapi-interaction-id':'string',
  'x-fapi-auth-date':'string',
  'x-fapi-customer-ip-address':'string',
  'x-cds-client-headers':'string'

};

fetch('https://data.holder.com.au/cds-au/v1/telco/accounts/balance',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /telco/accounts/balance

Obtain the current balance for a specified set of accounts

Body parameter

{
  "data": {
    "accountIds": [
      "string"
    ]
  },
  "meta": {}
}

Endpoint Version

Version 1

Parameters

Name In Type Required Description
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 mandatory 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 and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v 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
x-min-v header string optional Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
x-fapi-interaction-id header string optional An [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] UUID value is required to be provided in the response header to track the interaction.
x-fapi-auth-date header string conditional The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.
x-fapi-customer-ip-address header string optional The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.
x-cds-client-headers header Base64 conditional The customer's original standard http headers Base64 encoded, including the original User Agent header, if the customer is currently logged in to the data recipient. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.
body body accountIdList mandatory Request payload containing list of specific Accounts to obtain data for
» data body object mandatory none
»» accountIds body [string] mandatory Array of specific accountIds to obtain data for. In accordance with CDR ID permanence requirements
» meta body Meta mandatory none

Example responses

200 Response

{
  "data": {
    "balances": [
      {
        "accountId": "string",
        "balance": {
          "services": [
            {
              "serviceId": "string",
              "displayName": "string",
              "phoneNumber": "string",
              "startDate": "string",
              "endDate": "string",
              "balance": {
                "data": {
                  "planType": "METERED",
                  "description": "string",
                  "upload": 0,
                  "download": 0,
                  "amount": "string",
                  "roaming": {
                    "description": "string",
                    "download": 0,
                    "amount": "string"
                  }
                },
                "voice": {
                  "planType": "METERED",
                  "national": {
                    "description": "string",
                    "duration": "string",
                    "number": 0,
                    "amount": "string"
                  },
                  "international": {
                    "description": "string",
                    "duration": "string",
                    "number": 0,
                    "amount": "string"
                  },
                  "roaming": {
                    "description": "string",
                    "duration": "string",
                    "number": 0,
                    "amount": "string"
                  }
                },
                "messaging": {
                  "planType": "METERED",
                  "sms": {
                    "description": "string",
                    "national": 0,
                    "international": 0,
                    "roaming": 0,
                    "amount": "string"
                  },
                  "mms": {
                    "description": "string",
                    "national": 0,
                    "international": 0,
                    "roaming": 0,
                    "amount": "string"
                  }
                }
              }
            }
          ]
        }
      }
    ]
  },
  "links": {
    "self": "string",
    "first": "string",
    "prev": "string",
    "next": "string",
    "last": "string"
  },
  "meta": {
    "totalRecords": 0,
    "totalPages": 0
  }
}

Responses

Status Meaning Description Schema
200 OK Successful response TelcoBalanceListResponse
400 Bad Request The following error codes MUST be supported:
ResponseErrorListV2
406 Not Acceptable The following error codes MUST be supported:
ResponseErrorListV2
422 Unprocessable Entity The following error codes MUST be supported:
ResponseErrorListV2

Response Headers

Status Header Type Format Description
200 x-v string none
200 x-fapi-interaction-id string none
400 x-fapi-interaction-id string none
406 x-fapi-interaction-id string none
422 x-fapi-interaction-id string none

Get Invoices For Telco Account

Code samples

GET https://data.holder.com.au/cds-au/v1/telco/accounts/{accountId}/invoices HTTP/1.1
Host: data.holder.com.au
Accept: application/json
x-v: string
x-min-v: string
x-fapi-interaction-id: string
x-fapi-auth-date: string
x-fapi-customer-ip-address: string
x-cds-client-headers: string

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'x-v':'string',
  'x-min-v':'string',
  'x-fapi-interaction-id':'string',
  'x-fapi-auth-date':'string',
  'x-fapi-customer-ip-address':'string',
  'x-cds-client-headers':'string'

};

fetch('https://data.holder.com.au/cds-au/v1/telco/accounts/{accountId}/invoices',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /telco/accounts/{accountId}/invoices

Obtain the invoices for a specific account

Endpoint Version

Version 1

Parameters

Name In Type Required Description
accountId 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
x-v header string mandatory 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 and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v 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
x-min-v header string optional Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
x-fapi-interaction-id header string optional An [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] UUID value is required to be provided in the response header to track the interaction.
x-fapi-auth-date header string conditional The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.
x-fapi-customer-ip-address header string optional The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.
x-cds-client-headers header Base64 conditional The customer's original standard http headers Base64 encoded, including the original User Agent header, if the customer is currently logged in to the data recipient. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.

Example responses

200 Response

{
  "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": {}
}

Responses

Status Meaning Description Schema
200 OK Successful response TelcoInvoiceResponse
400 Bad Request The following error codes MUST be supported:
ResponseErrorListV2
404 Not Found The following error codes MUST be supported:
ResponseErrorListV2
406 Not Acceptable The following error codes MUST be supported:
ResponseErrorListV2
422 Unprocessable Entity The following error codes MUST be supported:
ResponseErrorListV2

Response Headers

Status Header Type Format Description
200 x-v string none
200 x-fapi-interaction-id string none
400 x-fapi-interaction-id string none
404 x-fapi-interaction-id string none
406 x-fapi-interaction-id string none
422 x-fapi-interaction-id string none

Get Telco Invoices

Code samples

GET https://data.holder.com.au/cds-au/v1/telco/accounts/invoices HTTP/1.1
Host: data.holder.com.au
Accept: application/json
x-v: string
x-min-v: string
x-fapi-interaction-id: string
x-fapi-auth-date: string
x-fapi-customer-ip-address: string
x-cds-client-headers: string

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'x-v':'string',
  'x-min-v':'string',
  'x-fapi-interaction-id':'string',
  'x-fapi-auth-date':'string',
  'x-fapi-customer-ip-address':'string',
  'x-cds-client-headers':'string'

};

fetch('https://data.holder.com.au/cds-au/v1/telco/accounts/invoices',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /telco/accounts/invoices

Obtain the invoices for all accounts

Endpoint Version

Version 1

Parameters

Name In Type Required Description
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)
x-v header string mandatory 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 and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v 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
x-min-v header string optional Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
x-fapi-interaction-id header string optional An [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] UUID value is required to be provided in the response header to track the interaction.
x-fapi-auth-date header string conditional The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.
x-fapi-customer-ip-address header string optional The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.
x-cds-client-headers header Base64 conditional The customer's original standard http headers Base64 encoded, including the original User Agent header, if the customer is currently logged in to the data recipient. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.

Example responses

200 Response

{
  "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
  }
}

Responses

Status Meaning Description Schema
200 OK Successful response TelcoInvoiceListResponse
400 Bad Request The following error codes MUST be supported:
ResponseErrorListV2
406 Not Acceptable The following error codes MUST be supported:
ResponseErrorListV2
422 Unprocessable Entity The following error codes MUST be supported:
ResponseErrorListV2

Response Headers

Status Header Type Format Description
200 x-v string none
200 x-fapi-interaction-id string none
400 x-fapi-interaction-id string none
406 x-fapi-interaction-id string none
422 x-fapi-interaction-id string none

Get Invoices For Specific Telco Accounts

Code samples

POST https://data.holder.com.au/cds-au/v1/telco/accounts/invoices HTTP/1.1
Host: data.holder.com.au
Content-Type: application/json
Accept: application/json
x-v: string
x-min-v: string
x-fapi-interaction-id: string
x-fapi-auth-date: string
x-fapi-customer-ip-address: string
x-cds-client-headers: string

const fetch = require('node-fetch');
const inputBody = '{
  "data": {
    "accountIds": [
      "string"
    ]
  },
  "meta": {}
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'x-v':'string',
  'x-min-v':'string',
  'x-fapi-interaction-id':'string',
  'x-fapi-auth-date':'string',
  'x-fapi-customer-ip-address':'string',
  'x-cds-client-headers':'string'

};

fetch('https://data.holder.com.au/cds-au/v1/telco/accounts/invoices',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /telco/accounts/invoices

Obtain invoices for a specified set of accounts

Body parameter

{
  "data": {
    "accountIds": [
      "string"
    ]
  },
  "meta": {}
}

Endpoint Version

Version 1

Parameters

Name In Type Required Description
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)
x-v header string mandatory 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 and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v 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
x-min-v header string optional Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
x-fapi-interaction-id header string optional An [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] UUID value is required to be provided in the response header to track the interaction.
x-fapi-auth-date header string conditional The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.
x-fapi-customer-ip-address header string optional The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.
x-cds-client-headers header Base64 conditional The customer's original standard http headers Base64 encoded, including the original User Agent header, if the customer is currently logged in to the data recipient. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.
body body accountIdList mandatory Request payload containing list of specific Accounts to obtain data for
» data body object mandatory none
»» accountIds body [string] mandatory Array of specific accountIds to obtain data for. In accordance with CDR ID permanence requirements
» meta body Meta mandatory none

Example responses

200 Response

{
  "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
  }
}

Responses

Status Meaning Description Schema
200 OK Successful response TelcoInvoiceListResponse
400 Bad Request The following error codes MUST be supported:
ResponseErrorListV2
406 Not Acceptable The following error codes MUST be supported:
ResponseErrorListV2
422 Unprocessable Entity The following error codes MUST be supported:
ResponseErrorListV2

Response Headers

Status Header Type Format Description
200 x-v string none
200 x-fapi-interaction-id string none
400 x-fapi-interaction-id string none
406 x-fapi-interaction-id string none
422 x-fapi-interaction-id string none

Get Transactions For Telco Account

Code samples

GET https://data.holder.com.au/cds-au/v1/telco/accounts/{accountId}/transactions HTTP/1.1
Host: data.holder.com.au
Accept: application/json
x-v: string
x-min-v: string
x-fapi-interaction-id: string
x-fapi-auth-date: string
x-fapi-customer-ip-address: string
x-cds-client-headers: string

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'x-v':'string',
  'x-min-v':'string',
  'x-fapi-interaction-id':'string',
  'x-fapi-auth-date':'string',
  'x-fapi-customer-ip-address':'string',
  'x-cds-client-headers':'string'

};

fetch('https://data.holder.com.au/cds-au/v1/telco/accounts/{accountId}/transactions',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /telco/accounts/{accountId}/transactions

Obtain the billing transactions for a specific account

Endpoint Version

Version 1

Parameters

Name In Type Required Description
accountId 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-time query DateTimeString optional Constrain the request to records with effective time at or before this date/time. If absent defaults to current date/time. Format is aligned to DateTimeString common type
oldest-time query DateTimeString optional Constrain the request to records with effective time at or after this date/time. If absent defaults to newest-time minus 12 months. Format is aligned to DateTimeString common type
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 mandatory 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 and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v 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
x-min-v header string optional Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
x-fapi-interaction-id header string optional An [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] UUID value is required to be provided in the response header to track the interaction.
x-fapi-auth-date header string conditional The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.
x-fapi-customer-ip-address header string optional The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.
x-cds-client-headers header Base64 conditional The customer's original standard http headers Base64 encoded, including the original User Agent header, if the customer is currently logged in to the data recipient. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.

Example responses

200 Response

{
  "data": {
    "transactions": [
      {
        "accountId": "string",
        "executionDateTime": "string",
        "gst": "string",
        "transactionUType": "account",
        "account": {
          "serviceIds": "string",
          "invoiceNumber": "string",
          "description": "string",
          "startDate": "string",
          "endDate": "string",
          "amount": "string",
          "adjustments": [
            {
              "amount": "string",
              "description": "string"
            }
          ]
        },
        "onceOff": {
          "serviceId": "string",
          "invoiceNumber": "string",
          "amount": "string",
          "description": "string"
        },
        "otherCharges": {
          "serviceId": "string",
          "invoiceNumber": "string",
          "startDate": "string",
          "endDate": "string",
          "type": "SERVICE",
          "amount": "string",
          "description": "string",
          "adjustments": [
            {
              "amount": "string",
              "description": "string"
            }
          ]
        },
        "payment": {
          "amount": "string",
          "method": "DIRECT_DEBIT"
        }
      }
    ]
  },
  "links": {
    "self": "string",
    "first": "string",
    "prev": "string",
    "next": "string",
    "last": "string"
  },
  "meta": {
    "totalRecords": 0,
    "totalPages": 0
  }
}

Responses

Status Meaning Description Schema
200 OK Successful response TelcoTransactionListResponse
400 Bad Request The following error codes MUST be supported:
ResponseErrorListV2
404 Not Found The following error codes MUST be supported:
ResponseErrorListV2
406 Not Acceptable The following error codes MUST be supported:
ResponseErrorListV2
422 Unprocessable Entity The following error codes MUST be supported:
ResponseErrorListV2

Response Headers

Status Header Type Format Description
200 x-v string none
200 x-fapi-interaction-id string none
400 x-fapi-interaction-id string none
404 x-fapi-interaction-id string none
406 x-fapi-interaction-id string none
422 x-fapi-interaction-id string none

Get Telco Transactions

Code samples

GET https://data.holder.com.au/cds-au/v1/telco/accounts/transactions HTTP/1.1
Host: data.holder.com.au
Accept: application/json
x-v: string
x-min-v: string
x-fapi-interaction-id: string
x-fapi-auth-date: string
x-fapi-customer-ip-address: string
x-cds-client-headers: string

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'x-v':'string',
  'x-min-v':'string',
  'x-fapi-interaction-id':'string',
  'x-fapi-auth-date':'string',
  'x-fapi-customer-ip-address':'string',
  'x-cds-client-headers':'string'

};

fetch('https://data.holder.com.au/cds-au/v1/telco/accounts/transactions',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /telco/accounts/transactions

Obtain billing transactions for all accounts

Endpoint Version

Version 1

Parameters

Name In Type Required Description
newest-time query DateTimeString optional Constrain the request to records with effective time at or before this date/time. If absent defaults to current date/time. Format is aligned to DateTimeString common type
oldest-time query DateTimeString optional Constrain the request to records with effective time at or after this date/time. If absent defaults to newest-time minus 12 months. Format is aligned to DateTimeString common type
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 mandatory 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 and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v 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
x-min-v header string optional Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
x-fapi-interaction-id header string optional An [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] UUID value is required to be provided in the response header to track the interaction.
x-fapi-auth-date header string conditional The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.
x-fapi-customer-ip-address header string optional The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.
x-cds-client-headers header Base64 conditional The customer's original standard http headers Base64 encoded, including the original User Agent header, if the customer is currently logged in to the data recipient. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.

Example responses

200 Response

{
  "data": {
    "transactions": [
      {
        "accountId": "string",
        "executionDateTime": "string",
        "gst": "string",
        "transactionUType": "account",
        "account": {
          "serviceIds": "string",
          "invoiceNumber": "string",
          "description": "string",
          "startDate": "string",
          "endDate": "string",
          "amount": "string",
          "adjustments": [
            {
              "amount": "string",
              "description": "string"
            }
          ]
        },
        "onceOff": {
          "serviceId": "string",
          "invoiceNumber": "string",
          "amount": "string",
          "description": "string"
        },
        "otherCharges": {
          "serviceId": "string",
          "invoiceNumber": "string",
          "startDate": "string",
          "endDate": "string",
          "type": "SERVICE",
          "amount": "string",
          "description": "string",
          "adjustments": [
            {
              "amount": "string",
              "description": "string"
            }
          ]
        },
        "payment": {
          "amount": "string",
          "method": "DIRECT_DEBIT"
        }
      }
    ]
  },
  "links": {
    "self": "string",
    "first": "string",
    "prev": "string",
    "next": "string",
    "last": "string"
  },
  "meta": {
    "totalRecords": 0,
    "totalPages": 0
  }
}

Responses

Status Meaning Description Schema
200 OK Successful response TelcoTransactionListResponse
400 Bad Request The following error codes MUST be supported:
ResponseErrorListV2
406 Not Acceptable The following error codes MUST be supported:
ResponseErrorListV2
422 Unprocessable Entity The following error codes MUST be supported:
ResponseErrorListV2

Response Headers

Status Header Type Format Description
200 x-v string none
200 x-fapi-interaction-id string none
400 x-fapi-interaction-id string none
406 x-fapi-interaction-id string none
422 x-fapi-interaction-id string none

Get Transactions For Specific Telco Accounts

Code samples

POST https://data.holder.com.au/cds-au/v1/telco/accounts/transactions HTTP/1.1
Host: data.holder.com.au
Content-Type: application/json
Accept: application/json
x-v: string
x-min-v: string
x-fapi-interaction-id: string
x-fapi-auth-date: string
x-fapi-customer-ip-address: string
x-cds-client-headers: string

const fetch = require('node-fetch');
const inputBody = '{
  "data": {
    "accountIds": [
      "string"
    ]
  },
  "meta": {}
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'x-v':'string',
  'x-min-v':'string',
  'x-fapi-interaction-id':'string',
  'x-fapi-auth-date':'string',
  'x-fapi-customer-ip-address':'string',
  'x-cds-client-headers':'string'

};

fetch('https://data.holder.com.au/cds-au/v1/telco/accounts/transactions',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /telco/accounts/transactions

Obtain transactions for a specified set of accounts

Body parameter

{
  "data": {
    "accountIds": [
      "string"
    ]
  },
  "meta": {}
}

Endpoint Version

Version 1

Parameters

Name In Type Required Description
newest-time query DateTimeString optional Constrain the request to records with effective time at or before this date/time. If absent defaults to current date/time. Format is aligned to DateTimeString common type
oldest-time query DateTimeString optional Constrain the request to records with effective time at or after this date/time. If absent defaults to newest-time minus 12 months. Format is aligned to DateTimeString common type
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 mandatory 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 and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v 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
x-min-v header string optional Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
x-fapi-interaction-id header string optional An [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] UUID value is required to be provided in the response header to track the interaction.
x-fapi-auth-date header string conditional The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.
x-fapi-customer-ip-address header string optional The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.
x-cds-client-headers header Base64 conditional The customer's original standard http headers Base64 encoded, including the original User Agent header, if the customer is currently logged in to the data recipient. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.
body body accountIdList mandatory Request payload containing list of specific Accounts to obtain data for
» data body object mandatory none
»» accountIds body [string] mandatory Array of specific accountIds to obtain data for. In accordance with CDR ID permanence requirements
» meta body Meta mandatory none

Example responses

200 Response

{
  "data": {
    "transactions": [
      {
        "accountId": "string",
        "executionDateTime": "string",
        "gst": "string",
        "transactionUType": "account",
        "account": {
          "serviceIds": "string",
          "invoiceNumber": "string",
          "description": "string",
          "startDate": "string",
          "endDate": "string",
          "amount": "string",
          "adjustments": [
            {
              "amount": "string",
              "description": "string"
            }
          ]
        },
        "onceOff": {
          "serviceId": "string",
          "invoiceNumber": "string",
          "amount": "string",
          "description": "string"
        },
        "otherCharges": {
          "serviceId": "string",
          "invoiceNumber": "string",
          "startDate": "string",
          "endDate": "string",
          "type": "SERVICE",
          "amount": "string",
          "description": "string",
          "adjustments": [
            {
              "amount": "string",
              "description": "string"
            }
          ]
        },
        "payment": {
          "amount": "string",
          "method": "DIRECT_DEBIT"
        }
      }
    ]
  },
  "links": {
    "self": "string",
    "first": "string",
    "prev": "string",
    "next": "string",
    "last": "string"
  },
  "meta": {
    "totalRecords": 0,
    "totalPages": 0
  }
}

Responses

Status Meaning Description Schema
200 OK Successful response TelcoTransactionListResponse
400 Bad Request The following error codes MUST be supported:
ResponseErrorListV2
406 Not Acceptable The following error codes MUST be supported:
ResponseErrorListV2
422 Unprocessable Entity The following error codes MUST be supported:
ResponseErrorListV2

Response Headers

Status Header Type Format Description
200 x-v string none
200 x-fapi-interaction-id string none
400 x-fapi-interaction-id string none
406 x-fapi-interaction-id string none
422 x-fapi-interaction-id string none

Schemas

TelcoProductListResponse

{
  "data": {
    "plans": [
      {
        "productId": "string",
        "effectiveFrom": "string",
        "effectiveTo": "string",
        "lastUpdated": "string",
        "displayName": "string",
        "description": "string",
        "type": "MOBILE",
        "purpose": "PERSONAL",
        "billingType": "PRE_PAID",
        "contract": {
          "name": "string",
          "description": "string",
          "duration": 0,
          "contractUri": "string"
        },
        "bundle": true,
        "brand": "string",
        "brandName": "string",
        "pricing": [
          {
            "name": "string",
            "description": "string",
            "period": "string",
            "amount": "string"
          }
        ],
        "thirdPartyAgentId": "string",
        "thirdPartyAgentName": "string",
        "applicationUri": "string",
        "additionalInformation": {
          "overviewUri": "string",
          "termsUri": "string",
          "eligibilityUri": "string",
          "pricingUri": "string",
          "bundleUri": "string"
        }
      }
    ]
  },
  "links": {
    "self": "string",
    "first": "string",
    "prev": "string",
    "next": "string",
    "last": "string"
  },
  "meta": {
    "totalRecords": 0,
    "totalPages": 0
  }
}

Properties

Name Type Required Description
data TelcoProductListResponseData mandatory none
links LinksPaginated mandatory none
meta MetaPaginated mandatory none

TelcoProductResponse

{
  "data": {
    "productId": "string",
    "effectiveFrom": "string",
    "effectiveTo": "string",
    "lastUpdated": "string",
    "displayName": "string",
    "description": "string",
    "type": "MOBILE",
    "purpose": "PERSONAL",
    "billingType": "PRE_PAID",
    "contract": {
      "name": "string",
      "description": "string",
      "duration": 0,
      "contractUri": "string"
    },
    "bundle": true,
    "brand": "string",
    "brandName": "string",
    "pricing": [
      {
        "name": "string",
        "description": "string",
        "period": "string",
        "amount": "string"
      }
    ],
    "thirdPartyAgentId": "string",
    "thirdPartyAgentName": "string",
    "applicationUri": "string",
    "additionalInformation": {
      "overviewUri": "string",
      "termsUri": "string",
      "eligibilityUri": "string",
      "pricingUri": "string",
      "bundleUri": "string"
    },
    "meteringCharges": [
      {
        "displayName": "string",
        "description": "string",
        "minimumValue": "string",
        "maximumValue": "string",
        "period": "string"
      }
    ],
    "bundles": [
      {
        "displayName": "string",
        "description": "string",
        "bundleUri": "string",
        "features": [
          {
            "displayName": "string",
            "description": "string",
            "category": "DATA"
          }
        ]
      }
    ],
    "plans": [
      {
        "displayName": "string",
        "description": "string",
        "planUri": "string",
        "features": [
          {
            "displayName": "string",
            "description": "string"
          }
        ]
      }
    ],
    "discounts": [
      {
        "displayName": "string",
        "description": "string",
        "discountUri": "string",
        "features": [
          {
            "displayName": "string",
            "description": "string"
          }
        ]
      }
    ],
    "incentives": [
      {
        "displayName": "string",
        "description": "string",
        "incentiveUri": "string",
        "features": [
          {
            "displayName": "string",
            "description": "string"
          }
        ]
      }
    ]
  },
  "links": {
    "self": "string"
  },
  "meta": {}
}

Properties

Name Type Required Description
data any mandatory none

allOf

Name Type Required Description
» anonymous TelcoProduct mandatory none

and

Name Type Required Description
» anonymous TelcoProductDetail mandatory none

continued

Name Type Required Description
links Links mandatory none
meta Meta optional none

TelcoUsageResponse

{
  "data": {
    "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 Type Required Description
data TelcoAccountUsage mandatory none
links Links mandatory none
meta Meta mandatory none

TelcoServiceUsageResponse

{
  "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"
  },
  "meta": {}
}

Properties

Name Type Required Description
data TelcoServiceUsage mandatory none
links Links mandatory none
meta Meta mandatory none

TelcoServiceUsageListResponse

{
  "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
  }
}

Properties

Name Type Required Description
data [TelcoServiceUsage] mandatory none
links LinksPaginated mandatory none
meta MetaPaginated mandatory none

TelcoAccountListResponse

{
  "data": {
    "accounts": [
      {
        "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"
            }
          }
        ]
      }
    ]
  },
  "links": {
    "self": "string",
    "first": "string",
    "prev": "string",
    "next": "string",
    "last": "string"
  },
  "meta": {
    "totalRecords": 0,
    "totalPages": 0
  }
}

Properties

Name Type Required Description
data TelcoAccountListResponseData mandatory none
links LinksPaginated mandatory none
meta MetaPaginated mandatory none

TelcoAccountDetailResponse

{
  "data": {
    "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"
            }
          ]
        }
      }
    ]
  },
  "links": {
    "self": "string"
  },
  "meta": {}
}

Properties

Name Type Required Description
data TelcoAccountDetailResponseData mandatory none
links Links mandatory none
meta Meta mandatory none

TelcoPaymentScheduleResponse

{
  "data": {
    "paymentSchedules": [
      {
        "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"
        }
      }
    ]
  },
  "links": {
    "self": "string",
    "first": "string",
    "prev": "string",
    "next": "string",
    "last": "string"
  },
  "meta": {
    "totalRecords": 0,
    "totalPages": 0
  }
}

Properties

Name Type Required Description
data TelcoPaymentScheduleResponseData mandatory none
links LinksPaginated mandatory none
meta MetaPaginated mandatory none

TelcoConcessionsResponse

{
  "data": {
    "concessions": [
      {
        "type": "CONCESSION",
        "displayName": "string",
        "additionalInfo": "string",
        "additionalInfoUri": "string",
        "startDate": "string",
        "endDate": "string",
        "discountFrequency": "string",
        "amount": "string",
        "percentage": "string",
        "appliedTo": [
          "INVOICE"
        ]
      }
    ]
  },
  "links": {
    "self": "string",
    "first": "string",
    "prev": "string",
    "next": "string",
    "last": "string"
  },
  "meta": {
    "totalRecords": 0,
    "totalPages": 0
  }
}

Properties

Name Type Required Description
data TelcoConcessionsResponseData mandatory none
links LinksPaginated mandatory none
meta MetaPaginated mandatory none

TelcoBalanceListResponse

{
  "data": {
    "balances": [
      {
        "accountId": "string",
        "balance": {
          "services": [
            {
              "serviceId": "string",
              "displayName": "string",
              "phoneNumber": "string",
              "startDate": "string",
              "endDate": "string",
              "balance": {
                "data": {
                  "planType": "METERED",
                  "description": "string",
                  "upload": 0,
                  "download": 0,
                  "amount": "string",
                  "roaming": {
                    "description": "string",
                    "download": 0,
                    "amount": "string"
                  }
                },
                "voice": {
                  "planType": "METERED",
                  "national": {
                    "description": "string",
                    "duration": "string",
                    "number": 0,
                    "amount": "string"
                  },
                  "international": {
                    "description": "string",
                    "duration": "string",
                    "number": 0,
                    "amount": "string"
                  },
                  "roaming": {
                    "description": "string",
                    "duration": "string",
                    "number": 0,
                    "amount": "string"
                  }
                },
                "messaging": {
                  "planType": "METERED",
                  "sms": {
                    "description": "string",
                    "national": 0,
                    "international": 0,
                    "roaming": 0,
                    "amount": "string"
                  },
                  "mms": {
                    "description": "string",
                    "national": 0,
                    "international": 0,
                    "roaming": 0,
                    "amount": "string"
                  }
                }
              }
            }
          ]
        }
      }
    ]
  },
  "links": {
    "self": "string",
    "first": "string",
    "prev": "string",
    "next": "string",
    "last": "string"
  },
  "meta": {
    "totalRecords": 0,
    "totalPages": 0
  }
}

Properties

Name Type Required Description
data TelcoBalanceListResponseData mandatory none
links LinksPaginated mandatory none
meta MetaPaginated mandatory none

TelcoBalanceResponse

{
  "data": {
    "services": [
      {
        "serviceId": "string",
        "displayName": "string",
        "phoneNumber": "string",
        "startDate": "string",
        "endDate": "string",
        "balance": {
          "data": {
            "planType": "METERED",
            "description": "string",
            "upload": 0,
            "download": 0,
            "amount": "string",
            "roaming": {
              "description": "string",
              "download": 0,
              "amount": "string"
            }
          },
          "voice": {
            "planType": "METERED",
            "national": {
              "description": "string",
              "duration": "string",
              "number": 0,
              "amount": "string"
            },
            "international": {
              "description": "string",
              "duration": "string",
              "number": 0,
              "amount": "string"
            },
            "roaming": {
              "description": "string",
              "duration": "string",
              "number": 0,
              "amount": "string"
            }
          },
          "messaging": {
            "planType": "METERED",
            "sms": {
              "description": "string",
              "national": 0,
              "international": 0,
              "roaming": 0,
              "amount": "string"
            },
            "mms": {
              "description": "string",
              "national": 0,
              "international": 0,
              "roaming": 0,
              "amount": "string"
            }
          }
        }
      }
    ]
  },
  "links": {
    "self": "string"
  },
  "meta": {}
}

Properties

Name Type Required Description
data TelcoBalance mandatory Object containing account service usage summary
links Links mandatory none
meta Meta mandatory none

TelcoTransactionListResponse

{
  "data": {
    "transactions": [
      {
        "accountId": "string",
        "executionDateTime": "string",
        "gst": "string",
        "transactionUType": "account",
        "account": {
          "serviceIds": "string",
          "invoiceNumber": "string",
          "description": "string",
          "startDate": "string",
          "endDate": "string",
          "amount": "string",
          "adjustments": [
            {
              "amount": "string",
              "description": "string"
            }
          ]
        },
        "onceOff": {
          "serviceId": "string",
          "invoiceNumber": "string",
          "amount": "string",
          "description": "string"
        },
        "otherCharges": {
          "serviceId": "string",
          "invoiceNumber": "string",
          "startDate": "string",
          "endDate": "string",
          "type": "SERVICE",
          "amount": "string",
          "description": "string",
          "adjustments": [
            {
              "amount": "string",
              "description": "string"
            }
          ]
        },
        "payment": {
          "amount": "string",
          "method": "DIRECT_DEBIT"
        }
      }
    ]
  },
  "links": {
    "self": "string",
    "first": "string",
    "prev": "string",
    "next": "string",
    "last": "string"
  },
  "meta": {
    "totalRecords": 0,
    "totalPages": 0
  }
}

Properties

Name Type Required Description
data TelcoTransactionListResponseData mandatory none
links LinksPaginated mandatory none
meta MetaPaginated mandatory none

MetaError

{
  "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": [
    {
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": {
        "urn": "string"
      }
    }
  ]
}

Properties

Name Type Required Description
errors [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

{
  "productId": "string",
  "effectiveFrom": "string",
  "effectiveTo": "string",
  "lastUpdated": "string",
  "displayName": "string",
  "description": "string",
  "type": "MOBILE",
  "purpose": "PERSONAL",
  "billingType": "PRE_PAID",
  "contract": {
    "name": "string",
    "description": "string",
    "duration": 0,
    "contractUri": "string"
  },
  "bundle": true,
  "brand": "string",
  "brandName": "string",
  "pricing": [
    {
      "name": "string",
      "description": "string",
      "period": "string",
      "amount": "string"
    }
  ],
  "thirdPartyAgentId": "string",
  "thirdPartyAgentName": "string",
  "applicationUri": "string",
  "additionalInformation": {
    "overviewUri": "string",
    "termsUri": "string",
    "eligibilityUri": "string",
    "pricingUri": "string",
    "bundleUri": "string"
  }
}

Properties

Name Type Required Description
productId ASCIIString mandatory The ID of the specific product
effectiveFrom DateTimeString optional The date and time from which this product is effective (ie. is available for origination). Used to enable the articulation of products to the regime before they are available for customers to originate
effectiveTo DateTimeString optional The date and time at which this product will be retired and will no longer be offered. Used to enable the managed deprecation of plans
lastUpdated DateTimeString optional The last date and time that the information for this plan was changed (or the creation date for the plan if it has never been altered)
displayName string optional The display name of the product
description string optional A description of the product
type Enum mandatory The type of product. MOBILE service or BROADBAND fixed internet service
purpose Enum optional The purpose type of the product. If absent, then the value PERSONAL is assumed
billingType Enum mandatory The type of product
contract TelcoContract conditional 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 boolean optional Required if part of a bundle. If not present FALSE is assumed
brand string mandatory The ID of the brand under which this product is offered
brandName string mandatory The display name of the brand under which this product is offered
pricing [TelcoProductPricing] mandatory List of pricing details for the product plan
thirdPartyAgentId string optional The ID of the Third Party through which this product may be originated
thirdPartyAgentName string optional The display name of the Third Party through which this product may be originated
applicationUri URIString optional A link to an application web page where this plan can be applied for
additionalInformation TelcoAdditionalInformation optional Object that contains links to additional information on specific topics

Enumerated Values

Property Value
type MOBILE
type BROADBAND
purpose PERSONAL
purpose BUSINESS
purpose ALL
billingType PRE_PAID
billingType POST_PAID
billingType UPFRONT_PAID
billingType OTHER

TelcoContract

{
  "name": "string",
  "description": "string",
  "duration": 0,
  "contractUri": "string"
}

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 Type Required Description
name string mandatory Name of the contract
description string optional Description of the contract
duration Number mandatory Minimum contract duration in months
contractUri URIString optional URI of the contract conditions

TelcoServiceDetail

{
  "serviceId": "string"
}

Properties

Name Type Required Description
serviceId string mandatory The tokenised ID of the service identifier for use in the CDR APIs. E.g a mobile MSISDN, FNN or internet service e.g NBN AVC Service ID. Created according to the CDR rules for CDR ID permanence

TelcoAccountUsage

{
  "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"
            }
          }
        }
      }
    }
  ]
}

Properties

Name Type Required Description
accountId string mandatory Tokenised ID of the account. In accordance with CDR ID permanence requirements
services [TelcoAccountUsageServices] mandatory List of services that are part of the account

TelcoServiceUsage

{
  "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"
      }
    }
  }
}

Properties

Name Type Required Description
serviceId string mandatory Tokenised ID of the service identifier. E.g. a mobile MSISDN, FNN or internet service e.g NBN AVC Service ID. To be created in accordance with CDR ID permanence requirements
displayName string optional Optional description of the service used for display purposes
phoneNumber string conditional Required if the service includes a phone number
startDate DateTimeString mandatory Date when the usage period started
endDate DateTimeString optional Date when the usage period ends
usage TelcoUsage optional Object containing usage summary

TelcoAccountBase

{
  "accountId": "string",
  "accountNumber": "string",
  "displayName": "string",
  "creationDate": "string",
  "lastUpdated": "string",
  "brand": "string",
  "openStatus": "CLOSED"
}

Properties

Name Type Required Description
accountId string optional The ID of the account. To be created in accordance with CDR ID permanence requirements
accountNumber string conditional Masked identifier of the account as defined by the data holder. This must be the value presented on physical statements (required if it exists) and must not be used for the value of the accountId
displayName string optional An optional display name for the account if one exists or can be derived. The content of this field is at the discretion of the data holder
creationDate DateString optional The date that the account was created or opened. Mandatory if openStatus is OPEN
lastUpdated DateString optional The date and time which the account was last updated
brand string optional The retail name of the brand
openStatus Enum optional Open or closed status for the account. If not present then OPEN is assumed

Enumerated Values

Property Value
openStatus CLOSED
openStatus OPEN

TelcoAccountResponseData

{
  "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"
      }
    }
  ]
}

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

TelcoAccountDetailResponseData

{
  "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
amount AmountString optional Optional payment amount indicating that a constant payment amount is scheduled to be paid (used in bill smoothing scenarios)
paymentScheduleUType Enum mandatory The type of object present in this response
cardDebit TelcoPaymentScheduleCardDebit conditional Represents a regular credit card payment schedule. Mandatory if paymentScheduleUType is set to cardDebit
directDebit TelcoPaymentScheduleDirectDebit conditional Represents a regular direct debit from a specified bank account. Mandatory if paymentScheduleUType is set to directDebit
digitalWallet TelcoPaymentScheduleDigitalWallet conditional Represents a regular payment from a digital wallet. Mandatory if paymentScheduleUType is set to digitalWallet
manualPayment TelcoPaymentScheduleManualPayment conditional Represents a manual payment schedule where the customer pays in response to a delivered statement. Mandatory if paymentScheduleUType is set to manualPayment

Enumerated Values

Property Value
paymentScheduleUType cardDebit
paymentScheduleUType directDebit
paymentScheduleUType manualPayment
paymentScheduleUType digitalWallet

TelcoConcession

{
  "type": "CONCESSION",
  "displayName": "string",
  "additionalInfo": "string",
  "additionalInfoUri": "string",
  "startDate": "string",
  "endDate": "string",
  "discountFrequency": "string",
  "amount": "string",
  "percentage": "string",
  "appliedTo": [
    "INVOICE"
  ]
}

Properties

Name Type Required Description
type Enum mandatory The concession type
displayName string mandatory The display name of the concession
additionalInfo string optional Display text providing more information on the concession
additionalInfoUri URIString optional Optional link to additional information regarding the concession
startDate DateString mandatory Optional start date for the application of the concession
endDate DateString optional Optional end date for the application of the concession
discountFrequency ExternalRef conditional Conditional attribute for frequency at which a concession is applied. Required if type is FIXED_AMOUNT or FIXED_PERCENTAGE. Formatted according to ISO 8601 Durations (excludes recurrence syntax)
amount AmountString conditional Conditional attribute for the amount of discount for the concession- required if type is FIXED_AMOUNT
percentage RateString conditional Conditional attribute for the percentage of discount of concession - required if type is FIXED_PERCENTAGE
appliedTo [Enum] optional Array of ENUM's to specify what the concession applies to. Multiple ENUM values can be provided. If absent, USAGE is assumed

Enumerated Values

Property Value
type CONCESSION
type REBATE
type GRANT
appliedTo INVOICE
appliedTo USAGE

TelcoInvoice

{
  "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"
}

Properties

Name Type Required Description
accountId string mandatory The ID of the account for which the invoice was issued. accountId must comply in accordance with CDR ID permanence
invoiceNumber string mandatory The number assigned to this invoice by the telco Retailer
issueDate DateString mandatory The date that the invoice was actually issued (as opposed to generated or calculated)
dueDate DateString optional The date that the invoice is due to be paid
period TelcoInvoicePeriod conditional 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
invoiceAmount AmountString optional The net amount due for this invoice regardless of previous balance
gstAmount AmountString optional The total GST amount for this invoice. If absent then zero is assumed
payOnTimeDiscount TelcoInvoicePayOnTimeDiscount optional A discount for on time payment
balanceAtIssue AmountString mandatory The account balance at the time the invoice was issued
services [string] mandatory An array of service IDs to which this invoice applies. May be empty if the invoice contains no usage related charges
accountCharges TelcoInvoiceAccountCharges optional Object contain charges and credits related to usage
accountUsage TelcoUsage optional Object containing usage summary
paymentStatus Enum mandatory Indicator of the payment status for the invoice

Enumerated Values

Property Value
paymentStatus PAID
paymentStatus PARTIALLY_PAID
paymentStatus NOT_PAID

TelcoUsage

{
  "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"
    }
  }
}

Object containing usage summary

Properties

Name Type Required Description
data TelcoUsageData conditional Summary of data usage
voice TelcoUsageVoice conditional Summary of voice calls. Required if voice calls are included in product plan
messaging TelcoUsageMessaging conditional Summary of messaging. Required if messaging services is included in the product plan

TelcoInvoiceAccountCharges

{
  "totalUsageCharges": "string",
  "totalOnceOffCharges": "string",
  "totalDiscounts": "string",
  "otherCharges": {
    "amount": "string",
    "description": "string",
    "type": "SERVICE"
  },
  "totalGst": "string"
}

Object contain charges and credits related to usage

Properties

Name Type Required Description
totalUsageCharges AmountString mandatory The aggregate total of usage charges for the period covered by the invoice (exclusive of GST)
totalOnceOffCharges AmountString mandatory The aggregate total of any once off charges arising from usage for the period covered by the invoice (exclusive of GST)
totalDiscounts AmountString mandatory The aggregate total of account level discounts or credits for the period covered by the invoice
otherCharges TelcoInvoiceAccountChargesOtherCharges optional Optional array of charges that may be part of the invoice (for example services fees) (exclusive of GST)
totalGst AmountString optional The total GST for all account level charges. If absent then zero is assumed

TelcoBillingTransaction

{
  "accountId": "string",
  "executionDateTime": "string",
  "gst": "string",
  "transactionUType": "account",
  "account": {
    "serviceIds": "string",
    "invoiceNumber": "string",
    "description": "string",
    "startDate": "string",
    "endDate": "string",
    "amount": "string",
    "adjustments": [
      {
        "amount": "string",
        "description": "string"
      }
    ]
  },
  "onceOff": {
    "serviceId": "string",
    "invoiceNumber": "string",
    "amount": "string",
    "description": "string"
  },
  "otherCharges": {
    "serviceId": "string",
    "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
accountId string mandatory The ID of the account for which the transaction occurred. accountId must comply in accordance with CDR ID permanence
executionDateTime DateTimeString mandatory The date and time that the transaction occurred
gst AmountString optional The GST incurred in the transaction. Should not be included for credits or payments. If absent zero is assumed
transactionUType Enum mandatory Indicator of the type of transaction object present in this record
account TelcoBillingAccountTransaction optional none
onceOff TelcoBillingOnceOffTransaction conditional none
otherCharges TelcoBillingOtherTransaction optional none
payment TelcoBillingPaymentTransaction conditional none

Enumerated Values

Property Value
transactionUType account
transactionUType onceOff
transactionUType otherCharges
transactionUType payment

TelcoBillingAccountTransaction

{
  "serviceIds": "string",
  "invoiceNumber": "string",
  "description": "string",
  "startDate": "string",
  "endDate": "string",
  "amount": "string",
  "adjustments": [
    {
      "amount": "string",
      "description": "string"
    }
  ]
}

Properties

Name Type Required Description
serviceIds string optional Array list of services identifiers to which this transaction applies if any. E.g. a mobile MSISDN, FNN or internet service e.g NBN AVC Service ID. In accordance with CDR ID permanence requirements
invoiceNumber string optional The number of the invoice in which this transaction is included if it has been issued
description string optional Optional description of the transaction that can be used for display purposes
startDate DateTimeString mandatory Date and time when the usage period starts
endDate DateTimeString mandatory Date and time when the usage period ends
amount AmountString mandatory The amount charged or credited for this transaction prior to any adjustments being applied. A negative value indicates a credit
adjustments [TelcoBillingAccountTransactionAdjustments] optional Optional array of adjustments arising for this transaction

TelcoBillingOnceOffTransaction

{
  "serviceId": "string",
  "invoiceNumber": "string",
  "amount": "string",
  "description": "string"
}

Properties

Name Type Required Description
serviceId string optional The ID of the service identifier to which this transaction applies if any. E.g a MSISDN, FNN or internet service e.g NBN AVC Service ID. In accordance with CDR ID permanence requirements
invoiceNumber string optional The number of the invoice in which this transaction is included if it has been issued
amount AmountString mandatory The amount of the charge or credit. A positive value indicates a charge and a negative value indicates a credit
description string mandatory A free text description of the item

TelcoBillingOtherTransaction

{
  "serviceId": "string",
  "invoiceNumber": "string",
  "startDate": "string",
  "endDate": "string",
  "type": "SERVICE",
  "amount": "string",
  "description": "string",
  "adjustments": [
    {
      "amount": "string",
      "description": "string"
    }
  ]
}

Properties

Name Type Required Description
serviceId string optional The service identifier to which this transaction applies if any. E.g a mobile MSISDN, FNN or internet service e.g NBN AVC Service ID. In accordance with CDR ID permanence requirements
invoiceNumber string optional The number of the invoice in which this transaction is included if it has been issued
startDate DateString optional Optional start date for the application of the charge
endDate DateString optional Optional end date for the application of the charge
type Enum optional Type of charge. Assumed to be OTHER if absent
amount AmountString mandatory The amount of the charge
description string mandatory A free text description of the item
adjustments [TelcoBillingAccountTransactionAdjustments] optional Optional array of adjustments arising for this transaction

Enumerated Values

Property Value
type SERVICE
type NETWORK
type EQUIPMENT
type METERING
type OTHER

TelcoBillingPaymentTransaction

{
  "amount": "string",
  "method": "DIRECT_DEBIT"
}

Properties

Name Type Required Description
amount AmountString mandatory The amount paid
method Enum mandatory The method of payment

Enumerated Values

Property Value
method DIRECT_DEBIT
method CARD
method TRANSFER
method BPAY
method CASH
method CHEQUE
method VOUCHER
method OTHER

TelcoBalance

{
  "services": [
    {
      "serviceId": "string",
      "displayName": "string",
      "phoneNumber": "string",
      "startDate": "string",
      "endDate": "string",
      "balance": {
        "data": {
          "planType": "METERED",
          "description": "string",
          "upload": 0,
          "download": 0,
          "amount": "string",
          "roaming": {
            "description": "string",
            "download": 0,
            "amount": "string"
          }
        },
        "voice": {
          "planType": "METERED",
          "national": {
            "description": "string",
            "duration": "string",
            "number": 0,
            "amount": "string"
          },
          "international": {
            "description": "string",
            "duration": "string",
            "number": 0,
            "amount": "string"
          },
          "roaming": {
            "description": "string",
            "duration": "string",
            "number": 0,
            "amount": "string"
          }
        },
        "messaging": {
          "planType": "METERED",
          "sms": {
            "description": "string",
            "national": 0,
            "international": 0,
            "roaming": 0,
            "amount": "string"
          },
          "mms": {
            "description": "string",
            "national": 0,
            "international": 0,
            "roaming": 0,
            "amount": "string"
          }
        }
      }
    }
  ]
}

Object containing account service usage summary

Properties

Name Type Required Description
services [allOf] mandatory Summary of balances

TelcoServiceBalance

{
  "serviceId": "string",
  "displayName": "string",
  "phoneNumber": "string",
  "startDate": "string",
  "endDate": "string",
  "balance": {
    "data": {
      "planType": "METERED",
      "description": "string",
      "upload": 0,
      "download": 0,
      "amount": "string",
      "roaming": {
        "description": "string",
        "download": 0,
        "amount": "string"
      }
    },
    "voice": {
      "planType": "METERED",
      "national": {
        "description": "string",
        "duration": "string",
        "number": 0,
        "amount": "string"
      },
      "international": {
        "description": "string",
        "duration": "string",
        "number": 0,
        "amount": "string"
      },
      "roaming": {
        "description": "string",
        "duration": "string",
        "number": 0,
        "amount": "string"
      }
    },
    "messaging": {
      "planType": "METERED",
      "sms": {
        "description": "string",
        "national": 0,
        "international": 0,
        "roaming": 0,
        "amount": "string"
      },
      "mms": {
        "description": "string",
        "national": 0,
        "international": 0,
        "roaming": 0,
        "amount": "string"
      }
    }
  }
}

Telco balances for a service

Properties

Name Type Required Description
serviceId string optional 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 requirements
displayName string optional Optional description of the service used for display purposes
phoneNumber string conditional Required if the service includes a phone number
startDate DateTimeString optional Date when the balance period started
endDate DateTimeString optional Date when the balance period ends
balance TelcoServiceBalances optional A summary of Service balances

TelcoPlanType

"METERED"

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

Name Type Required Description
anonymous Enum mandatory 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

Enumerated Values

Property Value
anonymous METERED
anonymous UNMETERED
anonymous LIMITED
anonymous UNSUPPORTED

CommonPhysicalAddress

{
  "addressUType": "paf",
  "simple": {
    "mailingName": "string",
    "addressLine1": "string",
    "addressLine2": "string",
    "addressLine3": "string",
    "postcode": "string",
    "city": "string",
    "state": "string",
    "country": "AUS"
  },
  "paf": {
    "dpid": "string",
    "thoroughfareNumber1": 0,
    "thoroughfareNumber1Suffix": "string",
    "thoroughfareNumber2": 0,
    "thoroughfareNumber2Suffix": "string",
    "flatUnitType": "string",
    "flatUnitNumber": "string",
    "floorLevelType": "string",
    "floorLevelNumber": "string",
    "lotNumber": "string",
    "buildingName1": "string",
    "buildingName2": "string",
    "streetName": "string",
    "streetType": "string",
    "streetSuffix": "string",
    "postalDeliveryType": "string",
    "postalDeliveryNumber": 0,
    "postalDeliveryNumberPrefix": "string",
    "postalDeliveryNumberSuffix": "string",
    "localityName": "string",
    "postcode": "string",
    "state": "string"
  }
}

Properties

Name Type Required Description
addressUType Enum mandatory The type of address object present
simple CommonSimpleAddress conditional Required if addressUType is set to simple
paf CommonPAFAddress conditional Australian address formatted according to the file format defined by the PAF file format. Required if addressUType is set to paf

Enumerated Values

Property Value
addressUType paf
addressUType simple

CommonSimpleAddress

{
  "mailingName": "string",
  "addressLine1": "string",
  "addressLine2": "string",
  "addressLine3": "string",
  "postcode": "string",
  "city": "string",
  "state": "string",
  "country": "AUS"
}

Required if addressUType is set to simple

Properties

Name Type Required Description
mailingName string optional Name of the individual or business formatted for inclusion in an address used for physical mail
addressLine1 string mandatory First line of the standard address object
addressLine2 string optional Second line of the standard address object
addressLine3 string optional Third line of the standard address object
postcode string conditional Mandatory for Australian addresses
city string mandatory Name of the city or locality
state string mandatory Free text if the country is not Australia. If country is Australia then must be one of the values defined by the State Type Abbreviation in the PAF file format. NSW, QLD, VIC, NT, WA, SA, TAS, ACT, AAT
country ExternalRef optional A valid ISO 3166 Alpha-3 country code. Australia (AUS) is assumed if country is not present.

CommonPAFAddress

{
  "dpid": "string",
  "thoroughfareNumber1": 0,
  "thoroughfareNumber1Suffix": "string",
  "thoroughfareNumber2": 0,
  "thoroughfareNumber2Suffix": "string",
  "flatUnitType": "string",
  "flatUnitNumber": "string",
  "floorLevelType": "string",
  "floorLevelNumber": "string",
  "lotNumber": "string",
  "buildingName1": "string",
  "buildingName2": "string",
  "streetName": "string",
  "streetType": "string",
  "streetSuffix": "string",
  "postalDeliveryType": "string",
  "postalDeliveryNumber": 0,
  "postalDeliveryNumberPrefix": "string",
  "postalDeliveryNumberSuffix": "string",
  "localityName": "string",
  "postcode": "string",
  "state": "string"
}

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

Properties

Name Type Required Description
dpid string optional Unique identifier for an address as defined by Australia Post. Also known as Delivery Point Identifier
thoroughfareNumber1 PositiveInteger optional Thoroughfare number for a property (first number in a property ranged address)
thoroughfareNumber1Suffix string optional Suffix for the thoroughfare number. Only relevant is thoroughfareNumber1 is populated
thoroughfareNumber2 PositiveInteger optional Second thoroughfare number (only used if the property has a ranged address eg 23-25)
thoroughfareNumber2Suffix string optional Suffix for the second thoroughfare number. Only relevant is thoroughfareNumber2 is populated
flatUnitType string optional Type of flat or unit for the address
flatUnitNumber string optional Unit number (including suffix, if applicable)
floorLevelType string optional Type of floor or level for the address
floorLevelNumber string optional Floor or level number (including alpha characters)
lotNumber string optional Allotment number for the address
buildingName1 string optional Building/Property name 1
buildingName2 string optional Building/Property name 2
streetName string optional The name of the street
streetType string optional The street type. Valid enumeration defined by Australia Post PAF code file
streetSuffix string optional The street type suffix. Valid enumeration defined by Australia Post PAF code file
postalDeliveryType string optional Postal delivery type. (eg. PO BOX). Valid enumeration defined by Australia Post PAF code file
postalDeliveryNumber PositiveInteger optional Postal delivery number if the address is a postal delivery type
postalDeliveryNumberPrefix string optional Postal delivery number prefix related to the postal delivery number
postalDeliveryNumberSuffix string optional Postal delivery number suffix related to the postal delivery number
localityName string mandatory Full name of locality
postcode string mandatory Postcode for the locality
state string mandatory State in which the address belongs. Valid enumeration defined by Australia Post PAF code file State Type Abbreviation. NSW, QLD, VIC, NT, WA, SA, TAS, ACT, AAT

{
  "self": "string"
}

Properties

Name Type Required Description
self URIString mandatory Fully qualified link that generated the current response document

Meta

{}

Properties

None

LinksPaginated

{
  "self": "string",
  "first": "string",
  "prev": "string",
  "next": "string",
  "last": "string"
}

Properties

Name Type Required Description
self URIString mandatory Fully qualified link that generated the current response document
first URIString conditional URI to the first page of this set. Mandatory if this response is not the first page
prev URIString conditional URI to the previous page of this set. Mandatory if this response is not the first page
next URIString conditional URI to the next page of this set. Mandatory if this response is not the last page
last URIString conditional URI to the last page of this set. Mandatory if this response is not the last page

MetaPaginated

{
  "totalRecords": 0,
  "totalPages": 0
}

Properties

Name Type Required Description
totalRecords NaturalNumber mandatory The total number of records in the full set. See pagination.
totalPages NaturalNumber mandatory The total number of pages in the full set. See pagination.

TelcoProductListResponseData

{
  "plans": [
    {
      "productId": "string",
      "effectiveFrom": "string",
      "effectiveTo": "string",
      "lastUpdated": "string",
      "displayName": "string",
      "description": "string",
      "type": "MOBILE",
      "purpose": "PERSONAL",
      "billingType": "PRE_PAID",
      "contract": {
        "name": "string",
        "description": "string",
        "duration": 0,
        "contractUri": "string"
      },
      "bundle": true,
      "brand": "string",
      "brandName": "string",
      "pricing": [
        {
          "name": "string",
          "description": "string",
          "period": "string",
          "amount": "string"
        }
      ],
      "thirdPartyAgentId": "string",
      "thirdPartyAgentName": "string",
      "applicationUri": "string",
      "additionalInformation": {
        "overviewUri": "string",
        "termsUri": "string",
        "eligibilityUri": "string",
        "pricingUri": "string",
        "bundleUri": "string"
      }
    }
  ]
}

Properties

Name Type Required Description
plans [TelcoProduct] mandatory Array of Products

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 Type Required Description
data TelcoUsageListResponseData mandatory none
links Links mandatory none
meta Meta mandatory none

TelcoUsageListResponseData

{
  "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"
                }
              }
            }
          }
        }
      ]
    }
  ]
}

Properties

Name Type Required Description
accounts [TelcoAccountUsage] mandatory Array of usage on accounts

TelcoAccountListResponseData

{
  "accounts": [
    {
      "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"
          }
        }
      ]
    }
  ]
}

Properties

Name Type Required Description
accounts [TelcoAccountResponseData] mandatory Array of accounts

TelcoPaymentScheduleResponseData

{
  "paymentSchedules": [
    {
      "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
paymentSchedules [TelcoPaymentSchedule] mandatory Array may be empty if no payment schedule exist

TelcoConcessionsResponseData

{
  "concessions": [
    {
      "type": "CONCESSION",
      "displayName": "string",
      "additionalInfo": "string",
      "additionalInfoUri": "string",
      "startDate": "string",
      "endDate": "string",
      "discountFrequency": "string",
      "amount": "string",
      "percentage": "string",
      "appliedTo": [
        "INVOICE"
      ]
    }
  ]
}

Properties

Name Type Required Description
concessions [TelcoConcession] mandatory Array may be empty if no concessions exist

TelcoBalanceListResponseData

{
  "balances": [
    {
      "accountId": "string",
      "balance": {
        "services": [
          {
            "serviceId": "string",
            "displayName": "string",
            "phoneNumber": "string",
            "startDate": "string",
            "endDate": "string",
            "balance": {
              "data": {
                "planType": "METERED",
                "description": "string",
                "upload": 0,
                "download": 0,
                "amount": "string",
                "roaming": {
                  "description": "string",
                  "download": 0,
                  "amount": "string"
                }
              },
              "voice": {
                "planType": "METERED",
                "national": {
                  "description": "string",
                  "duration": "string",
                  "number": 0,
                  "amount": "string"
                },
                "international": {
                  "description": "string",
                  "duration": "string",
                  "number": 0,
                  "amount": "string"
                },
                "roaming": {
                  "description": "string",
                  "duration": "string",
                  "number": 0,
                  "amount": "string"
                }
              },
              "messaging": {
                "planType": "METERED",
                "sms": {
                  "description": "string",
                  "national": 0,
                  "international": 0,
                  "roaming": 0,
                  "amount": "string"
                },
                "mms": {
                  "description": "string",
                  "national": 0,
                  "international": 0,
                  "roaming": 0,
                  "amount": "string"
                }
              }
            }
          }
        ]
      }
    }
  ]
}

Properties

Name Type Required Description
balances [TelcoBalanceResponseData] mandatory Array of account balances

TelcoBalanceResponseData

{
  "accountId": "string",
  "balance": {
    "services": [
      {
        "serviceId": "string",
        "displayName": "string",
        "phoneNumber": "string",
        "startDate": "string",
        "endDate": "string",
        "balance": {
          "data": {
            "planType": "METERED",
            "description": "string",
            "upload": 0,
            "download": 0,
            "amount": "string",
            "roaming": {
              "description": "string",
              "download": 0,
              "amount": "string"
            }
          },
          "voice": {
            "planType": "METERED",
            "national": {
              "description": "string",
              "duration": "string",
              "number": 0,
              "amount": "string"
            },
            "international": {
              "description": "string",
              "duration": "string",
              "number": 0,
              "amount": "string"
            },
            "roaming": {
              "description": "string",
              "duration": "string",
              "number": 0,
              "amount": "string"
            }
          },
          "messaging": {
            "planType": "METERED",
            "sms": {
              "description": "string",
              "national": 0,
              "international": 0,
              "roaming": 0,
              "amount": "string"
            },
            "mms": {
              "description": "string",
              "national": 0,
              "international": 0,
              "roaming": 0,
              "amount": "string"
            }
          }
        }
      }
    ]
  }
}

Properties

Name Type Required Description
accountId string optional The ID of the account. In accordance with CDR ID permanence requirements
balance TelcoBalance optional Object containing account service usage summary

TelcoInvoiceResponse

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

Name Type Required Description
data TelcoInvoiceListResponseData mandatory none
links Links mandatory none
meta Meta mandatory none

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

Name Type Required Description
data TelcoInvoiceListResponseData mandatory none
links LinksPaginated mandatory none
meta MetaPaginated mandatory none

TelcoInvoiceListResponseData

{
  "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"
    }
  ]
}

Properties

Name Type Required Description
invoices [TelcoInvoice] mandatory Array of invoices sorted by issue date in descending order

TelcoTransactionListResponseData

{
  "transactions": [
    {
      "accountId": "string",
      "executionDateTime": "string",
      "gst": "string",
      "transactionUType": "account",
      "account": {
        "serviceIds": "string",
        "invoiceNumber": "string",
        "description": "string",
        "startDate": "string",
        "endDate": "string",
        "amount": "string",
        "adjustments": [
          {
            "amount": "string",
            "description": "string"
          }
        ]
      },
      "onceOff": {
        "serviceId": "string",
        "invoiceNumber": "string",
        "amount": "string",
        "description": "string"
      },
      "otherCharges": {
        "serviceId": "string",
        "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

TelcoProductPricing

{
  "name": "string",
  "description": "string",
  "period": "string",
  "amount": "string"
}

Properties

Name Type Required Description
name string mandatory The display name of the pricing
description string mandatory The description of the pricing
period ExternalRef optional The duration that occurs on a pricing schedule indicates the frequency. Formatted according to ISO 8601 Durations (excludes recurrence syntax)
amount AmountString mandatory The amount charged for the duration period

TelcoAdditionalInformation

{
  "overviewUri": "string",
  "termsUri": "string",
  "eligibilityUri": "string",
  "pricingUri": "string",
  "bundleUri": "string"
}

Object that contains links to additional information on specific topics

Properties

Name Type Required Description
overviewUri URIString optional A link to a general overview of the plan
termsUri URIString optional A link to terms and conditions for the plan
eligibilityUri URIString optional A link to detail on eligibility criteria for the plan
pricingUri URIString optional A link to detail on pricing for the plan
bundleUri URIString optional A link to detail on bundles that this plan can be a part of

TelcoProductDetailMeteringCharges

{
  "displayName": "string",
  "description": "string",
  "minimumValue": "string",
  "maximumValue": "string",
  "period": "string"
}

Properties

Name Type Required Description
displayName string mandatory Display name of the charge
description string optional Description of the charge
minimumValue AmountString mandatory Minimum value of the charge if the charge is a range or the absolute value of the charge if no range is specified
maximumValue AmountString optional The upper limit of the charge if the charge could occur in a range
period ExternalRef optional The charges that occur on a schedule indicates the frequency. Formatted according to ISO 8601 Durations (excludes recurrence syntax)

TelcoProductDetailFeature

{
  "displayName": "string",
  "description": "string",
  "category": "DATA"
}

Properties

Name Type Required Description
displayName string mandatory The display name of the feature
description string optional The description of the feature
category Enum optional The type of the feature

Enumerated Values

Property Value
category DATA
category VOICE
category MESSAGING
category HANDSET
category DEVICE
category NETWORK
category ENTERTAINMENT
category SUBSCRIPTION
category SOFTWARE
category OTHER

TelcoProductDetailBundles

{
  "displayName": "string",
  "description": "string",
  "bundleUri": "string",
  "features": [
    {
      "displayName": "string",
      "description": "string",
      "category": "DATA"
    }
  ]
}

Properties

Name Type Required Description
displayName string mandatory The display name of the product bundle
description string optional The description of the product bundle
bundleUri URIString optional The URI of the product bundle
features [TelcoProductDetailFeature] optional Optional list of features of the bundle

TelcoProductDetailPlan

{
  "displayName": "string",
  "description": "string",
  "planUri": "string",
  "features": [
    {
      "displayName": "string",
      "description": "string"
    }
  ]
}

Properties

Name Type Required Description
displayName string mandatory The display name of the product plan
description string optional The display name of the product plan
planUri URIString optional The URI of the product plan
features [TelcoProductDetailPlanFeature] optional Optional list of features of the plan

TelcoProductDetailPlanFeature

{
  "displayName": "string",
  "description": "string"
}

Properties

Name Type Required Description
displayName string mandatory The display name of the feature
description string optional The description of the feature

TelcoProductDetailDiscountFeature

{
  "displayName": "string",
  "description": "string"
}

Properties

Name Type Required Description
displayName string mandatory The display name of the discount feature
description string optional The description of the discount feature

TelcoProductDetailDiscounts

{
  "displayName": "string",
  "description": "string",
  "discountUri": "string",
  "features": [
    {
      "displayName": "string",
      "description": "string"
    }
  ]
}

Properties

Name Type Required Description
displayName string mandatory The display name of the product plan
description string optional The description name of the product plan
discountUri URIString optional The URI of the discount
features [TelcoProductDetailDiscountFeature] optional Optional list of features of the discount

TelcoProductDetailIncentiveFeature

{
  "displayName": "string",
  "description": "string"
}

Properties

Name Type Required Description
displayName string mandatory The display name of the incentive feature
description string optional The description of the incentive feature

TelcoProductDetailIncentives

{
  "displayName": "string",
  "description": "string",
  "incentiveUri": "string",
  "features": [
    {
      "displayName": "string",
      "description": "string"
    }
  ]
}

Properties

Name Type Required Description
displayName string mandatory The display name of the incentive
description string optional The description of the incentive
incentiveUri URIString optional The URI of the incentive
features [TelcoProductDetailIncentiveFeature] optional Optional list of features of the incentive

TelcoProductDetail

{
  "meteringCharges": [
    {
      "displayName": "string",
      "description": "string",
      "minimumValue": "string",
      "maximumValue": "string",
      "period": "string"
    }
  ],
  "bundles": [
    {
      "displayName": "string",
      "description": "string",
      "bundleUri": "string",
      "features": [
        {
          "displayName": "string",
          "description": "string",
          "category": "DATA"
        }
      ]
    }
  ],
  "plans": [
    {
      "displayName": "string",
      "description": "string",
      "planUri": "string",
      "features": [
        {
          "displayName": "string",
          "description": "string"
        }
      ]
    }
  ],
  "discounts": [
    {
      "displayName": "string",
      "description": "string",
      "discountUri": "string",
      "features": [
        {
          "displayName": "string",
          "description": "string"
        }
      ]
    }
  ],
  "incentives": [
    {
      "displayName": "string",
      "description": "string",
      "incentiveUri": "string",
      "features": [
        {
          "displayName": "string",
          "description": "string"
        }
      ]
    }
  ]
}

Properties

Name Type Required Description
meteringCharges [TelcoProductDetailMeteringCharges] optional Charges for metering included in the plan
bundles [TelcoProductDetailBundles] optional Bundles the product can be part of
plans [TelcoProductDetailPlan] optional Plans associated to the product
discounts [TelcoProductDetailDiscounts] optional Discounts associated to the product
incentives [TelcoProductDetailIncentives] optional Incentives associated to the product

TelcoAccountUsageServices

{
  "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"
        }
      }
    }
  }
}

Properties

Name Type Required Description
service TelcoServiceUsage mandatory none

TelcoAccountPlanOverview

{
  "displayName": "string",
  "startDate": "string",
  "endDate": "string"
}

Mandatory if openStatus is OPEN

Properties

Name Type Required Description
displayName string optional The name of the plan if one exists
startDate DateString mandatory The start date of the applicability of this plan
endDate DateString optional The end date of the applicability of this plan

TelcoAccountPlan

{
  "nickname": "string",
  "type": "MOBILE",
  "billingType": "PRE_PAID",
  "serviceIds": [
    "string"
  ],
  "planOverview": {
    "displayName": "string",
    "startDate": "string",
    "endDate": "string"
  }
}

Properties

Name Type Required Description
nickname string optional Optional display name for the plan provided by the customer to help differentiate multiple plans
type Enum mandatory The type of the plan. The type of plan. A MOBILE service or BROADBAND fixed internet service
billingType Enum mandatory The billing type of then plan
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 mandatory Mandatory if openStatus is OPEN

Enumerated Values

Property Value
type MOBILE
type BROADBAND
billingType PRE_PAID
billingType POST_PAID
billingType UPFRONT_PAID
billingType OTHER

TelcoAccount

{
  "plans": [
    {
      "nickname": "string",
      "type": "MOBILE",
      "billingType": "PRE_PAID",
      "serviceIds": [
        "string"
      ],
      "planOverview": {
        "displayName": "string",
        "startDate": "string",
        "endDate": "string"
      }
    }
  ]
}

The array of plans containing services and associated plan details

Properties

Name Type Required Description
plans [TelcoAccountPlan] mandatory The array of plans containing service and associated plan details

TelcoAccountPlanDetail

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

Name Type Required Description
planDetail object mandatory none
» charges [TelcoProductDetailMeteringCharges] mandatory Charges for metering included in the plan

TelcoAccountDetailAuthorisedContacts

{
  "firstName": "string",
  "lastName": "string",
  "middleNames": [
    "string"
  ],
  "prefix": "string",
  "suffix": "string"
}

Properties

Name Type Required Description
firstName string optional For people with single names this field need not be present. The single name should be in the lastName field
lastName string mandatory For people with single names the single name should be in this field
middleNames [string] optional Field is mandatory but array may be empty
prefix string optional Also known as title or salutation. The prefix to the name (e.g. Mr, Mrs, Ms, Miss, Sir, etc)
suffix string optional Used for a trailing suffix to the name (e.g. Jr)

TelcoAccountDetail

{
  "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"
          }
        ]
      }
    }
  ]
}

The array of plans containing services and associated plan details

Properties

Name Type Required Description
plans [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

{
  "cardScheme": "VISA",
  "paymentFrequency": "string",
  "calculationType": "STATIC"
}

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

Properties

Name Type Required Description
cardScheme Enum mandatory The type of credit card held on file
paymentFrequency ExternalRef mandatory The frequency that payments will occur. Formatted according to ISO 8601 Durations (excludes recurrence syntax)
calculationType Enum mandatory The mechanism by which the payment amount is calculated. Explanation of values are as follows:
  • STATIC - Indicates a consistent, static amount, per payment
  • BALANCE - Indicates that the outstanding balance for the account is paid per period
  • CALCULATED - Indicates that the payment amount is variable and calculated using a pre-defined algorithm

Enumerated Values

Property Value
cardScheme VISA
cardScheme MASTERCARD
cardScheme AMEX
cardScheme DINERS
cardScheme OTHER
cardScheme UNKNOWN
calculationType STATIC
calculationType BALANCE
calculationType CALCULATED

TelcoPaymentScheduleDirectDebit

{
  "isTokenised": true,
  "bsb": "string",
  "accountNumber": "string",
  "paymentFrequency": "string",
  "calculationType": "STATIC"
}

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

Properties

Name Type Required Description
isTokenised boolean optional Flag indicating that the account details are tokenised and cannot be shared. False if absent
bsb string conditional The unmasked BSB for the account to be debited. Is expected to be formatted as digits only with leading zeros included and no punctuation or spaces. Is required if isTokenised is absent or false
accountNumber string conditional The unmasked account number for the account to be debited. Is expected to be formatted as digits only with leading zeros included and no punctuation or spaces. Is required if isTokenised is absent or false
paymentFrequency ExternalRef mandatory The frequency that payments will occur. Formatted according to ISO 8601 Durations (excludes recurrence syntax)
calculationType Enum mandatory The mechanism by which the payment amount is calculated. Explanation of values are as follows:
  • STATIC - Indicates a consistent, static amount, per payment
  • BALANCE - Indicates that the outstanding balance for the account is paid per period
  • CALCULATED - Indicates that the payment amount is variable and calculated using a pre-defined algorithm

Enumerated Values

Property Value
calculationType STATIC
calculationType BALANCE
calculationType CALCULATED

TelcoPaymentScheduleDigitalWallet

{
  "name": "string",
  "identifier": "string",
  "type": "EMAIL",
  "provider": "PAYPAL_AU",
  "paymentFrequency": "string",
  "calculationType": "STATIC"
}

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

Properties

Name Type Required Description
name string mandatory The display name of the wallet as given by the customer, else a default value defined by the data holder
identifier string mandatory The identifier of the digital wallet (dependent on type)
type Enum mandatory The type of the digital wallet identifier
provider Enum mandatory The provider of the digital wallet
paymentFrequency ExternalRef mandatory The frequency that payments will occur. Formatted according to ISO 8601 Durations (excludes recurrence syntax)
calculationType Enum mandatory The mechanism by which the payment amount is calculated. Explanation of values are as follows:
  • STATIC - Indicates a consistent, static amount, per payment
  • BALANCE - Indicates that the outstanding balance for the account is paid per period
  • CALCULATED - Indicates that the payment amount is variable and calculated using a pre-defined algorithm

Enumerated Values

Property Value
type EMAIL
type CONTACT_NAME
type TELEPHONE
provider PAYPAL_AU
provider OTHER
calculationType STATIC
calculationType BALANCE
calculationType CALCULATED

TelcoPaymentScheduleManualPayment

{
  "billFrequency": "string"
}

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

Properties

Name Type Required Description
billFrequency ExternalRef mandatory The frequency with which a bill will be issued. Formatted according to ISO 8601 Durations (excludes recurrence syntax)

TelcoInvoicePeriod

{
  "startDate": "string",
  "endDate": "string"
}

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

Name Type Required Description
startDate DateString mandatory The start date of the period covered by this invoice
endDate DateString mandatory The end date of the period covered by this invoice

TelcoInvoicePayOnTimeDiscount

{
  "discountAmount": "string",
  "gstAmount": "string",
  "date": "string"
}

A discount for on time payment

Properties

Name Type Required Description
discountAmount AmountString mandatory The amount that will be discounted if the invoice is paid by the date specified
gstAmount AmountString optional The GST amount that will be discounted if the invoice is paid by the date specified. If absent then zero is assumed
date DateString mandatory The date by which the invoice must be paid to receive the pay on time discount

TelcoUsageDatRoaming

{
  "download": 0,
  "amount": "string"
}

Roaming Data Usage

Properties

Name Type Required Description
download Number conditional Amount of data used while roaming in megabytes (MB)
amount AmountString conditional Amount value of data roaming charges

TelcoUsageData

{
  "upload": 0,
  "download": 0,
  "sessions": 0,
  "amount": "string",
  "roaming": {
    "download": 0,
    "amount": "string"
  }
}

Summary of data usage

Properties

Name Type Required Description
upload Number mandatory Amount of data uploaded in megabytes (MB)
download Number mandatory Amount of data downloaded in megabytes (MB)
sessions Number optional Number of data sessions
amount AmountString mandatory Cost amount of data usage
roaming TelcoUsageDatRoaming optional Required if roaming is suipported

TelcoUsageVoiceNational

{
  "duration": "string",
  "number": 0,
  "amount": "string"
}

National voice calls

Properties

Name Type Required Description
duration TimeString mandatory Total duration (hours, minutes, and seconds) of national voice calls. Not limited to 24hrs
number Number mandatory Number of national voice calls
amount AmountString mandatory Cost amount of national calls

TelcoUsageVoiceInternational

{
  "duration": "string",
  "number": 0,
  "amount": "string"
}

International voice calls. Requied if international calling is supported

Properties

Name Type Required Description
duration TimeString mandatory Total duration (hours, minutes, and seconds) of international voice calls. Not limited to 24hrs
number Number mandatory Number of international voice calls
amount AmountString mandatory Cost amount of international voice calls

TelcoUsageVoiceRoaming

{
  "duration": "string",
  "number": 0,
  "amount": "string"
}

Roaming voice calls, Required if roaming is supported

Properties

Name Type Required Description
duration TimeString mandatory Total duration (hours, minutes, and seconds) of roaming voice calls. Not limited to 24hrs
number Number mandatory Number of roaming voice calls
amount AmountString mandatory Cost amount of roaming voice calls

TelcoUsageVoice

{
  "national": {
    "duration": "string",
    "number": 0,
    "amount": "string"
  },
  "international": {
    "duration": "string",
    "number": 0,
    "amount": "string"
  },
  "roaming": {
    "duration": "string",
    "number": 0,
    "amount": "string"
  }
}

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

Properties

Name Type Required Description
national TelcoUsageVoiceNational mandatory National voice calls
international TelcoUsageVoiceInternational mandatory International voice calls. Requied if international calling is supported
roaming TelcoUsageVoiceRoaming mandatory Roaming voice calls, Required if roaming is supported

TelcoUsageMessagingSms

{
  "national": 0,
  "international": 0,
  "roaming": 0,
  "amount": "string"
}

Summary of SMS usage

Properties

Name Type Required Description
national Number mandatory Number of national SMS messages sent. Including premium SMS services
international Number conditional Number of international SMS messages sent. Including premium SMS services
roaming Number conditional Number of roaming SMS messages sent. Including premium SMS services
amount AmountString mandatory Cost amount of SMS messages. Including premium SMS services

TelcoUsageMessagingMms

{
  "national": 0,
  "international": 0,
  "roaming": 0,
  "amount": "string"
}

Summary of MMS usage

Properties

Name Type Required Description
national Number mandatory Number of national MMS messages sent
international Number conditional ber of international MMS messages sent
roaming Number conditional Number of roaming SMS messages sent. Including premium SMS services
amount AmountString mandatory Cost amount of MMS messages

TelcoUsageMessaging

{
  "sms": {
    "national": 0,
    "international": 0,
    "roaming": 0,
    "amount": "string"
  },
  "mms": {
    "national": 0,
    "international": 0,
    "roaming": 0,
    "amount": "string"
  }
}

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

Properties

Name Type Required Description
sms TelcoUsageMessagingSms mandatory Summary of SMS usage
mms TelcoUsageMessagingMms mandatory Summary of MMS usage

TelcoInvoiceAccountChargesOtherCharges

{
  "amount": "string",
  "description": "string",
  "type": "SERVICE"
}

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

Properties

Name Type Required Description
amount AmountString mandatory The aggregate total of charges for this item (exclusive of GST)
description AmountString mandatory A free text description of the charge
type Enum optional A free text description of the charge

Enumerated Values

Property Value
type SERVICE
type EQUIPMENT
type NETWORK
type HANDSET
type DEVICE
type ENTERTAINMENT
type SUBSCRIPTION
type SOFTWARE
type OTHER

TelcoBillingAccountTransactionAdjustments

{
  "amount": "string",
  "description": "string"
}

Properties

Name Type Required Description
amount AmountString mandatory The amount of the adjustment
description string mandatory A free text description of the adjustment

TelcoServiceBalanceDataRoaming

{
  "description": "string",
  "download": 0,
  "amount": "string"
}

Balance of data roaming charges. Required unless planType is UNSUPPORTED

Properties

Name Type Required Description
description string optional An overview of plan limits. Required unless planType is UNSUPPORTED
download Number conditional Amount of data used overseas in megabytes (MB). Required unless planType is UNSUPPORTED
amount AmountString conditional Amount value of data roaming charges. Required unless planType is UNSUPPORTED

TelcoServiceBalanceData

{
  "planType": "METERED",
  "description": "string",
  "upload": 0,
  "download": 0,
  "amount": "string",
  "roaming": {
    "description": "string",
    "download": 0,
    "amount": "string"
  }
}

Summary of data balances

Properties

Name Type Required Description
planType TelcoPlanType mandatory 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
description string conditional An overview of plan limits. Required unless planType is UNSUPPORTED
upload Number optional Remaining upload data in megabytes (MB). Required unless planType is UNSUPPORTED or UNMETERED
download Number conditional Remaining download data in megabytes (MB). Required unless planType is UNSUPPORTED or UNMETERED
amount AmountString conditional Remaining value amount of data available. Required unless planType is UNSUPPORTED or UNMETERED
roaming TelcoServiceBalanceDataRoaming optional Balance of data roaming charges. Required unless planType is UNSUPPORTED

TelcoServiceBalanceVoiceNational

{
  "description": "string",
  "duration": "string",
  "number": 0,
  "amount": "string"
}

National voice calls

Properties

Name Type Required Description
description string conditional An overview of plan limits. Required unless planType is UNSUPPORTED
duration TimeString conditional Total duration (hours, minutes, and seconds) of national voice calls. Not limited to 24hrs. Required unless planType is UNSUPPORTED or UNMETERED
number Number conditional Number of national voice calls. Required unless planType is UNSUPPORTED or UNMETERED
amount AmountString conditional Amount balance of national calls. Required unless planType is UNSUPPORTED or UNMETERED

TelcoServiceBalanceVoiceInternational

{
  "description": "string",
  "duration": "string",
  "number": 0,
  "amount": "string"
}

International voice calls

Properties

Name Type Required Description
description string conditional An overview of plan limits. Required unless planType is UNSUPPORTED
duration TimeString optional Total duration (hours, minutes, and seconds) of international voice calls available. Not limited to 24hrs. Required unless planType is UNSUPPORTED or UNMETERED
number Number optional Number of international voice calls available Required unless planType is UNSUPPORTED or UNMETERED
amount AmountString conditional Amount value of international calls available. Required unless planType is UNSUPPORTED or UNMETERED

TelcoServiceBalanceVoiceRoaming

{
  "description": "string",
  "duration": "string",
  "number": 0,
  "amount": "string"
}

Roaming voice calls

Properties

Name Type Required Description
description string conditional An overview of plan limits. Required unless planType is UNSUPPORTED
duration TimeString optional Total duration (hours, minutes, and seconds) of roaming voice calls available. Not limited to 24hrs. Required unless planType is UNSUPPORTED or UNMETERED
number Number optional Number of roaming voice calls available Required unless planType is UNSUPPORTED or UNMETERED
amount AmountString conditional Amount value of roaming calls available. Required unless planType is UNSUPPORTED or UNMETERED

TelcoServiceBalanceVoice

{
  "planType": "METERED",
  "national": {
    "description": "string",
    "duration": "string",
    "number": 0,
    "amount": "string"
  },
  "international": {
    "description": "string",
    "duration": "string",
    "number": 0,
    "amount": "string"
  },
  "roaming": {
    "description": "string",
    "duration": "string",
    "number": 0,
    "amount": "string"
  }
}

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

Properties

Name Type Required Description
planType TelcoPlanType mandatory 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
national TelcoServiceBalanceVoiceNational conditional National voice calls
international TelcoServiceBalanceVoiceInternational conditional International voice calls
roaming TelcoServiceBalanceVoiceRoaming conditional Roaming voice calls

TelcoServiceBalanceMessagingSms

{
  "description": "string",
  "national": 0,
  "international": 0,
  "roaming": 0,
  "amount": "string"
}

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

Properties

Name Type Required Description
description string conditional An overview of plan limits. Required unless planType is UNSUPPORTED
national Number conditional Number of national SMS messages remaining. Required unless planType is UNSUPPORTED or UNMETERED
international Number conditional Number of international SMS messages remaining. Required unless planType is UNSUPPORTED or UNMETERED
roaming Number conditional Number of roaming SMS messages remaining. Required unless planType is UNSUPPORTED or UNMETERED
amount AmountString conditional Amount value of SMS messages remaining. Required unless planType is UNSUPPORTED or UNMETERED

TelcoServiceBalanceMessagingMms

{
  "description": "string",
  "national": 0,
  "international": 0,
  "roaming": 0,
  "amount": "string"
}

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

Properties

Name Type Required Description
description string conditional An overview of plan limits. Required unless planType is UNSUPPORTED
national Number conditional Number of national MMS messages remaining. Required unless planType is UNSUPPORTED or UNMETERED
international Number conditional Number of international MMS messages remaining. Required unless planType is UNSUPPORTED or UNMETERED
roaming Number conditional Number of roaming MMS messages remaining. Required unless planType is UNSUPPORTED or UNMETERED
amount AmountString conditional Amount value of MMS messages remaining. Required unless planType is UNSUPPORTED or UNMETERED

TelcoServiceBalanceMessaging

{
  "planType": "METERED",
  "sms": {
    "description": "string",
    "national": 0,
    "international": 0,
    "roaming": 0,
    "amount": "string"
  },
  "mms": {
    "description": "string",
    "national": 0,
    "international": 0,
    "roaming": 0,
    "amount": "string"
  }
}

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

Properties

Name Type Required Description
planType TelcoPlanType optional 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
sms TelcoServiceBalanceMessagingSms mandatory Summary of SMS Balance. Required if the service plan supports SMS messaging
mms TelcoServiceBalanceMessagingMms mandatory Summary of MMS Balance. Required if the service plan supports MMS messaging

TelcoServiceBalances

{
  "data": {
    "planType": "METERED",
    "description": "string",
    "upload": 0,
    "download": 0,
    "amount": "string",
    "roaming": {
      "description": "string",
      "download": 0,
      "amount": "string"
    }
  },
  "voice": {
    "planType": "METERED",
    "national": {
      "description": "string",
      "duration": "string",
      "number": 0,
      "amount": "string"
    },
    "international": {
      "description": "string",
      "duration": "string",
      "number": 0,
      "amount": "string"
    },
    "roaming": {
      "description": "string",
      "duration": "string",
      "number": 0,
      "amount": "string"
    }
  },
  "messaging": {
    "planType": "METERED",
    "sms": {
      "description": "string",
      "national": 0,
      "international": 0,
      "roaming": 0,
      "amount": "string"
    },
    "mms": {
      "description": "string",
      "national": 0,
      "international": 0,
      "roaming": 0,
      "amount": "string"
    }
  }
}

A summary of Service balances

Properties

Name Type Required Description
data TelcoServiceBalanceData conditional Summary of data balances
voice TelcoServiceBalanceVoice conditional Summary of voice balances. Required if voice calls are included in product plan
messaging TelcoServiceBalanceMessaging conditional Summary of messaging. Required if messaging services is included in the product plan