# API Reference Billing Platform API Version: 1.0 License: Apache 2.0 ## Servers ``` https://my.billingplatform.com/demogm ``` ## Security ### JWT JWT bearer token description... Type: http Scheme: bearer Bearer Format: JWT ## Download OpenAPI description [API Reference](https://bp-api-docs-v3.redocly.app/_bundle/schema_10_05_2025.yaml) ## CONTRACT Contracts add a level of pricing control after the provisioned products and provisioned package products. ### Retrieve By Id Contract - [GET /rest/2.0/CONTRACT/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/contract/retrieve_by_id_contract.md): Get Contract By Id ### Retrieve Filtered Contract - [GET /rest/2.0/CONTRACT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/contract/retrievefiltered_contract.md): Get record(s) using filters ### Update Contract - [PUT /rest/2.0/CONTRACT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/contract/put_contract.md): Update Contract ### Save Contract - [POST /rest/2.0/CONTRACT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/contract/post_contract.md): Save Contract ### Upsert Contract - [PATCH /rest/2.0/CONTRACT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/contract/patch_contract.md): Upsert Contract ### Delete Contract - [DELETE /rest/2.0/delete/CONTRACT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/contract/delete_contract.md): Delete Contract ### Retrieve By Id Contract - [GET /rest/2.0/CONTRACT/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/contract/retrieve_by_id_contract.md): Get Contract By Id ### Retrieve Filtered Contract - [GET /rest/2.0/CONTRACT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/contract/retrievefiltered_contract.md): Get record(s) using filters ### Update Contract - [PUT /rest/2.0/CONTRACT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/contract/put_contract.md): Update Contract ### Save Contract - [POST /rest/2.0/CONTRACT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/contract/post_contract.md): Save Contract ### Upsert Contract - [PATCH /rest/2.0/CONTRACT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/contract/patch_contract.md): Upsert Contract ### Delete Contract - [DELETE /rest/2.0/delete/CONTRACT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/contract/delete_contract.md): Delete Contract ### Retrieve By Id Contract - [GET /rest/2.0/CONTRACT/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/contract/retrieve_by_id_contract.md): Get Contract By Id ### Retrieve Filtered Contract - [GET /rest/2.0/CONTRACT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/contract/retrievefiltered_contract.md): Get record(s) using filters ### Update Contract - [PUT /rest/2.0/CONTRACT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/contract/put_contract.md): Update Contract ### Save Contract - [POST /rest/2.0/CONTRACT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/contract/post_contract.md): Save Contract ### Upsert Contract - [PATCH /rest/2.0/CONTRACT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/contract/patch_contract.md): Upsert Contract ### Delete Contract - [DELETE /rest/2.0/delete/CONTRACT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/contract/delete_contract.md): Delete Contract ### Retrieve By Id Contract - [GET /rest/2.0/CONTRACT/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/contract/retrieve_by_id_contract.md): Get Contract By Id ### Retrieve Filtered Contract - [GET /rest/2.0/CONTRACT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/contract/retrievefiltered_contract.md): Get record(s) using filters ### Update Contract - [PUT /rest/2.0/CONTRACT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/contract/put_contract.md): Update Contract ### Save Contract - [POST /rest/2.0/CONTRACT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/contract/post_contract.md): Save Contract ### Upsert Contract - [PATCH /rest/2.0/CONTRACT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/contract/patch_contract.md): Upsert Contract ### Delete Contract - [DELETE /rest/2.0/delete/CONTRACT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/contract/delete_contract.md): Delete Contract ## CONTRACT_RATE A contract rate contains the rating method and pricing records under a contract for a given account and product. ### Retrieve By Id Contract Rates - [GET /rest/2.0/CONTRACT_RATE/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/contract_rate/retrieve_by_id_contract_rate.md): Get Contract Rates By Id ### Retrieve Filtered Contract Rates - [GET /rest/2.0/CONTRACT_RATE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/contract_rate/retrievefiltered_contract_rate.md): Get record(s) using filters ### Update Contract Rates - [PUT /rest/2.0/CONTRACT_RATE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/contract_rate/put_contract_rate.md): Update Contract Rates ### Save Contract Rates - [POST /rest/2.0/CONTRACT_RATE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/contract_rate/post_contract_rate.md): Save Contract Rates ### Upsert Contract Rates - [PATCH /rest/2.0/CONTRACT_RATE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/contract_rate/patch_contract_rate.md): Upsert Contract Rates ### Delete Contract Rates - [DELETE /rest/2.0/delete/CONTRACT_RATE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/contract_rate/delete_contract_rate.md): Delete Contract Rates ### Retrieve By Id Contract Rates - [GET /rest/2.0/CONTRACT_RATE/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/contract_rate/retrieve_by_id_contract_rate.md): Get Contract Rates By Id ### Retrieve Filtered Contract Rates - [GET /rest/2.0/CONTRACT_RATE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/contract_rate/retrievefiltered_contract_rate.md): Get record(s) using filters ### Update Contract Rates - [PUT /rest/2.0/CONTRACT_RATE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/contract_rate/put_contract_rate.md): Update Contract Rates ### Save Contract Rates - [POST /rest/2.0/CONTRACT_RATE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/contract_rate/post_contract_rate.md): Save Contract Rates ### Upsert Contract Rates - [PATCH /rest/2.0/CONTRACT_RATE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/contract_rate/patch_contract_rate.md): Upsert Contract Rates ### Delete Contract Rates - [DELETE /rest/2.0/delete/CONTRACT_RATE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/contract_rate/delete_contract_rate.md): Delete Contract Rates ### Retrieve By Id Contract Rates - [GET /rest/2.0/CONTRACT_RATE/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/contract_rate/retrieve_by_id_contract_rate.md): Get Contract Rates By Id ### Retrieve Filtered Contract Rates - [GET /rest/2.0/CONTRACT_RATE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/contract_rate/retrievefiltered_contract_rate.md): Get record(s) using filters ### Update Contract Rates - [PUT /rest/2.0/CONTRACT_RATE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/contract_rate/put_contract_rate.md): Update Contract Rates ### Save Contract Rates - [POST /rest/2.0/CONTRACT_RATE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/contract_rate/post_contract_rate.md): Save Contract Rates ### Upsert Contract Rates - [PATCH /rest/2.0/CONTRACT_RATE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/contract_rate/patch_contract_rate.md): Upsert Contract Rates ### Delete Contract Rates - [DELETE /rest/2.0/delete/CONTRACT_RATE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/contract_rate/delete_contract_rate.md): Delete Contract Rates ### Retrieve By Id Contract Rates - [GET /rest/2.0/CONTRACT_RATE/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/contract_rate/retrieve_by_id_contract_rate.md): Get Contract Rates By Id ### Retrieve Filtered Contract Rates - [GET /rest/2.0/CONTRACT_RATE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/contract_rate/retrievefiltered_contract_rate.md): Get record(s) using filters ### Update Contract Rates - [PUT /rest/2.0/CONTRACT_RATE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/contract_rate/put_contract_rate.md): Update Contract Rates ### Save Contract Rates - [POST /rest/2.0/CONTRACT_RATE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/contract_rate/post_contract_rate.md): Save Contract Rates ### Upsert Contract Rates - [PATCH /rest/2.0/CONTRACT_RATE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/contract_rate/patch_contract_rate.md): Upsert Contract Rates ### Delete Contract Rates - [DELETE /rest/2.0/delete/CONTRACT_RATE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/contract_rate/delete_contract_rate.md): Delete Contract Rates ## COUNTRY COUNTRY API Reference ### Retrieve By Id Country - [GET /rest/2.0/COUNTRY/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/country/retrieve_by_id_country.md): Get Country By Id ### Retrieve Filtered Country - [GET /rest/2.0/COUNTRY](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/country/retrievefiltered_country.md): Get record(s) using filters ### Update Country - [PUT /rest/2.0/COUNTRY](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/country/put_country.md): Update Country ### Save Country - [POST /rest/2.0/COUNTRY](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/country/post_country.md): Save Country ### Upsert Country - [PATCH /rest/2.0/COUNTRY](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/country/patch_country.md): Upsert Country ### Delete Country - [DELETE /rest/2.0/delete/COUNTRY](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/country/delete_country.md): Delete Country ### Retrieve By Id Country - [GET /rest/2.0/COUNTRY/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/country/retrieve_by_id_country.md): Get Country By Id ### Retrieve Filtered Country - [GET /rest/2.0/COUNTRY](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/country/retrievefiltered_country.md): Get record(s) using filters ### Update Country - [PUT /rest/2.0/COUNTRY](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/country/put_country.md): Update Country ### Save Country - [POST /rest/2.0/COUNTRY](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/country/post_country.md): Save Country ### Upsert Country - [PATCH /rest/2.0/COUNTRY](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/country/patch_country.md): Upsert Country ### Delete Country - [DELETE /rest/2.0/delete/COUNTRY](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/country/delete_country.md): Delete Country ## COUNTRY_CODE_MAP Used for creating international rates and associating the pricing to provisioned products/packages and rate classes. ### Retrieve By Id Country Code Map - [GET /rest/2.0/COUNTRY_CODE_MAP/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/country_code_map/retrieve_by_id_country_code_map.md): Get Country Code Map By Id ### Retrieve Filtered Country Code Map - [GET /rest/2.0/COUNTRY_CODE_MAP](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/country_code_map/retrievefiltered_country_code_map.md): Get record(s) using filters ### Update Country Code Map - [PUT /rest/2.0/COUNTRY_CODE_MAP](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/country_code_map/put_country_code_map.md): Update Country Code Map ### Save Country Code Map - [POST /rest/2.0/COUNTRY_CODE_MAP](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/country_code_map/post_country_code_map.md): Save Country Code Map ### Upsert Country Code Map - [PATCH /rest/2.0/COUNTRY_CODE_MAP](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/country_code_map/patch_country_code_map.md): Upsert Country Code Map ### Delete Country Code Map - [DELETE /rest/2.0/delete/COUNTRY_CODE_MAP](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/country_code_map/delete_country_code_map.md): Delete Country Code Map ### Retrieve By Id Country Code Map - [GET /rest/2.0/COUNTRY_CODE_MAP/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/country_code_map/retrieve_by_id_country_code_map.md): Get Country Code Map By Id ### Retrieve Filtered Country Code Map - [GET /rest/2.0/COUNTRY_CODE_MAP](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/country_code_map/retrievefiltered_country_code_map.md): Get record(s) using filters ### Update Country Code Map - [PUT /rest/2.0/COUNTRY_CODE_MAP](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/country_code_map/put_country_code_map.md): Update Country Code Map ### Save Country Code Map - [POST /rest/2.0/COUNTRY_CODE_MAP](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/country_code_map/post_country_code_map.md): Save Country Code Map ### Upsert Country Code Map - [PATCH /rest/2.0/COUNTRY_CODE_MAP](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/country_code_map/patch_country_code_map.md): Upsert Country Code Map ### Delete Country Code Map - [DELETE /rest/2.0/delete/COUNTRY_CODE_MAP](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/country_code_map/delete_country_code_map.md): Delete Country Code Map ### Retrieve By Id Country Code Map - [GET /rest/2.0/COUNTRY_CODE_MAP/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/country_code_map/retrieve_by_id_country_code_map.md): Get Country Code Map By Id ### Retrieve Filtered Country Code Map - [GET /rest/2.0/COUNTRY_CODE_MAP](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/country_code_map/retrievefiltered_country_code_map.md): Get record(s) using filters ### Update Country Code Map - [PUT /rest/2.0/COUNTRY_CODE_MAP](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/country_code_map/put_country_code_map.md): Update Country Code Map ### Save Country Code Map - [POST /rest/2.0/COUNTRY_CODE_MAP](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/country_code_map/post_country_code_map.md): Save Country Code Map ### Upsert Country Code Map - [PATCH /rest/2.0/COUNTRY_CODE_MAP](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/country_code_map/patch_country_code_map.md): Upsert Country Code Map ### Delete Country Code Map - [DELETE /rest/2.0/delete/COUNTRY_CODE_MAP](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/country_code_map/delete_country_code_map.md): Delete Country Code Map ### Retrieve By Id Country Code Map - [GET /rest/2.0/COUNTRY_CODE_MAP/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/country_code_map/retrieve_by_id_country_code_map.md): Get Country Code Map By Id ### Retrieve Filtered Country Code Map - [GET /rest/2.0/COUNTRY_CODE_MAP](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/country_code_map/retrievefiltered_country_code_map.md): Get record(s) using filters ### Update Country Code Map - [PUT /rest/2.0/COUNTRY_CODE_MAP](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/country_code_map/put_country_code_map.md): Update Country Code Map ### Save Country Code Map - [POST /rest/2.0/COUNTRY_CODE_MAP](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/country_code_map/post_country_code_map.md): Save Country Code Map ### Upsert Country Code Map - [PATCH /rest/2.0/COUNTRY_CODE_MAP](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/country_code_map/patch_country_code_map.md): Upsert Country Code Map ### Delete Country Code Map - [DELETE /rest/2.0/delete/COUNTRY_CODE_MAP](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/country_code_map/delete_country_code_map.md): Delete Country Code Map ## DESTINATION_COUNTRY_CODE ### Retrieve By Id Destination Country Code - [GET /rest/2.0/DESTINATION_COUNTRY_CODE/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/destination_country_code/retrieve_by_id_destination_country_code.md): Get Destination Country Code By Id ### Retrieve Filtered Destination Country Code - [GET /rest/2.0/DESTINATION_COUNTRY_CODE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/destination_country_code/retrievefiltered_destination_country_code.md): Get record(s) using filters ### Update Destination Country Code - [PUT /rest/2.0/DESTINATION_COUNTRY_CODE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/destination_country_code/put_destination_country_code.md): Update Destination Country Code ### Save Destination Country Code - [POST /rest/2.0/DESTINATION_COUNTRY_CODE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/destination_country_code/post_destination_country_code.md): Save Destination Country Code ### Upsert Destination Country Code - [PATCH /rest/2.0/DESTINATION_COUNTRY_CODE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/destination_country_code/patch_destination_country_code.md): Upsert Destination Country Code ### Delete Destination Country Code - [DELETE /rest/2.0/delete/DESTINATION_COUNTRY_CODE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/destination_country_code/delete_destination_country_code.md): Delete Destination Country Code ### Retrieve By Id Destination Country Code - [GET /rest/2.0/DESTINATION_COUNTRY_CODE/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/destination_country_code/retrieve_by_id_destination_country_code.md): Get Destination Country Code By Id ### Retrieve Filtered Destination Country Code - [GET /rest/2.0/DESTINATION_COUNTRY_CODE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/destination_country_code/retrievefiltered_destination_country_code.md): Get record(s) using filters ### Update Destination Country Code - [PUT /rest/2.0/DESTINATION_COUNTRY_CODE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/destination_country_code/put_destination_country_code.md): Update Destination Country Code ### Save Destination Country Code - [POST /rest/2.0/DESTINATION_COUNTRY_CODE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/destination_country_code/post_destination_country_code.md): Save Destination Country Code ### Upsert Destination Country Code - [PATCH /rest/2.0/DESTINATION_COUNTRY_CODE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/destination_country_code/patch_destination_country_code.md): Upsert Destination Country Code ### Delete Destination Country Code - [DELETE /rest/2.0/delete/DESTINATION_COUNTRY_CODE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/destination_country_code/delete_destination_country_code.md): Delete Destination Country Code ## LABEL_VERSION LABEL_VERSION API Reference ### Retrieve By Id Labels - [GET /rest/2.0/LABEL_VERSION/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/label_version/retrieve_by_id_label_version.md): Get Labels By Id ### Retrieve Filtered Labels - [GET /rest/2.0/LABEL_VERSION](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/label_version/retrievefiltered_label_version.md): Get record(s) using filters ### Update Labels - [PUT /rest/2.0/LABEL_VERSION](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/label_version/put_label_version.md): Update Labels ### Save Labels - [POST /rest/2.0/LABEL_VERSION](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/label_version/post_label_version.md): Save Labels ### Delete Labels - [DELETE /rest/2.0/delete/LABEL_VERSION](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/label_version/delete_label_version.md): Delete Labels ### Retrieve By Id Labels - [GET /rest/2.0/LABEL_VERSION/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/label_version/retrieve_by_id_label_version.md): Get Labels By Id ### Retrieve Filtered Labels - [GET /rest/2.0/LABEL_VERSION](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/label_version/retrievefiltered_label_version.md): Get record(s) using filters ### Update Labels - [PUT /rest/2.0/LABEL_VERSION](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/label_version/put_label_version.md): Update Labels ### Save Labels - [POST /rest/2.0/LABEL_VERSION](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/label_version/post_label_version.md): Save Labels ### Delete Labels - [DELETE /rest/2.0/delete/LABEL_VERSION](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/label_version/delete_label_version.md): Delete Labels ## LANGUAGE LANGUAGE API Reference ### Retrieve By Id Language - [GET /rest/2.0/LANGUAGE/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/language/retrieve_by_id_language.md): Get Language By Id ### Retrieve Filtered Language - [GET /rest/2.0/LANGUAGE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/language/retrievefiltered_language.md): Get record(s) using filters ### Update Language - [PUT /rest/2.0/LANGUAGE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/language/put_language.md): Update Language ### Save Language - [POST /rest/2.0/LANGUAGE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/language/post_language.md): Save Language ### Upsert Language - [PATCH /rest/2.0/LANGUAGE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/language/patch_language.md): Upsert Language ### Delete Language - [DELETE /rest/2.0/delete/LANGUAGE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/language/delete_language.md): Delete Language ### Retrieve By Id Language - [GET /rest/2.0/LANGUAGE/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/language/retrieve_by_id_language.md): Get Language By Id ### Retrieve Filtered Language - [GET /rest/2.0/LANGUAGE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/language/retrievefiltered_language.md): Get record(s) using filters ### Update Language - [PUT /rest/2.0/LANGUAGE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/language/put_language.md): Update Language ### Save Language - [POST /rest/2.0/LANGUAGE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/language/post_language.md): Save Language ### Upsert Language - [PATCH /rest/2.0/LANGUAGE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/language/patch_language.md): Upsert Language ### Delete Language - [DELETE /rest/2.0/delete/LANGUAGE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/language/delete_language.md): Delete Language ## ORIGINATION_COUNTRY_CODE ### Retrieve By Id Origination Country Code - [GET /rest/2.0/ORIGINATION_COUNTRY_CODE/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/origination_country_code/retrieve_by_id_origination_country_code.md): Get Origination Country Code By Id ### Retrieve Filtered Origination Country Code - [GET /rest/2.0/ORIGINATION_COUNTRY_CODE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/origination_country_code/retrievefiltered_origination_country_code.md): Get record(s) using filters ### Update Origination Country Code - [PUT /rest/2.0/ORIGINATION_COUNTRY_CODE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/origination_country_code/put_origination_country_code.md): Update Origination Country Code ### Save Origination Country Code - [POST /rest/2.0/ORIGINATION_COUNTRY_CODE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/origination_country_code/post_origination_country_code.md): Save Origination Country Code ### Upsert Origination Country Code - [PATCH /rest/2.0/ORIGINATION_COUNTRY_CODE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/origination_country_code/patch_origination_country_code.md): Upsert Origination Country Code ### Delete Origination Country Code - [DELETE /rest/2.0/delete/ORIGINATION_COUNTRY_CODE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/origination_country_code/delete_origination_country_code.md): Delete Origination Country Code ### Retrieve By Id Origination Country Code - [GET /rest/2.0/ORIGINATION_COUNTRY_CODE/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/origination_country_code/retrieve_by_id_origination_country_code.md): Get Origination Country Code By Id ### Retrieve Filtered Origination Country Code - [GET /rest/2.0/ORIGINATION_COUNTRY_CODE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/origination_country_code/retrievefiltered_origination_country_code.md): Get record(s) using filters ### Update Origination Country Code - [PUT /rest/2.0/ORIGINATION_COUNTRY_CODE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/origination_country_code/put_origination_country_code.md): Update Origination Country Code ### Save Origination Country Code - [POST /rest/2.0/ORIGINATION_COUNTRY_CODE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/origination_country_code/post_origination_country_code.md): Save Origination Country Code ### Upsert Origination Country Code - [PATCH /rest/2.0/ORIGINATION_COUNTRY_CODE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/origination_country_code/patch_origination_country_code.md): Upsert Origination Country Code ### Delete Origination Country Code - [DELETE /rest/2.0/delete/ORIGINATION_COUNTRY_CODE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/origination_country_code/delete_origination_country_code.md): Delete Origination Country Code ## PACKAGE Packages, also known as "Bundles" are used to price and provision a specified set of Products. ### Retrieve By Id Packages - [GET /rest/2.0/PACKAGE/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/package/retrieve_by_id_package.md): Get Packages By Id ### Retrieve Filtered Packages - [GET /rest/2.0/PACKAGE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/package/retrievefiltered_package.md): Get record(s) using filters ### Update Packages - [PUT /rest/2.0/PACKAGE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/package/put_package.md): Update Packages ### Save Packages - [POST /rest/2.0/PACKAGE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/package/post_package.md): Save Packages ### Upsert Packages - [PATCH /rest/2.0/PACKAGE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/package/patch_package.md): Upsert Packages ### Delete Packages - [DELETE /rest/2.0/delete/PACKAGE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/package/delete_package.md): Delete Packages ### Retrieve By Id Packages - [GET /rest/2.0/PACKAGE/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/package/retrieve_by_id_package.md): Get Packages By Id ### Retrieve Filtered Packages - [GET /rest/2.0/PACKAGE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/package/retrievefiltered_package.md): Get record(s) using filters ### Update Packages - [PUT /rest/2.0/PACKAGE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/package/put_package.md): Update Packages ### Save Packages - [POST /rest/2.0/PACKAGE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/package/post_package.md): Save Packages ### Upsert Packages - [PATCH /rest/2.0/PACKAGE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/package/patch_package.md): Upsert Packages ### Delete Packages - [DELETE /rest/2.0/delete/PACKAGE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/package/delete_package.md): Delete Packages ## PACKAGE_CURRENCY This object is used to define a currency for a given package. It is a junction between the Package and Currency objects. ### Retrieve By Id Package Currency - [GET /rest/2.0/PACKAGE_CURRENCY/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/package_currency/retrieve_by_id_package_currency.md): Get Package Currency By Id ### Retrieve Filtered Package Currency - [GET /rest/2.0/PACKAGE_CURRENCY](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/package_currency/retrievefiltered_package_currency.md): Get record(s) using filters ### Update Package Currency - [PUT /rest/2.0/PACKAGE_CURRENCY](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/package_currency/put_package_currency.md): Update Package Currency ### Save Package Currency - [POST /rest/2.0/PACKAGE_CURRENCY](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/package_currency/post_package_currency.md): Save Package Currency ### Upsert Package Currency - [PATCH /rest/2.0/PACKAGE_CURRENCY](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/package_currency/patch_package_currency.md): Upsert Package Currency ### Delete Package Currency - [DELETE /rest/2.0/delete/PACKAGE_CURRENCY](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/package_currency/delete_package_currency.md): Delete Package Currency ### Retrieve By Id Package Currency - [GET /rest/2.0/PACKAGE_CURRENCY/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/package_currency/retrieve_by_id_package_currency.md): Get Package Currency By Id ### Retrieve Filtered Package Currency - [GET /rest/2.0/PACKAGE_CURRENCY](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/package_currency/retrievefiltered_package_currency.md): Get record(s) using filters ### Update Package Currency - [PUT /rest/2.0/PACKAGE_CURRENCY](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/package_currency/put_package_currency.md): Update Package Currency ### Save Package Currency - [POST /rest/2.0/PACKAGE_CURRENCY](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/package_currency/post_package_currency.md): Save Package Currency ### Upsert Package Currency - [PATCH /rest/2.0/PACKAGE_CURRENCY](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/package_currency/patch_package_currency.md): Upsert Package Currency ### Delete Package Currency - [DELETE /rest/2.0/delete/PACKAGE_CURRENCY](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/package_currency/delete_package_currency.md): Delete Package Currency ## PACKAGE_PRODUCT Package Products are the products that belong to a package or bundle. ### Retrieve By Id Package Products - [GET /rest/2.0/PACKAGE_PRODUCT/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/package_product/retrieve_by_id_package_product.md): Get Package Products By Id ### Retrieve Filtered Package Products - [GET /rest/2.0/PACKAGE_PRODUCT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/package_product/retrievefiltered_package_product.md): Get record(s) using filters ### Update Package Products - [PUT /rest/2.0/PACKAGE_PRODUCT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/package_product/put_package_product.md): Update Package Products ### Save Package Products - [POST /rest/2.0/PACKAGE_PRODUCT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/package_product/post_package_product.md): Save Package Products ### Upsert Package Products - [PATCH /rest/2.0/PACKAGE_PRODUCT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/package_product/patch_package_product.md): Upsert Package Products ### Delete Package Products - [DELETE /rest/2.0/delete/PACKAGE_PRODUCT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/package_product/delete_package_product.md): Delete Package Products ### Retrieve By Id Package Products - [GET /rest/2.0/PACKAGE_PRODUCT/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/package_product/retrieve_by_id_package_product.md): Get Package Products By Id ### Retrieve Filtered Package Products - [GET /rest/2.0/PACKAGE_PRODUCT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/package_product/retrievefiltered_package_product.md): Get record(s) using filters ### Update Package Products - [PUT /rest/2.0/PACKAGE_PRODUCT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/package_product/put_package_product.md): Update Package Products ### Save Package Products - [POST /rest/2.0/PACKAGE_PRODUCT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/package_product/post_package_product.md): Save Package Products ### Upsert Package Products - [PATCH /rest/2.0/PACKAGE_PRODUCT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/package_product/patch_package_product.md): Upsert Package Products ### Delete Package Products - [DELETE /rest/2.0/delete/PACKAGE_PRODUCT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/package_product/delete_package_product.md): Delete Package Products ## PARENT_PACKAGE_PRODUCT ### Retrieve By Id Parent Package Product - [GET /rest/2.0/PARENT_PACKAGE_PRODUCT/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/parent_package_product/retrieve_by_id_parent_package_product.md): Get Parent Package Product By Id ### Retrieve Filtered Parent Package Product - [GET /rest/2.0/PARENT_PACKAGE_PRODUCT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/parent_package_product/retrievefiltered_parent_package_product.md): Get record(s) using filters ### Update Parent Package Product - [PUT /rest/2.0/PARENT_PACKAGE_PRODUCT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/parent_package_product/put_parent_package_product.md): Update Parent Package Product ### Save Parent Package Product - [POST /rest/2.0/PARENT_PACKAGE_PRODUCT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/parent_package_product/post_parent_package_product.md): Save Parent Package Product ### Delete Parent Package Product - [DELETE /rest/2.0/delete/PARENT_PACKAGE_PRODUCT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/parent_package_product/delete_parent_package_product.md): Delete Parent Package Product ### Retrieve By Id Parent Package Product - [GET /rest/2.0/PARENT_PACKAGE_PRODUCT/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/parent_package_product/retrieve_by_id_parent_package_product.md): Get Parent Package Product By Id ### Retrieve Filtered Parent Package Product - [GET /rest/2.0/PARENT_PACKAGE_PRODUCT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/parent_package_product/retrievefiltered_parent_package_product.md): Get record(s) using filters ### Update Parent Package Product - [PUT /rest/2.0/PARENT_PACKAGE_PRODUCT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/parent_package_product/put_parent_package_product.md): Update Parent Package Product ### Save Parent Package Product - [POST /rest/2.0/PARENT_PACKAGE_PRODUCT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/parent_package_product/post_parent_package_product.md): Save Parent Package Product ### Delete Parent Package Product - [DELETE /rest/2.0/delete/PARENT_PACKAGE_PRODUCT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/parent_package_product/delete_parent_package_product.md): Delete Parent Package Product ## PRICING Pricing records are used for pricing on Contracts, Rate Classes, Account Products and Account Package Products. ### Retrieve By Id Pricing - [GET /rest/2.0/PRICING/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/pricing/retrieve_by_id_pricing.md): Get Pricing By Id ### Retrieve Filtered Pricing - [GET /rest/2.0/PRICING](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/pricing/retrievefiltered_pricing.md): Get record(s) using filters ### Update Pricing - [PUT /rest/2.0/PRICING](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/pricing/put_pricing.md): Update Pricing ### Save Pricing - [POST /rest/2.0/PRICING](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/pricing/post_pricing.md): Save Pricing ### Upsert Pricing - [PATCH /rest/2.0/PRICING](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/pricing/patch_pricing.md): Upsert Pricing ### Delete Pricing - [DELETE /rest/2.0/delete/PRICING](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/pricing/delete_pricing.md): Delete Pricing ### Retrieve By Id Pricing - [GET /rest/2.0/PRICING/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/pricing/retrieve_by_id_pricing.md): Get Pricing By Id ### Retrieve Filtered Pricing - [GET /rest/2.0/PRICING](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/pricing/retrievefiltered_pricing.md): Get record(s) using filters ### Update Pricing - [PUT /rest/2.0/PRICING](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/pricing/put_pricing.md): Update Pricing ### Save Pricing - [POST /rest/2.0/PRICING](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/pricing/post_pricing.md): Save Pricing ### Upsert Pricing - [PATCH /rest/2.0/PRICING](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/pricing/patch_pricing.md): Upsert Pricing ### Delete Pricing - [DELETE /rest/2.0/delete/PRICING](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/pricing/delete_pricing.md): Delete Pricing ### Retrieve By Id Pricing - [GET /rest/2.0/PRICING/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/pricing/retrieve_by_id_pricing.md): Get Pricing By Id ### Retrieve Filtered Pricing - [GET /rest/2.0/PRICING](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/pricing/retrievefiltered_pricing.md): Get record(s) using filters ### Update Pricing - [PUT /rest/2.0/PRICING](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/pricing/put_pricing.md): Update Pricing ### Save Pricing - [POST /rest/2.0/PRICING](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/pricing/post_pricing.md): Save Pricing ### Upsert Pricing - [PATCH /rest/2.0/PRICING](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/pricing/patch_pricing.md): Upsert Pricing ### Delete Pricing - [DELETE /rest/2.0/delete/PRICING](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/pricing/delete_pricing.md): Delete Pricing ### Retrieve By Id Pricing - [GET /rest/2.0/PRICING/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/pricing/retrieve_by_id_pricing.md): Get Pricing By Id ### Retrieve Filtered Pricing - [GET /rest/2.0/PRICING](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/pricing/retrievefiltered_pricing.md): Get record(s) using filters ### Update Pricing - [PUT /rest/2.0/PRICING](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/pricing/put_pricing.md): Update Pricing ### Save Pricing - [POST /rest/2.0/PRICING](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/pricing/post_pricing.md): Save Pricing ### Upsert Pricing - [PATCH /rest/2.0/PRICING](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/pricing/patch_pricing.md): Upsert Pricing ### Delete Pricing - [DELETE /rest/2.0/delete/PRICING](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/pricing/delete_pricing.md): Delete Pricing ## PRODUCT The foundation of BillingPlatform is the product. It offers a way to structure your pricing information. ### Retrieve By Id Products - [GET /rest/2.0/PRODUCT/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/product/retrieve_by_id_product.md): Get Products By Id ### Retrieve Filtered Products - [GET /rest/2.0/PRODUCT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/product/retrievefiltered_product.md): Get record(s) using filters ### Update Products - [PUT /rest/2.0/PRODUCT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/product/put_product.md): Update Products ### Save Products - [POST /rest/2.0/PRODUCT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/product/post_product.md): Save Products ### Upsert Products - [PATCH /rest/2.0/PRODUCT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/product/patch_product.md): Upsert Products ### Delete Products - [DELETE /rest/2.0/delete/PRODUCT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/product/delete_product.md): Delete Products ### Retrieve By Id Products - [GET /rest/2.0/PRODUCT/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/product/retrieve_by_id_product.md): Get Products By Id ### Retrieve Filtered Products - [GET /rest/2.0/PRODUCT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/product/retrievefiltered_product.md): Get record(s) using filters ### Update Products - [PUT /rest/2.0/PRODUCT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/product/put_product.md): Update Products ### Save Products - [POST /rest/2.0/PRODUCT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/product/post_product.md): Save Products ### Upsert Products - [PATCH /rest/2.0/PRODUCT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/product/patch_product.md): Upsert Products ### Delete Products - [DELETE /rest/2.0/delete/PRODUCT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/product/delete_product.md): Delete Products ## RATE_CLASS A rate class is used to house product pricing that can be centrally managed and assigned to Account Contracts. ### Retrieve By Id Rate Classes - [GET /rest/2.0/RATE_CLASS/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/rate_class/retrieve_by_id_rate_class.md): Get Rate Classes By Id ### Retrieve Filtered Rate Classes - [GET /rest/2.0/RATE_CLASS](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/rate_class/retrievefiltered_rate_class.md): Get record(s) using filters ### Update Rate Classes - [PUT /rest/2.0/RATE_CLASS](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/rate_class/put_rate_class.md): Update Rate Classes ### Save Rate Classes - [POST /rest/2.0/RATE_CLASS](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/rate_class/post_rate_class.md): Save Rate Classes ### Upsert Rate Classes - [PATCH /rest/2.0/RATE_CLASS](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/rate_class/patch_rate_class.md): Upsert Rate Classes ### Delete Rate Classes - [DELETE /rest/2.0/delete/RATE_CLASS](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/rate_class/delete_rate_class.md): Delete Rate Classes ### Retrieve By Id Rate Classes - [GET /rest/2.0/RATE_CLASS/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/rate_class/retrieve_by_id_rate_class.md): Get Rate Classes By Id ### Retrieve Filtered Rate Classes - [GET /rest/2.0/RATE_CLASS](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/rate_class/retrievefiltered_rate_class.md): Get record(s) using filters ### Update Rate Classes - [PUT /rest/2.0/RATE_CLASS](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/rate_class/put_rate_class.md): Update Rate Classes ### Save Rate Classes - [POST /rest/2.0/RATE_CLASS](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/rate_class/post_rate_class.md): Save Rate Classes ### Upsert Rate Classes - [PATCH /rest/2.0/RATE_CLASS](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/rate_class/patch_rate_class.md): Upsert Rate Classes ### Delete Rate Classes - [DELETE /rest/2.0/delete/RATE_CLASS](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/rate_class/delete_rate_class.md): Delete Rate Classes ## RATE_CLASS_PRODUCT RATE_CLASS_PRODUCT API Reference ### Retrieve By Id Rate Class Product - [GET /rest/2.0/RATE_CLASS_PRODUCT/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/rate_class_product/retrieve_by_id_rate_class_product.md): Get Rate Class Product By Id ### Retrieve Filtered Rate Class Product - [GET /rest/2.0/RATE_CLASS_PRODUCT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/rate_class_product/retrievefiltered_rate_class_product.md): Get record(s) using filters ### Update Rate Class Product - [PUT /rest/2.0/RATE_CLASS_PRODUCT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/rate_class_product/put_rate_class_product.md): Update Rate Class Product ### Save Rate Class Product - [POST /rest/2.0/RATE_CLASS_PRODUCT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/rate_class_product/post_rate_class_product.md): Save Rate Class Product ### Upsert Rate Class Product - [PATCH /rest/2.0/RATE_CLASS_PRODUCT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/rate_class_product/patch_rate_class_product.md): Upsert Rate Class Product ### Delete Rate Class Product - [DELETE /rest/2.0/delete/RATE_CLASS_PRODUCT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/rate_class_product/delete_rate_class_product.md): Delete Rate Class Product ### Retrieve By Id Rate Class Product - [GET /rest/2.0/RATE_CLASS_PRODUCT/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/rate_class_product/retrieve_by_id_rate_class_product.md): Get Rate Class Product By Id ### Retrieve Filtered Rate Class Product - [GET /rest/2.0/RATE_CLASS_PRODUCT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/rate_class_product/retrievefiltered_rate_class_product.md): Get record(s) using filters ### Update Rate Class Product - [PUT /rest/2.0/RATE_CLASS_PRODUCT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/rate_class_product/put_rate_class_product.md): Update Rate Class Product ### Save Rate Class Product - [POST /rest/2.0/RATE_CLASS_PRODUCT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/rate_class_product/post_rate_class_product.md): Save Rate Class Product ### Upsert Rate Class Product - [PATCH /rest/2.0/RATE_CLASS_PRODUCT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/rate_class_product/patch_rate_class_product.md): Upsert Rate Class Product ### Delete Rate Class Product - [DELETE /rest/2.0/delete/RATE_CLASS_PRODUCT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/rate_class_product/delete_rate_class_product.md): Delete Rate Class Product ## RATING_METHOD A Rating Method is used to define a Product's rating behavior. Examples of rating method types are Usage and Subscription. ### Retrieve By Id Rating Method - [GET /rest/2.0/RATING_METHOD/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/rating_method/retrieve_by_id_rating_method.md): Get Rating Method By Id ### Retrieve Filtered Rating Method - [GET /rest/2.0/RATING_METHOD](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/rating_method/retrievefiltered_rating_method.md): Get record(s) using filters ### Update Rating Method - [PUT /rest/2.0/RATING_METHOD](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/rating_method/put_rating_method.md): Update Rating Method ### Save Rating Method - [POST /rest/2.0/RATING_METHOD](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/rating_method/post_rating_method.md): Save Rating Method ### Upsert Rating Method - [PATCH /rest/2.0/RATING_METHOD](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/rating_method/patch_rating_method.md): Upsert Rating Method ### Delete Rating Method - [DELETE /rest/2.0/delete/RATING_METHOD](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/rating_method/delete_rating_method.md): Delete Rating Method ### Retrieve By Id Rating Method - [GET /rest/2.0/RATING_METHOD/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/rating_method/retrieve_by_id_rating_method.md): Get Rating Method By Id ### Retrieve Filtered Rating Method - [GET /rest/2.0/RATING_METHOD](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/rating_method/retrievefiltered_rating_method.md): Get record(s) using filters ### Update Rating Method - [PUT /rest/2.0/RATING_METHOD](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/rating_method/put_rating_method.md): Update Rating Method ### Save Rating Method - [POST /rest/2.0/RATING_METHOD](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/rating_method/post_rating_method.md): Save Rating Method ### Upsert Rating Method - [PATCH /rest/2.0/RATING_METHOD](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/rating_method/patch_rating_method.md): Upsert Rating Method ### Delete Rating Method - [DELETE /rest/2.0/delete/RATING_METHOD](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/rating_method/delete_rating_method.md): Delete Rating Method ## ACCOUNT An account in BillingPlatform is a customer account with the billing profile that consolidates all customer information. ### Retrieve By Id Account - [GET /rest/2.0/ACCOUNT/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/account/retrieve_by_id_account.md): Get Account By Id ### Retrieve Filtered Account - [GET /rest/2.0/ACCOUNT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/account/retrievefiltered_account.md): Get record(s) using filters ### Update Account - [PUT /rest/2.0/ACCOUNT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/account/put_account.md): Update Account ### Save Account - [POST /rest/2.0/ACCOUNT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/account/post_account.md): Save Account ### Upsert Account - [PATCH /rest/2.0/ACCOUNT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/account/patch_account.md): Upsert Account ### Delete Account - [DELETE /rest/2.0/delete/ACCOUNT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/account/delete_account.md): Delete Account ### Retrieve By Id Account - [GET /rest/2.0/ACCOUNT/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/account/retrieve_by_id_account.md): Get Account By Id ### Retrieve Filtered Account - [GET /rest/2.0/ACCOUNT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/account/retrievefiltered_account.md): Get record(s) using filters ### Update Account - [PUT /rest/2.0/ACCOUNT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/account/put_account.md): Update Account ### Save Account - [POST /rest/2.0/ACCOUNT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/account/post_account.md): Save Account ### Upsert Account - [PATCH /rest/2.0/ACCOUNT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/account/patch_account.md): Upsert Account ### Delete Account - [DELETE /rest/2.0/delete/ACCOUNT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/account/delete_account.md): Delete Account ## ACCOUNT_PACKAGE Account packages are collections of bundled products that are provisioned to the customer. ### Retrieve By Id Account Packages - [GET /rest/2.0/ACCOUNT_PACKAGE/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/account_package/retrieve_by_id_account_package.md): Get Account Packages By Id ### Retrieve Filtered Account Packages - [GET /rest/2.0/ACCOUNT_PACKAGE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/account_package/retrievefiltered_account_package.md): Get record(s) using filters ### Update Account Packages - [PUT /rest/2.0/ACCOUNT_PACKAGE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/account_package/put_account_package.md): Update Account Packages ### Save Account Packages - [POST /rest/2.0/ACCOUNT_PACKAGE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/account_package/post_account_package.md): Save Account Packages ### Delete Account Packages - [DELETE /rest/2.0/delete/ACCOUNT_PACKAGE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/account_package/delete_account_package.md): Delete Account Packages ### Retrieve By Id Account Packages - [GET /rest/2.0/ACCOUNT_PACKAGE/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/account_package/retrieve_by_id_account_package.md): Get Account Packages By Id ### Retrieve Filtered Account Packages - [GET /rest/2.0/ACCOUNT_PACKAGE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/account_package/retrievefiltered_account_package.md): Get record(s) using filters ### Update Account Packages - [PUT /rest/2.0/ACCOUNT_PACKAGE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/account_package/put_account_package.md): Update Account Packages ### Save Account Packages - [POST /rest/2.0/ACCOUNT_PACKAGE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/account_package/post_account_package.md): Save Account Packages ### Delete Account Packages - [DELETE /rest/2.0/delete/ACCOUNT_PACKAGE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/account_package/delete_account_package.md): Delete Account Packages ## ACCOUNT_PRODUCT An Account Product is used to provision services to an account such as subscriptions and discounts that generate charges. ### Retrieve By Id Account Products - [GET /rest/2.0/ACCOUNT_PRODUCT/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/account_product/retrieve_by_id_account_product.md): Get Account Products By Id ### Retrieve Filtered Account Products - [GET /rest/2.0/ACCOUNT_PRODUCT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/account_product/retrievefiltered_account_product.md): Get record(s) using filters ### Update Account Products - [PUT /rest/2.0/ACCOUNT_PRODUCT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/account_product/put_account_product.md): Update Account Products ### Save Account Products - [POST /rest/2.0/ACCOUNT_PRODUCT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/account_product/post_account_product.md): Save Account Products ### Delete Account Products - [DELETE /rest/2.0/delete/ACCOUNT_PRODUCT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/account_product/delete_account_product.md): Delete Account Products ### Retrieve By Id Account Products - [GET /rest/2.0/ACCOUNT_PRODUCT/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/account_product/retrieve_by_id_account_product.md): Get Account Products By Id ### Retrieve Filtered Account Products - [GET /rest/2.0/ACCOUNT_PRODUCT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/account_product/retrievefiltered_account_product.md): Get record(s) using filters ### Update Account Products - [PUT /rest/2.0/ACCOUNT_PRODUCT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/account_product/put_account_product.md): Update Account Products ### Save Account Products - [POST /rest/2.0/ACCOUNT_PRODUCT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/account_product/post_account_product.md): Save Account Products ### Delete Account Products - [DELETE /rest/2.0/delete/ACCOUNT_PRODUCT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/account_product/delete_account_product.md): Delete Account Products ## ACCOUNT_PRODUCT_QUOTE ACCOUNT_PRODUCT_QUOTE API Reference ### Retrieve By Id Account Product Quote - [GET /rest/2.0/ACCOUNT_PRODUCT_QUOTE/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/account_product_quote/retrieve_by_id_account_product_quote.md): Get Account Product Quote By Id ### Retrieve Filtered Account Product Quote - [GET /rest/2.0/ACCOUNT_PRODUCT_QUOTE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/account_product_quote/retrievefiltered_account_product_quote.md): Get record(s) using filters ### Update Account Product Quote - [PUT /rest/2.0/ACCOUNT_PRODUCT_QUOTE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/account_product_quote/put_account_product_quote.md): Update Account Product Quote ### Save Account Product Quote - [POST /rest/2.0/ACCOUNT_PRODUCT_QUOTE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/account_product_quote/post_account_product_quote.md): Save Account Product Quote ### Delete Account Product Quote - [DELETE /rest/2.0/delete/ACCOUNT_PRODUCT_QUOTE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/account_product_quote/delete_account_product_quote.md): Delete Account Product Quote ### Retrieve By Id Account Product Quote - [GET /rest/2.0/ACCOUNT_PRODUCT_QUOTE/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/account_product_quote/retrieve_by_id_account_product_quote.md): Get Account Product Quote By Id ### Retrieve Filtered Account Product Quote - [GET /rest/2.0/ACCOUNT_PRODUCT_QUOTE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/account_product_quote/retrievefiltered_account_product_quote.md): Get record(s) using filters ### Update Account Product Quote - [PUT /rest/2.0/ACCOUNT_PRODUCT_QUOTE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/account_product_quote/put_account_product_quote.md): Update Account Product Quote ### Save Account Product Quote - [POST /rest/2.0/ACCOUNT_PRODUCT_QUOTE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/account_product_quote/post_account_product_quote.md): Save Account Product Quote ### Delete Account Product Quote - [DELETE /rest/2.0/delete/ACCOUNT_PRODUCT_QUOTE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/account_product_quote/delete_account_product_quote.md): Delete Account Product Quote ## BILLING_PROFILE Identifies the billing and invoicing attributes for a given element of the hierarchy ### Retrieve By Id Billing Profile - [GET /rest/2.0/BILLING_PROFILE/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/billing_profile/retrieve_by_id_billing_profile.md): Get Billing Profile By Id ### Retrieve Filtered Billing Profile - [GET /rest/2.0/BILLING_PROFILE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/billing_profile/retrievefiltered_billing_profile.md): Get record(s) using filters ### Update Billing Profile - [PUT /rest/2.0/BILLING_PROFILE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/billing_profile/put_billing_profile.md): Update Billing Profile ### Save Billing Profile - [POST /rest/2.0/BILLING_PROFILE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/billing_profile/post_billing_profile.md): Save Billing Profile ### Upsert Billing Profile - [PATCH /rest/2.0/BILLING_PROFILE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/billing_profile/patch_billing_profile.md): Upsert Billing Profile ### Delete Billing Profile - [DELETE /rest/2.0/delete/BILLING_PROFILE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/billing_profile/delete_billing_profile.md): Delete Billing Profile ### Retrieve By Id Billing Profile - [GET /rest/2.0/BILLING_PROFILE/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/billing_profile/retrieve_by_id_billing_profile.md): Get Billing Profile By Id ### Retrieve Filtered Billing Profile - [GET /rest/2.0/BILLING_PROFILE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/billing_profile/retrievefiltered_billing_profile.md): Get record(s) using filters ### Update Billing Profile - [PUT /rest/2.0/BILLING_PROFILE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/billing_profile/put_billing_profile.md): Update Billing Profile ### Save Billing Profile - [POST /rest/2.0/BILLING_PROFILE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/billing_profile/post_billing_profile.md): Save Billing Profile ### Upsert Billing Profile - [PATCH /rest/2.0/BILLING_PROFILE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/billing_profile/patch_billing_profile.md): Upsert Billing Profile ### Delete Billing Profile - [DELETE /rest/2.0/delete/BILLING_PROFILE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/billing_profile/delete_billing_profile.md): Delete Billing Profile ## CONTRACT_CURRENCY CONTRACT_CURRENCY API Reference ### Retrieve By Id Contract Currency - [GET /rest/2.0/CONTRACT_CURRENCY/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/contract_currency/retrieve_by_id_contract_currency.md): Get Contract Currency By Id ### Retrieve Filtered Contract Currency - [GET /rest/2.0/CONTRACT_CURRENCY](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/contract_currency/retrievefiltered_contract_currency.md): Get record(s) using filters ### Update Contract Currency - [PUT /rest/2.0/CONTRACT_CURRENCY](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/contract_currency/put_contract_currency.md): Update Contract Currency ### Save Contract Currency - [POST /rest/2.0/CONTRACT_CURRENCY](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/contract_currency/post_contract_currency.md): Save Contract Currency ### Delete Contract Currency - [DELETE /rest/2.0/delete/CONTRACT_CURRENCY](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/contract_currency/delete_contract_currency.md): Delete Contract Currency ### Retrieve By Id Contract Currency - [GET /rest/2.0/CONTRACT_CURRENCY/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/contract_currency/retrieve_by_id_contract_currency.md): Get Contract Currency By Id ### Retrieve Filtered Contract Currency - [GET /rest/2.0/CONTRACT_CURRENCY](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/contract_currency/retrievefiltered_contract_currency.md): Get record(s) using filters ### Update Contract Currency - [PUT /rest/2.0/CONTRACT_CURRENCY](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/contract_currency/put_contract_currency.md): Update Contract Currency ### Save Contract Currency - [POST /rest/2.0/CONTRACT_CURRENCY](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/contract_currency/post_contract_currency.md): Save Contract Currency ### Delete Contract Currency - [DELETE /rest/2.0/delete/CONTRACT_CURRENCY](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/contract_currency/delete_contract_currency.md): Delete Contract Currency ## COUNTRY_CODE COUNTRY_CODE API Reference ### Retrieve By Id Location - [GET /rest/2.0/COUNTRY_CODE/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/country_code/retrieve_by_id_country_code.md): Get Location By Id ### Retrieve Filtered Location - [GET /rest/2.0/COUNTRY_CODE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/country_code/retrievefiltered_country_code.md): Get record(s) using filters ### Update Location - [PUT /rest/2.0/COUNTRY_CODE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/country_code/put_country_code.md): Update Location ### Save Location - [POST /rest/2.0/COUNTRY_CODE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/country_code/post_country_code.md): Save Location ### Upsert Location - [PATCH /rest/2.0/COUNTRY_CODE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/country_code/patch_country_code.md): Upsert Location ### Delete Location - [DELETE /rest/2.0/delete/COUNTRY_CODE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/country_code/delete_country_code.md): Delete Location ### Retrieve By Id Location - [GET /rest/2.0/COUNTRY_CODE/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/country_code/retrieve_by_id_country_code.md): Get Location By Id ### Retrieve Filtered Location - [GET /rest/2.0/COUNTRY_CODE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/country_code/retrievefiltered_country_code.md): Get record(s) using filters ### Update Location - [PUT /rest/2.0/COUNTRY_CODE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/country_code/put_country_code.md): Update Location ### Save Location - [POST /rest/2.0/COUNTRY_CODE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/country_code/post_country_code.md): Save Location ### Upsert Location - [PATCH /rest/2.0/COUNTRY_CODE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/country_code/patch_country_code.md): Upsert Location ### Delete Location - [DELETE /rest/2.0/delete/COUNTRY_CODE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/country_code/delete_country_code.md): Delete Location ## CURRENCY CURRENCY API Reference ### Retrieve By Id Currency - [GET /rest/2.0/CURRENCY/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/currency/retrieve_by_id_currency.md): Get Currency By Id ### Retrieve Filtered Currency - [GET /rest/2.0/CURRENCY](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/currency/retrievefiltered_currency.md): Get record(s) using filters ### Update Currency - [PUT /rest/2.0/CURRENCY](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/currency/put_currency.md): Update Currency ### Save Currency - [POST /rest/2.0/CURRENCY](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/currency/post_currency.md): Save Currency ### Delete Currency - [DELETE /rest/2.0/delete/CURRENCY](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/currency/delete_currency.md): Delete Currency ### Retrieve By Id Currency - [GET /rest/2.0/CURRENCY/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/currency/retrieve_by_id_currency.md): Get Currency By Id ### Retrieve Filtered Currency - [GET /rest/2.0/CURRENCY](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/currency/retrievefiltered_currency.md): Get record(s) using filters ### Update Currency - [PUT /rest/2.0/CURRENCY](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/currency/put_currency.md): Update Currency ### Save Currency - [POST /rest/2.0/CURRENCY](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/currency/post_currency.md): Save Currency ### Delete Currency - [DELETE /rest/2.0/delete/CURRENCY](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/currency/delete_currency.md): Delete Currency ## SHARING_GROUP SHARING_GROUP API Reference ### Retrieve By Id Sharing Groups - [GET /rest/2.0/SHARING_GROUP/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/sharing_group/retrieve_by_id_sharing_group.md): Get Sharing Groups By Id ### Retrieve Filtered Sharing Groups - [GET /rest/2.0/SHARING_GROUP](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/sharing_group/retrievefiltered_sharing_group.md): Get record(s) using filters ### Update Sharing Groups - [PUT /rest/2.0/SHARING_GROUP](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/sharing_group/put_sharing_group.md): Update Sharing Groups ### Save Sharing Groups - [POST /rest/2.0/SHARING_GROUP](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/sharing_group/post_sharing_group.md): Save Sharing Groups ### Upsert Sharing Groups - [PATCH /rest/2.0/SHARING_GROUP](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/sharing_group/patch_sharing_group.md): Upsert Sharing Groups ### Delete Sharing Groups - [DELETE /rest/2.0/delete/SHARING_GROUP](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/sharing_group/delete_sharing_group.md): Delete Sharing Groups ### Retrieve By Id Sharing Groups - [GET /rest/2.0/SHARING_GROUP/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/sharing_group/retrieve_by_id_sharing_group.md): Get Sharing Groups By Id ### Retrieve Filtered Sharing Groups - [GET /rest/2.0/SHARING_GROUP](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/sharing_group/retrievefiltered_sharing_group.md): Get record(s) using filters ### Update Sharing Groups - [PUT /rest/2.0/SHARING_GROUP](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/sharing_group/put_sharing_group.md): Update Sharing Groups ### Save Sharing Groups - [POST /rest/2.0/SHARING_GROUP](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/sharing_group/post_sharing_group.md): Save Sharing Groups ### Upsert Sharing Groups - [PATCH /rest/2.0/SHARING_GROUP](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/sharing_group/patch_sharing_group.md): Upsert Sharing Groups ### Delete Sharing Groups - [DELETE /rest/2.0/delete/SHARING_GROUP](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/sharing_group/delete_sharing_group.md): Delete Sharing Groups ## SHARING_GROUP_RULE SHARING_GROUP_RULE API Reference ### Retrieve By Id Sharing Group Rules - [GET /rest/2.0/SHARING_GROUP_RULE/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/sharing_group_rule/retrieve_by_id_sharing_group_rule.md): Get Sharing Group Rules By Id ### Retrieve Filtered Sharing Group Rules - [GET /rest/2.0/SHARING_GROUP_RULE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/sharing_group_rule/retrievefiltered_sharing_group_rule.md): Get record(s) using filters ### Update Sharing Group Rules - [PUT /rest/2.0/SHARING_GROUP_RULE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/sharing_group_rule/put_sharing_group_rule.md): Update Sharing Group Rules ### Save Sharing Group Rules - [POST /rest/2.0/SHARING_GROUP_RULE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/sharing_group_rule/post_sharing_group_rule.md): Save Sharing Group Rules ### Upsert Sharing Group Rules - [PATCH /rest/2.0/SHARING_GROUP_RULE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/sharing_group_rule/patch_sharing_group_rule.md): Upsert Sharing Group Rules ### Delete Sharing Group Rules - [DELETE /rest/2.0/delete/SHARING_GROUP_RULE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/sharing_group_rule/delete_sharing_group_rule.md): Delete Sharing Group Rules ### Retrieve By Id Sharing Group Rules - [GET /rest/2.0/SHARING_GROUP_RULE/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/sharing_group_rule/retrieve_by_id_sharing_group_rule.md): Get Sharing Group Rules By Id ### Retrieve Filtered Sharing Group Rules - [GET /rest/2.0/SHARING_GROUP_RULE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/sharing_group_rule/retrievefiltered_sharing_group_rule.md): Get record(s) using filters ### Update Sharing Group Rules - [PUT /rest/2.0/SHARING_GROUP_RULE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/sharing_group_rule/put_sharing_group_rule.md): Update Sharing Group Rules ### Save Sharing Group Rules - [POST /rest/2.0/SHARING_GROUP_RULE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/sharing_group_rule/post_sharing_group_rule.md): Save Sharing Group Rules ### Upsert Sharing Group Rules - [PATCH /rest/2.0/SHARING_GROUP_RULE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/sharing_group_rule/patch_sharing_group_rule.md): Upsert Sharing Group Rules ### Delete Sharing Group Rules - [DELETE /rest/2.0/delete/SHARING_GROUP_RULE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/sharing_group_rule/delete_sharing_group_rule.md): Delete Sharing Group Rules ## SHARING_GROUP_USER SHARING_GROUP_USER API Reference ### Retrieve By Id Sharing Group User - [GET /rest/2.0/SHARING_GROUP_USER/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/sharing_group_user/retrieve_by_id_sharing_group_user.md): Get Sharing Group User By Id ### Retrieve Filtered Sharing Group User - [GET /rest/2.0/SHARING_GROUP_USER](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/sharing_group_user/retrievefiltered_sharing_group_user.md): Get record(s) using filters ### Update Sharing Group User - [PUT /rest/2.0/SHARING_GROUP_USER](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/sharing_group_user/put_sharing_group_user.md): Update Sharing Group User ### Save Sharing Group User - [POST /rest/2.0/SHARING_GROUP_USER](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/sharing_group_user/post_sharing_group_user.md): Save Sharing Group User ### Delete Sharing Group User - [DELETE /rest/2.0/delete/SHARING_GROUP_USER](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/sharing_group_user/delete_sharing_group_user.md): Delete Sharing Group User ### Retrieve By Id Sharing Group User - [GET /rest/2.0/SHARING_GROUP_USER/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/sharing_group_user/retrieve_by_id_sharing_group_user.md): Get Sharing Group User By Id ### Retrieve Filtered Sharing Group User - [GET /rest/2.0/SHARING_GROUP_USER](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/sharing_group_user/retrievefiltered_sharing_group_user.md): Get record(s) using filters ### Update Sharing Group User - [PUT /rest/2.0/SHARING_GROUP_USER](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/sharing_group_user/put_sharing_group_user.md): Update Sharing Group User ### Save Sharing Group User - [POST /rest/2.0/SHARING_GROUP_USER](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/sharing_group_user/post_sharing_group_user.md): Save Sharing Group User ### Delete Sharing Group User - [DELETE /rest/2.0/delete/SHARING_GROUP_USER](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/sharing_group_user/delete_sharing_group_user.md): Delete Sharing Group User ## TIME_ZONE TIME_ZONE API Reference ### Retrieve By Id Time Zone - [GET /rest/2.0/TIME_ZONE/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/time_zone/retrieve_by_id_time_zone.md): Get Time Zone By Id ### Retrieve Filtered Time Zone - [GET /rest/2.0/TIME_ZONE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/time_zone/retrievefiltered_time_zone.md): Get record(s) using filters ### Update Time Zone - [PUT /rest/2.0/TIME_ZONE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/time_zone/put_time_zone.md): Update Time Zone ### Save Time Zone - [POST /rest/2.0/TIME_ZONE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/time_zone/post_time_zone.md): Save Time Zone ### Upsert Time Zone - [PATCH /rest/2.0/TIME_ZONE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/time_zone/patch_time_zone.md): Upsert Time Zone ### Delete Time Zone - [DELETE /rest/2.0/delete/TIME_ZONE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/time_zone/delete_time_zone.md): Delete Time Zone ### Retrieve By Id Time Zone - [GET /rest/2.0/TIME_ZONE/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/time_zone/retrieve_by_id_time_zone.md): Get Time Zone By Id ### Retrieve Filtered Time Zone - [GET /rest/2.0/TIME_ZONE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/time_zone/retrievefiltered_time_zone.md): Get record(s) using filters ### Update Time Zone - [PUT /rest/2.0/TIME_ZONE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/time_zone/put_time_zone.md): Update Time Zone ### Save Time Zone - [POST /rest/2.0/TIME_ZONE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/time_zone/post_time_zone.md): Save Time Zone ### Upsert Time Zone - [PATCH /rest/2.0/TIME_ZONE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/time_zone/patch_time_zone.md): Upsert Time Zone ### Delete Time Zone - [DELETE /rest/2.0/delete/TIME_ZONE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/time_zone/delete_time_zone.md): Delete Time Zone ## ACTIVITY The Activity Object, also known as "Invoice Detail", contains all of the rated charges in the system for any given product. ### Retrieve By Id Invoice Detail - [GET /rest/2.0/ACTIVITY/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/activity/retrieve_by_id_activity.md): Get Invoice Detail By Id ### Retrieve Filtered Invoice Detail - [GET /rest/2.0/ACTIVITY](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/activity/retrievefiltered_activity.md): Get record(s) using filters ### Update Invoice Detail - [PUT /rest/2.0/ACTIVITY](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/activity/put_activity.md): Update Invoice Detail ### Save Invoice Detail - [POST /rest/2.0/ACTIVITY](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/activity/post_activity.md): Save Invoice Detail ### Delete Invoice Detail - [DELETE /rest/2.0/delete/ACTIVITY](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/activity/delete_activity.md): Delete Invoice Detail ### Retrieve By Id Invoice Detail - [GET /rest/2.0/ACTIVITY/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/activity/retrieve_by_id_activity.md): Get Invoice Detail By Id ### Retrieve Filtered Invoice Detail - [GET /rest/2.0/ACTIVITY](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/activity/retrievefiltered_activity.md): Get record(s) using filters ### Update Invoice Detail - [PUT /rest/2.0/ACTIVITY](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/activity/put_activity.md): Update Invoice Detail ### Save Invoice Detail - [POST /rest/2.0/ACTIVITY](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/activity/post_activity.md): Save Invoice Detail ### Delete Invoice Detail - [DELETE /rest/2.0/delete/ACTIVITY](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/activity/delete_activity.md): Delete Invoice Detail ## ACTIVITY_COLLECTOR Also known as a Usage Collector, the Activity Collector is the primary object used for mediation. ### Retrieve By Id Usage Collectors - [GET /rest/2.0/ACTIVITY_COLLECTOR/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/activity_collector/retrieve_by_id_activity_collector.md): Get Usage Collectors By Id ### Retrieve Filtered Usage Collectors - [GET /rest/2.0/ACTIVITY_COLLECTOR](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/activity_collector/retrievefiltered_activity_collector.md): Get record(s) using filters ### Update Usage Collectors - [PUT /rest/2.0/ACTIVITY_COLLECTOR](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/activity_collector/put_activity_collector.md): Update Usage Collectors ### Save Usage Collectors - [POST /rest/2.0/ACTIVITY_COLLECTOR](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/activity_collector/post_activity_collector.md): Save Usage Collectors ### Upsert Usage Collectors - [PATCH /rest/2.0/ACTIVITY_COLLECTOR](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/activity_collector/patch_activity_collector.md): Upsert Usage Collectors ### Delete Usage Collectors - [DELETE /rest/2.0/delete/ACTIVITY_COLLECTOR](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/activity_collector/delete_activity_collector.md): Delete Usage Collectors ### Retrieve By Id Usage Collectors - [GET /rest/2.0/ACTIVITY_COLLECTOR/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/activity_collector/retrieve_by_id_activity_collector.md): Get Usage Collectors By Id ### Retrieve Filtered Usage Collectors - [GET /rest/2.0/ACTIVITY_COLLECTOR](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/activity_collector/retrievefiltered_activity_collector.md): Get record(s) using filters ### Update Usage Collectors - [PUT /rest/2.0/ACTIVITY_COLLECTOR](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/activity_collector/put_activity_collector.md): Update Usage Collectors ### Save Usage Collectors - [POST /rest/2.0/ACTIVITY_COLLECTOR](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/activity_collector/post_activity_collector.md): Save Usage Collectors ### Upsert Usage Collectors - [PATCH /rest/2.0/ACTIVITY_COLLECTOR](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/activity_collector/patch_activity_collector.md): Upsert Usage Collectors ### Delete Usage Collectors - [DELETE /rest/2.0/delete/ACTIVITY_COLLECTOR](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/activity_collector/delete_activity_collector.md): Delete Usage Collectors ## BILLING_IDENTIFIER BILLING_IDENTIFIER API Reference ### Retrieve By Id Provisioning Attributes - [GET /rest/2.0/BILLING_IDENTIFIER/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/billing_identifier/retrieve_by_id_billing_identifier.md): Get Provisioning Attributes By Id ### Retrieve Filtered Provisioning Attributes - [GET /rest/2.0/BILLING_IDENTIFIER](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/billing_identifier/retrievefiltered_billing_identifier.md): Get record(s) using filters ### Update Provisioning Attributes - [PUT /rest/2.0/BILLING_IDENTIFIER](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/billing_identifier/put_billing_identifier.md): Update Provisioning Attributes ### Save Provisioning Attributes - [POST /rest/2.0/BILLING_IDENTIFIER](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/billing_identifier/post_billing_identifier.md): Save Provisioning Attributes ### Delete Provisioning Attributes - [DELETE /rest/2.0/delete/BILLING_IDENTIFIER](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/billing_identifier/delete_billing_identifier.md): Delete Provisioning Attributes ### Retrieve By Id Provisioning Attributes - [GET /rest/2.0/BILLING_IDENTIFIER/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/billing_identifier/retrieve_by_id_billing_identifier.md): Get Provisioning Attributes By Id ### Retrieve Filtered Provisioning Attributes - [GET /rest/2.0/BILLING_IDENTIFIER](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/billing_identifier/retrievefiltered_billing_identifier.md): Get record(s) using filters ### Update Provisioning Attributes - [PUT /rest/2.0/BILLING_IDENTIFIER](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/billing_identifier/put_billing_identifier.md): Update Provisioning Attributes ### Save Provisioning Attributes - [POST /rest/2.0/BILLING_IDENTIFIER](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/billing_identifier/post_billing_identifier.md): Save Provisioning Attributes ### Delete Provisioning Attributes - [DELETE /rest/2.0/delete/BILLING_IDENTIFIER](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/billing_identifier/delete_billing_identifier.md): Delete Provisioning Attributes ## COLLECTOR_FIELDS Also Known as Usage Data, Collector Fields is used to define the fild mappings for Usage Data files. ### Retrieve By Id Usage Data - [GET /rest/2.0/COLLECTOR_FIELDS/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/collector_fields/retrieve_by_id_collector_fields.md): Get Usage Data By Id ### Retrieve Filtered Usage Data - [GET /rest/2.0/COLLECTOR_FIELDS](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/collector_fields/retrievefiltered_collector_fields.md): Get record(s) using filters ### Update Usage Data - [PUT /rest/2.0/COLLECTOR_FIELDS](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/collector_fields/put_collector_fields.md): Update Usage Data ### Save Usage Data - [POST /rest/2.0/COLLECTOR_FIELDS](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/collector_fields/post_collector_fields.md): Save Usage Data ### Delete Usage Data - [DELETE /rest/2.0/delete/COLLECTOR_FIELDS](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/collector_fields/delete_collector_fields.md): Delete Usage Data ### Retrieve By Id Usage Data - [GET /rest/2.0/COLLECTOR_FIELDS/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/collector_fields/retrieve_by_id_collector_fields.md): Get Usage Data By Id ### Retrieve Filtered Usage Data - [GET /rest/2.0/COLLECTOR_FIELDS](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/collector_fields/retrievefiltered_collector_fields.md): Get record(s) using filters ### Update Usage Data - [PUT /rest/2.0/COLLECTOR_FIELDS](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/collector_fields/put_collector_fields.md): Update Usage Data ### Save Usage Data - [POST /rest/2.0/COLLECTOR_FIELDS](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/collector_fields/post_collector_fields.md): Save Usage Data ### Delete Usage Data - [DELETE /rest/2.0/delete/COLLECTOR_FIELDS](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/collector_fields/delete_collector_fields.md): Delete Usage Data ## CREDIT The credit object is used to provide a credit to an Account or Billing Profile. ### Retrieve By Id Credits - [GET /rest/2.0/CREDIT/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/credit/retrieve_by_id_credit.md): Get Credits By Id ### Retrieve Filtered Credits - [GET /rest/2.0/CREDIT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/credit/retrievefiltered_credit.md): Get record(s) using filters ### Update Credits - [PUT /rest/2.0/CREDIT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/credit/put_credit.md): Update Credits ### Save Credits - [POST /rest/2.0/CREDIT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/credit/post_credit.md): Save Credits ### Delete Credits - [DELETE /rest/2.0/delete/CREDIT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/credit/delete_credit.md): Delete Credits ### Retrieve By Id Credits - [GET /rest/2.0/CREDIT/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/credit/retrieve_by_id_credit.md): Get Credits By Id ### Retrieve Filtered Credits - [GET /rest/2.0/CREDIT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/credit/retrievefiltered_credit.md): Get record(s) using filters ### Update Credits - [PUT /rest/2.0/CREDIT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/credit/put_credit.md): Update Credits ### Save Credits - [POST /rest/2.0/CREDIT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/credit/post_credit.md): Save Credits ### Delete Credits - [DELETE /rest/2.0/delete/CREDIT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/credit/delete_credit.md): Delete Credits ## CREDIT_ALLOCATION Used to allocate a Credit to an invoice. Can only allocate as much of the unallocated credit amount that's available at creation ### Retrieve By Id Credit Allocation - [GET /rest/2.0/CREDIT_ALLOCATION/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/credit_allocation/retrieve_by_id_credit_allocation.md): Get Credit Allocation By Id ### Retrieve Filtered Credit Allocation - [GET /rest/2.0/CREDIT_ALLOCATION](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/credit_allocation/retrievefiltered_credit_allocation.md): Get record(s) using filters ### Update Credit Allocation - [PUT /rest/2.0/CREDIT_ALLOCATION](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/credit_allocation/put_credit_allocation.md): Update Credit Allocation ### Save Credit Allocation - [POST /rest/2.0/CREDIT_ALLOCATION](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/credit_allocation/post_credit_allocation.md): Save Credit Allocation ### Delete Credit Allocation - [DELETE /rest/2.0/delete/CREDIT_ALLOCATION](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/credit_allocation/delete_credit_allocation.md): Delete Credit Allocation ### Retrieve By Id Credit Allocation - [GET /rest/2.0/CREDIT_ALLOCATION/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/credit_allocation/retrieve_by_id_credit_allocation.md): Get Credit Allocation By Id ### Retrieve Filtered Credit Allocation - [GET /rest/2.0/CREDIT_ALLOCATION](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/credit_allocation/retrievefiltered_credit_allocation.md): Get record(s) using filters ### Update Credit Allocation - [PUT /rest/2.0/CREDIT_ALLOCATION](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/credit_allocation/put_credit_allocation.md): Update Credit Allocation ### Save Credit Allocation - [POST /rest/2.0/CREDIT_ALLOCATION](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/credit_allocation/post_credit_allocation.md): Save Credit Allocation ### Delete Credit Allocation - [DELETE /rest/2.0/delete/CREDIT_ALLOCATION](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/credit_allocation/delete_credit_allocation.md): Delete Credit Allocation ## CREDIT_TYPE CREDIT_TYPE API Reference ### Retrieve By Id Credit Type - [GET /rest/2.0/CREDIT_TYPE/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/credit_type/retrieve_by_id_credit_type.md): Get Credit Type By Id ### Retrieve Filtered Credit Type - [GET /rest/2.0/CREDIT_TYPE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/credit_type/retrievefiltered_credit_type.md): Get record(s) using filters ### Update Credit Type - [PUT /rest/2.0/CREDIT_TYPE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/credit_type/put_credit_type.md): Update Credit Type ### Save Credit Type - [POST /rest/2.0/CREDIT_TYPE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/credit_type/post_credit_type.md): Save Credit Type ### Delete Credit Type - [DELETE /rest/2.0/delete/CREDIT_TYPE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/credit_type/delete_credit_type.md): Delete Credit Type ### Retrieve By Id Credit Type - [GET /rest/2.0/CREDIT_TYPE/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/credit_type/retrieve_by_id_credit_type.md): Get Credit Type By Id ### Retrieve Filtered Credit Type - [GET /rest/2.0/CREDIT_TYPE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/credit_type/retrievefiltered_credit_type.md): Get record(s) using filters ### Update Credit Type - [PUT /rest/2.0/CREDIT_TYPE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/credit_type/put_credit_type.md): Update Credit Type ### Save Credit Type - [POST /rest/2.0/CREDIT_TYPE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/credit_type/post_credit_type.md): Save Credit Type ### Delete Credit Type - [DELETE /rest/2.0/delete/CREDIT_TYPE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/credit_type/delete_credit_type.md): Delete Credit Type ## DUNNING_INTERVAL DUNNING_INTERVAL API Reference ### Retrieve By Id Dunning - [GET /rest/2.0/DUNNING_INTERVAL/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/dunning_interval/retrieve_by_id_dunning_interval.md): Get Dunning By Id ### Retrieve Filtered Dunning - [GET /rest/2.0/DUNNING_INTERVAL](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/dunning_interval/retrievefiltered_dunning_interval.md): Get record(s) using filters ### Update Dunning - [PUT /rest/2.0/DUNNING_INTERVAL](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/dunning_interval/put_dunning_interval.md): Update Dunning ### Save Dunning - [POST /rest/2.0/DUNNING_INTERVAL](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/dunning_interval/post_dunning_interval.md): Save Dunning ### Delete Dunning - [DELETE /rest/2.0/delete/DUNNING_INTERVAL](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/dunning_interval/delete_dunning_interval.md): Delete Dunning ### Retrieve By Id Dunning - [GET /rest/2.0/DUNNING_INTERVAL/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/dunning_interval/retrieve_by_id_dunning_interval.md): Get Dunning By Id ### Retrieve Filtered Dunning - [GET /rest/2.0/DUNNING_INTERVAL](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/dunning_interval/retrievefiltered_dunning_interval.md): Get record(s) using filters ### Update Dunning - [PUT /rest/2.0/DUNNING_INTERVAL](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/dunning_interval/put_dunning_interval.md): Update Dunning ### Save Dunning - [POST /rest/2.0/DUNNING_INTERVAL](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/dunning_interval/post_dunning_interval.md): Save Dunning ### Delete Dunning - [DELETE /rest/2.0/delete/DUNNING_INTERVAL](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/dunning_interval/delete_dunning_interval.md): Delete Dunning ## INVOICE Contain charges (Activity) associated with an account. Invoices aggregate service charges, Payments Allocations, etc. ### Retrieve By Id Invoices - [GET /rest/2.0/INVOICE/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/invoice/retrieve_by_id_invoice.md): Get Invoices By Id ### Retrieve Filtered Invoices - [GET /rest/2.0/INVOICE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/invoice/retrievefiltered_invoice.md): Get record(s) using filters ### Update Invoices - [PUT /rest/2.0/INVOICE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/invoice/put_invoice.md): Update Invoices ### Save Invoices - [POST /rest/2.0/INVOICE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/invoice/post_invoice.md): Save Invoices ### Upsert Invoices - [PATCH /rest/2.0/INVOICE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/invoice/patch_invoice.md): Upsert Invoices ### Delete Invoices - [DELETE /rest/2.0/delete/INVOICE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/invoice/delete_invoice.md): Delete Invoices ### Retrieve By Id Invoices - [GET /rest/2.0/INVOICE/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/invoice/retrieve_by_id_invoice.md): Get Invoices By Id ### Retrieve Filtered Invoices - [GET /rest/2.0/INVOICE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/invoice/retrievefiltered_invoice.md): Get record(s) using filters ### Update Invoices - [PUT /rest/2.0/INVOICE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/invoice/put_invoice.md): Update Invoices ### Save Invoices - [POST /rest/2.0/INVOICE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/invoice/post_invoice.md): Save Invoices ### Upsert Invoices - [PATCH /rest/2.0/INVOICE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/invoice/patch_invoice.md): Upsert Invoices ### Delete Invoices - [DELETE /rest/2.0/delete/INVOICE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/invoice/delete_invoice.md): Delete Invoices ## INVOICE_TEMPLATE INVOICE_TEMPLATE API Reference ### Retrieve By Id Invoice Template - [GET /rest/2.0/INVOICE_TEMPLATE/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/invoice_template/retrieve_by_id_invoice_template.md): Get Invoice Template By Id ### Retrieve Filtered Invoice Template - [GET /rest/2.0/INVOICE_TEMPLATE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/invoice_template/retrievefiltered_invoice_template.md): Get record(s) using filters ### Update Invoice Template - [PUT /rest/2.0/INVOICE_TEMPLATE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/invoice_template/put_invoice_template.md): Update Invoice Template ### Save Invoice Template - [POST /rest/2.0/INVOICE_TEMPLATE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/invoice_template/post_invoice_template.md): Save Invoice Template ### Upsert Invoice Template - [PATCH /rest/2.0/INVOICE_TEMPLATE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/invoice_template/patch_invoice_template.md): Upsert Invoice Template ### Delete Invoice Template - [DELETE /rest/2.0/delete/INVOICE_TEMPLATE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/invoice_template/delete_invoice_template.md): Delete Invoice Template ### Retrieve By Id Invoice Template - [GET /rest/2.0/INVOICE_TEMPLATE/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/invoice_template/retrieve_by_id_invoice_template.md): Get Invoice Template By Id ### Retrieve Filtered Invoice Template - [GET /rest/2.0/INVOICE_TEMPLATE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/invoice_template/retrievefiltered_invoice_template.md): Get record(s) using filters ### Update Invoice Template - [PUT /rest/2.0/INVOICE_TEMPLATE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/invoice_template/put_invoice_template.md): Update Invoice Template ### Save Invoice Template - [POST /rest/2.0/INVOICE_TEMPLATE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/invoice_template/post_invoice_template.md): Save Invoice Template ### Upsert Invoice Template - [PATCH /rest/2.0/INVOICE_TEMPLATE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/invoice_template/patch_invoice_template.md): Upsert Invoice Template ### Delete Invoice Template - [DELETE /rest/2.0/delete/INVOICE_TEMPLATE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/invoice_template/delete_invoice_template.md): Delete Invoice Template ## PAYMENT The Payment table is a crucial component of our database that records all transactions related to payments. ### Retrieve By Id Payments - [GET /rest/2.0/PAYMENT/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/payment/retrieve_by_id_payment.md): Get Payments By Id ### Retrieve Filtered Payments - [GET /rest/2.0/PAYMENT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/payment/retrievefiltered_payment.md): Get record(s) using filters ### Update Payments - [PUT /rest/2.0/PAYMENT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/payment/put_payment.md): Update Payments ### Save Payments - [POST /rest/2.0/PAYMENT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/payment/post_payment.md): Save Payments ### Upsert Payments - [PATCH /rest/2.0/PAYMENT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/payment/patch_payment.md): Upsert Payments ### Delete Payments - [DELETE /rest/2.0/delete/PAYMENT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/payment/delete_payment.md): Delete Payments ### Retrieve By Id Payments - [GET /rest/2.0/PAYMENT/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/payment/retrieve_by_id_payment.md): Get Payments By Id ### Retrieve Filtered Payments - [GET /rest/2.0/PAYMENT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/payment/retrievefiltered_payment.md): Get record(s) using filters ### Update Payments - [PUT /rest/2.0/PAYMENT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/payment/put_payment.md): Update Payments ### Save Payments - [POST /rest/2.0/PAYMENT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/payment/post_payment.md): Save Payments ### Upsert Payments - [PATCH /rest/2.0/PAYMENT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/payment/patch_payment.md): Upsert Payments ### Delete Payments - [DELETE /rest/2.0/delete/PAYMENT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/payment/delete_payment.md): Delete Payments ## REFUND A Refund is used to refund credit card payments. ### Retrieve By Id Refunds - [GET /rest/2.0/REFUND/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/refund/retrieve_by_id_refund.md): Get Refunds By Id ### Retrieve Filtered Refunds - [GET /rest/2.0/REFUND](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/refund/retrievefiltered_refund.md): Get record(s) using filters ### Update Refunds - [PUT /rest/2.0/REFUND](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/refund/put_refund.md): Update Refunds ### Save Refunds - [POST /rest/2.0/REFUND](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/refund/post_refund.md): Save Refunds ### Delete Refunds - [DELETE /rest/2.0/delete/REFUND](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/refund/delete_refund.md): Delete Refunds ### Retrieve By Id Refunds - [GET /rest/2.0/REFUND/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/refund/retrieve_by_id_refund.md): Get Refunds By Id ### Retrieve Filtered Refunds - [GET /rest/2.0/REFUND](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/refund/retrievefiltered_refund.md): Get record(s) using filters ### Update Refunds - [PUT /rest/2.0/REFUND](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/refund/put_refund.md): Update Refunds ### Save Refunds - [POST /rest/2.0/REFUND](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/refund/post_refund.md): Save Refunds ### Delete Refunds - [DELETE /rest/2.0/delete/REFUND](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/refund/delete_refund.md): Delete Refunds ## REFUND_TYPE REFUND_TYPE API Reference ### Retrieve By Id Refund Type - [GET /rest/2.0/REFUND_TYPE/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/refund_type/retrieve_by_id_refund_type.md): Get Refund Type By Id ### Retrieve Filtered Refund Type - [GET /rest/2.0/REFUND_TYPE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/refund_type/retrievefiltered_refund_type.md): Get record(s) using filters ### Update Refund Type - [PUT /rest/2.0/REFUND_TYPE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/refund_type/put_refund_type.md): Update Refund Type ### Save Refund Type - [POST /rest/2.0/REFUND_TYPE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/refund_type/post_refund_type.md): Save Refund Type ### Delete Refund Type - [DELETE /rest/2.0/delete/REFUND_TYPE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/refund_type/delete_refund_type.md): Delete Refund Type ### Retrieve By Id Refund Type - [GET /rest/2.0/REFUND_TYPE/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/refund_type/retrieve_by_id_refund_type.md): Get Refund Type By Id ### Retrieve Filtered Refund Type - [GET /rest/2.0/REFUND_TYPE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/refund_type/retrievefiltered_refund_type.md): Get record(s) using filters ### Update Refund Type - [PUT /rest/2.0/REFUND_TYPE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/refund_type/put_refund_type.md): Update Refund Type ### Save Refund Type - [POST /rest/2.0/REFUND_TYPE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/refund_type/post_refund_type.md): Save Refund Type ### Delete Refund Type - [DELETE /rest/2.0/delete/REFUND_TYPE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/refund_type/delete_refund_type.md): Delete Refund Type ## TAX_DETAIL TAX_DETAIL API Reference ### Retrieve By Id Tax Detail - [GET /rest/2.0/TAX_DETAIL/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/tax_detail/retrieve_by_id_tax_detail.md): Get Tax Detail By Id ### Retrieve Filtered Tax Detail - [GET /rest/2.0/TAX_DETAIL](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/tax_detail/retrievefiltered_tax_detail.md): Get record(s) using filters ### Update Tax Detail - [PUT /rest/2.0/TAX_DETAIL](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/tax_detail/put_tax_detail.md): Update Tax Detail ### Save Tax Detail - [POST /rest/2.0/TAX_DETAIL](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/tax_detail/post_tax_detail.md): Save Tax Detail ### Delete Tax Detail - [DELETE /rest/2.0/delete/TAX_DETAIL](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/tax_detail/delete_tax_detail.md): Delete Tax Detail ### Retrieve By Id Tax Detail - [GET /rest/2.0/TAX_DETAIL/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/tax_detail/retrieve_by_id_tax_detail.md): Get Tax Detail By Id ### Retrieve Filtered Tax Detail - [GET /rest/2.0/TAX_DETAIL](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/tax_detail/retrievefiltered_tax_detail.md): Get record(s) using filters ### Update Tax Detail - [PUT /rest/2.0/TAX_DETAIL](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/tax_detail/put_tax_detail.md): Update Tax Detail ### Save Tax Detail - [POST /rest/2.0/TAX_DETAIL](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/tax_detail/post_tax_detail.md): Save Tax Detail ### Delete Tax Detail - [DELETE /rest/2.0/delete/TAX_DETAIL](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/tax_detail/delete_tax_detail.md): Delete Tax Detail ## TAX_ENGINE TAX_ENGINE API Reference ### Retrieve By Id Tax Engine - [GET /rest/2.0/TAX_ENGINE/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/tax_engine/retrieve_by_id_tax_engine.md): Get Tax Engine By Id ### Retrieve Filtered Tax Engine - [GET /rest/2.0/TAX_ENGINE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/tax_engine/retrievefiltered_tax_engine.md): Get record(s) using filters ### Update Tax Engine - [PUT /rest/2.0/TAX_ENGINE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/tax_engine/put_tax_engine.md): Update Tax Engine ### Save Tax Engine - [POST /rest/2.0/TAX_ENGINE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/tax_engine/post_tax_engine.md): Save Tax Engine ### Upsert Tax Engine - [PATCH /rest/2.0/TAX_ENGINE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/tax_engine/patch_tax_engine.md): Upsert Tax Engine ### Delete Tax Engine - [DELETE /rest/2.0/delete/TAX_ENGINE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/tax_engine/delete_tax_engine.md): Delete Tax Engine ### Retrieve By Id Tax Engine - [GET /rest/2.0/TAX_ENGINE/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/tax_engine/retrieve_by_id_tax_engine.md): Get Tax Engine By Id ### Retrieve Filtered Tax Engine - [GET /rest/2.0/TAX_ENGINE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/tax_engine/retrievefiltered_tax_engine.md): Get record(s) using filters ### Update Tax Engine - [PUT /rest/2.0/TAX_ENGINE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/tax_engine/put_tax_engine.md): Update Tax Engine ### Save Tax Engine - [POST /rest/2.0/TAX_ENGINE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/tax_engine/post_tax_engine.md): Save Tax Engine ### Upsert Tax Engine - [PATCH /rest/2.0/TAX_ENGINE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/tax_engine/patch_tax_engine.md): Upsert Tax Engine ### Delete Tax Engine - [DELETE /rest/2.0/delete/TAX_ENGINE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/tax_engine/delete_tax_engine.md): Delete Tax Engine ### Retrieve By Id Tax Engine - [GET /rest/2.0/TAX_ENGINE/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/tax_engine/retrieve_by_id_tax_engine.md): Get Tax Engine By Id ### Retrieve Filtered Tax Engine - [GET /rest/2.0/TAX_ENGINE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/tax_engine/retrievefiltered_tax_engine.md): Get record(s) using filters ### Update Tax Engine - [PUT /rest/2.0/TAX_ENGINE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/tax_engine/put_tax_engine.md): Update Tax Engine ### Save Tax Engine - [POST /rest/2.0/TAX_ENGINE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/tax_engine/post_tax_engine.md): Save Tax Engine ### Upsert Tax Engine - [PATCH /rest/2.0/TAX_ENGINE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/tax_engine/patch_tax_engine.md): Upsert Tax Engine ### Delete Tax Engine - [DELETE /rest/2.0/delete/TAX_ENGINE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/tax_engine/delete_tax_engine.md): Delete Tax Engine ### Retrieve By Id Tax Engine - [GET /rest/2.0/TAX_ENGINE/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/tax_engine/retrieve_by_id_tax_engine.md): Get Tax Engine By Id ### Retrieve Filtered Tax Engine - [GET /rest/2.0/TAX_ENGINE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/tax_engine/retrievefiltered_tax_engine.md): Get record(s) using filters ### Update Tax Engine - [PUT /rest/2.0/TAX_ENGINE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/tax_engine/put_tax_engine.md): Update Tax Engine ### Save Tax Engine - [POST /rest/2.0/TAX_ENGINE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/tax_engine/post_tax_engine.md): Save Tax Engine ### Upsert Tax Engine - [PATCH /rest/2.0/TAX_ENGINE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/tax_engine/patch_tax_engine.md): Upsert Tax Engine ### Delete Tax Engine - [DELETE /rest/2.0/delete/TAX_ENGINE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/tax_engine/delete_tax_engine.md): Delete Tax Engine ## TAX_ENGINE_AUDIT TAX_ENGINE_AUDIT API Reference ### Retrieve By Id Tax Engine Audit - [GET /rest/2.0/TAX_ENGINE_AUDIT/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/tax_engine_audit/retrieve_by_id_tax_engine_audit.md): Get Tax Engine Audit By Id ### Retrieve Filtered Tax Engine Audit - [GET /rest/2.0/TAX_ENGINE_AUDIT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/tax_engine_audit/retrievefiltered_tax_engine_audit.md): Get record(s) using filters ### Update Tax Engine Audit - [PUT /rest/2.0/TAX_ENGINE_AUDIT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/tax_engine_audit/put_tax_engine_audit.md): Update Tax Engine Audit ### Save Tax Engine Audit - [POST /rest/2.0/TAX_ENGINE_AUDIT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/tax_engine_audit/post_tax_engine_audit.md): Save Tax Engine Audit ### Delete Tax Engine Audit - [DELETE /rest/2.0/delete/TAX_ENGINE_AUDIT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/tax_engine_audit/delete_tax_engine_audit.md): Delete Tax Engine Audit ### Retrieve By Id Tax Engine Audit - [GET /rest/2.0/TAX_ENGINE_AUDIT/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/tax_engine_audit/retrieve_by_id_tax_engine_audit.md): Get Tax Engine Audit By Id ### Retrieve Filtered Tax Engine Audit - [GET /rest/2.0/TAX_ENGINE_AUDIT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/tax_engine_audit/retrievefiltered_tax_engine_audit.md): Get record(s) using filters ### Update Tax Engine Audit - [PUT /rest/2.0/TAX_ENGINE_AUDIT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/tax_engine_audit/put_tax_engine_audit.md): Update Tax Engine Audit ### Save Tax Engine Audit - [POST /rest/2.0/TAX_ENGINE_AUDIT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/tax_engine_audit/post_tax_engine_audit.md): Save Tax Engine Audit ### Delete Tax Engine Audit - [DELETE /rest/2.0/delete/TAX_ENGINE_AUDIT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/tax_engine_audit/delete_tax_engine_audit.md): Delete Tax Engine Audit ## ACCOUNT_CONTACT The Account Contact entity represents the person who the bills are addressed to. This name typically appears on invoices. ### Retrieve By Id Contacts - [GET /rest/2.0/ACCOUNT_CONTACT/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/account_contact/retrieve_by_id_account_contact.md): Get Contacts By Id ### Retrieve Filtered Contacts - [GET /rest/2.0/ACCOUNT_CONTACT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/account_contact/retrievefiltered_account_contact.md): Get record(s) using filters ### Update Contacts - [PUT /rest/2.0/ACCOUNT_CONTACT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/account_contact/put_account_contact.md): Update Contacts ### Save Contacts - [POST /rest/2.0/ACCOUNT_CONTACT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/account_contact/post_account_contact.md): Save Contacts ### Delete Contacts - [DELETE /rest/2.0/delete/ACCOUNT_CONTACT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/account_contact/delete_account_contact.md): Delete Contacts ### Retrieve By Id Contacts - [GET /rest/2.0/ACCOUNT_CONTACT/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/account_contact/retrieve_by_id_account_contact.md): Get Contacts By Id ### Retrieve Filtered Contacts - [GET /rest/2.0/ACCOUNT_CONTACT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/account_contact/retrievefiltered_account_contact.md): Get record(s) using filters ### Update Contacts - [PUT /rest/2.0/ACCOUNT_CONTACT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/account_contact/put_account_contact.md): Update Contacts ### Save Contacts - [POST /rest/2.0/ACCOUNT_CONTACT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/account_contact/post_account_contact.md): Save Contacts ### Delete Contacts - [DELETE /rest/2.0/delete/ACCOUNT_CONTACT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/account_contact/delete_account_contact.md): Delete Contacts ## CONTACT_TYPE The types an Account Contact can be. This contact receives the Action Items of a Collection Strategy. ### Retrieve By Id Contact Categories - [GET /rest/2.0/CONTACT_TYPE/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/contact_type/retrieve_by_id_contact_type.md): Get Contact Categories By Id ### Retrieve Filtered Contact Categories - [GET /rest/2.0/CONTACT_TYPE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/contact_type/retrievefiltered_contact_type.md): Get record(s) using filters ### Update Contact Categories - [PUT /rest/2.0/CONTACT_TYPE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/contact_type/put_contact_type.md): Update Contact Categories ### Save Contact Categories - [POST /rest/2.0/CONTACT_TYPE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/contact_type/post_contact_type.md): Save Contact Categories ### Upsert Contact Categories - [PATCH /rest/2.0/CONTACT_TYPE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/contact_type/patch_contact_type.md): Upsert Contact Categories ### Delete Contact Categories - [DELETE /rest/2.0/delete/CONTACT_TYPE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/contact_type/delete_contact_type.md): Delete Contact Categories ### Retrieve By Id Contact Categories - [GET /rest/2.0/CONTACT_TYPE/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/contact_type/retrieve_by_id_contact_type.md): Get Contact Categories By Id ### Retrieve Filtered Contact Categories - [GET /rest/2.0/CONTACT_TYPE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/contact_type/retrievefiltered_contact_type.md): Get record(s) using filters ### Update Contact Categories - [PUT /rest/2.0/CONTACT_TYPE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/contact_type/put_contact_type.md): Update Contact Categories ### Save Contact Categories - [POST /rest/2.0/CONTACT_TYPE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/contact_type/post_contact_type.md): Save Contact Categories ### Upsert Contact Categories - [PATCH /rest/2.0/CONTACT_TYPE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/contact_type/patch_contact_type.md): Upsert Contact Categories ### Delete Contact Categories - [DELETE /rest/2.0/delete/CONTACT_TYPE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/contact_type/delete_contact_type.md): Delete Contact Categories ## CS_ACCOUNT_ACTION The collections Action associated with an account that is in collections. Such as emails, phone calls, termination of service. ### Retrieve By Id Account Actions - [GET /rest/2.0/CS_ACCOUNT_ACTION/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/cs_account_action/retrieve_by_id_cs_account_action.md): Get Account Actions By Id ### Retrieve Filtered Account Actions - [GET /rest/2.0/CS_ACCOUNT_ACTION](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/cs_account_action/retrievefiltered_cs_account_action.md): Get record(s) using filters ### Update Account Actions - [PUT /rest/2.0/CS_ACCOUNT_ACTION](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/cs_account_action/put_cs_account_action.md): Update Account Actions ### Save Account Actions - [POST /rest/2.0/CS_ACCOUNT_ACTION](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/cs_account_action/post_cs_account_action.md): Save Account Actions ### Delete Account Actions - [DELETE /rest/2.0/delete/CS_ACCOUNT_ACTION](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/cs_account_action/delete_cs_account_action.md): Delete Account Actions ### Retrieve By Id Account Actions - [GET /rest/2.0/CS_ACCOUNT_ACTION/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/cs_account_action/retrieve_by_id_cs_account_action.md): Get Account Actions By Id ### Retrieve Filtered Account Actions - [GET /rest/2.0/CS_ACCOUNT_ACTION](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/cs_account_action/retrievefiltered_cs_account_action.md): Get record(s) using filters ### Update Account Actions - [PUT /rest/2.0/CS_ACCOUNT_ACTION](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/cs_account_action/put_cs_account_action.md): Update Account Actions ### Save Account Actions - [POST /rest/2.0/CS_ACCOUNT_ACTION](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/cs_account_action/post_cs_account_action.md): Save Account Actions ### Delete Account Actions - [DELETE /rest/2.0/delete/CS_ACCOUNT_ACTION](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/cs_account_action/delete_cs_account_action.md): Delete Account Actions ## CS_ACTION Collection Actions are activities that are done whenever a workflow rule is evaluated as true ### Retrieve By Id Actions - [GET /rest/2.0/CS_ACTION/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/cs_action/retrieve_by_id_cs_action.md): Get Actions By Id ### Retrieve Filtered Actions - [GET /rest/2.0/CS_ACTION](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/cs_action/retrievefiltered_cs_action.md): Get record(s) using filters ### Update Actions - [PUT /rest/2.0/CS_ACTION](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/cs_action/put_cs_action.md): Update Actions ### Save Actions - [POST /rest/2.0/CS_ACTION](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/cs_action/post_cs_action.md): Save Actions ### Delete Actions - [DELETE /rest/2.0/delete/CS_ACTION](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/cs_action/delete_cs_action.md): Delete Actions ### Retrieve By Id Actions - [GET /rest/2.0/CS_ACTION/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/cs_action/retrieve_by_id_cs_action.md): Get Actions By Id ### Retrieve Filtered Actions - [GET /rest/2.0/CS_ACTION](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/cs_action/retrievefiltered_cs_action.md): Get record(s) using filters ### Update Actions - [PUT /rest/2.0/CS_ACTION](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/cs_action/put_cs_action.md): Update Actions ### Save Actions - [POST /rest/2.0/CS_ACTION](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/cs_action/post_cs_action.md): Save Actions ### Delete Actions - [DELETE /rest/2.0/delete/CS_ACTION](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/cs_action/delete_cs_action.md): Delete Actions ## CS_ACTION_TYPE CS_ACTION_TYPE API Reference ### Retrieve By Id Collection Actions - [GET /rest/2.0/CS_ACTION_TYPE/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/cs_action_type/retrieve_by_id_cs_action_type.md): Get Collection Actions By Id ### Retrieve Filtered Collection Actions - [GET /rest/2.0/CS_ACTION_TYPE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/cs_action_type/retrievefiltered_cs_action_type.md): Get record(s) using filters ### Update Collection Actions - [PUT /rest/2.0/CS_ACTION_TYPE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/cs_action_type/put_cs_action_type.md): Update Collection Actions ### Save Collection Actions - [POST /rest/2.0/CS_ACTION_TYPE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/cs_action_type/post_cs_action_type.md): Save Collection Actions ### Upsert Collection Actions - [PATCH /rest/2.0/CS_ACTION_TYPE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/cs_action_type/patch_cs_action_type.md): Upsert Collection Actions ### Delete Collection Actions - [DELETE /rest/2.0/delete/CS_ACTION_TYPE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/cs_action_type/delete_cs_action_type.md): Delete Collection Actions ### Retrieve By Id Collection Actions - [GET /rest/2.0/CS_ACTION_TYPE/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/cs_action_type/retrieve_by_id_cs_action_type.md): Get Collection Actions By Id ### Retrieve Filtered Collection Actions - [GET /rest/2.0/CS_ACTION_TYPE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/cs_action_type/retrievefiltered_cs_action_type.md): Get record(s) using filters ### Update Collection Actions - [PUT /rest/2.0/CS_ACTION_TYPE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/cs_action_type/put_cs_action_type.md): Update Collection Actions ### Save Collection Actions - [POST /rest/2.0/CS_ACTION_TYPE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/cs_action_type/post_cs_action_type.md): Save Collection Actions ### Upsert Collection Actions - [PATCH /rest/2.0/CS_ACTION_TYPE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/cs_action_type/patch_cs_action_type.md): Upsert Collection Actions ### Delete Collection Actions - [DELETE /rest/2.0/delete/CS_ACTION_TYPE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/cs_action_type/delete_cs_action_type.md): Delete Collection Actions ## CS_STRATEGY Used to define a named strategy and the filter or selection criteria that identifies what accounts to apply this strategy. ### Retrieve By Id Collection Strategies - [GET /rest/2.0/CS_STRATEGY/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/cs_strategy/retrieve_by_id_cs_strategy.md): Get Collection Strategies By Id ### Retrieve Filtered Collection Strategies - [GET /rest/2.0/CS_STRATEGY](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/cs_strategy/retrievefiltered_cs_strategy.md): Get record(s) using filters ### Update Collection Strategies - [PUT /rest/2.0/CS_STRATEGY](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/cs_strategy/put_cs_strategy.md): Update Collection Strategies ### Save Collection Strategies - [POST /rest/2.0/CS_STRATEGY](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/cs_strategy/post_cs_strategy.md): Save Collection Strategies ### Upsert Collection Strategies - [PATCH /rest/2.0/CS_STRATEGY](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/cs_strategy/patch_cs_strategy.md): Upsert Collection Strategies ### Delete Collection Strategies - [DELETE /rest/2.0/delete/CS_STRATEGY](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/cs_strategy/delete_cs_strategy.md): Delete Collection Strategies ### Retrieve By Id Collection Strategies - [GET /rest/2.0/CS_STRATEGY/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/cs_strategy/retrieve_by_id_cs_strategy.md): Get Collection Strategies By Id ### Retrieve Filtered Collection Strategies - [GET /rest/2.0/CS_STRATEGY](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/cs_strategy/retrievefiltered_cs_strategy.md): Get record(s) using filters ### Update Collection Strategies - [PUT /rest/2.0/CS_STRATEGY](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/cs_strategy/put_cs_strategy.md): Update Collection Strategies ### Save Collection Strategies - [POST /rest/2.0/CS_STRATEGY](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/cs_strategy/post_cs_strategy.md): Save Collection Strategies ### Upsert Collection Strategies - [PATCH /rest/2.0/CS_STRATEGY](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/cs_strategy/patch_cs_strategy.md): Upsert Collection Strategies ### Delete Collection Strategies - [DELETE /rest/2.0/delete/CS_STRATEGY](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/cs_strategy/delete_cs_strategy.md): Delete Collection Strategies ## INVOICE_WALLET INVOICE_WALLET API Reference ### Retrieve By Id Invoice Wallet - [GET /rest/2.0/INVOICE_WALLET/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/invoice_wallet/retrieve_by_id_invoice_wallet.md): Get Invoice Wallet By Id ### Retrieve Filtered Invoice Wallet - [GET /rest/2.0/INVOICE_WALLET](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/invoice_wallet/retrievefiltered_invoice_wallet.md): Get record(s) using filters ### Update Invoice Wallet - [PUT /rest/2.0/INVOICE_WALLET](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/invoice_wallet/put_invoice_wallet.md): Update Invoice Wallet ### Save Invoice Wallet - [POST /rest/2.0/INVOICE_WALLET](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/invoice_wallet/post_invoice_wallet.md): Save Invoice Wallet ### Delete Invoice Wallet - [DELETE /rest/2.0/delete/INVOICE_WALLET](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/invoice_wallet/delete_invoice_wallet.md): Delete Invoice Wallet ### Retrieve By Id Invoice Wallet - [GET /rest/2.0/INVOICE_WALLET/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/invoice_wallet/retrieve_by_id_invoice_wallet.md): Get Invoice Wallet By Id ### Retrieve Filtered Invoice Wallet - [GET /rest/2.0/INVOICE_WALLET](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/invoice_wallet/retrievefiltered_invoice_wallet.md): Get record(s) using filters ### Update Invoice Wallet - [PUT /rest/2.0/INVOICE_WALLET](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/invoice_wallet/put_invoice_wallet.md): Update Invoice Wallet ### Save Invoice Wallet - [POST /rest/2.0/INVOICE_WALLET](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/invoice_wallet/post_invoice_wallet.md): Save Invoice Wallet ### Delete Invoice Wallet - [DELETE /rest/2.0/delete/INVOICE_WALLET](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/invoice_wallet/delete_invoice_wallet.md): Delete Invoice Wallet ## PAYMENT_ALLOCATION This object is used to allocate a Payments to an invoice. ### Retrieve By Id Payment Allocation - [GET /rest/2.0/PAYMENT_ALLOCATION/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/payment_allocation/retrieve_by_id_payment_allocation.md): Get Payment Allocation By Id ### Retrieve Filtered Payment Allocation - [GET /rest/2.0/PAYMENT_ALLOCATION](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/payment_allocation/retrievefiltered_payment_allocation.md): Get record(s) using filters ### Update Payment Allocation - [PUT /rest/2.0/PAYMENT_ALLOCATION](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/payment_allocation/put_payment_allocation.md): Update Payment Allocation ### Save Payment Allocation - [POST /rest/2.0/PAYMENT_ALLOCATION](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/payment_allocation/post_payment_allocation.md): Save Payment Allocation ### Delete Payment Allocation - [DELETE /rest/2.0/delete/PAYMENT_ALLOCATION](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/payment_allocation/delete_payment_allocation.md): Delete Payment Allocation ### Retrieve By Id Payment Allocation - [GET /rest/2.0/PAYMENT_ALLOCATION/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/payment_allocation/retrieve_by_id_payment_allocation.md): Get Payment Allocation By Id ### Retrieve Filtered Payment Allocation - [GET /rest/2.0/PAYMENT_ALLOCATION](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/payment_allocation/retrievefiltered_payment_allocation.md): Get record(s) using filters ### Update Payment Allocation - [PUT /rest/2.0/PAYMENT_ALLOCATION](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/payment_allocation/put_payment_allocation.md): Update Payment Allocation ### Save Payment Allocation - [POST /rest/2.0/PAYMENT_ALLOCATION](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/payment_allocation/post_payment_allocation.md): Save Payment Allocation ### Delete Payment Allocation - [DELETE /rest/2.0/delete/PAYMENT_ALLOCATION](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/payment_allocation/delete_payment_allocation.md): Delete Payment Allocation ## PAYMENT_TYPE PAYMENT_TYPE API Reference ### Retrieve By Id Payment Type - [GET /rest/2.0/PAYMENT_TYPE/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/payment_type/retrieve_by_id_payment_type.md): Get Payment Type By Id ### Retrieve Filtered Payment Type - [GET /rest/2.0/PAYMENT_TYPE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/payment_type/retrievefiltered_payment_type.md): Get record(s) using filters ### Update Payment Type - [PUT /rest/2.0/PAYMENT_TYPE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/payment_type/put_payment_type.md): Update Payment Type ### Save Payment Type - [POST /rest/2.0/PAYMENT_TYPE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/payment_type/post_payment_type.md): Save Payment Type ### Delete Payment Type - [DELETE /rest/2.0/delete/PAYMENT_TYPE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/payment_type/delete_payment_type.md): Delete Payment Type ### Retrieve By Id Payment Type - [GET /rest/2.0/PAYMENT_TYPE/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/payment_type/retrieve_by_id_payment_type.md): Get Payment Type By Id ### Retrieve Filtered Payment Type - [GET /rest/2.0/PAYMENT_TYPE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/payment_type/retrievefiltered_payment_type.md): Get record(s) using filters ### Update Payment Type - [PUT /rest/2.0/PAYMENT_TYPE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/payment_type/put_payment_type.md): Update Payment Type ### Save Payment Type - [POST /rest/2.0/PAYMENT_TYPE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/payment_type/post_payment_type.md): Save Payment Type ### Delete Payment Type - [DELETE /rest/2.0/delete/PAYMENT_TYPE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/payment_type/delete_payment_type.md): Delete Payment Type ## STATEMENT_TEMPLATE STATEMENT_TEMPLATE API Reference ### Retrieve By Id Statement Template - [GET /rest/2.0/STATEMENT_TEMPLATE/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/statement_template/retrieve_by_id_statement_template.md): Get Statement Template By Id ### Retrieve Filtered Statement Template - [GET /rest/2.0/STATEMENT_TEMPLATE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/statement_template/retrievefiltered_statement_template.md): Get record(s) using filters ### Update Statement Template - [PUT /rest/2.0/STATEMENT_TEMPLATE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/statement_template/put_statement_template.md): Update Statement Template ### Save Statement Template - [POST /rest/2.0/STATEMENT_TEMPLATE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/statement_template/post_statement_template.md): Save Statement Template ### Upsert Statement Template - [PATCH /rest/2.0/STATEMENT_TEMPLATE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/statement_template/patch_statement_template.md): Upsert Statement Template ### Delete Statement Template - [DELETE /rest/2.0/delete/STATEMENT_TEMPLATE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/statement_template/delete_statement_template.md): Delete Statement Template ### Retrieve By Id Statement Template - [GET /rest/2.0/STATEMENT_TEMPLATE/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/statement_template/retrieve_by_id_statement_template.md): Get Statement Template By Id ### Retrieve Filtered Statement Template - [GET /rest/2.0/STATEMENT_TEMPLATE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/statement_template/retrievefiltered_statement_template.md): Get record(s) using filters ### Update Statement Template - [PUT /rest/2.0/STATEMENT_TEMPLATE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/statement_template/put_statement_template.md): Update Statement Template ### Save Statement Template - [POST /rest/2.0/STATEMENT_TEMPLATE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/statement_template/post_statement_template.md): Save Statement Template ### Upsert Statement Template - [PATCH /rest/2.0/STATEMENT_TEMPLATE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/statement_template/patch_statement_template.md): Upsert Statement Template ### Delete Statement Template - [DELETE /rest/2.0/delete/STATEMENT_TEMPLATE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/statement_template/delete_statement_template.md): Delete Statement Template ## GENERAL_LEDGER_TRANSACTION The ability to report journal entries to the General Ledger system is an essential element of the sub ledger system. ### Retrieve By Id General Ledger - [GET /rest/2.0/GENERAL_LEDGER_TRANSACTION/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/general_ledger_transaction/retrieve_by_id_general_ledger_transaction.md): Get General Ledger By Id ### Retrieve Filtered General Ledger - [GET /rest/2.0/GENERAL_LEDGER_TRANSACTION](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/general_ledger_transaction/retrievefiltered_general_ledger_transaction.md): Get record(s) using filters ### Update General Ledger - [PUT /rest/2.0/GENERAL_LEDGER_TRANSACTION](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/general_ledger_transaction/put_general_ledger_transaction.md): Update General Ledger ### Save General Ledger - [POST /rest/2.0/GENERAL_LEDGER_TRANSACTION](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/general_ledger_transaction/post_general_ledger_transaction.md): Save General Ledger ### Delete General Ledger - [DELETE /rest/2.0/delete/GENERAL_LEDGER_TRANSACTION](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/general_ledger_transaction/delete_general_ledger_transaction.md): Delete General Ledger ### Retrieve By Id General Ledger - [GET /rest/2.0/GENERAL_LEDGER_TRANSACTION/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/general_ledger_transaction/retrieve_by_id_general_ledger_transaction.md): Get General Ledger By Id ### Retrieve Filtered General Ledger - [GET /rest/2.0/GENERAL_LEDGER_TRANSACTION](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/general_ledger_transaction/retrievefiltered_general_ledger_transaction.md): Get record(s) using filters ### Update General Ledger - [PUT /rest/2.0/GENERAL_LEDGER_TRANSACTION](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/general_ledger_transaction/put_general_ledger_transaction.md): Update General Ledger ### Save General Ledger - [POST /rest/2.0/GENERAL_LEDGER_TRANSACTION](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/general_ledger_transaction/post_general_ledger_transaction.md): Save General Ledger ### Delete General Ledger - [DELETE /rest/2.0/delete/GENERAL_LEDGER_TRANSACTION](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/general_ledger_transaction/delete_general_ledger_transaction.md): Delete General Ledger ## PROCESS_QUEUE_REVENUE_COMMITMENT PROCESS_QUEUE_REVENUE_COMMITMENT API Reference ### Retrieve By Id Revenue commitment - [GET /rest/2.0/PROCESS_QUEUE_REVENUE_COMMITMENT/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/process_queue_revenue_commitment/retrieve_by_id_process_queue_revenue_commitment.md): Get Revenue commitment By Id ### Retrieve Filtered Revenue commitment - [GET /rest/2.0/PROCESS_QUEUE_REVENUE_COMMITMENT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/process_queue_revenue_commitment/retrievefiltered_process_queue_revenue_commitment.md): Get record(s) using filters ### Update Revenue commitment - [PUT /rest/2.0/PROCESS_QUEUE_REVENUE_COMMITMENT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/process_queue_revenue_commitment/put_process_queue_revenue_commitment.md): Update Revenue commitment ### Save Revenue commitment - [POST /rest/2.0/PROCESS_QUEUE_REVENUE_COMMITMENT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/process_queue_revenue_commitment/post_process_queue_revenue_commitment.md): Save Revenue commitment ### Delete Revenue commitment - [DELETE /rest/2.0/delete/PROCESS_QUEUE_REVENUE_COMMITMENT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/process_queue_revenue_commitment/delete_process_queue_revenue_commitment.md): Delete Revenue commitment ### Retrieve By Id Revenue commitment - [GET /rest/2.0/PROCESS_QUEUE_REVENUE_COMMITMENT/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/process_queue_revenue_commitment/retrieve_by_id_process_queue_revenue_commitment.md): Get Revenue commitment By Id ### Retrieve Filtered Revenue commitment - [GET /rest/2.0/PROCESS_QUEUE_REVENUE_COMMITMENT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/process_queue_revenue_commitment/retrievefiltered_process_queue_revenue_commitment.md): Get record(s) using filters ### Update Revenue commitment - [PUT /rest/2.0/PROCESS_QUEUE_REVENUE_COMMITMENT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/process_queue_revenue_commitment/put_process_queue_revenue_commitment.md): Update Revenue commitment ### Save Revenue commitment - [POST /rest/2.0/PROCESS_QUEUE_REVENUE_COMMITMENT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/process_queue_revenue_commitment/post_process_queue_revenue_commitment.md): Save Revenue commitment ### Delete Revenue commitment - [DELETE /rest/2.0/delete/PROCESS_QUEUE_REVENUE_COMMITMENT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/process_queue_revenue_commitment/delete_process_queue_revenue_commitment.md): Delete Revenue commitment ## REVREC_CONTRACT BillingPlatform provides Revenue Recognition Contracts to facilitate key steps to ensure seamless compliance of ASC 606/IFRS 15. ### Retrieve By Id Rev Rec Contract - [GET /rest/2.0/REVREC_CONTRACT/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/revrec_contract/retrieve_by_id_revrec_contract.md): Get Rev Rec Contract By Id ### Retrieve Filtered Rev Rec Contract - [GET /rest/2.0/REVREC_CONTRACT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/revrec_contract/retrievefiltered_revrec_contract.md): Get record(s) using filters ### Update Rev Rec Contract - [PUT /rest/2.0/REVREC_CONTRACT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/revrec_contract/put_revrec_contract.md): Update Rev Rec Contract ### Save Rev Rec Contract - [POST /rest/2.0/REVREC_CONTRACT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/revrec_contract/post_revrec_contract.md): Save Rev Rec Contract ### Delete Rev Rec Contract - [DELETE /rest/2.0/delete/REVREC_CONTRACT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/revrec_contract/delete_revrec_contract.md): Delete Rev Rec Contract ### Retrieve By Id Rev Rec Contract - [GET /rest/2.0/REVREC_CONTRACT/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/revrec_contract/retrieve_by_id_revrec_contract.md): Get Rev Rec Contract By Id ### Retrieve Filtered Rev Rec Contract - [GET /rest/2.0/REVREC_CONTRACT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/revrec_contract/retrievefiltered_revrec_contract.md): Get record(s) using filters ### Update Rev Rec Contract - [PUT /rest/2.0/REVREC_CONTRACT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/revrec_contract/put_revrec_contract.md): Update Rev Rec Contract ### Save Rev Rec Contract - [POST /rest/2.0/REVREC_CONTRACT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/revrec_contract/post_revrec_contract.md): Save Rev Rec Contract ### Delete Rev Rec Contract - [DELETE /rest/2.0/delete/REVREC_CONTRACT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/revrec_contract/delete_revrec_contract.md): Delete Rev Rec Contract ## ENTITY Represent an object or table in the system. Entities are metadata and contains information used by the application. ### Retrieve By Id Entities - [GET /rest/2.0/ENTITY/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/entity/retrieve_by_id_entity.md): Get Entities By Id ### Retrieve Filtered Entities - [GET /rest/2.0/ENTITY](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/entity/retrievefiltered_entity.md): Get record(s) using filters ### Update Entities - [PUT /rest/2.0/ENTITY](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/entity/put_entity.md): Update Entities ### Save Entities - [POST /rest/2.0/ENTITY](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/entity/post_entity.md): Save Entities ### Upsert Entities - [PATCH /rest/2.0/ENTITY](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/entity/patch_entity.md): Upsert Entities ### Delete Entities - [DELETE /rest/2.0/delete/ENTITY](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/entity/delete_entity.md): Delete Entities ### Retrieve By Id Entities - [GET /rest/2.0/ENTITY/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/entity/retrieve_by_id_entity.md): Get Entities By Id ### Retrieve Filtered Entities - [GET /rest/2.0/ENTITY](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/entity/retrievefiltered_entity.md): Get record(s) using filters ### Update Entities - [PUT /rest/2.0/ENTITY](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/entity/put_entity.md): Update Entities ### Save Entities - [POST /rest/2.0/ENTITY](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/entity/post_entity.md): Save Entities ### Upsert Entities - [PATCH /rest/2.0/ENTITY](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/entity/patch_entity.md): Upsert Entities ### Delete Entities - [DELETE /rest/2.0/delete/ENTITY](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/entity/delete_entity.md): Delete Entities ## ENTITY_FIELD Entity Fields are the fields defined for an entity. Entity Fields can be of various types like a number, date or text ### Retrieve By Id Fields - [GET /rest/2.0/ENTITY_FIELD/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/entity_field/retrieve_by_id_entity_field.md): Get Fields By Id ### Retrieve Filtered Fields - [GET /rest/2.0/ENTITY_FIELD](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/entity_field/retrievefiltered_entity_field.md): Get record(s) using filters ### Update Fields - [PUT /rest/2.0/ENTITY_FIELD](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/entity_field/put_entity_field.md): Update Fields ### Save Fields - [POST /rest/2.0/ENTITY_FIELD](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/entity_field/post_entity_field.md): Save Fields ### Upsert Fields - [PATCH /rest/2.0/ENTITY_FIELD](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/entity_field/patch_entity_field.md): Upsert Fields ### Delete Fields - [DELETE /rest/2.0/delete/ENTITY_FIELD](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/entity_field/delete_entity_field.md): Delete Fields ### Retrieve By Id Fields - [GET /rest/2.0/ENTITY_FIELD/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/entity_field/retrieve_by_id_entity_field.md): Get Fields By Id ### Retrieve Filtered Fields - [GET /rest/2.0/ENTITY_FIELD](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/entity_field/retrievefiltered_entity_field.md): Get record(s) using filters ### Update Fields - [PUT /rest/2.0/ENTITY_FIELD](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/entity_field/put_entity_field.md): Update Fields ### Save Fields - [POST /rest/2.0/ENTITY_FIELD](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/entity_field/post_entity_field.md): Save Fields ### Upsert Fields - [PATCH /rest/2.0/ENTITY_FIELD](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/entity_field/patch_entity_field.md): Upsert Fields ### Delete Fields - [DELETE /rest/2.0/delete/ENTITY_FIELD](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/entity_field/delete_entity_field.md): Delete Fields ## ENTITY_FIELD_ROLE This Object is used to define the access for a given role to a given Entity. ### Retrieve By Id Entity Field Role - [GET /rest/2.0/ENTITY_FIELD_ROLE/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/entity_field_role/retrieve_by_id_entity_field_role.md): Get Entity Field Role By Id ### Retrieve Filtered Entity Field Role - [GET /rest/2.0/ENTITY_FIELD_ROLE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/entity_field_role/retrievefiltered_entity_field_role.md): Get record(s) using filters ### Update Entity Field Role - [PUT /rest/2.0/ENTITY_FIELD_ROLE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/entity_field_role/put_entity_field_role.md): Update Entity Field Role ### Save Entity Field Role - [POST /rest/2.0/ENTITY_FIELD_ROLE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/entity_field_role/post_entity_field_role.md): Save Entity Field Role ### Delete Entity Field Role - [DELETE /rest/2.0/delete/ENTITY_FIELD_ROLE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/entity_field_role/delete_entity_field_role.md): Delete Entity Field Role ### Retrieve By Id Entity Field Role - [GET /rest/2.0/ENTITY_FIELD_ROLE/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/entity_field_role/retrieve_by_id_entity_field_role.md): Get Entity Field Role By Id ### Retrieve Filtered Entity Field Role - [GET /rest/2.0/ENTITY_FIELD_ROLE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/entity_field_role/retrievefiltered_entity_field_role.md): Get record(s) using filters ### Update Entity Field Role - [PUT /rest/2.0/ENTITY_FIELD_ROLE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/entity_field_role/put_entity_field_role.md): Update Entity Field Role ### Save Entity Field Role - [POST /rest/2.0/ENTITY_FIELD_ROLE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/entity_field_role/post_entity_field_role.md): Save Entity Field Role ### Delete Entity Field Role - [DELETE /rest/2.0/delete/ENTITY_FIELD_ROLE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/entity_field_role/delete_entity_field_role.md): Delete Entity Field Role ## ENTITY_FIELD_VALUES ENTITY_FIELD_VALUES API Reference ### Retrieve By Id Entity Field Values - [GET /rest/2.0/ENTITY_FIELD_VALUES/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/entity_field_values/retrieve_by_id_entity_field_values.md): Get Entity Field Values By Id ### Retrieve Filtered Entity Field Values - [GET /rest/2.0/ENTITY_FIELD_VALUES](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/entity_field_values/retrievefiltered_entity_field_values.md): Get record(s) using filters ### Update Entity Field Values - [PUT /rest/2.0/ENTITY_FIELD_VALUES](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/entity_field_values/put_entity_field_values.md): Update Entity Field Values ### Save Entity Field Values - [POST /rest/2.0/ENTITY_FIELD_VALUES](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/entity_field_values/post_entity_field_values.md): Save Entity Field Values ### Upsert Entity Field Values - [PATCH /rest/2.0/ENTITY_FIELD_VALUES](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/entity_field_values/patch_entity_field_values.md): Upsert Entity Field Values ### Delete Entity Field Values - [DELETE /rest/2.0/delete/ENTITY_FIELD_VALUES](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/entity_field_values/delete_entity_field_values.md): Delete Entity Field Values ### Retrieve By Id Entity Field Values - [GET /rest/2.0/ENTITY_FIELD_VALUES/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/entity_field_values/retrieve_by_id_entity_field_values.md): Get Entity Field Values By Id ### Retrieve Filtered Entity Field Values - [GET /rest/2.0/ENTITY_FIELD_VALUES](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/entity_field_values/retrievefiltered_entity_field_values.md): Get record(s) using filters ### Update Entity Field Values - [PUT /rest/2.0/ENTITY_FIELD_VALUES](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/entity_field_values/put_entity_field_values.md): Update Entity Field Values ### Save Entity Field Values - [POST /rest/2.0/ENTITY_FIELD_VALUES](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/entity_field_values/post_entity_field_values.md): Save Entity Field Values ### Upsert Entity Field Values - [PATCH /rest/2.0/ENTITY_FIELD_VALUES](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/entity_field_values/patch_entity_field_values.md): Upsert Entity Field Values ### Delete Entity Field Values - [DELETE /rest/2.0/delete/ENTITY_FIELD_VALUES](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/entity_field_values/delete_entity_field_values.md): Delete Entity Field Values ## QUOTE_DRAFT QUOTE_DRAFT API Reference ### Retrieve By Id Quote Draft - [GET /rest/2.0/QUOTE_DRAFT/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/quote_draft/retrieve_by_id_quote_draft.md): Get Quote Draft By Id ### Retrieve Filtered Quote Draft - [GET /rest/2.0/QUOTE_DRAFT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/quote_draft/retrievefiltered_quote_draft.md): Get record(s) using filters ### Update Quote Draft - [PUT /rest/2.0/QUOTE_DRAFT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/quote_draft/put_quote_draft.md): Update Quote Draft ### Save Quote Draft - [POST /rest/2.0/QUOTE_DRAFT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/quote_draft/post_quote_draft.md): Save Quote Draft ### Delete Quote Draft - [DELETE /rest/2.0/delete/QUOTE_DRAFT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/quote_draft/delete_quote_draft.md): Delete Quote Draft ### Retrieve By Id Quote Draft - [GET /rest/2.0/QUOTE_DRAFT/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/quote_draft/retrieve_by_id_quote_draft.md): Get Quote Draft By Id ### Retrieve Filtered Quote Draft - [GET /rest/2.0/QUOTE_DRAFT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/quote_draft/retrievefiltered_quote_draft.md): Get record(s) using filters ### Update Quote Draft - [PUT /rest/2.0/QUOTE_DRAFT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/quote_draft/put_quote_draft.md): Update Quote Draft ### Save Quote Draft - [POST /rest/2.0/QUOTE_DRAFT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/quote_draft/post_quote_draft.md): Save Quote Draft ### Delete Quote Draft - [DELETE /rest/2.0/delete/QUOTE_DRAFT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/quote_draft/delete_quote_draft.md): Delete Quote Draft ## QUOTE QUOTE API Reference ### Retrieve By Id Quote - [GET /rest/2.0/QUOTE/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/quote/retrieve_by_id_quote.md): Get Quote By Id ### Retrieve Filtered Quote - [GET /rest/2.0/QUOTE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/quote/retrievefiltered_quote.md): Get record(s) using filters ### Update Quote - [PUT /rest/2.0/QUOTE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/quote/put_quote.md): Update Quote ### Save Quote - [POST /rest/2.0/QUOTE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/quote/post_quote.md): Save Quote ### Upsert Quote - [PATCH /rest/2.0/QUOTE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/quote/patch_quote.md): Upsert Quote ### Delete Quote - [DELETE /rest/2.0/delete/QUOTE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/quote/delete_quote.md): Delete Quote ### Retrieve By Id Quote - [GET /rest/2.0/QUOTE/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/quote/retrieve_by_id_quote.md): Get Quote By Id ### Retrieve Filtered Quote - [GET /rest/2.0/QUOTE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/quote/retrievefiltered_quote.md): Get record(s) using filters ### Update Quote - [PUT /rest/2.0/QUOTE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/quote/put_quote.md): Update Quote ### Save Quote - [POST /rest/2.0/QUOTE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/quote/post_quote.md): Save Quote ### Upsert Quote - [PATCH /rest/2.0/QUOTE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/quote/patch_quote.md): Upsert Quote ### Delete Quote - [DELETE /rest/2.0/delete/QUOTE](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/quote/delete_quote.md): Delete Quote ## QUOTE_PRODUCT QUOTE_PRODUCT API Reference ### Retrieve By Id Quote Product - [GET /rest/2.0/QUOTE_PRODUCT/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/quote_product/retrieve_by_id_quote_product.md): Get Quote Product By Id ### Retrieve Filtered Quote Product - [GET /rest/2.0/QUOTE_PRODUCT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/quote_product/retrievefiltered_quote_product.md): Get record(s) using filters ### Update Quote Product - [PUT /rest/2.0/QUOTE_PRODUCT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/quote_product/put_quote_product.md): Update Quote Product ### Save Quote Product - [POST /rest/2.0/QUOTE_PRODUCT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/quote_product/post_quote_product.md): Save Quote Product ### Delete Quote Product - [DELETE /rest/2.0/delete/QUOTE_PRODUCT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/quote_product/delete_quote_product.md): Delete Quote Product ### Retrieve By Id Quote Product - [GET /rest/2.0/QUOTE_PRODUCT/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/quote_product/retrieve_by_id_quote_product.md): Get Quote Product By Id ### Retrieve Filtered Quote Product - [GET /rest/2.0/QUOTE_PRODUCT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/quote_product/retrievefiltered_quote_product.md): Get record(s) using filters ### Update Quote Product - [PUT /rest/2.0/QUOTE_PRODUCT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/quote_product/put_quote_product.md): Update Quote Product ### Save Quote Product - [POST /rest/2.0/QUOTE_PRODUCT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/quote_product/post_quote_product.md): Save Quote Product ### Delete Quote Product - [DELETE /rest/2.0/delete/QUOTE_PRODUCT](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/quote_product/delete_quote_product.md): Delete Quote Product ## QUOTE_PERIOD QUOTE_PERIOD API Reference ### Retrieve By Id Quote Period - [GET /rest/2.0/QUOTE_PERIOD/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/quote_period/retrieve_by_id_quote_period.md): Get Quote Period By Id ### Retrieve Filtered Quote Period - [GET /rest/2.0/QUOTE_PERIOD](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/quote_period/retrievefiltered_quote_period.md): Get record(s) using filters ### Update Quote Period - [PUT /rest/2.0/QUOTE_PERIOD](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/quote_period/put_quote_period.md): Update Quote Period ### Save Quote Period - [POST /rest/2.0/QUOTE_PERIOD](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/quote_period/post_quote_period.md): Save Quote Period ### Delete Quote Period - [DELETE /rest/2.0/delete/QUOTE_PERIOD](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/quote_period/delete_quote_period.md): Delete Quote Period ### Retrieve By Id Quote Period - [GET /rest/2.0/QUOTE_PERIOD/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/quote_period/retrieve_by_id_quote_period.md): Get Quote Period By Id ### Retrieve Filtered Quote Period - [GET /rest/2.0/QUOTE_PERIOD](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/quote_period/retrievefiltered_quote_period.md): Get record(s) using filters ### Update Quote Period - [PUT /rest/2.0/QUOTE_PERIOD](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/quote_period/put_quote_period.md): Update Quote Period ### Save Quote Period - [POST /rest/2.0/QUOTE_PERIOD](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/quote_period/post_quote_period.md): Save Quote Period ### Delete Quote Period - [DELETE /rest/2.0/delete/QUOTE_PERIOD](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/quote_period/delete_quote_period.md): Delete Quote Period ## QUOTE_PRODUCT_PERIOD QUOTE_PRODUCT_PERIOD API Reference ### Retrieve By Id Quote Product Period - [GET /rest/2.0/QUOTE_PRODUCT_PERIOD/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/quote_product_period/retrieve_by_id_quote_product_period.md): Get Quote Product Period By Id ### Retrieve Filtered Quote Product Period - [GET /rest/2.0/QUOTE_PRODUCT_PERIOD](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/quote_product_period/retrievefiltered_quote_product_period.md): Get record(s) using filters ### Update Quote Product Period - [PUT /rest/2.0/QUOTE_PRODUCT_PERIOD](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/quote_product_period/put_quote_product_period.md): Update Quote Product Period ### Save Quote Product Period - [POST /rest/2.0/QUOTE_PRODUCT_PERIOD](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/quote_product_period/post_quote_product_period.md): Save Quote Product Period ### Delete Quote Product Period - [DELETE /rest/2.0/delete/QUOTE_PRODUCT_PERIOD](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/quote_product_period/delete_quote_product_period.md): Delete Quote Product Period ### Retrieve By Id Quote Product Period - [GET /rest/2.0/QUOTE_PRODUCT_PERIOD/{id}](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/quote_product_period/retrieve_by_id_quote_product_period.md): Get Quote Product Period By Id ### Retrieve Filtered Quote Product Period - [GET /rest/2.0/QUOTE_PRODUCT_PERIOD](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/quote_product_period/retrievefiltered_quote_product_period.md): Get record(s) using filters ### Update Quote Product Period - [PUT /rest/2.0/QUOTE_PRODUCT_PERIOD](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/quote_product_period/put_quote_product_period.md): Update Quote Product Period ### Save Quote Product Period - [POST /rest/2.0/QUOTE_PRODUCT_PERIOD](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/quote_product_period/post_quote_product_period.md): Save Quote Product Period ### Delete Quote Product Period - [DELETE /rest/2.0/delete/QUOTE_PRODUCT_PERIOD](https://bp-api-docs-v3.redocly.app/schema_10_05_2025/quote_product_period/delete_quote_product_period.md): Delete Quote Product Period