Skip to content
/
Create a new Charge Group

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

Get a list of charge group categories

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
startDatestring(DateFilterParam)

Filter charge group categories based on start date

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

Filter charge groups categories based on 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/charge-group-categories?page=1&pageSize=100&sort=id%2Cname+%7C+name%3Adesc&fields=id%2Cname&name=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&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 charge group category

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

Charge group category name

chargingUnitTypestring(ChargingUnitType)required

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

Enum"DURATION""MB""ONE_OFF"
startDatestring(date)required

Date this charge group category applies from

endDatestring(date)

Date this charge group category applies to

]
Response
application/json
[
  {
    "id": 1,
    "name": "string",
    "chargingUnitType": "DURATION",
    "startDate": "2019-08-24",
    "endDate": "2019-08-24"
  }
]

Get a specific Charge Group Category

Request

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

Charge group Category identifier

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

Responses

Charge Group Category found

Bodyapplication/json
idinteger(int64)read-only

Internal identifier of charge group category

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

Charge group category name

chargingUnitTypestring(ChargingUnitType)required

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

Enum"DURATION""MB""ONE_OFF"
startDatestring(date)required

Date this charge group category applies from

endDatestring(date)

Date this charge group category applies to

Response
application/json
{
  "id": 1,
  "name": "string",
  "chargingUnitType": "DURATION",
  "startDate": "2019-08-24",
  "endDate": "2019-08-24"
}

Get a list of charge-groups

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

Filter by a particular charge group category id

Example: chargeGroupCategoryId=0
startDatestring(DateFilterParam)

Filter charge groups based on start date

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

Filter charge groups based on 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/charge-groups?page=1&pageSize=100&sort=id%2Cname+%7C+name%3Adesc&fields=id%2Cname&name=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&chargeGroupCategoryId=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 charge group

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

Charge group name

chargeGroupCategoryIdinteger(int64)required

Identifier of category that this charge group belongs to

Example: 1
typestring(ChargeGroupType)

Type of charge group i.e. NATIONAL, LOCAL or GENERAL

Enum"NATIONAL""LOCAL""GENERAL"
startDatestring(date)required

Date this charge group applies from

endDatestring(date)

Date this charge group applies to

requiresAccessChargeboolean

Indicates that this charge group has an access charge

Default false
dontShowOnItemisationboolean

Indicator to control charges from this charge group showing on itemisation or not

Default false
applicableForDrcVatboolean

Indicates that charges in this charge group are applicable for VAT DRC (Domestic Reverse Charge)

Default false
applyUsageCapboolean

Indicator to control whether a usage cap should be applied or not

Default false
taxBandIdinteger(int64)

Identifier of tax band to apply for this charge group

Example: 1
]
Response
application/json
[
  {
    "id": 1,
    "name": "string",
    "chargeGroupCategoryId": 1,
    "type": "NATIONAL",
    "startDate": "2019-08-24",
    "endDate": "2019-08-24",
    "requiresAccessCharge": false,
    "dontShowOnItemisation": false,
    "applicableForDrcVat": false,
    "applyUsageCap": false,
    "taxBandId": 1
  }
]

Create a new Charge Group

Request

Security
bearerAuth
Bodyapplication/jsonrequired

New Charge Group

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

Charge group name

chargeGroupCategoryIdinteger(int64)required

Identifier of category that this charge group belongs to

Example: 1
typestring(ChargeGroupType)

Type of charge group i.e. NATIONAL, LOCAL or GENERAL

Enum"NATIONAL""LOCAL""GENERAL"
startDatestring(date)required

Date this charge group applies from

endDatestring(date)

Date this charge group applies to

requiresAccessChargeboolean

Indicates that this charge group has an access charge

Default false
dontShowOnItemisationboolean

Indicator to control charges from this charge group showing on itemisation or not

Default false
applicableForDrcVatboolean

Indicates that charges in this charge group are applicable for VAT DRC (Domestic Reverse Charge)

Default false
applyUsageCapboolean

Indicator to control whether a usage cap should be applied or not

Default false
taxBandIdinteger(int64)

Identifier of tax band to apply for this charge group

