Lexware icon

Lexware

Interact with the Lexware API

Overview

The Lexware node integrates with the Lexware API, enabling automation of various business document workflows. Specifically, the Dunnings - Create operation allows users to create a dunning notice (a reminder or demand for payment) based on an existing sales voucher (invoice). This is useful in scenarios where businesses want to automate follow-ups on unpaid invoices by generating dunning letters programmatically.

Practical examples include:

  • Automatically creating dunning notices for overdue invoices in an accounting workflow.
  • Adding custom line items or notes to dunning notices before sending them to customers.
  • Finalizing and issuing dunning notices as part of a larger accounts receivable automation process.

Properties

Name Meaning
Preceding Sales Voucher ID The ID of the sales voucher (invoice) that the dunning notice refers to; this is required to link the dunning to the original invoice.
Voucher Date The date assigned to the dunning notice document.
Title A title or subject line for the dunning notice.
Additional Line Items Extra line items to append after the original invoice's items in the dunning notice. Each item can be either "Custom" or "Text" type, with details such as name, description, quantity, unit name, pricing (currency, net/gross amount, tax rate), discount percentage, and total line item amount.
Finalize Boolean flag indicating whether to finalize the dunning creation immediately. If true, the dunning is completed and ready for further processing or sending.

Output

The node outputs JSON data representing the created dunning notice. This typically includes details such as the dunning ID, linked sales voucher ID, line items (including any additional ones added), dates, titles, status, and other metadata returned by the Lexware API.

If binary data output is supported (not explicitly shown here), it would likely represent generated documents such as PDFs of the dunning notice.

Dependencies

  • Requires an API key credential for authenticating with the Lexware API.
  • The node depends on the Lexware API being accessible and properly configured.
  • No additional environment variables are indicated beyond the API authentication.

Troubleshooting

  • Common issues:

    • Invalid or missing preceding sales voucher ID will cause the API to reject the dunning creation.
    • Incorrect date formats for the voucher date may lead to errors.
    • Adding line items with incomplete or invalid fields (e.g., negative quantities or prices) might cause validation failures.
    • Attempting to finalize a dunning without proper permissions or in an invalid state could result in errors.
  • Error messages:

    • "Unsupported resource" error if the resource parameter is not set to "dunnings".
    • API errors related to authentication failure if the API key is invalid or missing.
    • Validation errors from the API when required fields are missing or malformed.

To resolve these, ensure all required fields are correctly filled, the API credentials are valid, and the referenced sales voucher exists and is accessible.

Links and References


Note: The above summary is based solely on static analysis of the provided source code and property definitions.

Discussion