Skip to content

API Reference (1.0)

Billing Platform API

Languages
Servers
Mock server

https://bp-api-docs-v3.redocly.app/_mock/demogm_08_01_2025_schema/

https://my.billingplatform.com/demogm/

Operations

CONTRACT_RATE

CONTRACT_RATE API Reference

Operations
Operations

COUNTRY_CODE_MAP

COUNTRY_CODE_MAP API Reference

Operations
Operations

LABEL_VERSION

LABEL_VERSION API Reference

Operations
Operations
Operations
Operations

PACKAGE_CURRENCY

PACKAGE_CURRENCY API Reference

Operations

PACKAGE_PRODUCT

PACKAGE_PRODUCT API Reference

Operations
Operations
Operations

PRODUCT

Configure the Products in your product catalog

Operations

RATE_CLASS

RATE_CLASS API Reference

Operations

RATE_CLASS_PRODUCT

RATE_CLASS_PRODUCT API Reference

Operations

RATING_METHOD

RATING_METHOD API Reference

Operations

ACCOUNT

Account short help content.

Operations

ACCOUNT_PACKAGE

ACCOUNT_PACKAGE API Reference

Operations

ACCOUNT_PRODUCT

ACCOUNT_PRODUCT API Reference

Operations

ACCOUNT_PRODUCT_QUOTE

ACCOUNT_PRODUCT_QUOTE API Reference

Operations

BILLING_PROFILE

Identifies the billing and invoicing attributes for a given element of the hierarchy

Operations
Operations

CONTRACT_CURRENCY

CONTRACT_CURRENCY API Reference

Operations

CONTRACT_RATE

CONTRACT_RATE API Reference

Operations

COUNTRY_CODE

COUNTRY_CODE API Reference

Operations

COUNTRY_CODE_MAP

COUNTRY_CODE_MAP API Reference

Operations
Operations
Operations

SHARING_GROUP

SHARING_GROUP API Reference

Operations

SHARING_GROUP_RULE

SHARING_GROUP_RULE API Reference

Operations

SHARING_GROUP_USER

SHARING_GROUP_USER API Reference

Operations
Operations
Operations

ACTIVITY_COLLECTOR

ACTIVITY_COLLECTOR API Reference

Operations

BILLING_IDENTIFIER

BILLING_IDENTIFIER API Reference

Operations

COLLECTOR_FIELDS

COLLECTOR_FIELDS API Reference

Operations
Operations

CREDIT_ALLOCATION

CREDIT_ALLOCATION API Reference

Operations

CREDIT_TYPE

CREDIT_TYPE API Reference

Operations

DUNNING_INTERVAL

DUNNING_INTERVAL API Reference

Operations
Operations

INVOICE_TEMPLATE

INVOICE_TEMPLATE API Reference

Operations
Operations
Operations

REFUND_TYPE

REFUND_TYPE API Reference

Operations

TAX_DETAIL

TAX_DETAIL API Reference

Operations

TAX_ENGINE

TAX_ENGINE API Reference

Operations

TAX_ENGINE_AUDIT

TAX_ENGINE_AUDIT API Reference

Operations

ACCOUNT_CONTACT

ACCOUNT_CONTACT API Reference

Operations

CONTACT_TYPE

CONTACT_TYPE API Reference

Operations

CS_ACCOUNT_ACTION

CS_ACCOUNT_ACTION API Reference

Operations
Operations

CS_ACTION_TYPE

CS_ACTION_TYPE API Reference

Operations

CS_STRATEGY

CS_STRATEGY API Reference

Operations

INVOICE_WALLET

INVOICE_WALLET API Reference

Operations

PAYMENT_ALLOCATION

PAYMENT_ALLOCATION API Reference

Operations

PAYMENT_TYPE

PAYMENT_TYPE API Reference

Operations

STATEMENT_TEMPLATE

STATEMENT_TEMPLATE API Reference

Operations

GENERAL_LEDGER_TRANSACTION

