Billing Platform API
CONTRACT API Reference
CONTRACT_RATE API Reference
COUNTRY API Reference
COUNTRY_CODE_MAP API Reference
LABEL_VERSION API Reference
LANGUAGE API Reference
PACKAGE API Reference
PACKAGE_CURRENCY API Reference
PACKAGE_PRODUCT API Reference
PRICING API Reference
Configure the Products in your product catalog
RATE_CLASS API Reference
RATE_CLASS_PRODUCT API Reference
RATING_METHOD API Reference
Account short help
ACCOUNT_PACKAGE API Reference
ACCOUNT_PRODUCT API Reference
ACCOUNT_PRODUCT_QUOTE API Reference
Identifies the billing and invoicing attributes for a given element of the hierarchy
CONTRACT_CURRENCY API Reference
COUNTRY_CODE API Reference
CURRENCY API Reference
SHARING_GROUP API Reference
SHARING_GROUP_RULE API Reference
SHARING_GROUP_USER API Reference
TIME_ZONE API Reference
ACTIVITY API Reference
ACTIVITY_COLLECTOR API Reference
BILLING_IDENTIFIER API Reference
COLLECTOR_FIELDS API Reference
CREDIT API Reference
CREDIT_ALLOCATION API Reference
CREDIT_TYPE API Reference
DUNNING_INTERVAL API Reference
INVOICE API Reference
INVOICE_TEMPLATE API Reference
PAYMENT API Reference
REFUND API Reference
REFUND_TYPE API Reference
TAX_DETAIL API Reference
TAX_ENGINE API Reference
TAX_ENGINE_AUDIT API Reference
ACCOUNT_CONTACT API Reference
CONTACT_TYPE API Reference
CS_ACCOUNT_ACTION API Reference
CS_ACTION API Reference
CS_ACTION_TYPE API Reference
CS_STRATEGY API Reference
INVOICE_WALLET API Reference
PAYMENT_ALLOCATION API Reference
PAYMENT_TYPE API Reference
STATEMENT_TEMPLATE API Reference
GENERAL_LEDGER_TRANSACTION API Reference
PROCESS_QUEUE_REVENUE_COMMITMENT API Reference
REVREC_CONTRACT API Reference
ENTITY API Reference
ENTITY_FIELD API Reference
ENTITY_FIELD_ROLE API Reference
ENTITY_FIELD_VALUES API Reference
QUOTE_DRAFT API Reference
QUOTE API Reference
QUOTE_PRODUCT API Reference
QUOTE_PERIOD API Reference
QUOTE_PRODUCT_PERIOD API Reference
ACCOUNTING_DASHBOARD API Reference
ACCOUNTING_PERIOD API Reference
ACCOUNTING_PERIOD_HISTORY API Reference
ACCOUNTING_QUICK_LINK API Reference
ACCOUNT_ORDER API Reference
ACCOUNT_PACKAGE_PRODUCT API Reference
ACCOUNT_PRICING_CURRENCY API Reference
ACCOUNT_PRODUCT_RELATION API Reference
ACCOUNT_PRODUCT_VERSION API Reference
ACCOUNT_PRODUCT_VERSION_ITEM API Reference
ACCOUNT_PRODUCT_VERSION_REPORT API Reference
ACCOUNT_TAX_EXEMPTION API Reference
ACCOUNT_TRANSACTION_LEDGER API Reference
ACCOUNT_TYPE API Reference
ACCUMULATOR_VALUE_DETAILS API Reference
ACCUMULATOR_VALUE_INVOICE API Reference
ACTIVITY_COLLECTOR_HISTORY API Reference
ADHOC_SCHEDULED_REPORT API Reference
ADJUSTMENT API Reference
ALERT API Reference
ALERT_BATCH_QUEUE API Reference
ALERT_GROUP API Reference
ALERT_TYPE API Reference
APPLICATION_USER API Reference
APPROVAL_HISTORY API Reference
APPROVAL_HISTORY_DETAIL API Reference
APPROVAL_REQUEST API Reference
APPROVAL_REQUEST_DETAIL API Reference
AVALARA_REQUEST API Reference
BILLING_ACTIVITY_DISCOUNT API Reference
BILLING_ACTIVITY_FORMULA API Reference
BILLING_ACTIVITY_TAX API Reference
BILLING_PROFILE_LEDGER API Reference
BILLSOFT_TAX_TYPE API Reference
BPPAY_REPORT API Reference
BP_METRICS API Reference
BP_METRICS_LOG API Reference
BULK_API_REQUEST API Reference
BULK_APPROVE_REJECT_CREDITS API Reference
BULK_DATA_LOADER API Reference
BULK_RERATE_INVOICES API Reference
BULK_RESPONSE API Reference
BULK_UPLOAD_HISTORY API Reference
BUNDLE API Reference
BUNDLE_CONFIGURATION API Reference
BUNDLE_CONTENT API Reference
BUNDLE_LOG API Reference
CHARGE_ESTIMATION_RUN_HISTORY API Reference
COLLECTOR_AGGREGATE_FIELD API Reference
COLLECTOR_CRITERIA_FIELD API Reference
COLLECTOR_EXT_ENTITY_FIELD API Reference
COLLECTOR_FIELD_MAPPING API Reference
COLLECTOR_LOAD_STATUS API Reference
COLLECTOR_RERATE_FIELD API Reference
COLLECTOR_ROLLBACK_QUEUE API Reference
COLLECTOR_UPLOAD_PROGRESS API Reference
COMMITMENT_INCLUSION_CRITERIA API Reference
COMMITMENT_SCOPE API Reference
COMPANY_PROFILE API Reference
CONDITION API Reference
CONDITION_GROUP_MEMBER API Reference
CREDIT_LINE_ITEM API Reference
CREDIT_TAX_DETAIL API Reference
CS_ACCOUNT API Reference
CS_ACCOUNT_BALANCES API Reference
CS_EMAIL_ATTACHMENT API Reference
CS_MODULE_CONFIGURATION API Reference
CS_PTP API Reference
CS_PTP_INVOICE API Reference
CS_PTP_PAYMENT API Reference
CS_SUMMARY API Reference
CUSTOMER_AUTO_PAYMENT API Reference
CUSTOMER_BILLING_PROFILE API Reference
CUSTOM_FIELD_LABEL_VERSION API Reference
CUSTOM_FUNCTION API Reference
CUSTOM_REPORT API Reference
CUSTOM_REPORT_FIELD API Reference
CUSTOM_REPORT_FILTER API Reference
CUSTOM_REPORT_LABEL_VERSION API Reference
DATA_SOURCE API Reference
DISCOUNT_ELIG_FILTER API Reference
DISCOUNT_TARGET_FILTER API Reference
DOCGEN_QUEUE API Reference
DOCUMENT_STORAGE API Reference
DOCUMENT_TEMPLATE API Reference
DOCUMENT_TEMPLATE_QUERY API Reference
DUNNING_INTERVAL_EMAIL API Reference
ECOM_TRANSACTION API Reference
ECOM_TRANSACTION_REQUEST_FIELD API Reference
ECOM_TRANSACTION_RESPONSE API Reference
ECOM_TRANSACTION_RESP_FIELD API Reference
EFILE API Reference
EFILE_EVENT API Reference
EFILE_EVENT_CONTENT API Reference
EFILE_FORMAT_FIELDS API Reference
EFILE_TEMPLATE API Reference
EINVOICE_COUNTRY API Reference
EINVOICE_DOCUMENT_TYPE API Reference
EINVOICE_FORMAT API Reference
EINVOICE_NETWORK API Reference
EINVOICE_PROFILE API Reference
EINVOICE_XML_ENGINE API Reference
EMAIL_TEMPLATE API Reference
EMAIL_TEMPLATE_TYPE API Reference
ENTITY_DOMAIN_ROLE API Reference
ENTITY_FIELD_ADDITION_ATTR API Reference
ENTITY_FIELD_CASCADE API Reference
ENTITY_FIELD_INPUT_ROLE API Reference
ENTITY_FIELD_PICK_LIST API Reference
ENTITY_LAYOUT API Reference
ENTITY_LAYOUT_CONFIGURATION API Reference
ENTITY_LAYOUT_CONFIGURATION_FIELD API Reference
ENTITY_LAYOUT_CONFIGURATION_GROUP API Reference
ENTITY_LAYOUT_FIELD API Reference
ENTITY_LAYOUT_FILTER API Reference
ENTITY_VALIDATION API Reference
ENTITY_VIEW_FILTER_MET API Reference
ENTITY_WIDGET API Reference
ENTITY_WIDGET_ROLE API Reference
ENTITY_WIDGET_RULE_MET API Reference
EVENT_GROUP API Reference
EVENT_INVOICE_CYCLE API Reference
EXCHANGE_RATE API Reference
EXTENSION_WIDGET API Reference
EXTENSION_WIDGET_ROLE API Reference
EXTERNAL_USER API Reference
EXTERNAL_USER_ACCOUNT API Reference
FINANCIAL_ACCOUNT API Reference
FINANCIAL_ACCOUNT_CATEGORY API Reference
FINANCIAL_CRITERIA API Reference
FINANCIAL_CRITERIA_ATTR API Reference
FINANCIAL_CRITERIA_RULE API Reference
FINANCIAL_PERIOD API Reference
FINANCIAL_PERIOD_CONFIGURATION API Reference
FINANCIAL_PERIOD_INVOICE API Reference
FINANCIAL_QUEUE API Reference
FINANCIAL_QUEUE_ALERT API Reference
FORMULA_GROUP_IDENTIFIER API Reference
FORMULA_INVOICING_FILTER API Reference
FTP_DATA_SOURCE API Reference
FTP_QUEUE_EVENT API Reference
GENERAL_LEDGER_VOIDED_INVOICE API Reference
HISTORY_QUEUE API Reference
HISTORY_SALESFORCE_SYNC API Reference
HTTP_EVENT API Reference
INVOICE_BATCH_HISTORY API Reference
INVOICE_CLOSE_SET API Reference
INVOICE_CYCLE_CONFIG API Reference
INVOICE_DELIVERY_HISTORY API Reference
INVOICE_DETAIL API Reference
Mid-Invoice Cycle Charge Estimation
INVOICE_GROUP API Reference
INVOICE_GROUP_CONDITION API Reference
INVOICE_GROUP_DETAIL API Reference
INVOICE_MANAGEMENT API Reference
INVOICE_MERGE API Reference
INVOICE_MERGE_ACTIVITY API Reference
INVOICE_MERGE_DETAIL API Reference
INVOICE_PAYMENT_ADDRESS API Reference
INVOICE_PDF API Reference
INVOICE_PENDING_CHARGE API Reference
INVOICE_TEMPLATE_FIELDS API Reference
INVOICE_XSL API Reference
INVOICING_SUMMARY API Reference
LANGUAGE_BROWSER API Reference
LEDGER API Reference
LINKED_OVERAGE_COMPONENT API Reference
LOCKBOX_CONFIGURATION API Reference
LOCKBOX_INVOICE_ALLOCATION API Reference
LOCKBOX_MATCHING_RULE API Reference
LOCKBOX_MATCHING_RULE_MET API Reference
LOCKBOX_RECORD API Reference
LOCKBOX_UPLOAD_HISTORY API Reference
MDL_EVENT API Reference
MDL_RECONCILIATION_RUN API Reference
MDL_RECONCILIATION_RUN_RESULTS API Reference
MDL_ROLLBACK_FAILURE API Reference
MFA_INFORMATION API Reference
MICROSOFT_DYNAMICS_CONNECTOR API Reference
MICROSOFT_DYNAMICS_JOB_FIELD API Reference
MICROSOFT_DYNAMICS_JOB_FILTER API Reference
MICROSOFT_DYNAMICS_JOB_RUN_HISTORY API Reference
MICROSOFT_DYNAMICS_MAPPING API Reference
MICROSOFT_DYNAMICS_SYNC_JOB API Reference
MICROSOFT_DYNAMICS_UPSERT_FIELD API Reference
MIN_MAX_CHARGE API Reference
NATURAL_LANGUAGE_REPORT API Reference
ORDERS API Reference
ORDER_HISTORY API Reference
ORDER_LINE_ITEM API Reference
ORDER_STATUS API Reference
ORG_COMPARISON_BUNDLE API Reference
ORG_COMPARISON_INSTANCE API Reference
ORG_COMPARISON_ITEM API Reference
ORG_COMPARISON_ITEM_FILE API Reference
ORG_COMPARISON_ITEM_RESULT API Reference
PACKAGE_COMPONENT_HIER API Reference
PACKAGE_PACKAGE_relation API Reference
PACKAGE_PRODUCT_USAGE_IDENTIFIER_relation API Reference
PAGE_WIDGET API Reference
PAGE_WIDGET_ROLE API Reference
PARENT_ACCOUNT API Reference
PAYMENTS_GATEWAY_LOGS API Reference
PAYMENTS_REFUNDS API Reference
PAYMENT_ALLOCATION_MAPPING API Reference
PAYMENT_CHARGEBACK API Reference
PAYMENT_CHARGEBACK_FILE API Reference
PAYMENT_GATEWAY API Reference
PAYMENT_GATEWAY_DATA API Reference
PAYMENT_GATEWAY_FIELD API Reference
PAYMENT_GATEWAY_PROFILE API Reference
PAYMENT_GATEWAY_PROFILE_FIELD API Reference
PAYMENT_GATEWAY_PROFILE_RULE API Reference
PAYMENT_REPROCESS API Reference
PAYMENT_RETRY_SCHEDULE API Reference
PAYMENT_TRANSACTION_FEE API Reference
PAYOUT API Reference
PAYOUT_DETAIL API Reference
PERIOD_CLOSE_TASK API Reference
PERIOD_CLOSE_TASK_FILTER API Reference
PERIOD_CLOSE_TASK_STATUS API Reference
PRICING_ATTRIBUTE API Reference
PRICING_DRAFT API Reference
PRICING_DRAFT_CALC_DETAIL API Reference
PRICING_DRAFT_RULE_EXCLUDE API Reference
PRICING_FORMULA API Reference
PRICING_PLAN API Reference
PROCESS_CONSOLE API Reference
PROCESS_METRIC_HISTORY API Reference
PROCESS_METRIC_LOG API Reference
PROCESS_METRIC_POINT API Reference
PROCESS_QUEUE_ACCOUNT_PRODUCT_VERSION API Reference
PROCESS_QUEUE_ADHOC_REPORT API Reference
PROCESS_QUEUE_ALERT API Reference
PROCESS_QUEUE_BULK_REQUEST API Reference
PROCESS_QUEUE_BULK_UPLOAD API Reference
PROCESS_QUEUE_COLLECTOR_LOAD API Reference
PROCESS_QUEUE_CREDIT_CARD_REQUEST API Reference
PROCESS_QUEUE_CS_ACCOUNT API Reference
PROCESS_QUEUE_CS_ACCOUNT_ACTION API Reference
PROCESS_QUEUE_DUNNING API Reference
PROCESS_QUEUE_EFILE API Reference
PROCESS_QUEUE_EINVOICE API Reference
PROCESS_QUEUE_EMAIL API Reference
PROCESS_QUEUE_EMPTY_RECYCLE_BIN API Reference
PROCESS_QUEUE_FINANCIAL API Reference
PROCESS_QUEUE_FORMULA_CALC API Reference
PROCESS_QUEUE_FTP API Reference
PROCESS_QUEUE_FTP_DATA API Reference
PROCESS_QUEUE_INVOICE_CLOSE API Reference
PROCESS_QUEUE_INVOICE_ESTIMATE API Reference
PROCESS_QUEUE_INVOICE_FINISH_CLOSE API Reference
PROCESS_QUEUE_INVOICE_GEN API Reference
PROCESS_QUEUE_INVOICE_PDF API Reference
PROCESS_QUEUE_INVOICE_POST_RATING API Reference
PROCESS_QUEUE_INVOICE_REOPEN API Reference
PROCESS_QUEUE_LATE_FEE API Reference
PROCESS_QUEUE_LOCKBOX_UPLOAD API Reference
PROCESS_QUEUE_MAPPING API Reference
PROCESS_QUEUE_ONE_TIME_CHARGE API Reference
PROCESS_QUEUE_ORG_COMPARISON_INSTANCE API Reference
PROCESS_QUEUE_POST_RATING API Reference
PROCESS_QUEUE_RATE_LOAD API Reference
PROCESS_QUEUE_RATING API Reference
PROCESS_QUEUE_RECYCLE_BIN API Reference
PROCESS_QUEUE_REPORT_RUNTIME_CHECK API Reference
PROCESS_QUEUE_REPROCESS API Reference
PROCESS_QUEUE_RETRY_PAYMENT API Reference
PROCESS_QUEUE_ROLLBACK API Reference
PROCESS_QUEUE_SCHEDULER_REPORT API Reference
PROCESS_QUEUE_STATEMENT_GENERATION API Reference
PROCESS_QUEUE_SUBSCRIPTION API Reference
PROCESS_QUEUE_SUBSCRIPTION_PAUSE API Reference
PROCESS_QUEUE_TAX API Reference
PROCESS_QUEUE_UDP API Reference
PROCESS_QUEUE_WORKFLOW API Reference
PROCESS_SERVICE_MAINTENANCE API Reference
PRODUCT_ACCUMULATOR_VALUE API Reference
PRODUCT_RELATIONSHIPS API Reference
PRODUCT_USAGE_IDENTIFIER API Reference
QUANTITY_HISTORY API Reference
QUERY_API_REQUEST API Reference
QUEUE API Reference
QUEUE_EVENT API Reference
QUOTE_AVAILABLE_PRODUCT API Reference
QUOTE_DELIVERY_HISTORY API Reference
QUOTE_OVERAGE_PRODUCT API Reference
QUOTE_OVERAGE_PRODUCT_PERIOD API Reference
QUOTE_PERIOD_DRAFT API Reference
QUOTE_PERIOD_TEMPLATE API Reference
QUOTE_PRODUCT_DRAFT API Reference
QUOTE_PRODUCT_PERIOD_DRAFT API Reference
QUOTE_PRODUCT_SECTION API Reference
QUOTE_RELATIONSHIP_GROUP API Reference
QUOTE_RULE API Reference
QUOTE_RULES API Reference
QUOTE_RULE_AGGREGATE_CONDITION API Reference
QUOTE_RULE_CONDITION API Reference
RATE_CLASS_CURRENCY API Reference
RATING_METHOD_FIELD_OVERRIDE API Reference
RATING_METHOD_TYPE API Reference
RATING_QUEUE API Reference
RECYCLE_BIN API Reference
REGIONAL_SETTINGS API Reference
REPROCESS_QUEUE API Reference
REVREC_CONTRACT_EVENT API Reference
REVREC_CONTRACT_PREVIEW API Reference
REVREC_CONTRACT_PRODUCT API Reference
REVREC_CONTRACT_PRODUCT_EVENT API Reference
REVREC_CONTRACT_PRODUCT_PREVIEW API Reference
REVREC_MODULE_CONFIGURATION API Reference
REVREC_PERFORMANCE_OBLIGATION API Reference
REVREC_UPDATE_RULE API Reference
REVREC_UPDATE_RULE_MET API Reference
ROLE API Reference
SALESFORCE_SYNC API Reference
SALESFORCE_SYNC_CONF API Reference
SALESFORCE_SYNC_CONFIG API Reference
SALESFORCE_SYNC_JOB API Reference
SALESFORCE_SYNC_JOB_ATTACHMENT API Reference
SALESFORCE_SYNC_JOB_FIELD API Reference
SALESFORCE_SYNC_JOB_LOG API Reference
SALESFORCE_SYNC_JOB_MET API Reference
SALESFORCE_SYNC_JOB_SET API Reference
SALESFORCE_SYNC_JOB_SET_ITEM API Reference
SALESFORCE_SYNC_OBJECT API Reference
SCHEDULER_HOLIDAYS API Reference
SCHEDULER_HOLIDAY_GROUPS API Reference
SCHEDULER_JOB API Reference
SCHEDULER_JOB_EVENT API Reference
SCHEDULER_JOB_LOG API Reference
SCHEDULER_SETUP_EMAIL_OVERRIDE API Reference
SERVICE_PROVIDER API Reference
SHARING_GROUP_RULE_VALUE API Reference
SHARING_GROUP_SQL API Reference
SSO Setup
SINGLE_SIGN_ON_ATTRIBUTES API Reference
SMTP_EVENT API Reference
SMTP_RELAY_CONFIG API Reference
SMTP_RELAY_HEADER API Reference
SSO_URL_WHITELIST API Reference
SSP_PROFILE API Reference
SSP_PROFILE_ITEM API Reference
STANDARD_RATE_LOADER API Reference
STANDARD_RATE_LOADER_FIELD API Reference
STANDARD_RATE_LOADER_HISTORY API Reference
STATEMENT API Reference
STATEMENT_GROUP API Reference
STATEMENT_GROUP_FILTER API Reference
STATEMENT_INVOICE API Reference
STATEMENT_TRANSACTION API Reference
SUBSCRIPTION API Reference
SUBSCRIPTION_HISTORY API Reference
SUBSCRIPTION_PAUSE_RECORD API Reference
SUPPORT_USERS API Reference
SURCHARGE_CONFIG API Reference
SURETAX_NPA_NXX_TO_GEO_CODE API Reference
SURETAX_TRANS_TYPE_CODE API Reference
SURETAX_TRANS_TYPE_CODE_MAP API Reference
SURETAX_ZIP_CODE_TO_GEO_CODE API Reference
SYSTEM_USAGE_METRIC API Reference
SYSTEM_USAGE_METRICS API Reference
TAX_ENGINE_FIELD API Reference
TAX_ENGINE_TRANSLATION_LOGIC API Reference
TAX_ENGINE_TRANSL_LOGIC_FIELD API Reference
TAX_ENGINE_TYPE API Reference
TAX_EXEMPTION_CODE API Reference
TAX_PRODUCT API Reference
TAX_TYPE API Reference
TREE_MENU API Reference
Get Tree Menu By Id
Id of the record
curl -i -X GET \ 'https://bp-api-docs-v3.redocly.app/_mock/demogm_03_06_2025_schema_edited/rest/2.0/TREE_MENU/{id}' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'sessionId: string'
Successful response with requested data
{ "retrieveResponse": { "Id": "string", "ParentNodeId": 0, "NodeName": "string" } }
Get record(s) using filters
SQL Where part
curl -i -X GET \ 'https://bp-api-docs-v3.redocly.app/_mock/demogm_03_06_2025_schema_edited/rest/2.0/TREE_MENU?queryAnsiSql=string' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'sessionId: string'
Save Tree Menu
curl -i -X POST \ https://bp-api-docs-v3.redocly.app/_mock/demogm_03_06_2025_schema_edited/rest/2.0/TREE_MENU \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'Content-Type: application/json; charset=utf-8' \ -H 'sessionId: string' \ -d '{ "brmObjects": { "Id": "string", "ParentNodeId": 0, "NodeName": "string" } }'
USAGE_IDENTIFIER API Reference
USAGE_MAPPING_VIEW API Reference
USER API Reference
USER_ALERT_SIGNUP API Reference
USER_HELP_LINK API Reference
WALLET API Reference
WALLET_GATEWAY_DATA API Reference
WEB_REQUEST_LOG API Reference
WIDGET API Reference
WORKFLOW_ACTION API Reference
WORKFLOW_ACTION_ATTACHMENTS API Reference
WORKFLOW_ACTION_HTTP_HEAD API Reference
WORKFLOW_ACTION_HTTP_RESP API Reference
WORKFLOW_ACTION_LOG API Reference
WORKFLOW_ACTION_MET API Reference
WORKFLOW_DEPENDENCE API Reference
WORKFLOW_RULE API Reference
WORKFLOW_RULE_MET API Reference