API Reference (1.0)
Billing Platform API
Download OpenAPI description
Overview
Languages
Servers
Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/
https://my.billingplatform.com/demogm/
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/QUOTE/{id}
https://my.billingplatform.com/demogm/rest/2.0/QUOTE/{id}
- cURL
- JS
- Go
- Ruby
- Java 8
curl -i -X GET \
'https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/QUOTE/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'sessionId: string'Response
application/json
{ "retrieveResponse": { "AccountId": null, "AmendDate": null, "ApprovalRequestId": null, "ApprovedBy": null, "ApprovedOn": null, "CalculationMode": null, "Created": null, "CreatedUserId": null, "Currency": null, "DefaultContractId": null, "EmailSentOn": null, "EndDate": null, "FileName": null, "Id": null, "IsReadyForActivation": null, "NeedValidate": null, "OnEndDate": null, "OrderId": null, "OriginalQuoteId": null, "ParentQuoteId": null, "ProductCount": null, "ProductTreeMode": null, "QuoteCategory": null, "QuoteDocTemplateId": null, "QuoteDraftId": null, "QuoteName": null, "QuoteSource": null, "SalesforceAccountId": null, "SalesforceBPQuoteId": null, "SalesforceIsPrimary": null, "SalesforceOpportunityId": null, "SalesforceOpportunityUrl": null, "SalesforcePrimaryOpportunityCount": null, "SendQuote": null, "SourceQuoteId": null, "StartDate": null, "Status": null, "Updated": null, "UpdatedUserId": null } }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/QUOTE
https://my.billingplatform.com/demogm/rest/2.0/QUOTE
- cURL
- JS
- Go
- Ruby
- Java 8
curl -i -X GET \
'https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/QUOTE?queryAnsiSql=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'sessionId: string'Response
application/json
{ "retrieveResponse": { "AccountId": null, "AmendDate": null, "ApprovalRequestId": null, "ApprovedBy": null, "ApprovedOn": null, "CalculationMode": null, "Created": null, "CreatedUserId": null, "Currency": null, "DefaultContractId": null, "EmailSentOn": null, "EndDate": null, "FileName": null, "Id": null, "IsReadyForActivation": null, "NeedValidate": null, "OnEndDate": null, "OrderId": null, "OriginalQuoteId": null, "ParentQuoteId": null, "ProductCount": null, "ProductTreeMode": null, "QuoteCategory": null, "QuoteDocTemplateId": null, "QuoteDraftId": null, "QuoteName": null, "QuoteSource": null, "SalesforceAccountId": null, "SalesforceBPQuoteId": null, "SalesforceIsPrimary": null, "SalesforceOpportunityId": null, "SalesforceOpportunityUrl": null, "SalesforcePrimaryOpportunityCount": null, "SendQuote": null, "SourceQuoteId": null, "StartDate": null, "Status": null, "Updated": null, "UpdatedUserId": null } }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/QUOTE
https://my.billingplatform.com/demogm/rest/2.0/QUOTE
- cURL
- JS
- Go
- Ruby
- Java 8
curl -i -X PUT \
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/QUOTE \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"AccountId": null,
"AmendDate": null,
"ApprovalRequestId": null,
"ApprovedBy": null,
"ApprovedOn": null,
"CalculationMode": null,
"Created": null,
"CreatedUserId": null,
"Currency": null,
"DefaultContractId": null,
"EmailSentOn": null,
"EndDate": null,
"FileName": null,
"Id": null,
"IsReadyForActivation": null,
"NeedValidate": null,
"OnEndDate": null,
"OrderId": null,
"OriginalQuoteId": null,
"ParentQuoteId": null,
"ProductCount": null,
"ProductTreeMode": null,
"QuoteCategory": null,
"QuoteDocTemplateId": null,
"QuoteDraftId": null,
"QuoteName": null,
"QuoteSource": null,
"SalesforceAccountId": null,
"SalesforceBPQuoteId": null,
"SalesforceIsPrimary": null,
"SalesforceOpportunityId": null,
"SalesforceOpportunityUrl": null,
"SalesforcePrimaryOpportunityCount": null,
"SendQuote": null,
"SourceQuoteId": null,
"StartDate": null,
"Status": null,
"Updated": null,
"UpdatedUserId": null
}
}'Response
application/json
{ "updateResponse": [ { … } ] }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/QUOTE/{id}
https://my.billingplatform.com/demogm/rest/2.0/QUOTE/{id}
- cURL
- JS
- Go
- Ruby
- Java 8
curl -i -X GET \
'https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/QUOTE/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'sessionId: string'Response
application/json
{ "retrieveResponse": { "AccountId": null, "AmendDate": null, "ApprovalRequestId": null, "ApprovedBy": null, "ApprovedOn": null, "CalculationMode": null, "Created": null, "CreatedUserId": null, "Currency": null, "DefaultContractId": null, "EmailSentOn": null, "EndDate": null, "FileName": null, "Id": null, "IsReadyForActivation": null, "NeedValidate": null, "OnEndDate": null, "OrderId": null, "OriginalQuoteId": null, "ParentQuoteId": null, "ProductCount": null, "ProductTreeMode": null, "QuoteCategory": null, "QuoteDocTemplateId": null, "QuoteDraftId": null, "QuoteName": null, "QuoteSource": null, "SalesforceAccountId": null, "SalesforceBPQuoteId": null, "SalesforceIsPrimary": null, "SalesforceOpportunityId": null, "SalesforceOpportunityUrl": null, "SalesforcePrimaryOpportunityCount": null, "SendQuote": null, "SourceQuoteId": null, "StartDate": null, "Status": null, "Updated": null, "UpdatedUserId": null } }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/QUOTE
https://my.billingplatform.com/demogm/rest/2.0/QUOTE
- cURL
- JS
- Go
- Ruby
- Java 8
curl -i -X GET \
'https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/QUOTE?queryAnsiSql=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'sessionId: string'Response
application/json
{ "retrieveResponse": { "AccountId": null, "AmendDate": null, "ApprovalRequestId": null, "ApprovedBy": null, "ApprovedOn": null, "CalculationMode": null, "Created": null, "CreatedUserId": null, "Currency": null, "DefaultContractId": null, "EmailSentOn": null, "EndDate": null, "FileName": null, "Id": null, "IsReadyForActivation": null, "NeedValidate": null, "OnEndDate": null, "OrderId": null, "OriginalQuoteId": null, "ParentQuoteId": null, "ProductCount": null, "ProductTreeMode": null, "QuoteCategory": null, "QuoteDocTemplateId": null, "QuoteDraftId": null, "QuoteName": null, "QuoteSource": null, "SalesforceAccountId": null, "SalesforceBPQuoteId": null, "SalesforceIsPrimary": null, "SalesforceOpportunityId": null, "SalesforceOpportunityUrl": null, "SalesforcePrimaryOpportunityCount": null, "SendQuote": null, "SourceQuoteId": null, "StartDate": null, "Status": null, "Updated": null, "UpdatedUserId": null } }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/QUOTE
https://my.billingplatform.com/demogm/rest/2.0/QUOTE
- cURL
- JS
- Go
- Ruby
- Java 8
curl -i -X PUT \
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/QUOTE \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"AccountId": null,
"AmendDate": null,
"ApprovalRequestId": null,
"ApprovedBy": null,
"ApprovedOn": null,
"CalculationMode": null,
"Created": null,
"CreatedUserId": null,
"Currency": null,
"DefaultContractId": null,
"EmailSentOn": null,
"EndDate": null,
"FileName": null,
"Id": null,
"IsReadyForActivation": null,
"NeedValidate": null,
"OnEndDate": null,
"OrderId": null,
"OriginalQuoteId": null,
"ParentQuoteId": null,
"ProductCount": null,
"ProductTreeMode": null,
"QuoteCategory": null,
"QuoteDocTemplateId": null,
"QuoteDraftId": null,
"QuoteName": null,
"QuoteSource": null,
"SalesforceAccountId": null,
"SalesforceBPQuoteId": null,
"SalesforceIsPrimary": null,
"SalesforceOpportunityId": null,
"SalesforceOpportunityUrl": null,
"SalesforcePrimaryOpportunityCount": null,
"SendQuote": null,
"SourceQuoteId": null,
"StartDate": null,
"Status": null,
"Updated": null,
"UpdatedUserId": null
}
}'Response
application/json
{ "updateResponse": [ { … } ] }