Package Exports

@pixelandprocess_de/n8n-nodes-lexware-office
@pixelandprocess_de/n8n-nodes-lexware-office/dist/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@pixelandprocess_de/n8n-nodes-lexware-office) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

n8n Lexware Office Custom Node

A comprehensive n8n custom node for seamless integration with the Lexware Office API. This node provides full access to all major business resources including articles, contacts, invoices, orders, payments, and more, with advanced features like EU tax compliance, smart filtering, and comprehensive error handling.

🚀 Quick Start

Prerequisites

n8n: Version 0.125.0 or higher
Node.js: Version 18.0.0 or higher
Lexware Office API: Valid API credentials

Installation

Method 1: NPM Install (Recommended)

cd ~/.n8n/custom
npm install @pixelandprocess_de/n8n-nodes-lexware-office

Note: The package will be installed as @pixelandprocess_de/n8n-nodes-lexware-office in your custom nodes directory.

Method 2: Manual Installation

git clone https://github.com/fwartner/n8n-nodes-lexware-office.git
cd n8n-nodes-lexware-office
npm install && npm run build
cp -r dist ~/.n8n/custom/@pixelandprocess_de/n8n-nodes-lexware-office

Method 3: Docker Installation

volumes:
  - ./custom-nodes:/home/node/.n8n/custom
environment:
  - N8N_CUSTOM_EXTENSIONS=/home/node/.n8n/custom

Then install the package in the custom-nodes directory:

mkdir -p custom-nodes
cd custom-nodes
npm install @pixelandprocess_de/n8n-nodes-lexware-office
docker-compose restart n8n

Method 4: GitHub Installation

For developers or users who want the latest features:

cd ~/.n8n/custom
git clone https://github.com/fwartner/n8n-nodes-lexware-office.git
cd n8n-nodes-lexware-office
npm install && npm run build
cp -r dist ../@pixelandprocess_de/n8n-nodes-lexware-office

See GitHub Installation Guide for detailed instructions.

Configuration

Restart n8n after installation
Add credentials for your Lexware Office API
Use the node in your workflows

✨ Features

🔗 Full API Coverage: All major Lexware Office resources supported
🌍 EU Tax Compliance: Built-in support for European business requirements
🔍 Smart Filtering: Advanced search and filtering capabilities
📊 Status Management: Comprehensive status tracking and transitions
📄 Document Generation: PDF rendering and file download support
⚡ Performance: Optimized with rate limiting and caching
🛡️ Error Handling: Robust error management and validation
🔧 Type Safety: Full TypeScript support with comprehensive interfaces

📦 Supported Resources

Resource	Operations	Description
📋 Articles	CRUD + Specialized	Product and service management
👥 Contacts	CRUD + Specialized	Customer and vendor management
🌍 Countries	CRUD + Specialized	Geographic and tax information
🧾 Invoices	CRUD + Specialized	Full lifecycle management
📋 Orders	CRUD + Specialized	Order confirmation and documents
💰 Payments	CRUD + Specialized	Payment processing and tracking
📝 Quotations	CRUD + Specialized	Quote management and conversion
📊 Vouchers	CRUD + Specialized	Accounting voucher handling
📁 Files	CRUD + Specialized	Document management and metadata
⏰ Dunnings	CRUD + Specialized	Payment reminder management
🚚 Delivery Notes	CRUD + Specialized	Delivery tracking and management
💳 Credit Notes	CRUD + Specialized	Credit and refund management
💸 Down Payment Invoices	CRUD + Specialized	Partial payment handling
🔔 Event Subscriptions	CRUD + Specialized	Webhook and event management
⏱️ Payment Conditions	CRUD + Specialized	Payment terms and conditions
🏷️ Posting Categories	CRUD + Specialized	Accounting categorization
🎨 Print Layouts	CRUD + Specialized	Document formatting and templates
👤 Profiles	CRUD + Specialized	User and system profiles
🔄 Recurring Templates	CRUD + Specialized	Automated recurring operations
🚀 Triggers	Webhook Events	Real-time event monitoring and webhooks

🎯 Available Operations

Operation	Description	Resources
Create	Create new resources	All resources
Get	Retrieve single resource	All resources
Get All	List resources with filtering	All resources
Update	Modify existing resources	All resources
Delete	Remove resources	All resources
Specialized	Resource-specific operations	Varies by resource
Webhook Triggers	Real-time event monitoring	All business events

🔔 Webhook Triggers & Events

The Lexware Office Trigger Node provides real-time event monitoring capabilities for your workflows:

Event Types Supported

Contact Events: contact.created, contact.updated, contact.deleted
Invoice Events: invoice.created, invoice.status.changed, invoice.paid, invoice.overdue
Quotation Events: quotation.created, quotation.accepted, quotation.rejected
Payment Events: payment.received, payment.processed
Article Events: article.created, article.updated, article.deleted
File Events: file.uploaded
Dunning Events: dunning.created, dunning.status.changed

