Lexware Office icon

Lexware Office

Interact with Lexware Office API

Actions61

Overview

The Lexware Office node allows users to interact with the Lexware Office API to manage various business resources such as contacts, articles, invoices, dunnings, and more. Specifically, the "Dunning - Finalize" operation changes the status of a dunning from draft to open, effectively finalizing it. This is useful in scenarios where you want to automate the process of moving a dunning notice to an active state after review or preparation.

Practical examples include:

  • Automatically finalizing a dunning notice after certain conditions are met in your workflow.
  • Integrating dunning management into your accounting or CRM system to streamline overdue payment reminders.

Properties

Name Meaning
Dunning ID The unique identifier of the dunning notice to finalize. This is a required string input.

Output

The node outputs a JSON array containing the response from the Lexware Office API after finalizing the dunning. The structure of the JSON depends on the API's response but typically includes details about the dunning such as its ID, status (now "open"), and other metadata.

If the operation fails and "Continue On Fail" is enabled, the output will include an error object with a message describing the failure.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential for authenticating with the Lexware Office API.
  • The node expects the API base URL and API key to be configured in the credentials.
  • No other external dependencies are required.

Troubleshooting

  • Missing Required Fields: If the Dunning ID is not provided, the node will throw an error indicating missing required fields.
  • Authentication Errors: Ensure that the API key credential is correctly configured and has sufficient permissions.
  • API Errors: The API might return errors if the dunning ID does not exist or if the dunning cannot be finalized (e.g., already finalized). The node will propagate these errors unless "Continue On Fail" is enabled.
  • Network Issues: Connectivity problems to the Lexware API endpoint can cause failures.

To resolve errors:

  • Verify that the Dunning ID is correct and exists in your Lexware system.
  • Check API credentials and permissions.
  • Enable "Continue On Fail" to handle errors gracefully in workflows.

Links and References

Discussion