Actions61
- Contact Actions
- Article Actions
- Voucher Actions
- Invoice Actions
- Down Payment Invoice Actions
- Quotation Actions
- Credit Note Actions
- Delivery Note Actions
- Dunning Actions
- File Actions
- Profile Actions
- Country Actions
- Payment Condition Actions
- Event Subscription Actions
- Recurring Template Actions
- Voucherlist Actions
- Trigger Actions
Overview
This node integrates with the Lexware Office API to retrieve recurring templates based on various filtering criteria. Specifically, the "Get All" operation for the "Recurring Template" resource allows users to fetch multiple recurring templates, optionally filtered by template type, status, contact, recurrence pattern, language, currency, and other attributes.
Common scenarios where this node is beneficial include:
- Automating retrieval of recurring invoice or quotation templates for reporting or processing.
- Filtering active or expiring recurring templates to manage billing cycles.
- Searching templates by tags, categories, or contact associations for targeted workflows.
Practical example:
- A user wants to fetch all active invoice templates that are expiring within the next 30 days to trigger renewal notifications.
- Another use case is retrieving all recurring quotation templates in English currency for financial analysis.
Properties
| Name | Meaning |
|---|---|
| Template Type | Filter by template type. Options: Invoice, Quotation, Order Confirmation, Delivery Note |
| Status | Filter by template status. Options: All, Active, Inactive, Draft, Archived |
| Active Status | Filter by active status. Options: All, Active Only, Inactive Only |
| Contact ID | Filter by contact ID (string) |
| Recurrence Type | Filter by recurrence type. Options: All, Daily, Weekly, Monthly, Quarterly, Yearly, Custom |
| Category | Filter by category (string) |
| Search Term | Search templates by name or description (string) |
| Expiring Within Days | Filter templates expiring within specified days (number, default 30) |
| Min Generation Count | Filter templates with minimum generation count (number, default 10) |
| Language | Filter by language code (e.g., de, en) (string) |
| Currency | Filter by currency code (e.g., EUR, USD) (string) |
| Tag | Filter by tag (string) |
| Return All | Whether to return all results or only up to a given limit (boolean) |
| Limit | Max number of results to return (number, min 1, max 250, default 50) |
| Page | Page number for pagination (0-based) (number, default 0) |
| Sort | Sort order for results. Options include Created At (Asc/Desc), Updated At (Asc/Desc), Voucher Date (Asc/Desc), Name (Asc/Desc), ID (Asc/Desc) |
| Cursor | Cursor for cursor-based pagination (string) |
| Offset | Offset for offset-based pagination (number, default 0) |
Output
The node outputs an array of JSON objects representing recurring templates matching the filter criteria. Each object contains detailed information about a recurring template, such as its type, status, recurrence pattern, associated contact, language, currency, tags, expiration details, and generation counts.
If the "Return All" option is false, the output is limited to the specified number of items (Limit).
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 and API key from the configured credentials to make 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.
- API 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 options (
Page,Cursor,Offset), ensure values are valid and consistent to avoid empty or incomplete results. - Filter Misconfiguration: Incorrect filter values (e.g., invalid status or template type) may result in no data returned. Double-check filter options.
- Rate Limits: Excessive requests might hit API rate limits; consider adjusting request frequency or enabling retry logic.
Links and References
- Lexware Office API Documentation (general reference for API endpoints and data models)
- n8n documentation on Using Credentials
- n8n documentation on Pagination
This summary is based on static analysis of the node's source code and provided property definitions. It reflects the behavior of the "Get All" operation for the "Recurring Template" resource in the Lexware Office integration node.