Lexware Office icon

Lexware Office

Interact with Lexware Office API

Actions61

Overview

This node integrates with the Lexware Office API to manage various business resources, including invoices. Specifically, the "Invoice - Get All" operation retrieves a list of invoices from the Lexware system based on multiple filtering and sorting criteria.

This operation is useful for scenarios where you need to fetch invoice data for reporting, auditing, synchronization with other systems, or automated workflows that depend on invoice status or attributes. For example, you could use it to:

  • Retrieve all unpaid invoices to trigger payment reminders.
  • Fetch invoices within a specific date range for monthly financial reports.
  • Filter invoices by currency or language for regional accounting purposes.
  • Get all recurring invoices to analyze subscription revenue.

Properties

Name Meaning
Invoice Status Filter invoices by their status. Options: All Statuses, Draft, Open, Paid, Voided, Overdue, Partially Paid.
Start Date Filter invoices with an invoice date on or after this date (format YYYY-MM-DD).
End Date Filter invoices with an invoice date on or before this date (format YYYY-MM-DD).
Due Date Start Filter invoices with a due date on or after this date (format YYYY-MM-DD).
Due Date End Filter invoices with a due date on or before this date (format YYYY-MM-DD).
Min Amount Filter invoices with an amount greater than or equal to this value.
Max Amount Filter invoices with an amount less than or equal to this value.
Search Term Text search filter to find invoices matching the given text in relevant fields.
XRechnung Only Boolean flag to filter only invoices that are XRechnung compliant (a German e-invoice standard).
Recurring Only Boolean flag to filter only recurring invoices.
Closing Invoice Only Boolean flag to filter only closing invoices.
Tax Type Filter invoices by tax type, e.g., vat, vatfree, export.
Currency Filter invoices by currency code, e.g., EUR, USD.
Language Filter invoices by language code, e.g., de, en.
Return All Whether to return all matching invoices or limit the number of results.
Limit Maximum number of invoices to return if Return All is false. Range: 1 to 250. Default is 50.
Page Page number for pagination (0-based index).
Sort Sort order for the results. Options include Created At (Ascending/Descending), Updated At (Ascending/Descending), Voucher Date (Ascending/Descending), Name (Ascending/Descending), ID (Ascending/Descending). Default is Created At Descending.
Cursor Cursor string for cursor-based pagination.
Offset Offset number for offset-based pagination.

Output

The output is a JSON array containing invoice objects retrieved from the Lexware Office API. Each object represents an invoice with its associated data fields as provided by the API. The exact structure depends on the API response but typically includes invoice identifiers, dates, amounts, status, contact information, and other metadata.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential for authenticating with the Lexware Office API.
  • The node uses the base URL configured in the credentials to send requests.
  • No additional external dependencies are required beyond the Lexware Office API access.

Troubleshooting

  • Missing Required Fields Error: If required parameters for the operation are not provided, the node throws an error listing missing fields. Ensure all mandatory inputs are set.
  • Authentication Errors: Invalid or missing API key credentials will cause authentication failures. Verify the API key and resource URL in the credentials.
  • Pagination Issues: When using pagination parameters like limit, page, cursor, or offset, ensure values are within valid ranges to avoid empty or incomplete results.
  • Filter Misconfiguration: Incorrect filter values (e.g., invalid date formats or unsupported currency codes) may result in no data returned or API errors. Validate input formats carefully.
  • API Rate Limits: Excessive requests might be throttled by the API. Respect any rate limits configured in the credentials or API settings.

Links and References


This summary is based on static analysis of the node's source code and property definitions without runtime execution.

Discussion