Example: 1
curl -i -X POST \
  https://rest.elevatebilling.com/v1/charge-groups \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "chargeGroupCategoryId": 1,
    "type": "NATIONAL",
    "startDate": "2019-08-24",
    "endDate": "2019-08-24",
    "requiresAccessCharge": false,
    "dontShowOnItemisation": false,
    "applicableForDrcVat": false,
    "applyUsageCap": false,
    "taxBandId": 1
  }'

Responses

OK

Bodyapplication/json
idinteger(int64)read-only

Internal identifier of charge group

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

Charge group name

chargeGroupCategoryIdinteger(int64)required

Identifier of category that this charge group belongs to

Example: 1
typestring(ChargeGroupType)

Type of charge group i.e. NATIONAL, LOCAL or GENERAL

Enum"NATIONAL""LOCAL""GENERAL"
startDatestring(date)required

Date this charge group applies from

endDatestring(date)

Date this charge group applies to

requiresAccessChargeboolean

Indicates that this charge group has an access charge

Default false
dontShowOnItemisationboolean

Indicator to control charges from this charge group showing on itemisation or not

Default false
applicableForDrcVatboolean

Indicates that charges in this charge group are applicable for VAT DRC (Domestic Reverse Charge)

Default false
applyUsageCapboolean

Indicator to control whether a usage cap should be applied or not

Default false
taxBandIdinteger(int64)

Identifier of tax band to apply for this charge group

Example: 1
Response
application/json
{
  "id": 1,
  "name": "string",
  "chargeGroupCategoryId": 1,
  "type": "NATIONAL",
  "startDate": "2019-08-24",
  "endDate": "2019-08-24",
  "requiresAccessCharge": false,
  "dontShowOnItemisation": false,
  "applicableForDrcVat": false,
  "applyUsageCap": false,
  "taxBandId": 1
}

Check if Charge Group exists

Request

Security
bearerAuth
Query
namestring(StringFilterParam)

Check by name

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

Check by a particular charge group category id

Example: chargeGroupCategoryId=0
startDatestring(DateFilterParam)

Check for charge groups based on start date

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

Check for charge groups based on 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/charge-groups?name=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&chargeGroupCategoryId=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

Body

Get a specific Charge Group

Request

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

Charge group identifier

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

Responses

Charge Group found

Bodyapplication/json
idinteger(int64)read-only

Internal identifier of charge group

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

Charge group name

chargeGroupCategoryIdinteger(int64)required

Identifier of category that this charge group belongs to

Example: 1
typestring(ChargeGroupType)

Type of charge group i.e. NATIONAL, LOCAL or GENERAL

Enum"NATIONAL""LOCAL""GENERAL"
startDatestring(date)required

Date this charge group applies from

endDatestring(date)

Date this charge group applies to

requiresAccessChargeboolean

Indicates that this charge group has an access charge

Default false
dontShowOnItemisationboolean

Indicator to control charges from this charge group showing on itemisation or not

Default false
applicableForDrcVatboolean

Indicates that charges in this charge group are applicable for VAT DRC (Domestic Reverse Charge)

Default false
applyUsageCapboolean

Indicator to control whether a usage cap should be applied or not

Default false
taxBandIdinteger(int64)

Identifier of tax band to apply for this charge group

Example: 1
Response
application/json
{
  "id": 1,
  "name": "string",
  "chargeGroupCategoryId": 1,
  "type": "NATIONAL",
  "startDate": "2019-08-24",
  "endDate": "2019-08-24",
  "requiresAccessCharge": false,
  "dontShowOnItemisation": false,
  "applicableForDrcVat": false,
  "applyUsageCap": false,
  "taxBandId": 1
}

Update a Charge Group

Request

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

Charge group identifier

Example: 1
Bodyapplication/jsonrequired

Updated Charge Group

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

Charge group name

chargeGroupCategoryIdinteger(int64)required

Identifier of category that this charge group belongs to

Example: 1
typestring(ChargeGroupType)

Type of charge group i.e. NATIONAL, LOCAL or GENERAL

Enum"NATIONAL""LOCAL""GENERAL"
startDatestring(date)required

