Billing Platform API
API reference (1.0)
Download OpenAPI description
Overview
Languages
Servers
Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_03_06_2025_schema_edited/
https://my.billingplatform.com/demogm/
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_03_06_2025_schema_edited/rest/2.0/RECYCLE_BIN/{id}
https://my.billingplatform.com/demogm/rest/2.0/RECYCLE_BIN/{id}
- cURL
- JS
- Go
- Ruby
- Java 8
curl -i -X GET \
'https://bp-api-docs-v3.redocly.app/_mock/demogm_03_06_2025_schema_edited/rest/2.0/RECYCLE_BIN/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'sessionId: string'
Response
application/json
{ "retrieveResponse": { "Id": "string", "EntityId": 0, "USER_ID": "string", "NODE_DISPLAY_VALUE": "string", "DeletedUserId": "string", "ObjectId": "string", "DisplayValue": "string", "DeletedDate": "string", "Status": "string", "ErrorMessage": "string" } }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_03_06_2025_schema_edited/rest/2.0/RECYCLE_BIN
https://my.billingplatform.com/demogm/rest/2.0/RECYCLE_BIN
- cURL
- JS
- Go
- Ruby
- Java 8
curl -i -X GET \
'https://bp-api-docs-v3.redocly.app/_mock/demogm_03_06_2025_schema_edited/rest/2.0/RECYCLE_BIN?queryAnsiSql=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'sessionId: string'
Response
application/json
{ "retrieveResponse": { "Id": "string", "EntityId": 0, "USER_ID": "string", "NODE_DISPLAY_VALUE": "string", "DeletedUserId": "string", "ObjectId": "string", "DisplayValue": "string", "DeletedDate": "string", "Status": "string", "ErrorMessage": "string" } }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_03_06_2025_schema_edited/rest/2.0/RECYCLE_BIN
https://my.billingplatform.com/demogm/rest/2.0/RECYCLE_BIN
- cURL
- JS
- Go
- Ruby
- Java 8
curl -i -X POST \
https://bp-api-docs-v3.redocly.app/_mock/demogm_03_06_2025_schema_edited/rest/2.0/RECYCLE_BIN \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"Id": "string",
"EntityId": 0,
"USER_ID": "string",
"NODE_DISPLAY_VALUE": "string",
"DeletedUserId": "string",
"ObjectId": "string",
"DisplayValue": "string",
"DeletedDate": "string",
"Status": "string",
"ErrorMessage": "string"
}
}'
Response
application/json
{ "retrieveResponse": { "Id": "string", "EntityId": 0, "USER_ID": "string", "NODE_DISPLAY_VALUE": "string", "DeletedUserId": "string", "ObjectId": "string", "DisplayValue": "string", "DeletedDate": "string", "Status": "string", "ErrorMessage": "string" } }