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

Get a list of currency rates

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
sourceCurrencyIdstring(IdFilterParam)

Filter by source currency id

Example: sourceCurrencyId=0
targetCurrencyIdstring(IdFilterParam)

Filter by target currency id

Example: targetCurrencyId=0
startDatestring(DateFilterParam)

Filter by start date

Example: startDate=yyyy-MM-dd | lt:yyyy-MM-dd | gt:yyyy-MM-dd | gtn:yyyy-MM-dd
endDatestring(DateFilterParam)

Filter by end date

Example: endDate=yyyy-MM-dd | lt:yyyy-MM-dd | gt:yyyy-MM-dd | gtn:yyyy-MM-dd
curl -i -X GET \
  'https://rest.elevatebilling.com/v1/currency-rates?page=1&pageSize=100&sort=id%2Cname+%7C+name%3Adesc&fields=id%2Cname&sourceCurrencyId=0&targetCurrencyId=0&startDate=yyyy-MM-dd+%2C+lt%3Ayyyy-MM-dd+%2C+gt%3Ayyyy-MM-dd+%2C+gtn%3Ayyyy-MM-dd&endDate=yyyy-MM-dd+%2C+lt%3Ayyyy-MM-dd+%2C+gt%3Ayyyy-MM-dd+%2C+gtn%3Ayyyy-MM-dd' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/jsonArray [
idinteger(int64)read-only

Internal identifier of currency rate

Example: 1
sourceCurrencyIdinteger(int64)required

Identifier of currency that is being converted from

Example: 1
targetCurrencyIdinteger(int64)required

Identifier of currency that is being converted to

Example: 1
exchangeRatenumberrequired

Exchange rate from source currency to target currency in major currency (e.g pounds/dollars/euros) unit. For example, from Argentina Peso to GBP is 446.2497

Example: 446.2497
startDatestring(date)required

Start date

endDatestring(date)

End date

]
Response
application/json
[
  {
    "id": 1,
    "sourceCurrencyId": 1,
    "targetCurrencyId": 1,
    "exchangeRate": 446.2497,
    "startDate": "2019-08-24",
    "endDate": "2019-08-24"
  }
]

Count currency rates

Request

Security
bearerAuth
Query
sourceCurrencyIdstring(IdFilterParam)

Filter by source currency id

Example: sourceCurrencyId=0
targetCurrencyIdstring(IdFilterParam)

Filter by target currency id

Example: targetCurrencyId=0
startDatestring(DateFilterParam)

Filter by start date

Example: startDate=yyyy-MM-dd | lt:yyyy-MM-dd | gt:yyyy-MM-dd | gtn:yyyy-MM-dd
endDatestring(DateFilterParam)

Filter by end date

Example: endDate=yyyy-MM-dd | lt:yyyy-MM-dd | gt:yyyy-MM-dd | gtn:yyyy-MM-dd
curl -i -X HEAD \
  'https://rest.elevatebilling.com/v1/currency-rates?sourceCurrencyId=0&targetCurrencyId=0&startDate=yyyy-MM-dd+%2C+lt%3Ayyyy-MM-dd+%2C+gt%3Ayyyy-MM-dd+%2C+gtn%3Ayyyy-MM-dd&endDate=yyyy-MM-dd+%2C+lt%3Ayyyy-MM-dd+%2C+gt%3Ayyyy-MM-dd+%2C+gtn%3Ayyyy-MM-dd' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Exists

Headers
X-Total-Countinteger

Total number of currency rates

Create a new currency rate that does not overlap with any existing rates

Request

Security
bearerAuth
Bodyapplication/jsonrequired

New currency rate

sourceCurrencyIdinteger(int64)required

Identifier of currency that is being converted from

Example: 1
targetCurrencyIdinteger(int64)required

Identifier of currency that is being converted to

Example: 1
exchangeRatenumberrequired