Date this charge group applies from

endDatestring(date)

Date this charge group applies to

requiresAccessChargeboolean

Indicates that this charge group has an access charge

Default false
dontShowOnItemisationboolean

Indicator to control charges from this charge group showing on itemisation or not

Default false
applicableForDrcVatboolean

Indicates that charges in this charge group are applicable for VAT DRC (Domestic Reverse Charge)

Default false
applyUsageCapboolean

Indicator to control whether a usage cap should be applied or not

Default false
taxBandIdinteger(int64)

Identifier of tax band to apply for this charge group

Example: 1
curl -i -X PUT \
  https://rest.elevatebilling.com/v1/charge-groups/1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "chargeGroupCategoryId": 1,
    "type": "NATIONAL",
    "startDate": "2019-08-24",
    "endDate": "2019-08-24",
    "requiresAccessCharge": false,
    "dontShowOnItemisation": false,
    "applicableForDrcVat": false,
    "applyUsageCap": false,
    "taxBandId": 1
  }'

Responses

OK

Bodyapplication/json
idinteger(int64)read-only

Internal identifier of charge group

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

Charge group name

chargeGroupCategoryIdinteger(int64)required

Identifier of category that this charge group belongs to

Example: 1
typestring(ChargeGroupType)

Type of charge group i.e. NATIONAL, LOCAL or GENERAL

Enum"NATIONAL""LOCAL""GENERAL"
startDatestring(date)required

Date this charge group applies from

endDatestring(date)

Date this charge group applies to

requiresAccessChargeboolean

Indicates that this charge group has an access charge

Default false
dontShowOnItemisationboolean

Indicator to control charges from this charge group showing on itemisation or not

Default false
applicableForDrcVatboolean

Indicates that charges in this charge group are applicable for VAT DRC (Domestic Reverse Charge)

Default false
applyUsageCapboolean

Indicator to control whether a usage cap should be applied or not

Default false
taxBandIdinteger(int64)

Identifier of tax band to apply for this charge group

Example: 1
Response
application/json
{
  "id": 1,
  "name": "string",
  "chargeGroupCategoryId": 1,
  "type": "NATIONAL",
  "startDate": "2019-08-24",
  "endDate": "2019-08-24",
  "requiresAccessCharge": false,
  "dontShowOnItemisation": false,
  "applicableForDrcVat": false,
  "applyUsageCap": false,
  "taxBandId": 1
}

Delete Charge Group

Request

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

Charge group identifier

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

Responses

Success

Body

Patch update Charge Group

Request

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

Charge group 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/charge-groups/1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json-patch+json' \
  -d '[
    {
      "op": "replace",
      "path": "/name",
      "value": "My Group"
    }
  ]'

Responses

Success

Bodyapplication/json
idinteger(int64)read-only

Internal identifier of charge group

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

Charge group name

chargeGroupCategoryIdinteger(int64)required

Identifier of category that this charge group belongs to

Example: 1
typestring(ChargeGroupType)

Type of charge group i.e. NATIONAL, LOCAL or GENERAL

Enum"NATIONAL""LOCAL""GENERAL"
startDatestring(date)required

Date this charge group applies from

endDatestring(date)

Date this charge group applies to

requiresAccessChargeboolean

Indicates that this charge group has an access charge

Default false
dontShowOnItemisationboolean

Indicator to control charges from this charge group showing on itemisation or not

Default false
applicableForDrcVatboolean

Indicates that charges in this charge group are applicable for VAT DRC (Domestic Reverse Charge)

Default false
applyUsageCapboolean

Indicator to control whether a usage cap should be applied or not

Default false
taxBandIdinteger(int64)

Identifier of tax band to apply for this charge group

Example: 1
Response
application/json
{
  "id": 1,
  "name": "string",
  "chargeGroupCategoryId": 1,
  "type": "NATIONAL",
  "startDate": "2019-08-24",
  "endDate": "2019-08-24",
  "requiresAccessCharge": false,
  "dontShowOnItemisation": false,
  "applicableForDrcVat": false,
  "applyUsageCap": false,
  "taxBandId": 1
}

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