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

Get a list of available reference data sources

Request

Security
bearerAuth
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
fieldsstring(FieldsParam)

Comma-delimited list of the field(s) to return if only a subset is required

Example: fields=id,name
namestring(StringFilterParam)

Filter by name

Example: name=xyz | in:x,y | like:xyz
localestring(IdFilterParam)

Filter by locale id

Example: locale=0
siMaintainedstring(BooleanFilterParam)

Filter by whether they are automatically or manually maintained

Example: siMaintained=true | false
curl -i -X GET \
  'https://rest.elevatebilling.com/v1/reference-data-sources?page=1&pageSize=100&sort=id%2Cname+%7C+name%3Adesc&fields=id%2Cname&name=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&locale=0&siMaintained=true+%2C+false' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/jsonArray [
idinteger(int64)read-only

Internal identifier of reference data source

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

Reference data source name

localeobject(Locale)required
locale.​idinteger(int64)read-only

Internal identifier for locale entry

Example: 1
locale.​countryobject(Country)required
locale.​country.​codestring(CountryCode)= 2 characters[A-Z]{2}required

ISO 3166 alpha-2 code representing country

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

Name of country

Example: "United Kingdom"
locale.​currencyobject(schemas-Currency)required
locale.​currency.​idinteger(int64)read-only

Internal identifier for currency entry

Example: 1
locale.​currency.​codestring(CurrencyCode)= 3 characters[A-Z]{3}required

ISO 4217 3-character currency code

Example: "GBP"
locale.​currency.​symbolstring= 1 charactersrequired

Currency symbol

locale.​currency.​majorCurrencyNamestring[ 1 .. 10 ] characters[a-zA-Z]+required

Name of major currency

locale.​currency.​minorCurrencyNamestring[ 1 .. 10 ] characters[a-zA-Z]+required

Name of minor currency

locale.​currency.​majorCurrencyFormatstring[ 1 .. 20 ] characters[a-zA-Z0-9\\p{L}\\s\\+\\/\\-\\._\\&amp;#=,:@(...required

Format to use when displaying major currency

locale.​currency.​minorCurrencyFormatstring[ 1 .. 20 ] characters[a-zA-Z0-9\\p{L}\\s\\+\\/\\-\\._\\&amp;#=,:@(...required

Format to use when displaying minor currency

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

Name used for sales tax in this currency

siMaintainedbooleanrequired

Indicates if this reference data source can be managed externally (false) or only by Strategic Imperatives (true)

]
Response
application/json
[
  {
    "id": 1,
    "name": "string",
    "locale": { … },
    "siMaintained": true
  }
]

Get a specific reference data source

Request

Security
bearerAuth
Path
reference_data_source_idinteger(int64)(IdParam)>= 1required

Reference data source identifier

Example: 1
curl -i -X GET \
  https://rest.elevatebilling.com/v1/reference-data-sources/1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Reference data source found

Bodyapplication/json
idinteger(int64)read-only

Internal identifier of reference data source

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

Reference data source name

localeobject(Locale)required
locale.​idinteger(int64)read-only

Internal identifier for locale entry

Example: 1
locale.​countryobject(Country)required
locale.​country.​codestring(CountryCode)= 2 characters[A-Z]{2}required

ISO 3166 alpha-2 code representing country

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

Name of country

Example: "United Kingdom"
locale.​currencyobject(schemas-Currency)required
locale.​currency.​idinteger(int64)read-only

Internal identifier for currency entry

Example: 1
locale.​currency.​codestring(CurrencyCode)= 3 characters[A-Z]{3}required

ISO 4217 3-character currency code

Example: "GBP"
locale.​currency.​symbolstring= 1 charactersrequired

Currency symbol

locale.​currency.​majorCurrencyNamestring[ 1 .. 10 ] characters[a-zA-Z]+required

Name of major currency

locale.​currency.​minorCurrencyNamestring[ 1 .. 10 ] characters[a-zA-Z]+required

Name of minor currency

locale.​currency.​majorCurrencyFormatstring[ 1 .. 20 ] characters[a-zA-Z0-9\\p{L}\\s\\+\\/\\-\\._\\&amp;#=,:@(...required

Format to use when displaying major currency

locale.​currency.​minorCurrencyFormatstring[ 1 .. 20 ] characters[a-zA-Z0-9\\p{L}\\s\\+\\/\\-\\._\\&amp;#=,:@(...required

Format to use when displaying minor currency

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

Name used for sales tax in this currency

siMaintainedbooleanrequired

Indicates if this reference data source can be managed externally (false) or only by Strategic Imperatives (true)

Response
application/json
{
  "id": 1,
  "name": "string",
  "locale": {
    "id": 1,
    "country": { … },
    "currency": { … }
  },
  "siMaintained": true
}

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