Lexware Office icon

Lexware Office

Interact with Lexware Office API

Actions61

Overview

This node interacts with the Lexware Office API to manage event subscriptions among other resources. Specifically, the Event Subscription - Get All operation retrieves a list of event subscriptions filtered and sorted according to user-defined criteria. This is useful for monitoring or managing webhook subscriptions related to various business events such as voucher creation, invoice status changes, contact creation, and more.

Typical use cases include:

  • Fetching all active event subscriptions for a particular event type to audit or manage webhook listeners.
  • Searching event subscriptions by description or tags to find specific subscriptions.
  • Paginating through large sets of event subscriptions with sorting and filtering options.

For example, a user might want to retrieve all active subscriptions for "Invoice Created" events to verify which webhooks are currently listening for new invoices.

Properties

Name Meaning
Event Type Type of event to subscribe to. Options include: Voucher Created, Voucher Changed, Invoice Created, Invoice Status Changed, Quotation Created, Credit Note Created, Delivery Note Created, Dunning Created, Contact Created, Article Created, File Uploaded, Payment Received.
Active Status Filter subscriptions by active status: All, Active Only, or Inactive Only.
Contact ID Filter event subscriptions associated with a specific contact ID.
Voucher Type Filter event subscriptions by voucher type (string).
Search Term Search subscriptions by description or tags (string).
Return All Boolean flag to return all results or limit the number of results returned.
Limit Maximum number of results to return when Return All is false (1 to 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). Default is Created At (Descending).
Cursor Cursor string for cursor-based pagination.
Offset Offset number for offset-based pagination (minimum 0).

Output

The node outputs a JSON array where each item represents an event subscription object retrieved from the Lexware Office API. Each subscription includes details such as event type, active status, associated contact ID, voucher type, description, tags, and other metadata depending on the API response.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Lexware Office API.
  • The node expects the base URL of the Lexware Office API to be configured in the credentials.
  • 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 fields like eventSubscriptionId (for get/update) or eventType (for create) are set.
  • API Authentication Errors: If the API key or resource URL is incorrect or missing, authentication will fail. Verify that the API key credential is correctly configured.
  • Pagination Issues: When using pagination parameters (page, limit, cursor, offset), ensure values are within allowed ranges and consistent with the API's pagination method.
  • Empty Results: If filters are too restrictive (e.g., filtering by a non-existent contact ID or event type), no results may be returned. Adjust filters accordingly.
  • Continue On Fail: If enabled, errors on individual items will not stop execution but return error messages per item.

Links and References

This summary covers the static analysis of the Lexware Office node focusing on the Event Subscription resource and its Get All operation as requested.

Discussion