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/ACTIVITY_COLLECTOR
https://my.billingplatform.com/demogm/rest/2.0/ACTIVITY_COLLECTOR
- cURL
- JS
- Go
- Ruby
- Java 8
curl -i -X PATCH \
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/ACTIVITY_COLLECTOR \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"AccountId": null,
"ActivityCollectorName": null,
"AfterProcessAction": null,
"AfterProcessDirectory": null,
"AfterProcessFilePattern": null,
"BillableActivityFlag": null,
"ConsolidationMode": null,
"CreateAfterProcessDirectoryFlag": null,
"Created": null,
"CreatedUserId": null,
"DataSourceFolder": null,
"DataSourceId": null,
"Delimiter": null,
"EntityMethod": null,
"Entity_Id": null,
"ExternalEntityFieldId": null,
"FieldIncludedChar": null,
"FtpDataSource": null,
"FtpDirectory": null,
"FtpFilePattern": null,
"FtpLocationType": null,
"HostPort": null,
"Hostname": null,
"Id": null,
"LastRowId": null,
"LastRowIdChar": null,
"LastRuntime": null,
"LoadOrder": null,
"LookbackTimePeriodEnd": null,
"LookbackTimePeriodStart": null,
"OmitEnd": null,
"PrecollectorValidation": null,
"RateActivityFlag": null,
"RecordFormat": null,
"RejectClosedFlag": null,
"RetrieveSql": null,
"RunIntervalMin": null,
"ServicePointTypeId": null,
"SkipRows": null,
"Sproc": null,
"StartDate": null,
"Status": null,
"TimeZoneId": null,
"Type": null,
"Updated": null,
"UpdatedUserId": null,
"Username": null
},
"externalIDFieldName": "ActivityCollectorName"
}'Response
application/json
{ "upsertResponse": [ { … } ] }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/delete/ACTIVITY_COLLECTOR
https://my.billingplatform.com/demogm/rest/2.0/delete/ACTIVITY_COLLECTOR
- cURL
- JS
- Go
- Ruby
- Java 8
curl -i -X DELETE \
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/delete/ACTIVITY_COLLECTOR \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"Id": "string"
}
}'Response
application/json
{ "updateResponse": [ { … } ] }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/ACTIVITY_COLLECTOR
https://my.billingplatform.com/demogm/rest/2.0/ACTIVITY_COLLECTOR
- cURL
- JS
- Go
- Ruby
- Java 8
curl -i -X PATCH \
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/ACTIVITY_COLLECTOR \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"AccountId": null,
"ActivityCollectorName": null,
"AfterProcessAction": null,
"AfterProcessDirectory": null,
"AfterProcessFilePattern": null,
"BillableActivityFlag": null,
"ConsolidationMode": null,
"CreateAfterProcessDirectoryFlag": null,
"Created": null,
"CreatedUserId": null,
"DataSourceFolder": null,
"DataSourceId": null,
"Delimiter": null,
"EntityMethod": null,
"Entity_Id": null,
"ExternalEntityFieldId": null,
"FieldIncludedChar": null,
"FtpDataSource": null,
"FtpDirectory": null,
"FtpFilePattern": null,
"FtpLocationType": null,
"HostPort": null,
"Hostname": null,
"Id": null,
"LastRowId": null,
"LastRowIdChar": null,
"LastRuntime": null,
"LoadOrder": null,
"LookbackTimePeriodEnd": null,
"LookbackTimePeriodStart": null,
"OmitEnd": null,
"PrecollectorValidation": null,
"RateActivityFlag": null,
"RecordFormat": null,
"RejectClosedFlag": null,
"RetrieveSql": null,
"RunIntervalMin": null,
"ServicePointTypeId": null,
"SkipRows": null,
"Sproc": null,
"StartDate": null,
"Status": null,
"TimeZoneId": null,
"Type": null,
"Updated": null,
"UpdatedUserId": null,
"Username": null
},
"externalIDFieldName": "ActivityCollectorName"
}'Response
application/json
{ "upsertResponse": [ { … } ] }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/delete/ACTIVITY_COLLECTOR
https://my.billingplatform.com/demogm/rest/2.0/delete/ACTIVITY_COLLECTOR
- cURL
- JS
- Go
- Ruby
- Java 8
curl -i -X DELETE \
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/delete/ACTIVITY_COLLECTOR \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"Id": "string"
}
}'Response
application/json
{ "updateResponse": [ { … } ] }