Billing Platform API
Billing Platform API
curl -i -X POST \
https://bp-api-docs-v3.redocly.app/_mock/demogm_03_06_2025_schema_edited/rest/2.0/CONTRACT \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"Updated": "string",
"Created": "string",
"RateClassId": 0,
"AccountId": "string",
"Id": "string",
"ContractNumber": "string",
"OnEndDate": "string",
"StartDate": "string",
"CreatedUserId": "string",
"UpdatedUserId": "string",
"EndDate": "string",
"ContractStatus": "string"
}
}'
{ "retrieveResponse": { "Updated": "string", "Created": "string", "RateClassId": 0, "AccountId": "string", "Id": "string", "ContractNumber": "string", "OnEndDate": "string", "StartDate": "string", "CreatedUserId": "string", "UpdatedUserId": "string", "EndDate": "string", "ContractStatus": "string" } }
curl -i -X PUT \
https://bp-api-docs-v3.redocly.app/_mock/demogm_03_06_2025_schema_edited/rest/2.0/CONTRACT \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"Updated": "string",
"Created": "string",
"RateClassId": 0,
"AccountId": "string",
"Id": "string",
"ContractNumber": "string",
"OnEndDate": "string",
"StartDate": "string",
"CreatedUserId": "string",
"UpdatedUserId": "string",
"EndDate": "string",
"ContractStatus": "string"
}
}'
{ "retrieveResponse": { "Updated": "string", "Created": "string", "RateClassId": 0, "AccountId": "string", "Id": "string", "ContractNumber": "string", "OnEndDate": "string", "StartDate": "string", "CreatedUserId": "string", "UpdatedUserId": "string", "EndDate": "string", "ContractStatus": "string" } }
curl -i -X PATCH \
https://bp-api-docs-v3.redocly.app/_mock/demogm_03_06_2025_schema_edited/rest/2.0/CONTRACT \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"Updated": "string",
"Created": "string",
"RateClassId": 0,
"AccountId": "string",
"Id": "string",
"ContractNumber": "string",
"OnEndDate": "string",
"StartDate": "string",
"CreatedUserId": "string",
"UpdatedUserId": "string",
"EndDate": "string",
"ContractStatus": "string"
},
"externalIDFieldName": "ContractNumber"
}'
{ "upsertResponse": [ { … } ] }
curl -i -X POST \
https://bp-api-docs-v3.redocly.app/_mock/demogm_03_06_2025_schema_edited/rest/2.0/CONTRACT \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"Updated": "string",
"Created": "string",
"RateClassId": 0,
"AccountId": "string",
"Id": "string",
"ContractNumber": "string",
"OnEndDate": "string",
"StartDate": "string",
"CreatedUserId": "string",
"UpdatedUserId": "string",
"EndDate": "string",
"ContractStatus": "string"
}
}'
{ "retrieveResponse": { "Updated": "string", "Created": "string", "RateClassId": 0, "AccountId": "string", "Id": "string", "ContractNumber": "string", "OnEndDate": "string", "StartDate": "string", "CreatedUserId": "string", "UpdatedUserId": "string", "EndDate": "string", "ContractStatus": "string" } }
curl -i -X PUT \
https://bp-api-docs-v3.redocly.app/_mock/demogm_03_06_2025_schema_edited/rest/2.0/CONTRACT \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"Updated": "string",
"Created": "string",
"RateClassId": 0,
"AccountId": "string",
"Id": "string",
"ContractNumber": "string",
"OnEndDate": "string",
"StartDate": "string",
"CreatedUserId": "string",
"UpdatedUserId": "string",
"EndDate": "string",
"ContractStatus": "string"
}
}'
{ "retrieveResponse": { "Updated": "string", "Created": "string", "RateClassId": 0, "AccountId": "string", "Id": "string", "ContractNumber": "string", "OnEndDate": "string", "StartDate": "string", "CreatedUserId": "string", "UpdatedUserId": "string", "EndDate": "string", "ContractStatus": "string" } }
curl -i -X PATCH \
https://bp-api-docs-v3.redocly.app/_mock/demogm_03_06_2025_schema_edited/rest/2.0/CONTRACT \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"Updated": "string",
"Created": "string",
"RateClassId": 0,
"AccountId": "string",
"Id": "string",
"ContractNumber": "string",
"OnEndDate": "string",
"StartDate": "string",
"CreatedUserId": "string",
"UpdatedUserId": "string",
"EndDate": "string",
"ContractStatus": "string"
},
"externalIDFieldName": "ContractNumber"
}'
{ "upsertResponse": [ { … } ] }
curl -i -X POST \
https://bp-api-docs-v3.redocly.app/_mock/demogm_03_06_2025_schema_edited/rest/2.0/CONTRACT \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"Updated": "string",
"Created": "string",
"RateClassId": 0,
"AccountId": "string",
"Id": "string",
"ContractNumber": "string",
"OnEndDate": "string",
"StartDate": "string",
"CreatedUserId": "string",
"UpdatedUserId": "string",
"EndDate": "string",
"ContractStatus": "string"
}
}'
{ "retrieveResponse": { "Updated": "string", "Created": "string", "RateClassId": 0, "AccountId": "string", "Id": "string", "ContractNumber": "string", "OnEndDate": "string", "StartDate": "string", "CreatedUserId": "string", "UpdatedUserId": "string", "EndDate": "string", "ContractStatus": "string" } }
curl -i -X PUT \
https://bp-api-docs-v3.redocly.app/_mock/demogm_03_06_2025_schema_edited/rest/2.0/CONTRACT \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"Updated": "string",
"Created": "string",
"RateClassId": 0,
"AccountId": "string",
"Id": "string",
"ContractNumber": "string",
"OnEndDate": "string",
"StartDate": "string",
"CreatedUserId": "string",
"UpdatedUserId": "string",
"EndDate": "string",
"ContractStatus": "string"
}
}'
{ "retrieveResponse": { "Updated": "string", "Created": "string", "RateClassId": 0, "AccountId": "string", "Id": "string", "ContractNumber": "string", "OnEndDate": "string", "StartDate": "string", "CreatedUserId": "string", "UpdatedUserId": "string", "EndDate": "string", "ContractStatus": "string" } }
curl -i -X PATCH \
https://bp-api-docs-v3.redocly.app/_mock/demogm_03_06_2025_schema_edited/rest/2.0/CONTRACT \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"Updated": "string",
"Created": "string",
"RateClassId": 0,
"AccountId": "string",
"Id": "string",
"ContractNumber": "string",
"OnEndDate": "string",
"StartDate": "string",
"CreatedUserId": "string",
"UpdatedUserId": "string",
"EndDate": "string",
"ContractStatus": "string"
},
"externalIDFieldName": "ContractNumber"
}'
{ "upsertResponse": [ { … } ] }