GENERAL_LEDGER_TRANSACTION API Reference

Operations

PROCESS_QUEUE_REVENUE_COMMITMENT

PROCESS_QUEUE_REVENUE_COMMITMENT API Reference

Operations

REVREC_CONTRACT

REVREC_CONTRACT API Reference

Operations
Operations

ENTITY_FIELD

ENTITY_FIELD API Reference

Operations

ENTITY_FIELD_ROLE

ENTITY_FIELD_ROLE API Reference

Operations

ENTITY_FIELD_VALUES

ENTITY_FIELD_VALUES API Reference

Operations

QUOTE_DRAFT

QUOTE_DRAFT API Reference

Operations
Operations

Request

Update Quote

Security
JWT
Headers
sessionIdstringrequired
Bodyapplication/json; charset=utf-8required
brmObjectsobject
curl -i -X PUT \
  https://bp-api-docs-v3.redocly.app/_mock/demogm_08_01_2025_schema/rest/2.0/QUOTE \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json; charset=utf-8' \
  -H 'sessionId: string' \
  -d '{
    "brmObjects": {
      "AmendDate": "string",
      "ProductTreeMode": "string",
      "QuoteCategory": "string",
      "SalesforceIsPrimary": 0,
      "Id": "string",
      "QuoteName": "string",
      "AccountId": 0,
      "Created": "string",
      "Updated": "string",
      "CreatedUserId": "string",
      "UpdatedUserId": "string",
      "EmailSentOn": "string",
      "SendQuote": 0,
      "Status": "string",
      "ApprovedBy": "string",
      "FileName": "string",
      "NeedValidate": "string",
      "StartDate": "string",
      "EndDate": "string",
      "SalesforceAccountId": "string",
      "DefaultContractId": 0,
      "QuoteSource": "string",
      "Currency": 0,
      "QuoteDraftId": "string",
      "SourceQuoteId": 0,
      "ParentQuoteId": 0,
      "OnEndDate": "string",
      "QuoteDocTemplateId": 0,
      "OrderId": 0,
      "SalesforceOpportunityId": "string",
      "SalesforceOpportunityUrl": "string",
      "ProductCount": "string",
      "ApprovalRequestId": 0,
      "OriginalQuoteId": 0,
      "SalesforceBPQuoteId": "string",
      "CalculationMode": "string",
      "SalesforcePrimaryOpportunityCount": "string",
      "IsReadyForActivation": 0,
      "ApprovedOn": "string"
    }
  }'

Responses

Successful response with requested data

Bodyapplication/json
retrieveResponseobject
Response
application/json
{ "retrieveResponse": { "AmendDate": "string", "ProductTreeMode": "string", "QuoteCategory": "string", "SalesforceIsPrimary": 0, "Id": "string", "QuoteName": "string", "AccountId": 0, "Created": "string", "Updated": "string", "CreatedUserId": "string", "UpdatedUserId": "string", "EmailSentOn": "string", "SendQuote": 0, "Status": "string", "ApprovedBy": "string", "FileName": "string", "NeedValidate": "string", "StartDate": "string", "EndDate": "string", "SalesforceAccountId": "string", "DefaultContractId": 0, "QuoteSource": "string", "Currency": 0, "QuoteDraftId": "string", "SourceQuoteId": 0, "ParentQuoteId": 0, "OnEndDate": "string", "QuoteDocTemplateId": 0, "OrderId": 0, "SalesforceOpportunityId": "string", "SalesforceOpportunityUrl": "string", "ProductCount": "string", "ApprovalRequestId": 0, "OriginalQuoteId": 0, "SalesforceBPQuoteId": "string", "CalculationMode": "string", "SalesforcePrimaryOpportunityCount": "string", "IsReadyForActivation": 0, "ApprovedOn": "string" } }

Request

Upsert Quote