Exchange rate from source currency to target currency in major currency (e.g pounds/dollars/euros) unit. For example, from Argentina Peso to GBP is 446.2497

Example: 446.2497
startDatestring(date)required

Start date

endDatestring(date)

End date

curl -i -X POST \
  https://rest.elevatebilling.com/v1/currency-rates \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "sourceCurrencyId": 1,
    "targetCurrencyId": 1,
    "exchangeRate": 446.2497,
    "startDate": "2019-08-24",
    "endDate": "2019-08-24"
  }'

Responses

Created

Bodyapplication/json
idinteger(int64)read-only

Internal identifier of currency rate

Example: 1
sourceCurrencyIdinteger(int64)required

Identifier of currency that is being converted from

Example: 1
targetCurrencyIdinteger(int64)required

Identifier of currency that is being converted to

Example: 1
exchangeRatenumberrequired

Exchange rate from source currency to target currency in major currency (e.g pounds/dollars/euros) unit. For example, from Argentina Peso to GBP is 446.2497

Example: 446.2497
startDatestring(date)required

Start date

endDatestring(date)

End date

Response
application/json
{
  "id": 1,
  "sourceCurrencyId": 1,
  "targetCurrencyId": 1,
  "exchangeRate": 446.2497,
  "startDate": "2019-08-24",
  "endDate": "2019-08-24"
}

Update a currency rate

Request

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

Currency rate identifier

Example: 1
Bodyapplication/json-patch+jsonrequired

A set of JSONPatch operations to be performed

Array [
opstringrequired

The JSON Patch operation to be performed

Enum"add""remove""replace""move""copy""test"
pathstringrequired

A JSON-Pointer

valueobject

The value to be used within the operations

fromstring

A string containing a JSON Pointer value

]
curl -i -X PATCH \
  https://rest.elevatebilling.com/v1/currency-rates/1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json-patch+json' \
  -d '[
    {
      "op": "replace",
      "path": "/exchangeRate",
      "value": 416.1234
    }
  ]'

Responses

Success

Bodyapplication/json
idinteger(int64)read-only

Internal identifier of currency rate

Example: 1
sourceCurrencyIdinteger(int64)required

Identifier of currency that is being converted from

Example: 1
targetCurrencyIdinteger(int64)required

Identifier of currency that is being converted to

Example: 1
exchangeRatenumberrequired

Exchange rate from source currency to target currency in major currency (e.g pounds/dollars/euros) unit. For example, from Argentina Peso to GBP is 446.2497

Example: 446.2497
startDatestring(date)required

Start date

endDatestring(date)

End date

Response
application/json
{
  "id": 1,
  "sourceCurrencyId": 1,
  "targetCurrencyId": 1,
  "exchangeRate": 446.2497,
  "startDate": "2019-08-24",
  "endDate": "2019-08-24"
}

Get a specific currency rate

Request

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

Currency rate identifier

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

Responses

Currency rate found

Bodyapplication/json
idinteger(int64)read-only

Internal identifier of currency rate

Example: 1
sourceCurrencyIdinteger(int64)required

Identifier of currency that is being converted from

Example: 1
targetCurrencyIdinteger(int64)required

Identifier of currency that is being converted to

Example: 1
exchangeRatenumberrequired

Exchange rate from source currency to target currency in major currency (e.g pounds/dollars/euros) unit. For example, from Argentina Peso to GBP is 446.2497

Example: 446.2497
startDatestring(date)required

Start date

endDatestring(date)

End date

Response
application/json
{
  "id": 1,
  "sourceCurrencyId": 1,
  "targetCurrencyId": 1,
  "exchangeRate": 446.2497,
  "startDate": "2019-08-24",
  "endDate": "2019-08-24"
}

Delete a currency rate

Request

Delete a currency rate

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

Currency rate identifier

Example: 1
curl -i -X DELETE \
  https://rest.elevatebilling.com/v1/currency-rates/1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Body

reference-data-summaries

Operations