eliDocs
/
Integrations

Directus

Run Beliq inside Directus Flows with the extension. Generate, validate, parse, and convert e-invoices and save the output to Directus Files.

Available

A Directus Flow operation for Beliq: one operation, four use cases. Generated and converted documents can be saved straight into Directus Files, so a following operation can attach them to a record.

Install

Install

  • Marketplace (self-hosted with MARKETPLACE_TRUST=all): search for directus-extension-beliq.
  • Manual:
npm install directus-extension-beliq

Run it in your Directus project directory, then restart Directus. Directus loads the extensions listed in that project’s package.json dependencies.

Or give the extension its own folder under extensions/ (the EXTENSIONS_PATH setting) holding its package.json and dist/, then restart Directus. Directus reads each folder’s package.json to find the entry points and skips a folder without one, so a bare dist/ is never loaded:

mkdir -p extensions/directus-extension-beliq
npm pack directus-extension-beliq
tar -xzf directus-extension-beliq-*.tgz --strip-components=1 -C extensions/directus-extension-beliq
Use it in a Flow

Use it in a Flow

Add the beliq operation to a Flow and pick an operation.

  • API Key: paste a key from the Beliq dashboard (Integration → API Keys), or leave it blank to read the BELIQ_API_KEY environment variable (recommended: keeps the key out of the flow definition).
  • Delivery (Generate as PDF, and Convert):
    • Save to Directus File (default) returns { fileId, filename, contentType, sizeBytes, ... }.
    • Base64 returns { base64, ... }.
  • Generate as XML returns { xml, contentType, ... }; Validate and Parse return their JSON result into the flow data chain.
Operations

Operations

  • Generate an invoice from a structured EN 16931 object, as XML or a hybrid PDF/A-3.
  • Validate a document against the pinned rule set and return the compliance verdict.
  • Parse a document into a structured invoice.
  • Convert a document between formats (CII, UBL, ZUGFeRD, Factur-X, XRechnung, Peppol BIS Billing 3.0).
Example flows

Example flows

The repo’s examples/ holds three ready-to-load Flow definitions and a zero-dependency import.mjs that POSTs one to your instance through the Flows API:

DIRECTUS_URL=https://directus.example.com \
DIRECTUS_TOKEN=<admin static token> \
node examples/import.mjs validate-uploaded-file.flow.json
See also

See also