Lexware Office icon

Lexware Office

Interact with Lexware Office API

Actions61

Overview

This node integrates with the Lexware Office API to interact with various business resources, including Down Payment Invoices. Specifically, the "Get All" operation for the "Down Payment Invoice" resource allows users to retrieve multiple down payment invoices with flexible filtering, sorting, and pagination options.

Typical use cases include:

  • Fetching a list of all down payment invoices for reporting or reconciliation.
  • Retrieving filtered down payment invoices by status, date range, contact, or invoice number.
  • Integrating Lexware Office data into workflows that require batch processing or analysis of down payment invoices.

For example, a user might want to get all down payment invoices created within the last month, sorted by creation date descending, to generate a financial report.

Properties

Name Meaning
Return All Whether to return all results or limit the number of returned down payment invoices.
Limit Maximum number of down payment invoices to return (used if Return All is false).
Page Page number for paginated results (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)
Cursor Cursor string for cursor-based pagination.
Offset Offset number for offset-based pagination.
Closing Invoice ID Filter by associated closing invoice ID (optional).
Contact ID Filter down payment invoices by contact ID (optional).
Status Filter by status of the down payment invoice (optional).
Start Date Filter down payment invoices starting from this date (optional).
End Date Filter down payment invoices up to this date (optional).
Invoice Number Filter by invoice number (optional).
Tax Type Filter by tax type (optional).
Tax Sub Type Filter by tax subtype (optional).

Note: The last set of filters (Closing Invoice ID, Contact ID, Status, Start Date, End Date, Invoice Number, Tax Type, Tax Sub Type) are part of the additional fields available when performing the "Get All" operation on Down Payment Invoices.

Output

The node outputs an array of JSON objects representing down payment invoices retrieved from Lexware Office. Each object contains the properties of a down payment invoice as provided by the API, such as IDs, dates, status, amounts, contact references, and tax information.

If "Return All" is false, the output array length is limited to the specified "Limit". Otherwise, all matching records are returned.

The node does not output binary data 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 API credentials to send requests.
  • No additional external dependencies are required beyond the API access.

Troubleshooting

  • Missing Required Fields Error: If required parameters are not provided for the operation, the node throws an error listing missing fields. Ensure all mandatory inputs are filled.
  • API Authentication Errors: If the API key credential is invalid or missing, authentication will fail. Verify the API key and base URL in the credential settings.
  • Pagination Issues: When using pagination parameters like "Page", "Cursor", or "Offset", ensure values are valid and consistent to avoid empty or repeated results.
  • Rate Limits: The API may enforce rate limits; if exceeded, requests may fail temporarily. Adjust workflow frequency or handle errors with retries.
  • Empty Results: If no down payment invoices match the filters, the output will be an empty array. Check filter criteria for correctness.

Links and References

This summary is based on static analysis of the node's source code and provided property definitions, focusing on the "Down Payment Invoice" resource and "Get All" operation.

Discussion