Peppol Invoice to PDF Ruby

File to be converted. Value can be URL or file content.

Optional custom DOCX template used to render the Peppol invoice. The Peppol BIS Billing 3.0 (UBL) XML supplied as the source file is parsed and its values are substituted into the template's {{placeholder}} tokens. When this parameter is omitted, the bundled default template is used.

Text placeholders

Invoice identification:

• {{DocumentType}} — human-readable document type, resolved from UBL cbc:InvoiceTypeCode: 380 → INVOICE, 381 → CREDIT NOTE, 384 → CORRECTED INVOICE. Other codes are emitted verbatim.
• {{InvoiceNumber}} — UBL cbc:ID (e.g. INV-2025-001).
• {{IssueDate}} — UBL cbc:IssueDate (e.g. 2025-03-12).
• {{DueDate}} — UBL cbc:DueDate (e.g. 2025-04-11).
• {{Currency}} — UBL cbc:DocumentCurrencyCode (e.g. EUR, USD).
• {{BuyerReference}} — UBL cbc:BuyerReference (e.g. PO-12345).
• {{Note}} — UBL cbc:Note.

Parties (supplier from cac:AccountingSupplierParty, customer from cac:AccountingCustomerParty):

• {{SupplierName}} / {{CustomerName}} — cac:PartyLegalEntity/cbc:RegistrationName, falling back to cac:PartyName/cbc:Name.
• {{SupplierVatId}} / {{CustomerVatId}} — first non-empty cac:PartyTaxScheme/cbc:CompanyID.
• {{SupplierAddress}} / {{CustomerAddress}} — composed from cac:PostalAddress as StreetName, CityName, PostalZone, Country (empty parts skipped).

Contact (rendered inside {{#IF ShowContactDetails}} ... {{#ENDIF ShowContactDetails}}):

• {{SupplierContactName}} / {{CustomerContactName}} — cac:Contact/cbc:Name.
• {{SupplierContactPhone}} / {{CustomerContactPhone}} — cac:Contact/cbc:Telephone.
• {{SupplierContactEmail}} / {{CustomerContactEmail}} — cac:Contact/cbc:ElectronicMail.

Totals (from cac:LegalMonetaryTotal and cac:TaxTotal):

• {{TaxExclusiveAmount}} — net total before tax.
• {{TaxAmount}} — total VAT amount.
• {{PrepaidAmount}} — amount already paid.
• {{PayableAmount}} — final amount due.

Payment (from cac:PaymentMeans/cac:PayeeFinancialAccount):

• {{PayeeIBAN}} — account cbc:ID.
• {{PayeeAccountName}} — account cbc:Name.

Conditional sections

Wrap optional content in the template so it can be toggled via the ShowContactDetails and ShowNote parameters. The wrapper tags themselves are removed from the rendered output:

• {{#IF ShowContactDetails}} ... {{#ENDIF ShowContactDetails}} — kept when ShowContactDetails is true; the whole block is removed when false.
• {{#IF ShowNote}} ... {{#ENDIF ShowNote}} — kept when ShowNote is true; removed when false.

Table placeholders

Place each table placeholder in a single cell of a one-row template table — the row is cloned for each item, preserving formatting.

• {{InvoiceLines}} — one row per cac:InvoiceLine. Columns (in order): Description, Quantity, Unit Price, VAT %, Line Amount.
• {{VatBreakdown}} — one row per cac:TaxTotal/cac:TaxSubtotal. Columns (in order):
  • VAT Category label — VAT {percent}% for rated categories (e.g. VAT 21%), or a descriptive label with UNTDID 5305 code for non-rated ones: Standard rate (S), Zero-rated (Z), Exempt (E), Reverse charge (AE), Intra-community (K), Export (G), Out of scope (O), Canary Islands IGIC (L), Ceuta/Melilla IPSI (M).
  • Tax Amount with currency (e.g. 73.50 EUR).
  • Rate % (e.g. 21%, 8.5%).
  • Taxable Amount.

When enabled, supplier and customer contact details (name, phone, email) are included in the rendered invoice; when disabled, the contact block is hidden.

Takes effect by default when the bundled template is used. When a custom PeppolTemplateFile is supplied, the contact block must be wrapped with {{#IF ShowContactDetails}} ... {{#ENDIF ShowContactDetails}} for this parameter to have any effect.

When enabled, the invoice note is included in the rendered invoice; when disabled, the note block is hidden.

Takes effect by default when the bundled template is used. When a custom PeppolTemplateFile is supplied, the note block must be wrapped with {{#IF ShowNote}} ... {{#ENDIF ShowNote}} for this parameter to have any effect.

When the StoreFile parameter is set to True, your converted file is written to ConvertAPI’s encrypted, temporary storage and made available via a time-limited secure download URL, valid for up to 3 hours. After this period, the file is permanently deleted.

When StoreFile is set to False, conversion happens entirely in-memory. The raw file bytes are streamed back in the API response without touching disk or external storage, ensuring maximum security and zero persistence so that only you can access the content.