API Reference (1.0)
Billing Platform API
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/ENTITY
https://my.billingplatform.com/demogm/rest/2.0/ENTITY
- 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/ENTITY \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"AfterNode": null,
"AllowAttributeTable": null,
"AllowCache": null,
"AllowEditsForRejectedRecords": null,
"ApiEnabled": null,
"BaseEntity": null,
"BaseEntityId": null,
"CascadeDeleteFlag": null,
"CascadePermitionsFlag": null,
"CreateDefaultFields": null,
"CreateSearchForm": null,
"Created": null,
"CreatedUserId": null,
"CustomLayout": null,
"EnableAutoSearch": null,
"EntityLabel": null,
"EntityName": null,
"ExternalHelpTarget": null,
"GlobalSearchFlag": null,
"GlobalSearchStatus": null,
"HelpLanguage": null,
"HideFromTreeMenu": null,
"HighLoadFlag": null,
"HistoryFlag": null,
"HistoryRetentionDays": null,
"Id": null,
"InputForm": null,
"IsApplicationDeployable": null,
"LabelId": null,
"ListForm": null,
"ListSingleResultBehavior": null,
"LongHelpDescription": null,
"LookupEnabledFlag": null,
"Node": null,
"ParentEntityId": null,
"ParentNode": null,
"QuickSearchFlag": null,
"RecycleBinFlag": null,
"RelatedListFlag": null,
"RetentionDays": null,
"RevenueRecognitionEligible": null,
"ShortHelpLabel": null,
"SystemFlag": null,
"TableName": null,
"Updated": null,
"UpdatedUserId": null,
"ViewEntity": null,
"ViewFilterLogic": null,
"VirtualEntityFlag": null,
"VisibleFlag": null,
"Widget": null
}
}'
{ "updateResponse": [ { … } ] }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/ENTITY
https://my.billingplatform.com/demogm/rest/2.0/ENTITY
- cURL
- JS
- Go
- Ruby
- Java 8
curl -i -X POST \
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/ENTITY \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"AfterNode": null,
"AllowAttributeTable": null,
"AllowCache": null,
"AllowEditsForRejectedRecords": null,
"ApiEnabled": null,
"BaseEntity": null,
"BaseEntityId": null,
"CascadeDeleteFlag": null,
"CascadePermitionsFlag": null,
"CreateDefaultFields": null,
"CreateSearchForm": null,
"Created": null,
"CreatedUserId": null,
"CustomLayout": null,
"EnableAutoSearch": null,
"EntityLabel": null,
"EntityName": null,
"ExternalHelpTarget": null,
"GlobalSearchFlag": null,
"GlobalSearchStatus": null,
"HelpLanguage": null,
"HideFromTreeMenu": null,
"HighLoadFlag": null,
"HistoryFlag": null,
"HistoryRetentionDays": null,
"Id": null,
"InputForm": null,
"IsApplicationDeployable": null,
"LabelId": null,
"ListForm": null,
"ListSingleResultBehavior": null,
"LongHelpDescription": null,
"LookupEnabledFlag": null,
"Node": null,
"ParentEntityId": null,
"ParentNode": null,
"QuickSearchFlag": null,
"RecycleBinFlag": null,
"RelatedListFlag": null,
"RetentionDays": null,
"RevenueRecognitionEligible": null,
"ShortHelpLabel": null,
"SystemFlag": null,
"TableName": null,
"Updated": null,
"UpdatedUserId": null,
"ViewEntity": null,
"ViewFilterLogic": null,
"VirtualEntityFlag": null,
"VisibleFlag": null,
"Widget": null
}
}'
{ "createResponse": [ { … } ] }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/ENTITY
https://my.billingplatform.com/demogm/rest/2.0/ENTITY
- 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/ENTITY \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"AfterNode": null,
"AllowAttributeTable": null,
"AllowCache": null,
"AllowEditsForRejectedRecords": null,
"ApiEnabled": null,
"BaseEntity": null,
"BaseEntityId": null,
"CascadeDeleteFlag": null,
"CascadePermitionsFlag": null,
"CreateDefaultFields": null,
"CreateSearchForm": null,
"Created": null,
"CreatedUserId": null,
"CustomLayout": null,
"EnableAutoSearch": null,
"EntityLabel": null,
"EntityName": null,
"ExternalHelpTarget": null,
"GlobalSearchFlag": null,
"GlobalSearchStatus": null,
"HelpLanguage": null,
"HideFromTreeMenu": null,
"HighLoadFlag": null,
"HistoryFlag": null,
"HistoryRetentionDays": null,
"Id": null,
"InputForm": null,
"IsApplicationDeployable": null,
"LabelId": null,
"ListForm": null,
"ListSingleResultBehavior": null,
"LongHelpDescription": null,
"LookupEnabledFlag": null,
"Node": null,
"ParentEntityId": null,
"ParentNode": null,
"QuickSearchFlag": null,
"RecycleBinFlag": null,
"RelatedListFlag": null,
"RetentionDays": null,
"RevenueRecognitionEligible": null,
"ShortHelpLabel": null,
"SystemFlag": null,
"TableName": null,
"Updated": null,
"UpdatedUserId": null,
"ViewEntity": null,
"ViewFilterLogic": null,
"VirtualEntityFlag": null,
"VisibleFlag": null,
"Widget": null
},
"externalIDFieldName": "EntityName"
}'
{ "upsertResponse": [ { … } ] }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/ENTITY
https://my.billingplatform.com/demogm/rest/2.0/ENTITY
- 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/ENTITY \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"AfterNode": null,
"AllowAttributeTable": null,
"AllowCache": null,
"AllowEditsForRejectedRecords": null,
"ApiEnabled": null,
"BaseEntity": null,
"BaseEntityId": null,
"CascadeDeleteFlag": null,
"CascadePermitionsFlag": null,
"CreateDefaultFields": null,
"CreateSearchForm": null,
"Created": null,
"CreatedUserId": null,
"CustomLayout": null,
"EnableAutoSearch": null,
"EntityLabel": null,
"EntityName": null,
"ExternalHelpTarget": null,
"GlobalSearchFlag": null,
"GlobalSearchStatus": null,
"HelpLanguage": null,
"HideFromTreeMenu": null,
"HighLoadFlag": null,
"HistoryFlag": null,
"HistoryRetentionDays": null,
"Id": null,
"InputForm": null,
"IsApplicationDeployable": null,
"LabelId": null,
"ListForm": null,
"ListSingleResultBehavior": null,
"LongHelpDescription": null,
"LookupEnabledFlag": null,
"Node": null,
"ParentEntityId": null,
"ParentNode": null,
"QuickSearchFlag": null,
"RecycleBinFlag": null,
"RelatedListFlag": null,
"RetentionDays": null,
"RevenueRecognitionEligible": null,
"ShortHelpLabel": null,
"SystemFlag": null,
"TableName": null,
"Updated": null,
"UpdatedUserId": null,
"ViewEntity": null,
"ViewFilterLogic": null,
"VirtualEntityFlag": null,
"VisibleFlag": null,
"Widget": null
}
}'
{ "updateResponse": [ { … } ] }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/ENTITY
https://my.billingplatform.com/demogm/rest/2.0/ENTITY
- cURL
- JS
- Go
- Ruby
- Java 8
curl -i -X POST \
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/ENTITY \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"AfterNode": null,
"AllowAttributeTable": null,
"AllowCache": null,
"AllowEditsForRejectedRecords": null,
"ApiEnabled": null,
"BaseEntity": null,
"BaseEntityId": null,
"CascadeDeleteFlag": null,
"CascadePermitionsFlag": null,
"CreateDefaultFields": null,
"CreateSearchForm": null,
"Created": null,
"CreatedUserId": null,
"CustomLayout": null,
"EnableAutoSearch": null,
"EntityLabel": null,
"EntityName": null,
"ExternalHelpTarget": null,
"GlobalSearchFlag": null,
"GlobalSearchStatus": null,
"HelpLanguage": null,
"HideFromTreeMenu": null,
"HighLoadFlag": null,
"HistoryFlag": null,
"HistoryRetentionDays": null,
"Id": null,
"InputForm": null,
"IsApplicationDeployable": null,
"LabelId": null,
"ListForm": null,
"ListSingleResultBehavior": null,
"LongHelpDescription": null,
"LookupEnabledFlag": null,
"Node": null,
"ParentEntityId": null,
"ParentNode": null,
"QuickSearchFlag": null,
"RecycleBinFlag": null,
"RelatedListFlag": null,
"RetentionDays": null,
"RevenueRecognitionEligible": null,
"ShortHelpLabel": null,
"SystemFlag": null,
"TableName": null,
"Updated": null,
"UpdatedUserId": null,
"ViewEntity": null,
"ViewFilterLogic": null,
"VirtualEntityFlag": null,
"VisibleFlag": null,
"Widget": null
}
}'
{ "createResponse": [ { … } ] }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/ENTITY
https://my.billingplatform.com/demogm/rest/2.0/ENTITY
- 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/ENTITY \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"AfterNode": null,
"AllowAttributeTable": null,
"AllowCache": null,
"AllowEditsForRejectedRecords": null,
"ApiEnabled": null,
"BaseEntity": null,
"BaseEntityId": null,
"CascadeDeleteFlag": null,
"CascadePermitionsFlag": null,
"CreateDefaultFields": null,
"CreateSearchForm": null,
"Created": null,
"CreatedUserId": null,
"CustomLayout": null,
"EnableAutoSearch": null,
"EntityLabel": null,
"EntityName": null,
"ExternalHelpTarget": null,
"GlobalSearchFlag": null,
"GlobalSearchStatus": null,
"HelpLanguage": null,
"HideFromTreeMenu": null,
"HighLoadFlag": null,
"HistoryFlag": null,
"HistoryRetentionDays": null,
"Id": null,
"InputForm": null,
"IsApplicationDeployable": null,
"LabelId": null,
"ListForm": null,
"ListSingleResultBehavior": null,
"LongHelpDescription": null,
"LookupEnabledFlag": null,
"Node": null,
"ParentEntityId": null,
"ParentNode": null,
"QuickSearchFlag": null,
"RecycleBinFlag": null,
"RelatedListFlag": null,
"RetentionDays": null,
"RevenueRecognitionEligible": null,
"ShortHelpLabel": null,
"SystemFlag": null,
"TableName": null,
"Updated": null,
"UpdatedUserId": null,
"ViewEntity": null,
"ViewFilterLogic": null,
"VirtualEntityFlag": null,
"VisibleFlag": null,
"Widget": null
},
"externalIDFieldName": "EntityName"
}'
{ "upsertResponse": [ { … } ] }