Billing Platform API
Billing Platform API
curl -i -X GET \ 'https://bp-api-docs-v3.redocly.app/_mock/cwid_206_manual/rest/2.0/ENTITY/{id}' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'sessionId: string'
{ "retrieveResponse": { "CascadeDeleteFlag": "string", "BaseEntityId": 0, "SystemFlag": 0, "RelatedListFlag": "string", "LongHelpDiscription": "string", "Id": "string", "HistoryFlag": "string", "ViewEntity": 0, "IsApplicationDeployable": 0, "Created": "string", "RevenueRecognitionEligible": 0, "EntityName": "string", "LookupEnabledFlag": "string", "CreateSearchForm": "string", "HistoryRetentionDays": "string", "EntityLabel": "string", "RetentionDays": "string", "RecycleBinFlag": "string", "TableName": "string", "Widget": 0, "ShortHelpLabel": "string", "AllowAttributeTable": "string", "ApiEnabled": "string", "CustomLayout": "string", "ParentEntityId": 0, "VisibleFlag": "string", "Updated": "string", "CreatedUserId": "string", "UpdatedUserId": "string", "ExternalHelpTarget": "string", "HelpLanguage": "string", "CreateDefaultFields": "string", "ParentNode": "string", "AfterNode": "string", "Node": "string", "EnableAutoSearch": "string", "CascadePermitionsFlag": "string", "BaseEntity": "string", "ViewFilterLogic": "string", "InputForm": "string", "LabelId": "string", "HideFromTreeMenu": "string" } }
curl -i -X GET \ 'https://bp-api-docs-v3.redocly.app/_mock/cwid_206_manual/rest/2.0/ENTITY?queryAnsiSql=string' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'sessionId: string'
{ "retrieveResponse": { "CascadeDeleteFlag": "string", "BaseEntityId": 0, "SystemFlag": 0, "RelatedListFlag": "string", "LongHelpDiscription": "string", "Id": "string", "HistoryFlag": "string", "ViewEntity": 0, "IsApplicationDeployable": 0, "Created": "string", "RevenueRecognitionEligible": 0, "EntityName": "string", "LookupEnabledFlag": "string", "CreateSearchForm": "string", "HistoryRetentionDays": "string", "EntityLabel": "string", "RetentionDays": "string", "RecycleBinFlag": "string", "TableName": "string", "Widget": 0, "ShortHelpLabel": "string", "AllowAttributeTable": "string", "ApiEnabled": "string", "CustomLayout": "string", "ParentEntityId": 0, "VisibleFlag": "string", "Updated": "string", "CreatedUserId": "string", "UpdatedUserId": "string", "ExternalHelpTarget": "string", "HelpLanguage": "string", "CreateDefaultFields": "string", "ParentNode": "string", "AfterNode": "string", "Node": "string", "EnableAutoSearch": "string", "CascadePermitionsFlag": "string", "BaseEntity": "string", "ViewFilterLogic": "string", "InputForm": "string", "LabelId": "string", "HideFromTreeMenu": "string" } }
curl -i -X POST \ https://bp-api-docs-v3.redocly.app/_mock/cwid_206_manual/rest/2.0/ENTITY \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'Content-Type: application/json; charset=utf-8' \ -H 'sessionId: string' \ -d '{ "brmObjects": { "CascadeDeleteFlag": "string", "BaseEntityId": 0, "SystemFlag": 0, "RelatedListFlag": "string", "LongHelpDiscription": "string", "Id": "string", "HistoryFlag": "string", "ViewEntity": 0, "IsApplicationDeployable": 0, "Created": "string", "RevenueRecognitionEligible": 0, "EntityName": "string", "LookupEnabledFlag": "string", "CreateSearchForm": "string", "HistoryRetentionDays": "string", "EntityLabel": "string", "RetentionDays": "string", "RecycleBinFlag": "string", "TableName": "string", "Widget": 0, "ShortHelpLabel": "string", "AllowAttributeTable": "string", "ApiEnabled": "string", "CustomLayout": "string", "ParentEntityId": 0, "VisibleFlag": "string", "Updated": "string", "CreatedUserId": "string", "UpdatedUserId": "string", "ExternalHelpTarget": "string", "HelpLanguage": "string", "CreateDefaultFields": "string", "ParentNode": "string", "AfterNode": "string", "Node": "string", "EnableAutoSearch": "string", "CascadePermitionsFlag": "string", "BaseEntity": "string", "ViewFilterLogic": "string", "InputForm": "string", "LabelId": "string", "HideFromTreeMenu": "string" } }'
{ "retrieveResponse": { "CascadeDeleteFlag": "string", "BaseEntityId": 0, "SystemFlag": 0, "RelatedListFlag": "string", "LongHelpDiscription": "string", "Id": "string", "HistoryFlag": "string", "ViewEntity": 0, "IsApplicationDeployable": 0, "Created": "string", "RevenueRecognitionEligible": 0, "EntityName": "string", "LookupEnabledFlag": "string", "CreateSearchForm": "string", "HistoryRetentionDays": "string", "EntityLabel": "string", "RetentionDays": "string", "RecycleBinFlag": "string", "TableName": "string", "Widget": 0, "ShortHelpLabel": "string", "AllowAttributeTable": "string", "ApiEnabled": "string", "CustomLayout": "string", "ParentEntityId": 0, "VisibleFlag": "string", "Updated": "string", "CreatedUserId": "string", "UpdatedUserId": "string", "ExternalHelpTarget": "string", "HelpLanguage": "string", "CreateDefaultFields": "string", "ParentNode": "string", "AfterNode": "string", "Node": "string", "EnableAutoSearch": "string", "CascadePermitionsFlag": "string", "BaseEntity": "string", "ViewFilterLogic": "string", "InputForm": "string", "LabelId": "string", "HideFromTreeMenu": "string" } }
curl -i -X PUT \ https://bp-api-docs-v3.redocly.app/_mock/cwid_206_manual/rest/2.0/ENTITY \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'Content-Type: application/json; charset=utf-8' \ -H 'sessionId: string' \ -d '{ "brmObjects": { "CascadeDeleteFlag": "string", "BaseEntityId": 0, "SystemFlag": 0, "RelatedListFlag": "string", "LongHelpDiscription": "string", "Id": "string", "HistoryFlag": "string", "ViewEntity": 0, "IsApplicationDeployable": 0, "Created": "string", "RevenueRecognitionEligible": 0, "EntityName": "string", "LookupEnabledFlag": "string", "CreateSearchForm": "string", "HistoryRetentionDays": "string", "EntityLabel": "string", "RetentionDays": "string", "RecycleBinFlag": "string", "TableName": "string", "Widget": 0, "ShortHelpLabel": "string", "AllowAttributeTable": "string", "ApiEnabled": "string", "CustomLayout": "string", "ParentEntityId": 0, "VisibleFlag": "string", "Updated": "string", "CreatedUserId": "string", "UpdatedUserId": "string", "ExternalHelpTarget": "string", "HelpLanguage": "string", "CreateDefaultFields": "string", "ParentNode": "string", "AfterNode": "string", "Node": "string", "EnableAutoSearch": "string", "CascadePermitionsFlag": "string", "BaseEntity": "string", "ViewFilterLogic": "string", "InputForm": "string", "LabelId": "string", "HideFromTreeMenu": "string" } }'
{ "retrieveResponse": { "CascadeDeleteFlag": "string", "BaseEntityId": 0, "SystemFlag": 0, "RelatedListFlag": "string", "LongHelpDiscription": "string", "Id": "string", "HistoryFlag": "string", "ViewEntity": 0, "IsApplicationDeployable": 0, "Created": "string", "RevenueRecognitionEligible": 0, "EntityName": "string", "LookupEnabledFlag": "string", "CreateSearchForm": "string", "HistoryRetentionDays": "string", "EntityLabel": "string", "RetentionDays": "string", "RecycleBinFlag": "string", "TableName": "string", "Widget": 0, "ShortHelpLabel": "string", "AllowAttributeTable": "string", "ApiEnabled": "string", "CustomLayout": "string", "ParentEntityId": 0, "VisibleFlag": "string", "Updated": "string", "CreatedUserId": "string", "UpdatedUserId": "string", "ExternalHelpTarget": "string", "HelpLanguage": "string", "CreateDefaultFields": "string", "ParentNode": "string", "AfterNode": "string", "Node": "string", "EnableAutoSearch": "string", "CascadePermitionsFlag": "string", "BaseEntity": "string", "ViewFilterLogic": "string", "InputForm": "string", "LabelId": "string", "HideFromTreeMenu": "string" } }
curl -i -X PATCH \ https://bp-api-docs-v3.redocly.app/_mock/cwid_206_manual/rest/2.0/ENTITY \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'Content-Type: application/json; charset=utf-8' \ -H 'sessionId: string' \ -d '{ "brmObjects": { "CascadeDeleteFlag": "string", "BaseEntityId": 0, "SystemFlag": 0, "RelatedListFlag": "string", "LongHelpDiscription": "string", "Id": "string", "HistoryFlag": "string", "ViewEntity": 0, "IsApplicationDeployable": 0, "Created": "string", "RevenueRecognitionEligible": 0, "EntityName": "string", "LookupEnabledFlag": "string", "CreateSearchForm": "string", "HistoryRetentionDays": "string", "EntityLabel": "string", "RetentionDays": "string", "RecycleBinFlag": "string", "TableName": "string", "Widget": 0, "ShortHelpLabel": "string", "AllowAttributeTable": "string", "ApiEnabled": "string", "CustomLayout": "string", "ParentEntityId": 0, "VisibleFlag": "string", "Updated": "string", "CreatedUserId": "string", "UpdatedUserId": "string", "ExternalHelpTarget": "string", "HelpLanguage": "string", "CreateDefaultFields": "string", "ParentNode": "string", "AfterNode": "string", "Node": "string", "EnableAutoSearch": "string", "CascadePermitionsFlag": "string", "BaseEntity": "string", "ViewFilterLogic": "string", "InputForm": "string", "LabelId": "string", "HideFromTreeMenu": "string" }, "externalIDFieldName": "EntityName" }'
{ "upsertResponse": [ { … } ] }
curl -i -X DELETE \ https://bp-api-docs-v3.redocly.app/_mock/cwid_206_manual/rest/2.0/delete/ENTITY \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'Content-Type: application/json; charset=utf-8' \ -H 'sessionId: string' \ -d '{ "brmObjects": { "Id": "string" } }'
{ "retrieveResponse": { "CascadeDeleteFlag": "string", "BaseEntityId": 0, "SystemFlag": 0, "RelatedListFlag": "string", "LongHelpDiscription": "string", "Id": "string", "HistoryFlag": "string", "ViewEntity": 0, "IsApplicationDeployable": 0, "Created": "string", "RevenueRecognitionEligible": 0, "EntityName": "string", "LookupEnabledFlag": "string", "CreateSearchForm": "string", "HistoryRetentionDays": "string", "EntityLabel": "string", "RetentionDays": "string", "RecycleBinFlag": "string", "TableName": "string", "Widget": 0, "ShortHelpLabel": "string", "AllowAttributeTable": "string", "ApiEnabled": "string", "CustomLayout": "string", "ParentEntityId": 0, "VisibleFlag": "string", "Updated": "string", "CreatedUserId": "string", "UpdatedUserId": "string", "ExternalHelpTarget": "string", "HelpLanguage": "string", "CreateDefaultFields": "string", "ParentNode": "string", "AfterNode": "string", "Node": "string", "EnableAutoSearch": "string", "CascadePermitionsFlag": "string", "BaseEntity": "string", "ViewFilterLogic": "string", "InputForm": "string", "LabelId": "string", "HideFromTreeMenu": "string" } }