Billing Platform API
Billing Platform API
curl -i -X GET \
'https://bp-api-docs-v3.redocly.app/_mock/demogm_schema_10_21_2024/rest/2.0/PRODUCT/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'sessionId: string'{ "retrieveResponse": { "Status": "string", "ContractRequiredFlag": 0, "OverridePermissions": "string", "CustomizeTaxRules": 0, "Id": "string", "UpdatedUserId": "string", "RestrictUseOfUnreferencedContracts": 0, "Name": "string", "Created": "string", "CreatedUserId": "string", "OrderOfExecution": "string", "Updated": "string", "RatingMethodId": "string", "UseFormulaSSP": 0, "SSPFormula": "string", "Rate": "string", "SfLastSync": "string", "SfStatusError": "string", "DefaultRateFlag": 0, "ExternalKey": "string", "SfSyncBatchId": "string", "SfRecordId": "string" } }
curl -i -X GET \
'https://bp-api-docs-v3.redocly.app/_mock/demogm_schema_10_21_2024/rest/2.0/PRODUCT?queryAnsiSql=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'sessionId: string'{ "retrieveResponse": { "Status": "string", "ContractRequiredFlag": 0, "OverridePermissions": "string", "CustomizeTaxRules": 0, "Id": "string", "UpdatedUserId": "string", "RestrictUseOfUnreferencedContracts": 0, "Name": "string", "Created": "string", "CreatedUserId": "string", "OrderOfExecution": "string", "Updated": "string", "RatingMethodId": "string", "UseFormulaSSP": 0, "SSPFormula": "string", "Rate": "string", "SfLastSync": "string", "SfStatusError": "string", "DefaultRateFlag": 0, "ExternalKey": "string", "SfSyncBatchId": "string", "SfRecordId": "string" } }
curl -i -X POST \
https://bp-api-docs-v3.redocly.app/_mock/demogm_schema_10_21_2024/rest/2.0/PRODUCT \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"Status": "string",
"ContractRequiredFlag": 0,
"OverridePermissions": "string",
"CustomizeTaxRules": 0,
"Id": "string",
"UpdatedUserId": "string",
"RestrictUseOfUnreferencedContracts": 0,
"Name": "string",
"Created": "string",
"CreatedUserId": "string",
"OrderOfExecution": "string",
"Updated": "string",
"RatingMethodId": "string",
"UseFormulaSSP": 0,
"SSPFormula": "string",
"Rate": "string",
"SfLastSync": "string",
"SfStatusError": "string",
"DefaultRateFlag": 0,
"ExternalKey": "string",
"SfSyncBatchId": "string",
"SfRecordId": "string"
}
}'{ "retrieveResponse": { "Status": "string", "ContractRequiredFlag": 0, "OverridePermissions": "string", "CustomizeTaxRules": 0, "Id": "string", "UpdatedUserId": "string", "RestrictUseOfUnreferencedContracts": 0, "Name": "string", "Created": "string", "CreatedUserId": "string", "OrderOfExecution": "string", "Updated": "string", "RatingMethodId": "string", "UseFormulaSSP": 0, "SSPFormula": "string", "Rate": "string", "SfLastSync": "string", "SfStatusError": "string", "DefaultRateFlag": 0, "ExternalKey": "string", "SfSyncBatchId": "string", "SfRecordId": "string" } }
curl -i -X PUT \
https://bp-api-docs-v3.redocly.app/_mock/demogm_schema_10_21_2024/rest/2.0/PRODUCT \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"Status": "string",
"ContractRequiredFlag": 0,
"OverridePermissions": "string",
"CustomizeTaxRules": 0,
"Id": "string",
"UpdatedUserId": "string",
"RestrictUseOfUnreferencedContracts": 0,
"Name": "string",
"Created": "string",
"CreatedUserId": "string",
"OrderOfExecution": "string",
"Updated": "string",
"RatingMethodId": "string",
"UseFormulaSSP": 0,
"SSPFormula": "string",
"Rate": "string",
"SfLastSync": "string",
"SfStatusError": "string",
"DefaultRateFlag": 0,
"ExternalKey": "string",
"SfSyncBatchId": "string",
"SfRecordId": "string"
}
}'{ "retrieveResponse": { "Status": "string", "ContractRequiredFlag": 0, "OverridePermissions": "string", "CustomizeTaxRules": 0, "Id": "string", "UpdatedUserId": "string", "RestrictUseOfUnreferencedContracts": 0, "Name": "string", "Created": "string", "CreatedUserId": "string", "OrderOfExecution": "string", "Updated": "string", "RatingMethodId": "string", "UseFormulaSSP": 0, "SSPFormula": "string", "Rate": "string", "SfLastSync": "string", "SfStatusError": "string", "DefaultRateFlag": 0, "ExternalKey": "string", "SfSyncBatchId": "string", "SfRecordId": "string" } }
curl -i -X PATCH \
https://bp-api-docs-v3.redocly.app/_mock/demogm_schema_10_21_2024/rest/2.0/PRODUCT \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"Status": "string",
"ContractRequiredFlag": 0,
"OverridePermissions": "string",
"CustomizeTaxRules": 0,
"Id": "string",
"UpdatedUserId": "string",
"RestrictUseOfUnreferencedContracts": 0,
"Name": "string",
"Created": "string",
"CreatedUserId": "string",
"OrderOfExecution": "string",
"Updated": "string",
"RatingMethodId": "string",
"UseFormulaSSP": 0,
"SSPFormula": "string",
"Rate": "string",
"SfLastSync": "string",
"SfStatusError": "string",
"DefaultRateFlag": 0,
"ExternalKey": "string",
"SfSyncBatchId": "string",
"SfRecordId": "string"
},
"externalIDFieldName": "Name"
}'{ "upsertResponse": [ { … } ] }
curl -i -X DELETE \
https://bp-api-docs-v3.redocly.app/_mock/demogm_schema_10_21_2024/rest/2.0/delete/PRODUCT \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"Id": "string"
}
}'{ "retrieveResponse": { "Status": "string", "ContractRequiredFlag": 0, "OverridePermissions": "string", "CustomizeTaxRules": 0, "Id": "string", "UpdatedUserId": "string", "RestrictUseOfUnreferencedContracts": 0, "Name": "string", "Created": "string", "CreatedUserId": "string", "OrderOfExecution": "string", "Updated": "string", "RatingMethodId": "string", "UseFormulaSSP": 0, "SSPFormula": "string", "Rate": "string", "SfLastSync": "string", "SfStatusError": "string", "DefaultRateFlag": 0, "ExternalKey": "string", "SfSyncBatchId": "string", "SfRecordId": "string" } }
An Account is a fundamental entity used for billing customers. It plays a crucial role in various billing and invoicing processes. Each Account is associated with an Account Type, Activity Time Zone, and Country. The AllowPricingInDifferentCurrency field determines if pricing can be in a currency different from the default. The Account can be linked to other entities such as Billable Account, Billing Profile, Collector User, and Parent Account. The Billable Account and Billing Profile are essential for invoicing and payment information. The Collector User field identifies the user responsible for collecting payments.