# Elevate Reference Data API ### 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 Version: 1.12 ## Servers ``` https://rest.elevatebilling.com/v1 ``` ## Security ### bearerAuth Type: http Scheme: bearer Bearer Format: JWT ## Download OpenAPI description [Elevate Reference Data API](https://docs.elevatebilling.com/_bundle/openapi/prod/gen/billing-rest-reference-data.yaml) ## reference-data-sources Manage sources of reference data - only manually maintained data sources can be updated via this endpoint ### Get a list of available reference data sources - [GET /reference-data-sources](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-reference-data/reference-data-sources/getreferencedatasources.md) ### Get a specific reference data source - [GET /reference-data-sources/{reference_data_source_id}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-reference-data/reference-data-sources/getreferencedatasource.md) ## charge-groups Management of charge groups and charge group categories ### Get a list of charge group categories - [GET /charge-group-categories](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-reference-data/charge-groups/getchargegroupcategories.md) ### Get a specific Charge Group Category - [GET /charge-group-categories/{charge_group_category_id}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-reference-data/charge-groups/getchargegroupcategory.md) ### Get a list of charge-groups - [GET /charge-groups](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-reference-data/charge-groups/getchargegroups.md) ### Create a new Charge Group - [POST /charge-groups](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-reference-data/charge-groups/createchargegroup.md) ### Check if Charge Group exists - [HEAD /charge-groups](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-reference-data/charge-groups/checkchargegroup.md) ### Get a specific Charge Group - [GET /charge-groups/{charge_group_id}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-reference-data/charge-groups/getchargegroup.md) ### Update a Charge Group - [PUT /charge-groups/{charge_group_id}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-reference-data/charge-groups/updatechargegroupput.md) ### Delete Charge Group - [DELETE /charge-groups/{charge_group_id}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-reference-data/charge-groups/deletechargegroup.md) ### Patch update Charge Group - [PATCH /charge-groups/{charge_group_id}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-reference-data/charge-groups/updatechargegrouppatch.md) ## reference-data-source-charge-groups Charge group and charge group category management by reference data source ### Get a list of reference data source charge groups - [GET /reference-data-source-charge-groups](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-reference-data/reference-data-source-charge-groups/getreferencedatasourcechargegroups.md) ### Create a new reference data source charge group - [POST /reference-data-source-charge-groups](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-reference-data/reference-data-source-charge-groups/createreferencedatasourcechargegroup.md) ### Check if reference data source charge group exists - [HEAD /reference-data-source-charge-groups](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-reference-data/reference-data-source-charge-groups/checkreferencedatasourcechargegroup.md) ### Get a specific reference data source charge group - [GET /reference-data-source-charge-groups/{reference_data_source_charge_group_id}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-reference-data/reference-data-source-charge-groups/getreferencedatasourcechargegroup.md) ### Update a reference data source charge group - [PUT /reference-data-source-charge-groups/{reference_data_source_charge_group_id}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-reference-data/reference-data-source-charge-groups/updatereferencedatasourcechargegroupput.md) ### Delete reference data source charge group - [DELETE /reference-data-source-charge-groups/{reference_data_source_charge_group_id}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-reference-data/reference-data-source-charge-groups/deletereferencedatasourcechargegroup.md) ### Patch update reference data source charge group - [PATCH /reference-data-source-charge-groups/{reference_data_source_charge_group_id}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-reference-data/reference-data-source-charge-groups/updatereferencedatasourcechargegrouppatch.md) ## call-classes Management of manually maintained call-class information ### Get a list of Call Classes - [GET /call-classes](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-reference-data/call-classes/getcallclasses.md) ### Create a new Call-Class - [POST /call-classes](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-reference-data/call-classes/createcallclass.md) ### Check if Call Class exists - [HEAD /call-classes](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-reference-data/call-classes/checkcallclass.md) ### Get a specific Call Class - [GET /call-classes/{call_class_id}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-reference-data/call-classes/getcallclass.md) ### Update a Call Class - [PUT /call-classes/{call_class_id}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-reference-data/call-classes/updatecallclassput.md) ### Delete Call Class - [DELETE /call-classes/{call_class_id}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-reference-data/call-classes/deletecallclass.md) ### Patch update Call Class - [PATCH /call-classes/{call_class_id}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-reference-data/call-classes/updatecallclasspatch.md) ## ignored-call-classes Management of manually maintained ignored-call-class information ### Get a list of Ignored Call Classes - [GET /ignored-call-classes](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-reference-data/ignored-call-classes/getignoredcallclasses.md) ### Create new Ignored Call Class - [POST /ignored-call-classes](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-reference-data/ignored-call-classes/createignoredcallclasses.md) ### Check if Ignored Call Class exists - [HEAD /ignored-call-classes](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-reference-data/ignored-call-classes/checkignoredcallclass.md) ### Get a specific Ignored Call Class - [GET /ignored-call-classes/{ignored_call_class_id}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-reference-data/ignored-call-classes/getignoredcallclass.md) ### Update Ignored Call Class - [PATCH /ignored-call-classes/{ignored_call_class_id}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-reference-data/ignored-call-classes/updateignoredcallclass.md) ### Delete Ignored Call Class - [DELETE /ignored-call-classes/{ignored_call_class_id}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-reference-data/ignored-call-classes/deleteignoredcallclass.md) ## ignored-service-ids Management of manually maintained ignored-service-ids information ### Get a list of ignored service-ids - [GET /ignored-service-ids](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-reference-data/ignored-service-ids/getignoredserviceids.md) ### Create new ignored service-id record - [POST /ignored-service-ids](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-reference-data/ignored-service-ids/createignoredserviceid.md) ### Check if ignored service-id record exists - [HEAD /ignored-service-ids](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-reference-data/ignored-service-ids/checkignoredserviceid.md) ### Get a specific ignored service-id record by its id - [GET /ignored-service-ids/{ignored_service_id_record_id}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-reference-data/ignored-service-ids/getignoredserviceid.md) ### Update Ignored Service Id - [PATCH /ignored-service-ids/{ignored_service_id_record_id}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-reference-data/ignored-service-ids/updateignoredserviceid.md) ### Delete Ignored Service Id - [DELETE /ignored-service-ids/{ignored_service_id_record_id}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-reference-data/ignored-service-ids/deleteignoredserviceid.md) ## dialstrings Management of manually maintained dialstrings information ### Get a list of Dialstrings - [GET /dialstrings](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-reference-data/dialstrings/getdialstrings.md) ### Create a new Dialstring - [POST /dialstrings](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-reference-data/dialstrings/createdialstring.md) ### Check if Dialstring exists - [HEAD /dialstrings](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-reference-data/dialstrings/checkdialstring.md) ### Get a specific dialstring - [GET /dialstrings/{dialstring_id}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-reference-data/dialstrings/getdialstring.md) ### Update a dialstring - [PUT /dialstrings/{dialstring_id}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-reference-data/dialstrings/updatedialstringput.md) ### Delete Dialstring - [DELETE /dialstrings/{dialstring_id}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-reference-data/dialstrings/deletedialstring.md) ### Patch update Dialstring - [PATCH /dialstrings/{dialstring_id}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-reference-data/dialstrings/updatedialstringpatch.md) ## tax-bands Tax-band management ### Get a list of tax bands - [GET /tax-bands](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-reference-data/tax-bands/gettaxbands.md): Get a list of tax bands e.g. VAT ### Get a specific tax band - [GET /tax-bands/{tax_band_id}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-reference-data/tax-bands/gettaxband.md) ## currencies Currencies supported by the system ### Get a list of currencies - [GET /currencies](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-reference-data/currencies/getcurrencies.md) ## locales Locales supported by the system ### Get a list of locales - [GET /locales](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-reference-data/locales/getlocales.md) ### Get a specific locales - [GET /locales/{localeId}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-reference-data/locales/getlocale.md) ## currency-rates Management of the exchange rates between currencies ### Get a list of currency rates - [GET /currency-rates](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-reference-data/currency-rates/getcurrencyrates.md) ### Count currency rates - [HEAD /currency-rates](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-reference-data/currency-rates/countcurrencyrates.md) ### Create a new currency rate that does not overlap with any existing rates - [POST /currency-rates](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-reference-data/currency-rates/createcurrencyrate.md) ### Update a currency rate - [PATCH /currency-rates/{currencyRateId}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-reference-data/currency-rates/updatecurrencyrate.md) ### Get a specific currency rate - [GET /currency-rates/{currencyRateId}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-reference-data/currency-rates/getcurrencyrate.md) ### Delete a currency rate - [DELETE /currency-rates/{currencyRateId}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-reference-data/currency-rates/deletecurrencyrate.md): Delete a currency rate ## reference-data-summaries ### Get a reference data summaries - [GET /reference-data-summary/{referenceDataSummaryType}/{id}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-reference-data/reference-data-summaries/getreferencedatasummaries.md)