Security
JWT
Headers
sessionIdstringrequired
Bodyapplication/json; charset=utf-8required
brmObjectsobject
externalIDFieldNamestring
Value"QuoteDraftId"
curl -i -X PATCH \
  https://bp-api-docs-v3.redocly.app/_mock/demogm_08_01_2025_schema/rest/2.0/QUOTE \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json; charset=utf-8' \
  -H 'sessionId: string' \
  -d '{
    "brmObjects": {
      "AmendDate": "string",
      "ProductTreeMode": "string",
      "QuoteCategory": "string",
      "SalesforceIsPrimary": 0,
      "Id": "string",
      "QuoteName": "string",
      "AccountId": 0,
      "Created": "string",
      "Updated": "string",
      "CreatedUserId": "string",
      "UpdatedUserId": "string",
      "EmailSentOn": "string",
      "SendQuote": 0,
      "Status": "string",
      "ApprovedBy": "string",
      "FileName": "string",
      "NeedValidate": "string",
      "StartDate": "string",
      "EndDate": "string",
      "SalesforceAccountId": "string",
      "DefaultContractId": 0,
      "QuoteSource": "string",
      "Currency": 0,
      "QuoteDraftId": "string",
      "SourceQuoteId": 0,
      "ParentQuoteId": 0,
      "OnEndDate": "string",
      "QuoteDocTemplateId": 0,
      "OrderId": 0,
      "SalesforceOpportunityId": "string",
      "SalesforceOpportunityUrl": "string",
      "ProductCount": "string",
      "ApprovalRequestId": 0,
      "OriginalQuoteId": 0,
      "SalesforceBPQuoteId": "string",
      "CalculationMode": "string",
      "SalesforcePrimaryOpportunityCount": "string",
      "IsReadyForActivation": 0,
      "ApprovedOn": "string"
    },
    "externalIDFieldName": "QuoteDraftId"
  }'

Responses

Response with id of updated object

Bodyapplication/json
upsertResponseArray of objects
Response
application/json
{ "upsertResponse": [ { … } ] }

Request

Delete Quote

Security
JWT
Headers
sessionIdstringrequired
Bodyapplication/json; charset=utf-8required
brmObjectsobject
curl -i -X DELETE \
  https://bp-api-docs-v3.redocly.app/_mock/demogm_08_01_2025_schema/rest/2.0/delete/QUOTE \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json; charset=utf-8' \
  -H 'sessionId: string' \
  -d '{
    "brmObjects": {
      "Id": "string"
    }
  }'

Responses

Successful response with requested data

Bodyapplication/json
retrieveResponseobject
Response
application/json
{ "retrieveResponse": { "AmendDate": "string", "ProductTreeMode": "string", "QuoteCategory": "string", "SalesforceIsPrimary": 0, "Id": "string", "QuoteName": "string", "AccountId": 0, "Created": "string", "Updated": "string", "CreatedUserId": "string", "UpdatedUserId": "string", "EmailSentOn": "string", "SendQuote": 0, "Status": "string", "ApprovedBy": "string", "FileName": "string", "NeedValidate": "string", "StartDate": "string", "EndDate": "string", "SalesforceAccountId": "string", "DefaultContractId": 0, "QuoteSource": "string", "Currency": 0, "QuoteDraftId": "string", "SourceQuoteId": 0, "ParentQuoteId": 0, "OnEndDate": "string", "QuoteDocTemplateId": 0, "OrderId": 0, "SalesforceOpportunityId": "string", "SalesforceOpportunityUrl": "string", "ProductCount": "string", "ApprovalRequestId": 0, "OriginalQuoteId": 0, "SalesforceBPQuoteId": "string", "CalculationMode": "string", "SalesforcePrimaryOpportunityCount": "string", "IsReadyForActivation": 0, "ApprovedOn": "string" } }

QUOTE_PRODUCT

QUOTE_PRODUCT API Reference

Operations

QUOTE_PERIOD

QUOTE_PERIOD API Reference

Operations

QUOTE_PRODUCT_PERIOD