Advanced Features

Smart Filtering: Filter by contact ID, voucher type, status, amount, and date ranges
Webhook Security: HMAC-SHA256 signature verification
Retry Mechanism: Automatic retry of failed deliveries
Event Logging: Comprehensive monitoring and statistics

Use Cases

Automated Customer Communication: Welcome emails, payment confirmations
Invoice Processing: Status updates, payment reconciliation
Sales Follow-up: Quotation management, opportunity tracking
Document Management: File processing, automated workflows

📖 Complete Trigger Documentation - Detailed webhook trigger guide

🏗️ Project Structure

n8n-lexware-office/
├── 📁 dist/                    # Compiled JavaScript files
├── 📁 nodes/                   # Node implementations
│   └── 📁 LexwareOffice/      # Main node with SVG icon
│       ├── LexwareOffice.node.ts      # Main node implementation
│       └── LexwareOfficeTrigger.node.ts # Webhook trigger node
├── 📁 credentials/             # Credential types
├── 📁 resources/               # API resource handlers
├── 📁 utils/                   # Utility functions
├── 📁 types/                   # TypeScript type definitions
├── 📁 constants/               # Constants and enums
├── 📁 scripts/                 # Build scripts
├── 📄 package.json             # Package configuration
├── 📄 tsconfig.json            # TypeScript configuration
├── 📄 README.md                # This file
├── 📄 INSTALLATION.md          # Installation guide
├── 📄 LICENSE                  # MIT license
├── 📄 .eslintrc.js            # ESLint configuration
├── 📄 .prettierrc             # Prettier configuration
└── 📁 .github/                 # GitHub configurations

🔧 Advanced Features

Smart Filtering

Multi-criteria filtering with AND/OR logic
Text-based search across multiple fields
Date range filtering with timezone support
Custom field filtering for extended data

EU Tax Compliance

XRechnung support for German e-invoices
EU country detection and tax rate management
Distance sales support for cross-border operations
Tax classification with automatic validation

Error Handling

Comprehensive error codes with detailed messages
HTTP status handling with proper error responses
Rate limiting with automatic retry logic
Validation errors with field-specific messages

📚 Documentation

📖 Installation Guide - Complete setup instructions
🐙 GitHub Installation - Install directly from GitHub
🔧 API Reference - Detailed operation documentation
🚀 Quick Start - Get up and running fast
🏗️ Project Structure - Code organization
📋 Supported Resources - Available functionality
🔔 Webhook Triggers - Complete trigger and event documentation

🛠️ Development

Setup

git clone https://github.com/fwartner/n8n-nodes-lexware-office.git
cd n8n-nodes-lexware-office
npm install

Available Scripts

Script	Description
`npm run build`	Build the project
`npm run dev`	Watch mode for development
`npm run clean`	Clean build artifacts
`npm run lint`	Run ESLint
`npm run lint:fix`	Fix ESLint issues
`npm run format`	Format code with Prettier
`npm run format:check`	Check code formatting
`npm test`	Run tests (placeholder)

Building for Production

npm run clean
npm run build
npm pack --dry-run  # Test package creation

Testing

# Build and test package
npm run build
npm pack --dry-run

# Verify dist folder contents
ls -la dist/

🤝 Contributing

We welcome contributions! Please see our Contributing Guide for details.

🐛 Report Bugs: Use our Bug Report Template
💡 Request Features: Use our Feature Request Template
🔧 Submit PRs: Follow our Pull Request Template
📚 Improve Docs: Help make our documentation better

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🆘 Support

📖 Documentation: Check our Installation Guide
💬 GitHub Issues: Report problems or request features
🌐 n8n Community: Visit the n8n Community Forum
📧 Email: Contact us at florian+npm@pixelandprocess.de

🌟 Why Choose This Node?

🔒 Enterprise Ready: Production-grade with comprehensive error handling
🌍 EU Compliant: Built-in support for European business requirements
📊 Comprehensive: Covers all major Lexware Office resources
🚀 Performance: Optimized with smart caching and rate limiting
🛡️ Reliable: Robust error handling and validation
🔧 Maintainable: Clean, well-documented TypeScript code
🤝 Community: Open source with active community support

📊 Statistics

12+ Business Resources supported
50+ Operations available
25+ Event Types for webhook triggers
100% TypeScript codebase
MIT License for maximum flexibility
Active Development with regular updates
Community Driven with open contribution

⭐ Star This Repository

If this project helps you, please give it a star! It motivates us to keep improving and adding new features.

📞 Contact

Author: Florian Wartner
Email: florian+npm@pixelandprocess.de
GitHub: @fwartner
Website: pixelandprocess.de

Built with ❤️ for the n8n community