The DDCMS API supports cancelling and restarting contract schedules directly from integrated systems, allowing schedule changes to be automated without accessing the DDCMS interface.
Requirements
To use the Cancel and Restart actions, the following are needed:
Client Prefix
API Key
All API requests must include the header apiKey: {apiKey}.
📌Note: If your Client Prefix or API Key is not available, please contact us via the Access Digital Assistant. A member of the Support team will provide the details you need.
Cancel a schedule
Cancelling a schedule stops all future payments associated with that contract schedule. A cancellation request is sent as a POST request to:
{ddcmsurl}/api/v3/client/{clientPrefix}/contract/{contractId}/cancelSchedule
Send a POST request to the cancellation endpoint.
Add the API Key to the request header.
Include the correct contractId in the URL.
Submit the request.
A 200 OK confirms the schedule has been cancelled.
📌Note: A cancelled schedule moves to a Terminated status. Payments will not resume unless the schedule is restarted.
Restart a schedule
Restarting a schedule resumes payments for a contract schedule previously set to Terminated. A restart request is sent as a POST request to:
{ddcmsurl}/api/v3/client/{clientPrefix}/contract/{contractId}/restartSchedule
Send a POST request to the restart endpoint.
Add the API Key to the header.
Include the contractId in the URL.
Add an optional comment as a query parameter.
A 200 OK confirms the schedule has been restarted.
📌Note: Only schedules currently in a Terminated state can be restarted.
Response codes
Status Code | Meaning |
200 OK | Schedule cancelled or restarted successfully |
400 Bad Request | Request validation failed (details returned) |
403 Forbidden | Contract is protected and cannot be modified |
404 Not Found | No contract found for the provided ID |
500 Internal Server Error | An unexpected error occurred during processing |
Troubleshooting
If a request fails, check the following:
The contractId is correct
The contract is not protected
The API Key is valid and copied correctly
User permissions allow API access
The endpoint URL is accurate and complete
📌Note: Protected contracts cannot be updated via the API.