QUOTE_PRODUCT_PERIOD API Reference

Operations

TAX_ENGINE

TAX_ENGINE API Reference

Operations
Operations

CONTRACT_RATE

CONTRACT_RATE API Reference

Operations
Operations

COUNTRY_CODE_MAP

COUNTRY_CODE_MAP API Reference

Operations
Operations

LABEL_VERSION

LABEL_VERSION API Reference

Operations
Operations
Operations
Operations

PACKAGE_CURRENCY

PACKAGE_CURRENCY API Reference

Operations

PACKAGE_PRODUCT

PACKAGE_PRODUCT API Reference

Operations
Operations
Operations

PRODUCT

Configure the Products in your product catalog

Operations

RATE_CLASS

RATE_CLASS API Reference

Operations

RATE_CLASS_PRODUCT

RATE_CLASS_PRODUCT API Reference

Operations

RATING_METHOD

RATING_METHOD API Reference

Operations

ACCOUNT

Account short help content.

Operations

ACCOUNT_PACKAGE

ACCOUNT_PACKAGE API Reference

Operations

ACCOUNT_PRODUCT

ACCOUNT_PRODUCT API Reference

Operations

ACCOUNT_PRODUCT_QUOTE

ACCOUNT_PRODUCT_QUOTE API Reference

Operations

BILLING_PROFILE

Identifies the billing and invoicing attributes for a given element of the hierarchy

Operations
Operations

CONTRACT_CURRENCY

CONTRACT_CURRENCY API Reference

Operations

CONTRACT_RATE

CONTRACT_RATE API Reference

Operations

COUNTRY_CODE

COUNTRY_CODE API Reference

Operations

COUNTRY_CODE_MAP

COUNTRY_CODE_MAP API Reference

Operations
Operations
Operations

SHARING_GROUP

SHARING_GROUP API Reference

Operations

SHARING_GROUP_RULE

SHARING_GROUP_RULE API Reference

Operations

SHARING_GROUP_USER

SHARING_GROUP_USER API Reference

Operations
Operations
Operations

ACTIVITY_COLLECTOR

ACTIVITY_COLLECTOR API Reference

Operations

BILLING_IDENTIFIER

BILLING_IDENTIFIER API Reference

Operations

COLLECTOR_FIELDS

COLLECTOR_FIELDS API Reference

Operations
Operations

CREDIT_ALLOCATION

CREDIT_ALLOCATION API Reference

Operations

CREDIT_TYPE

CREDIT_TYPE API Reference

Operations

DUNNING_INTERVAL

DUNNING_INTERVAL API Reference

Operations
Operations

INVOICE_TEMPLATE

INVOICE_TEMPLATE API Reference

Operations
Operations
Operations

REFUND_TYPE

REFUND_TYPE API Reference

Operations

TAX_DETAIL

TAX_DETAIL API Reference

Operations

TAX_ENGINE

TAX_ENGINE API Reference

Operations

TAX_ENGINE_AUDIT

TAX_ENGINE_AUDIT API Reference

Operations

ACCOUNT_CONTACT

ACCOUNT_CONTACT API Reference

Operations

CONTACT_TYPE

CONTACT_TYPE API Reference

Operations

CS_ACCOUNT_ACTION

CS_ACCOUNT_ACTION API Reference

Operations
Operations

CS_ACTION_TYPE

CS_ACTION_TYPE API Reference

Operations

CS_STRATEGY

CS_STRATEGY API Reference

Operations

INVOICE_WALLET

INVOICE_WALLET API Reference

Operations

PAYMENT_ALLOCATION

PAYMENT_ALLOCATION API Reference

Operations

PAYMENT_TYPE

PAYMENT_TYPE API Reference

Operations

STATEMENT_TEMPLATE

STATEMENT_TEMPLATE API Reference

Operations

GENERAL_LEDGER_TRANSACTION

GENERAL_LEDGER_TRANSACTION API Reference

Operations

PROCESS_QUEUE_REVENUE_COMMITMENT

