Billing Platform API
Billing Platform API
curl -i -X GET \
'https://bp-api-docs-v3.redocly.app/_mock/demogm_03_06_2025_schema_edited/rest/2.0/SALESFORCE_SYNC_JOB/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'sessionId: string'
{ "retrieveResponse": { "LastNotificationTime": "string", "SyncTypeFilter": "string", "SalesforceExternalField": "string", "RunAdhoc": 0, "Created": "string", "SalesforceSyncConfigId": 0, "ScheduleInterval": "string", "CreatedUserId": "string", "StartDate": "string", "Id": "string", "FilterLogic": "string", "LastRunTime": "string", "UpdatedUserId": "string", "JobName": "string", "Operation": "string", "ExternalEntityField": "string", "SalesforceObject": "string", "ProcessingStatus": "string", "JobAPIBatchSize": "string", "Updated": "string", "EntityId": 0, "SyncTarget": "string" } }
curl -i -X GET \
'https://bp-api-docs-v3.redocly.app/_mock/demogm_03_06_2025_schema_edited/rest/2.0/SALESFORCE_SYNC_JOB?queryAnsiSql=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'sessionId: string'
{ "retrieveResponse": { "LastNotificationTime": "string", "SyncTypeFilter": "string", "SalesforceExternalField": "string", "RunAdhoc": 0, "Created": "string", "SalesforceSyncConfigId": 0, "ScheduleInterval": "string", "CreatedUserId": "string", "StartDate": "string", "Id": "string", "FilterLogic": "string", "LastRunTime": "string", "UpdatedUserId": "string", "JobName": "string", "Operation": "string", "ExternalEntityField": "string", "SalesforceObject": "string", "ProcessingStatus": "string", "JobAPIBatchSize": "string", "Updated": "string", "EntityId": 0, "SyncTarget": "string" } }
curl -i -X POST \
https://bp-api-docs-v3.redocly.app/_mock/demogm_03_06_2025_schema_edited/rest/2.0/SALESFORCE_SYNC_JOB \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"LastNotificationTime": "string",
"SyncTypeFilter": "string",
"SalesforceExternalField": "string",
"RunAdhoc": 0,
"Created": "string",
"SalesforceSyncConfigId": 0,
"ScheduleInterval": "string",
"CreatedUserId": "string",
"StartDate": "string",
"Id": "string",
"FilterLogic": "string",
"LastRunTime": "string",
"UpdatedUserId": "string",
"JobName": "string",
"Operation": "string",
"ExternalEntityField": "string",
"SalesforceObject": "string",
"ProcessingStatus": "string",
"JobAPIBatchSize": "string",
"Updated": "string",
"EntityId": 0,
"SyncTarget": "string"
}
}'
{ "retrieveResponse": { "LastNotificationTime": "string", "SyncTypeFilter": "string", "SalesforceExternalField": "string", "RunAdhoc": 0, "Created": "string", "SalesforceSyncConfigId": 0, "ScheduleInterval": "string", "CreatedUserId": "string", "StartDate": "string", "Id": "string", "FilterLogic": "string", "LastRunTime": "string", "UpdatedUserId": "string", "JobName": "string", "Operation": "string", "ExternalEntityField": "string", "SalesforceObject": "string", "ProcessingStatus": "string", "JobAPIBatchSize": "string", "Updated": "string", "EntityId": 0, "SyncTarget": "string" } }