Skip to content

Elevate Reference Data API (1.12)

Reference Data Management

Where possible, Elevate will manage reference data internally via incoming feeds of reliable dialstring and charge group information However, for data sources where this is not possible (e.g. for proprietary/internal data) this can be managed externally via this API

Where a usage product cannot be rated using the dialstring look up method to identify the dialled number, Elevate will rely on call-class to do this instead

Entity model

  • One or many dialstrings map to one reference-data-source-charge-group
  • One or many call-classes map to one reference-data-source-charge-group
  • One or many reference-data-source-charge-groups map to one charge-group and one reference-data-source
  • One or many charge-groups map to one charge-group-category
Download OpenAPI description
billing-rest-reference-data.json
billing-rest-reference-data.yaml
Languages
Servers
https://rest.elevatebilling.com/v1

reference-data-sources

Manage sources of reference data - only manually maintained data sources can be updated via this endpoint

Operations

charge-groups

Management of charge groups and charge group categories

Operations

reference-data-source-charge-groups

Charge group and charge group category management by reference data source

Operations

call-classes

Management of manually maintained call-class information

Operations

ignored-call-classes

Management of manually maintained ignored-call-class information

Operations

ignored-service-ids

Management of manually maintained ignored-service-ids information

Operations

dialstrings

Management of manually maintained dialstrings information

Operations

tax-bands

Tax-band management

Operations

currencies

Currencies supported by the system

Operations

locales

Locales supported by the system

Operations

currency-rates

Management of the exchange rates between currencies

Operations

reference-data-summaries

Operations

Get a reference data summaries

Request

Security
bearerAuth
Path
referenceDataSummaryTypestring(ReferenceDataSummaryType)required

Reference Data Summary Type

Enum"CALL_CLASS""DIALSTRING""CHARGE_GROUP"
idinteger(int64)(IdParam)>= 1required

Entity identifier

Example: 1
Query
pageinteger(int32)(PageParam)>= 1required

Page of results to show

Example: page=1
pageSizeinteger(int32)(ResultsPerPageParam)[ 1 .. 1000 ]required

Results to return per page

Example: pageSize=100
sortstring(SortParam)

Comma-delimited list of the fields to sort by - defaults to ascending order, suffix :desc to change

Example: sort=id,name | name:desc
curl -i -X GET \
  'https://rest.elevatebilling.com/v1/reference-data-summary/{referenceDataSummaryType}/1?page=1&pageSize=100&sort=id%2Cname+%7C+name%3Adesc' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/jsonArray [
chargeGroupIdinteger(int64)read-only

Internal identifier of charge group

Example: 1
chargeGroupNamestring[ 1 .. 255 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Charge group name

chargeGroupStartDatestring(date)

Date this charge group applies from

chargeGroupEndDatestring(date)

Date this charge group applies to

chargeGroupCategoryIdinteger(int64)read-only

Internal identifier of charge group category

Example: 1
chargeGroupCategoryNamestring[ 1 .. 50 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Charge group category name

chargeGroupCategoryChargingUnitTypestring(ChargingUnitType)

Charging unit i.e. duration or data (MB) or one off

Enum"DURATION""MB""ONE_OFF"
chargeGroupCategoryStartDatestring(date)

Date this charge group category applies from

chargeGroupCategoryEndDatestring(date)

Date this charge group category applies to

referenceDataSourceIdinteger(int64)read-only

Internal identifier of reference data source

Example: 1
referenceDataSourceNamestring[ 1 .. 50 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Reference data source name

referenceDataSourceChargeGroupIdinteger(int64)read-only

Internal identifier of reference data source charge group

Example: 1
referenceDataSourceChargeGroupNamestring[ 1 .. 255 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Name of the reference data source charge group

referenceDataSourceChargeGroupStartDatestring(date)

Date this reference data source charge group applies from

referenceDataSourceChargeGroupEndDatestring(date)

Date this reference data source charge group applies to

callClassIdinteger(int64)read-only

Internal identifier of call class

Example: 1
callClassstring[ 1 .. 255 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Call class

callClassStartDatestring(date)

Date this call class applies from

callClassEndDatestring(date)

Date this call class applies to

dialstringIdinteger(int64)read-only

Internal identifier for dialstring

Example: 1
dialstringstring[ 2 .. 15 ] characters[0-9]+

Dialstring prefix

dialstringStartDatestring(date)

Date this dialstring applies from

dialstringEndDatestring(date)

Date this dialstring applies to

]
Response
application/json
[
  {
    "chargeGroupId": 1,
    "chargeGroupName": "string",
    "chargeGroupStartDate": "2019-08-24",
    "chargeGroupEndDate": "2019-08-24",
    "chargeGroupCategoryId": 1,
    "chargeGroupCategoryName": "string",
    "chargeGroupCategoryChargingUnitType": "DURATION",
    "chargeGroupCategoryStartDate": "2019-08-24",
    "chargeGroupCategoryEndDate": "2019-08-24",
    "referenceDataSourceId": 1,
    "referenceDataSourceName": "string",
    "referenceDataSourceChargeGroupId": 1,
    "referenceDataSourceChargeGroupName": "string",
    "referenceDataSourceChargeGroupStartDate": "2019-08-24",
    "referenceDataSourceChargeGroupEndDate": "2019-08-24",
    "callClassId": 1,
    "callClass": "string",
    "callClassStartDate": "2019-08-24",
    "callClassEndDate": "2019-08-24",
    "dialstringId": 1,
    "dialstring": "string",
    "dialstringStartDate": "2019-08-24",
    "dialstringEndDate": "2019-08-24"
  }
]