PROCESS_QUEUE_REVENUE_COMMITMENT API Reference

Operations

REVREC_CONTRACT

REVREC_CONTRACT API Reference

Operations
Operations

ENTITY_FIELD

ENTITY_FIELD API Reference

Operations

ENTITY_FIELD_ROLE

ENTITY_FIELD_ROLE API Reference

Operations

ENTITY_FIELD_VALUES

ENTITY_FIELD_VALUES API Reference

Operations

QUOTE_DRAFT

QUOTE_DRAFT API Reference

Operations
Operations

Request

Update Quote

Security
JWT
Headers
sessionIdstringrequired
Bodyapplication/json; charset=utf-8required
brmObjectsobject
curl -i -X PUT \
  https://bp-api-docs-v3.redocly.app/_mock/demogm_08_01_2025_schema/rest/2.0/QUOTE \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json; charset=utf-8' \
  -H 'sessionId: string' \
  -d '{
    "brmObjects": {
      "AmendDate": "string",
      "ProductTreeMode": "string",
      "QuoteCategory": "string",
      "SalesforceIsPrimary": 0,
      "Id": "string",
      "QuoteName": "string",
      "AccountId": 0,
      "Created": "string",
      "Updated": "string",
      "CreatedUserId": "string",
      "UpdatedUserId": "string",
      "EmailSentOn": "string",
      "SendQuote": 0,
      "Status": "string",
      "ApprovedBy": "string",
      "FileName": "string",
      "NeedValidate": "string",
      "StartDate": "string",
      "EndDate": "string",
      "SalesforceAccountId": "string",
      "DefaultContractId": 0,
      "QuoteSource": "string",
      "Currency": 0,
      "QuoteDraftId": "string",
      "SourceQuoteId": 0,
      "ParentQuoteId": 0,
      "OnEndDate": "string",
      "QuoteDocTemplateId": 0,
      "OrderId": 0,
      "SalesforceOpportunityId": "string",
      "SalesforceOpportunityUrl": "string",
      "ProductCount": "string",
      "ApprovalRequestId": 0,
      "OriginalQuoteId": 0,
      "SalesforceBPQuoteId": "string",
      "CalculationMode": "string",
      "SalesforcePrimaryOpportunityCount": "string",
      "IsReadyForActivation": 0,
      "ApprovedOn": "string"
    }
  }'

Responses

Successful response with requested data

Bodyapplication/json
retrieveResponseobject
Response
application/json
{ "retrieveResponse": { "AmendDate": "string", "ProductTreeMode": "string", "QuoteCategory": "string", "SalesforceIsPrimary": 0, "Id": "string", "QuoteName": "string", "AccountId": 0, "Created": "string", "Updated": "string", "CreatedUserId": "string", "UpdatedUserId": "string", "EmailSentOn": "string", "SendQuote": 0, "Status": "string", "ApprovedBy": "string", "FileName": "string", "NeedValidate": "string", "StartDate": "string", "EndDate": "string", "SalesforceAccountId": "string", "DefaultContractId": 0, "QuoteSource": "string", "Currency": 0, "QuoteDraftId": "string", "SourceQuoteId": 0, "ParentQuoteId": 0, "OnEndDate": "string", "QuoteDocTemplateId": 0, "OrderId": 0, "SalesforceOpportunityId": "string", "SalesforceOpportunityUrl": "string", "ProductCount": "string", "ApprovalRequestId": 0, "OriginalQuoteId": 0, "SalesforceBPQuoteId": "string", "CalculationMode": "string", "SalesforcePrimaryOpportunityCount": "string", "IsReadyForActivation": 0, "ApprovedOn": "string" } }

Request

Upsert Quote

