mittwald icon

mittwald

Interact with mittwald mStudio API

Actions100

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 agreement associated with a particular contract item, for example, when a server or resource is no longer needed and should be formally terminated on the contract level.

Practical examples include:

  • Terminating a hosting service contract item when migrating to another provider.
  • Ending a software license contract item that is no longer required.
  • Cancelling a specific part of a multi-item contract without affecting other items.

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 (e.g., "Server wird nicht mehr benötigt").
Termination Target Date The desired termination date for the contract item. Must be valid according to the contract's activation and period. 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 specified contract item. This typically includes confirmation details about the termination request, such as status, effective dates, and any messages returned by the API.

No binary data output is indicated.

Dependencies

  • Requires an API key credential for authenticating with the mittwald mStudio API.
  • The node uses the base URL https://api.mittwald.de for API requests.
  • Proper configuration of the API credential in n8n is necessary for successful execution.

Troubleshooting

  • Invalid Contract or Contract Item ID: If the provided IDs do not exist or are incorrect, the API will likely return an error indicating the resource was not found. Verify the IDs before running the node.
  • Invalid Termination Date: Providing a termination date outside the allowed contract period or activation range may cause errors. Ensure the date complies with contract rules or leave it empty to use the default next possible date.
  • Missing Required Fields: Both Contract Id and Contract Item Id are mandatory. Omitting them will prevent the node from executing properly.
  • Authentication Errors: Ensure the API key credential is correctly set up and has sufficient permissions to perform contract terminations.
  • API Rate Limits or Downtime: Temporary failures might occur due to API rate limits or service outages. Retrying after some time or checking API status can help.

Links and References

Discussion