@pdfgeneratorapi/n8n-nodes-pdf-generator-api 0.3.0 → 0.5.0

package/README.md

@@ -24,6 +24,12 @@ Use the package name: `@pdfgeneratorapi/n8n-nodes-pdf-generator-api`
 
 This node supports the following operations organized by resource:
 
+### Asset
+- **Generate QR Code** - Generate QR codes with customizable colors and logos
+  - Support for base64 and file output formats
+  - Optional logo overlay (from URL or base64)
+  - Customizable QR code color
+
 ### Document
 - **Generate** - Generate a PDF document from a template with data
 - **Generate (Async)** - Generate a PDF document asynchronously with callback
@@ -41,6 +47,7 @@ This node supports the following operations organized by resource:
 - **List** - List available templates
 - **Copy** - Create a copy of an existing template
 - **Get Data Fields** - Extract data fields used in a template
+- **Get Template Schema** - Get Template JSON Schema for validation
 - **Open Editor** - Get URL to open template editor
 - **Validate** - Validate template configuration
 
@@ -48,6 +55,17 @@ This node supports the following operations organized by resource:
 - **HTML to PDF** - Convert HTML content directly to PDF
 - **URL to PDF** - Convert a public URL to PDF
 
+### E-Invoice
+- **Create E-Invoice** - Create an EN 16931 e-invoice as UBL or CII XML
+- **Create Factur-X E-Invoice** - Create a Factur-X PDF with the CII XML embedded, rendered from a template
+- **Create XRechnung E-Invoice** - Create an XRechnung 3.0 e-invoice, validated against the German BR-DE rules
+- **Get Schema** - Get the JSON schema of the accepted invoice payload
+
+Notes for the three Create operations:
+- Base64 and file outputs both attach the document as a binary item named `data`
+- Validation errors from the API (for example `[BR-DE-2]`) are shown in the node error
+- Known API limitations: BT-11, BT-12, BT-19 and attachments are accepted but not written to the output, and an attachment with unpadded base64 returns a 500
+
 ### PDF Services
 - **Add Watermark** - Add text or image watermarks to PDF documents
 - **Encrypt Document** - Encrypt PDF documents with password protection
@@ -88,12 +106,20 @@ The node automatically handles JWT token generation using your API credentials.
 
 ## Usage
 
+### QR Code Generation
+1. Select **Resource**: Asset
+2. Select **Operation**: Generate QR Code
+3. Enter the content to encode (URL, text, etc.)
+4. Choose output format (Base64 or File)
+5. Optionally add a logo from URL or base64
+6. Customize QR code color
+
 ### Basic Document Generation
 1. Select **Resource**: Document
 2. Select **Operation**: Generate
 3. Choose your template from the dropdown
 4. Provide JSON data to merge with the template
-5. Select output format (Base64, URL, or File)
+5. Select output format (Base64, URL, Viewer, or File)
 
 ### HTML to PDF Conversion
 1. Select **Resource**: Conversion
@@ -102,6 +128,16 @@ The node automatically handles JWT token generation using your API credentials.
 4. Configure paper size and orientation
 5. Specify filename and output format
 
+### E-Invoice Generation
+1. Select **Resource**: E-Invoice
+2. Run **Get Schema** once to see the payload structure (Peppol BIS Billing 3.0 UBL, rooted at `ubl:Invoice`)
+3. Select **Create E-Invoice**, **Create XRechnung E-Invoice** or **Create Factur-X E-Invoice**
+4. Provide the invoice JSON in **Invoice Data**
+5. For Factur-X, choose a template whose fields are mapped to UBL element names (for example `{cbc:ID}`), and pick a **Profile**. The default Basic profile drops item level detail, so use EN 16931 or Extended when lines carry extra attributes
+6. The XML or PDF is attached as binary `data`, ready for an email or upload node
+
+XRechnung is the strictest option: the seller contact (BG-6) and a buyer reference (BT-10) are mandatory, and a missing element fails with the rule ID in the error message.
+
 ### PDF Processing
 - **Watermarking**: Add text or image watermarks with positioning options
 - **Encryption**: Protect PDFs with owner and user passwords
@@ -126,6 +162,7 @@ Example form data:
 ### Output Formats
 - **Base64**: Returns PDF as base64 encoded string in JSON
 - **URL**: Returns download URL (files stored for 30 days)
+- **Viewer**: Returns viewer URL for viewing/downloading (files stored for 30 days)
 - **File**: Returns binary PDF data for direct download
 
 ### Supported Document Formats
@@ -152,6 +189,25 @@ For workflows that should continue on errors, enable "Continue on Fail" in node
 
 ## Version history
 
+### 0.5.0
+- **New**: Added E-Invoice resource
+  - Create E-Invoice (EN 16931, UBL or CII), Create Factur-X E-Invoice, Create XRechnung E-Invoice, Get Schema
+  - Base64 and file outputs attach the document as binary `data`
+  - API validation messages are surfaced in the node error instead of a generic HTTP status text
+
+### 0.4.0
+- **New**: Added Asset resource with QR code generation
+  - Generate QR codes with customizable colors
+  - Optional logo overlay support (URL or base64)
+  - Base64 and file output formats
+- **New**: Added "Get Template Schema" operation to Template resource
+  - Returns Template JSON Schema for validation
+- **New**: Added "Viewer" output format for document generation
+  - Available for all document generation operations (sync, async, batch)
+  - Returns viewer URL for viewing/downloading PDFs
+  - Files stored for 30 days like URL format
+- 🔧 **Improved**: Enhanced output format descriptions and help text
+
 ### 0.3.0
 - 🔧 **Breaking**: Removed ZIP and XLSX format support
 - 🐛 **Fixed**: Parameter name collisions that caused UI issues with action generation