Delete a contract
Deletes an existing contract by its internal ID or an external reference.
Tip
Check the Swagger page for more technical information on the endpoints.
Endpoint details
DELETE
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/contracts/{contractReference}
Headers: Authorization: Bearer {token}, User-Agent: {agent}
Scope: connector-protimeapi-contracts.write
URL parameters
| Parameter | Description |
|---|---|
{contractReference} |
The internal ID of the contract, or a custom external reference when externalReferences is set. |
External references
The endpoint resolves {contractReference} through the externalReferences query parameter. See the external references page for details.
| Collection | Predefined | Custom |
|---|---|---|
contracts |
Not available | Supported |
Error responses
| Status | Condition |
|---|---|
400 |
Invalid external reference specification, or the contract cannot be deleted |
401 |
Missing or invalid access token, or insufficient scope |
404 |
No contract exists for the given ID or external reference |
Success response
204 No Content. The response body is empty.
Examples
Delete a contract by internal ID
DELETE
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/contracts/186
Delete a contract by external reference
DELETE
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/contracts/CTR-0042?externalReferences=(contracts,customContractCode)