mittwald icon

mittwald

Interact with mittwald mStudio API

Actions409

Overview

This node operation allows you to terminate a specific contract item within a contract using the mittwald mStudio API. It is useful in scenarios where you need to end a service or subscription associated with a contract item before its natural expiration date. For example, if a server or service is no longer needed, you can provide a termination reason and optionally specify a termination target date to control when the contract item should be ended.

Properties

Name Meaning
Contract Id The unique identifier of the contract containing the item to be terminated.
Contract Item Id The unique identifier of the specific contract item to terminate.
Reason A plain text explanation for why the contract item is being terminated.
Termination Target Date Optional. The desired termination date for the contract item. Must be valid according to contract rules. If omitted, the next possible termination date will be used automatically.

Output

The node outputs JSON data representing the response from the mittwald mStudio API after attempting to terminate the contract item. This typically includes confirmation details about the termination status, any updated contract item information, or error messages if the termination failed. The output does not include binary data.

Dependencies

  • Requires an API key credential for authenticating with the mittwald mStudio API.
  • The node uses the base URL https://api.mittwald.de and expects JSON content-type headers.
  • No additional external dependencies are required beyond the configured API authentication.

Troubleshooting

  • Invalid Contract or Contract Item ID: If the provided IDs do not exist or are incorrect, the API will return an error. Verify that the IDs are correct and correspond to existing resources.
  • Invalid Termination Target Date: Providing a termination date outside the allowed activation or contract period may cause errors. Ensure the date is valid or leave it empty to use the default next possible termination date.
  • Missing Required Fields: Both Contract Id and Contract Item Id are mandatory. Omitting them will prevent the request from being sent.
  • API Authentication Errors: Ensure the API key credential is correctly configured and has sufficient permissions to perform contract terminations.
  • Network or API Downtime: Temporary connectivity issues or API outages can cause failures. Retry after some time or check the API status.

Links and References

Discussion