Billing Platform API
Billing Platform API
curl -i -X GET \ 'https://bp-api-docs-v3.redocly.app/_mock/cwid_206_manual/rest/2.0/QUOTE/{id}' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'sessionId: string'
{ "retrieveResponse": { "Id": "string", "UpdatedUserId": "string", "QuoteDocTemplateId": 0, "CreatedUserId": "string", "ProductTreeMode": "string", "AmendDate": "string", "QuoteSource": "string", "OnEndDate": "string", "OriginalQuoteId": 0, "QuoteName": "string", "Created": "string", "QuoteDraftId": "string", "StartDate": "string", "SalesforceIsPrimary": 0, "SourceQuoteId": 0, "Status": "string", "SalesforceAccountId": "string", "SalesforceOpportunityId": "string", "DefaultContractId": 0, "Currency": 0, "OrderId": 0, "AccountId": 0, "Updated": "string", "EndDate": "string", "CalculationMode": "string", "ProductCount": "string", "SalesforceOpportunityUrl": "string", "ApprovalRequestId": 0, "IsReadyForActivation": 0, "QuoteCategory": "string", "ParentQuoteId": 0, "EmailSentOn": "string", "ApprovedBy": "string", "FileName": "string", "NeedValidate": "string", "SalesforceBPQuoteId": "string", "SalesforcePrimaryOpportunityCount": "string", "ApprovedOn": "string", "SendQuote": 0 } }
curl -i -X GET \ 'https://bp-api-docs-v3.redocly.app/_mock/cwid_206_manual/rest/2.0/QUOTE?queryAnsiSql=string' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'sessionId: string'
{ "retrieveResponse": { "Id": "string", "UpdatedUserId": "string", "QuoteDocTemplateId": 0, "CreatedUserId": "string", "ProductTreeMode": "string", "AmendDate": "string", "QuoteSource": "string", "OnEndDate": "string", "OriginalQuoteId": 0, "QuoteName": "string", "Created": "string", "QuoteDraftId": "string", "StartDate": "string", "SalesforceIsPrimary": 0, "SourceQuoteId": 0, "Status": "string", "SalesforceAccountId": "string", "SalesforceOpportunityId": "string", "DefaultContractId": 0, "Currency": 0, "OrderId": 0, "AccountId": 0, "Updated": "string", "EndDate": "string", "CalculationMode": "string", "ProductCount": "string", "SalesforceOpportunityUrl": "string", "ApprovalRequestId": 0, "IsReadyForActivation": 0, "QuoteCategory": "string", "ParentQuoteId": 0, "EmailSentOn": "string", "ApprovedBy": "string", "FileName": "string", "NeedValidate": "string", "SalesforceBPQuoteId": "string", "SalesforcePrimaryOpportunityCount": "string", "ApprovedOn": "string", "SendQuote": 0 } }
curl -i -X POST \ https://bp-api-docs-v3.redocly.app/_mock/cwid_206_manual/rest/2.0/QUOTE \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'Content-Type: application/json; charset=utf-8' \ -H 'sessionId: string' \ -d '{ "brmObjects": { "Id": "string", "UpdatedUserId": "string", "QuoteDocTemplateId": 0, "CreatedUserId": "string", "ProductTreeMode": "string", "AmendDate": "string", "QuoteSource": "string", "OnEndDate": "string", "OriginalQuoteId": 0, "QuoteName": "string", "Created": "string", "QuoteDraftId": "string", "StartDate": "string", "SalesforceIsPrimary": 0, "SourceQuoteId": 0, "Status": "string", "SalesforceAccountId": "string", "SalesforceOpportunityId": "string", "DefaultContractId": 0, "Currency": 0, "OrderId": 0, "AccountId": 0, "Updated": "string", "EndDate": "string", "CalculationMode": "string", "ProductCount": "string", "SalesforceOpportunityUrl": "string", "ApprovalRequestId": 0, "IsReadyForActivation": 0, "QuoteCategory": "string", "ParentQuoteId": 0, "EmailSentOn": "string", "ApprovedBy": "string", "FileName": "string", "NeedValidate": "string", "SalesforceBPQuoteId": "string", "SalesforcePrimaryOpportunityCount": "string", "ApprovedOn": "string", "SendQuote": 0 } }'
{ "retrieveResponse": { "Id": "string", "UpdatedUserId": "string", "QuoteDocTemplateId": 0, "CreatedUserId": "string", "ProductTreeMode": "string", "AmendDate": "string", "QuoteSource": "string", "OnEndDate": "string", "OriginalQuoteId": 0, "QuoteName": "string", "Created": "string", "QuoteDraftId": "string", "StartDate": "string", "SalesforceIsPrimary": 0, "SourceQuoteId": 0, "Status": "string", "SalesforceAccountId": "string", "SalesforceOpportunityId": "string", "DefaultContractId": 0, "Currency": 0, "OrderId": 0, "AccountId": 0, "Updated": "string", "EndDate": "string", "CalculationMode": "string", "ProductCount": "string", "SalesforceOpportunityUrl": "string", "ApprovalRequestId": 0, "IsReadyForActivation": 0, "QuoteCategory": "string", "ParentQuoteId": 0, "EmailSentOn": "string", "ApprovedBy": "string", "FileName": "string", "NeedValidate": "string", "SalesforceBPQuoteId": "string", "SalesforcePrimaryOpportunityCount": "string", "ApprovedOn": "string", "SendQuote": 0 } }
curl -i -X PUT \ https://bp-api-docs-v3.redocly.app/_mock/cwid_206_manual/rest/2.0/QUOTE \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'Content-Type: application/json; charset=utf-8' \ -H 'sessionId: string' \ -d '{ "brmObjects": { "Id": "string", "UpdatedUserId": "string", "QuoteDocTemplateId": 0, "CreatedUserId": "string", "ProductTreeMode": "string", "AmendDate": "string", "QuoteSource": "string", "OnEndDate": "string", "OriginalQuoteId": 0, "QuoteName": "string", "Created": "string", "QuoteDraftId": "string", "StartDate": "string", "SalesforceIsPrimary": 0, "SourceQuoteId": 0, "Status": "string", "SalesforceAccountId": "string", "SalesforceOpportunityId": "string", "DefaultContractId": 0, "Currency": 0, "OrderId": 0, "AccountId": 0, "Updated": "string", "EndDate": "string", "CalculationMode": "string", "ProductCount": "string", "SalesforceOpportunityUrl": "string", "ApprovalRequestId": 0, "IsReadyForActivation": 0, "QuoteCategory": "string", "ParentQuoteId": 0, "EmailSentOn": "string", "ApprovedBy": "string", "FileName": "string", "NeedValidate": "string", "SalesforceBPQuoteId": "string", "SalesforcePrimaryOpportunityCount": "string", "ApprovedOn": "string", "SendQuote": 0 } }'
{ "retrieveResponse": { "Id": "string", "UpdatedUserId": "string", "QuoteDocTemplateId": 0, "CreatedUserId": "string", "ProductTreeMode": "string", "AmendDate": "string", "QuoteSource": "string", "OnEndDate": "string", "OriginalQuoteId": 0, "QuoteName": "string", "Created": "string", "QuoteDraftId": "string", "StartDate": "string", "SalesforceIsPrimary": 0, "SourceQuoteId": 0, "Status": "string", "SalesforceAccountId": "string", "SalesforceOpportunityId": "string", "DefaultContractId": 0, "Currency": 0, "OrderId": 0, "AccountId": 0, "Updated": "string", "EndDate": "string", "CalculationMode": "string", "ProductCount": "string", "SalesforceOpportunityUrl": "string", "ApprovalRequestId": 0, "IsReadyForActivation": 0, "QuoteCategory": "string", "ParentQuoteId": 0, "EmailSentOn": "string", "ApprovedBy": "string", "FileName": "string", "NeedValidate": "string", "SalesforceBPQuoteId": "string", "SalesforcePrimaryOpportunityCount": "string", "ApprovedOn": "string", "SendQuote": 0 } }
curl -i -X PATCH \ https://bp-api-docs-v3.redocly.app/_mock/cwid_206_manual/rest/2.0/QUOTE \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'Content-Type: application/json; charset=utf-8' \ -H 'sessionId: string' \ -d '{ "brmObjects": { "Id": "string", "UpdatedUserId": "string", "QuoteDocTemplateId": 0, "CreatedUserId": "string", "ProductTreeMode": "string", "AmendDate": "string", "QuoteSource": "string", "OnEndDate": "string", "OriginalQuoteId": 0, "QuoteName": "string", "Created": "string", "QuoteDraftId": "string", "StartDate": "string", "SalesforceIsPrimary": 0, "SourceQuoteId": 0, "Status": "string", "SalesforceAccountId": "string", "SalesforceOpportunityId": "string", "DefaultContractId": 0, "Currency": 0, "OrderId": 0, "AccountId": 0, "Updated": "string", "EndDate": "string", "CalculationMode": "string", "ProductCount": "string", "SalesforceOpportunityUrl": "string", "ApprovalRequestId": 0, "IsReadyForActivation": 0, "QuoteCategory": "string", "ParentQuoteId": 0, "EmailSentOn": "string", "ApprovedBy": "string", "FileName": "string", "NeedValidate": "string", "SalesforceBPQuoteId": "string", "SalesforcePrimaryOpportunityCount": "string", "ApprovedOn": "string", "SendQuote": 0 }, "externalIDFieldName": "QuoteDraftId" }'
{ "upsertResponse": [ { … } ] }
curl -i -X DELETE \ https://bp-api-docs-v3.redocly.app/_mock/cwid_206_manual/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" } }'
{ "retrieveResponse": { "Id": "string", "UpdatedUserId": "string", "QuoteDocTemplateId": 0, "CreatedUserId": "string", "ProductTreeMode": "string", "AmendDate": "string", "QuoteSource": "string", "OnEndDate": "string", "OriginalQuoteId": 0, "QuoteName": "string", "Created": "string", "QuoteDraftId": "string", "StartDate": "string", "SalesforceIsPrimary": 0, "SourceQuoteId": 0, "Status": "string", "SalesforceAccountId": "string", "SalesforceOpportunityId": "string", "DefaultContractId": 0, "Currency": 0, "OrderId": 0, "AccountId": 0, "Updated": "string", "EndDate": "string", "CalculationMode": "string", "ProductCount": "string", "SalesforceOpportunityUrl": "string", "ApprovalRequestId": 0, "IsReadyForActivation": 0, "QuoteCategory": "string", "ParentQuoteId": 0, "EmailSentOn": "string", "ApprovedBy": "string", "FileName": "string", "NeedValidate": "string", "SalesforceBPQuoteId": "string", "SalesforcePrimaryOpportunityCount": "string", "ApprovedOn": "string", "SendQuote": 0 } }