Actions28
Contracts → Unactivate
AI-generatedOverview
This node operation allows users to unactivate a specific line within a contract in the Dolibarr system. It is useful for scenarios where a contract line needs to be temporarily or permanently deactivated, such as stopping a service or pausing a subscription without deleting the entire contract. For example, a user can specify the contract ID and line ID to unactivate, provide a start date for the unactivation, and optionally add a comment explaining the reason.
Use Case Examples
- Unactivate a service line in a contract starting from a specific date with a comment for record-keeping.
- Pause a subscription line in a contract by unactivating it through the API.
Properties
| Name | Meaning |
|---|---|
| Contract ID | The unique identifier of the contract containing the line to be unactivated. This is a required numeric input with a minimum value of 1. |
| Line ID | The unique identifier of the specific line within the contract to unactivate. This is a required numeric input with a minimum value of 1. It is used in the API request URL to target the correct line. |
| Start Date | The date and time from which the line should be unactivated. This is a required datetime input and is sent in the request body as a timestamp. |
| Comment | An optional string input allowing the user to add a comment or reason for unactivating the line. This is sent in the request body. |
| Request Options | Settings to control request behavior such as batching, SSL certificate validation, proxy usage, and timeout duration. These options help customize how the API request is made. |
Output
JSON
response- The full response from the Dolibarr API after attempting to unactivate the contract line, including status and any returned data.
Dependencies
- Dolibarr API with valid API key credentials
Troubleshooting
- Ensure that the Contract ID and Line ID are valid and exist in the Dolibarr system to avoid 404 errors.
- Verify that the API credentials are correct and have sufficient permissions to modify contracts.
- Check the date format and ensure the Start Date is provided; missing or invalid dates may cause request failures.
- If SSL issues occur, consider enabling the 'Ignore SSL Issues' option, but be aware of security implications.
- Timeout errors can be resolved by increasing the timeout setting in Request Options if the server response is slow.
Links
- Dolibarr API Documentation - Contracts - Official Dolibarr API documentation for managing contracts, including operations like unactivating contract lines.