Lexware Office icon

Lexware Office

Interact with Lexware Office API

Actions61

Overview

This node interacts with the Lexware Office API to retrieve a list of vouchers based on various filtering criteria. Specifically, the "Voucherlist" resource with the "Get All" operation allows users to fetch multiple voucher records filtered by type, status, date ranges, amounts, and other attributes.

Common scenarios where this node is beneficial include:

  • Retrieving all sales invoices or purchase credit notes within a specific date range.
  • Filtering vouchers by their payment status or archived state for reporting or reconciliation.
  • Fetching vouchers related to a particular contact or currency.
  • Paginating through large sets of vouchers with sorting options.

Practical example: A user wants to get all open sales invoices created in the last month, sorted by creation date descending, to generate a report or trigger follow-up actions.

Properties

Name Meaning
Voucher Type Filter vouchers by type. Options include: All, Sales Invoice, Sales Credit Note, Purchase Invoice, Purchase Credit Note, Invoice, Down Payment Invoice, Credit Note, Order Confirmation, Quotation, Delivery Note, Dunning.
Voucher Status Filter vouchers by status. Options include: All, Draft, Open, Paid, Paid Off, Voided, Transferred, SEPA Debit, Overdue, Accepted, Rejected, Unchecked.
Archived Status Filter vouchers by archive state. Options: All, Archived Only, Public Only.
Contact ID Filter vouchers associated with a specific contact ID.
Voucher Date From Filter vouchers from this date (inclusive).
Voucher Date To Filter vouchers until this date (inclusive).
Created Date From Filter vouchers created from this date.
Created Date To Filter vouchers created until this date.
Updated Date From Filter vouchers updated from this date.
Updated Date To Filter vouchers updated until this date.
Voucher Number Search vouchers by their number.
Is Recurring Boolean filter to include only recurring vouchers.
Is Closing Invoice Boolean filter to include only closing invoices.
Is XRechnung Boolean filter to include only XRechnung vouchers.
Currency Filter vouchers by currency code (e.g., EUR, USD).
Language Filter vouchers by language code (e.g., de, en).
Min Amount Minimum amount value for filtering vouchers.
Max Amount Maximum amount value for filtering vouchers.
Tag Filter vouchers by tag string.
Return All Boolean indicating whether to return all matching results or limit the output.
Limit Maximum number of results to return if not returning all (1-250).
Page Page number for pagination (0-based).
Sort Sort order for results. Options include: Created At (Ascending/Descending), Updated At (Ascending/Descending), Voucher Date (Ascending/Descending), Name (Ascending/Descending), ID (Ascending/Descending).
Cursor Cursor string for cursor-based pagination.
Offset Offset number for offset-based pagination.

Output

The node outputs an array of JSON objects representing vouchers that match the specified filters. Each object contains detailed voucher data as returned by the Lexware Office API, including fields such as voucher ID, type, status, dates, amounts, contact information, and tags.

If the node is configured to return all results, it will output all matching vouchers; otherwise, it limits the output according to the Limit property.

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 provided by the credential configuration.
  • No additional external dependencies are required beyond the Lexware Office API access.

Troubleshooting

  • Missing Required Fields Error: If required parameters for the operation are missing, the node throws an error listing the missing fields. Ensure all mandatory inputs are provided.
  • API Authentication Errors: Invalid or missing API credentials will cause authentication failures. Verify the API key and resource URL in the credential settings.
  • Pagination Issues: When using pagination properties (Page, Cursor, Offset), ensure values are valid and consistent to avoid empty or repeated results.
  • Filter Misconfiguration: Using incompatible or incorrect filter values (e.g., invalid date formats or unsupported voucher types) may result in no data or errors. Double-check input formats and allowed options.

Links and References

This summary is based solely on static analysis of the provided source code and input property definitions.

Discussion