Security
JWT
Headers
sessionIdstringrequired
Bodyapplication/json; charset=utf-8required
brmObjectsobject
externalIDFieldNamestring
Value"QuoteDraftId"
curl -i -X PATCH \
  https://bp-api-docs-v3.redocly.app/_mock/demogm_08_01_2025_schema/rest/2.0/QUOTE \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json; charset=utf-8' \
  -H 'sessionId: string' \
  -d '{
    "brmObjects": {
      "AmendDate": "string",
      "ProductTreeMode": "string",
      "QuoteCategory": "string",
      "SalesforceIsPrimary": 0,
      "Id": "string",
      "QuoteName": "string",
      "AccountId": 0,
      "Created": "string",
      "Updated": "string",
      "CreatedUserId": "string",
      "UpdatedUserId": "string",
      "EmailSentOn": "string",
      "SendQuote": 0,
      "Status": "string",
      "ApprovedBy": "string",
      "FileName": "string",
      "NeedValidate": "string",
      "StartDate": "string",
      "EndDate": "string",
      "SalesforceAccountId": "string",
      "DefaultContractId": 0,
      "QuoteSource": "string",
      "Currency": 0,
      "QuoteDraftId": "string",
      "SourceQuoteId": 0,
      "ParentQuoteId": 0,
      "OnEndDate": "string",
      "QuoteDocTemplateId": 0,
      "OrderId": 0,
      "SalesforceOpportunityId": "string",
      "SalesforceOpportunityUrl": "string",
      "ProductCount": "string",
      "ApprovalRequestId": 0,
      "OriginalQuoteId": 0,
      "SalesforceBPQuoteId": "string",
      "CalculationMode": "string",
      "SalesforcePrimaryOpportunityCount": "string",
      "IsReadyForActivation": 0,
      "ApprovedOn": "string"
    },
    "externalIDFieldName": "QuoteDraftId"
  }'

Responses

Response with id of updated object

Bodyapplication/json
upsertResponseArray of objects
Response
application/json
{ "upsertResponse": [ { … } ] }

Request

Delete Quote

Security
JWT
Headers
sessionIdstringrequired
Bodyapplication/json; charset=utf-8required
brmObjectsobject
curl -i -X DELETE \
  https://bp-api-docs-v3.redocly.app/_mock/demogm_08_01_2025_schema/rest/2.0/delete/QUOTE \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json; charset=utf-8' \
  -H 'sessionId: string' \
  -d '{
    "brmObjects": {
      "Id": "string"
    }
  }'

Responses

Successful response with requested data

Bodyapplication/json
retrieveResponseobject
Response
application/json
{ "retrieveResponse": { "AmendDate": "string", "ProductTreeMode": "string", "QuoteCategory": "string", "SalesforceIsPrimary": 0, "Id": "string", "QuoteName": "string", "AccountId": 0, "Created": "string", "Updated": "string", "CreatedUserId": "string", "UpdatedUserId": "string", "EmailSentOn": "string", "SendQuote": 0, "Status": "string", "ApprovedBy": "string", "FileName": "string", "NeedValidate": "string", "StartDate": "string", "EndDate": "string", "SalesforceAccountId": "string", "DefaultContractId": 0, "QuoteSource": "string", "Currency": 0, "QuoteDraftId": "string", "SourceQuoteId": 0, "ParentQuoteId": 0, "OnEndDate": "string", "QuoteDocTemplateId": 0, "OrderId": 0, "SalesforceOpportunityId": "string", "SalesforceOpportunityUrl": "string", "ProductCount": "string", "ApprovalRequestId": 0, "OriginalQuoteId": 0, "SalesforceBPQuoteId": "string", "CalculationMode": "string", "SalesforcePrimaryOpportunityCount": "string", "IsReadyForActivation": 0, "ApprovedOn": "string" } }

QUOTE_PRODUCT

QUOTE_PRODUCT API Reference

Operations

QUOTE_PERIOD

QUOTE_PERIOD API Reference

Operations

QUOTE_PRODUCT_PERIOD

QUOTE_PRODUCT_PERIOD API Reference

Operations

TAX_ENGINE

TAX_ENGINE API Reference

Operations