Prototype · Preview: every server in the official registry, synced every 30 minutes. Sign in with Google to write reviews.Prototype · updated every 30 min
PopNx MCPMCP servers for people who use AI · explained in plain words Sign in

beliq

by beliq-euversion 0.5.0i★ 0iRuns on your computerOfficial site ↗
Registry nameio.github.beliq-eu/beliq-mcp

How to install

What it does

Validate, parse, generate and convert EU e-invoices (XRechnung, ZUGFeRD, Factur-X, Peppol BIS).

  • Connects Runs on your computer
  • Account or key Needs BELIQ_API_KEY, BELIQ_AUTH
  • Category Accounting, finance & tax

Why it ranks here

Lists are ordered by a usage score (out of 100) built from these parts

Popularity0/80GitHub stars or weekly downloads: the larger counts 60, the smaller 20
Freshness12/12Full marks for a release or code change within 30 days
Still answering0/8The cloud endpoint answered at the last check
Usage score12/100

Quality: Passed 3/3 basic checks (shown, not used for ordering) · Momentum: No data yet (Used only on the Trending tab)

Install

Pick the AI app you use, then copy the settings.

Let your AI install it with one sentence

Please install beliq. Follow https://mcp.popnx.com/i/beliq-eu-beliq-mcp.md, show me the commands and wait for my OK before running them.

Paste it into an AI that can work on your computer (such as Claude Code or Cursor). It reads our steps, shows you the commands and waits for your OK. No key, no sign-up. · See the full text your AI reads

Passed 3/3 checks · Runs on your computer · ✓ Commands checked Nov 17, 2026

First: which AI do you use?

Pick your app and the steps appear below.

Works with Claude, with some setup first

You need a beliq key (create it on the maker’s site) · Install Node.js on your computer first (one time) · Only the Claude desktop app (Windows or Mac), not the web or phone

Let AI install it

Copy this message into a Claude chat. The AI checks your computer, tells you which file it will change, and waits for your OK every time.

Please install the MCP server beliq for Claude on this computer, in this order: 1) Check Node.js with node -v. If it is missing, tell me to install it from https://nodejs.org/en/download; do not install it yourself. 2) Use only this config (already checked by PopNx MCP): { "mcpServers": { "beliq": { "command": "npx", "args": [ "-y", "beliq-mcp" ], "env": { "BELIQ_API_KEY": "your-value", "BELIQ_AUTH": "your-value" } } } } 3) Tell me the full path of the file you will change, or the command you will run, and wait for my OK. 4) For BELIQ_API_KEY, BELIQ_AUTH, leave "your-value" in place and tell me to paste the real value myself into the file or the app’s field. Never ask me to type a key in chat. 5) Do what we agreed, then check that the beliq tools really show up.

This message has no key in it. If a key is needed, the AI will ask you to paste it yourself into the file or the app’s field.

  1. Install Node.js (if you don’t have it)

    Already installed? Check first · Open Terminal, type this command and press Enter

    node -v
    • A version number such as v26.13.1 = installed, skip this step
    • "command not found" (on Windows: "is not recognized") = not installed yet, or installed but Terminal needs to be closed and reopened
    How to open Terminal

    Mac: press ⌘ + Space, type Terminal, press Enter

    Windows: open Start, type Windows PowerShell, then Open

    Not installed: Open the official download page, pick the LTS version and the click-through installer: .pkg on Mac · .msi on Windows. Double-click and follow it to the end. No curl command needed

    Open the Node.js download page ↗

    When it’s done, close Terminal, open it again and run the same command. You should see a version number: node -v

    Install once; it works for everything that needs Node.js

  2. Sign up and create a beliq key

    Open the maker’s site, sign up and create an API key for the next step. Check the maker’s site for pricing and free plans.

    Open the beliq site ↗

  3. Open the Claude desktop app’s settings file

    SettingsDeveloperEdit Config

  4. Paste these settings and save the file

    {
      "mcpServers": {
        "beliq": {
          "command": "npx",
          "args": [
            "-y",
            "beliq-mcp"
          ],
          "env": {
            "BELIQ_API_KEY": "your-value",
            "BELIQ_AUTH": "your-value"
          }
        }
      }
    }

    Paste the key only into the app’s field, never into a chat or to anyone

  5. Quit Claude and open it again

  6. Try it

    Use beliq and tell me what you can do for me, then show me one thing

    ✓ If Claude says it is using beliq or shows a beliq tool in the answer, you are connected

Menu names checked against Anthropic’s help page on Nov 11, 2026 · your screen may differ slightly by app version

ChatGPT cannot connect beliq yet

beliq runs on your computer, but ChatGPT can only connect servers that run on the web

What you can do instead

A · Use an app that can connect beliq

  • You need a beliq key (create it on the maker’s site) · Install Node.js on your computer first (one time) · Only the Claude desktop app (Windows or Mac), not the web or phone
  • You need a beliq key (create it on the maker’s site) · Install Node.js on your computer first (one time)
  • You need a beliq key (create it on the maker’s site) · Install Node.js on your computer first (one time)
  • You need a beliq key (create it on the maker’s site) · Install Node.js on your computer first (one time)

B · Others in Accounting, finance & tax that work with ChatGPT

Picked from the most used in the same category, only ones that connect by address with no key

Works with Claude Code, with some setup first

You need a beliq key (create it on the maker’s site) · Install Node.js on your computer first (one time)

Let AI install it

Copy this message into a Claude Code chat. The AI checks your computer, tells you which file it will change, and waits for your OK every time.

Please install the MCP server beliq for Claude Code on this computer, in this order: 1) Check Node.js with node -v. If it is missing, tell me to install it from https://nodejs.org/en/download; do not install it yourself. 2) Use only this config (already checked by PopNx MCP): claude mcp add --scope user beliq --env BELIQ_API_KEY=your-value --env BELIQ_AUTH=your-value -- npx -y beliq-mcp 3) Tell me the full path of the file you will change, or the command you will run, and wait for my OK. 4) For BELIQ_API_KEY, BELIQ_AUTH, leave "your-value" in place and tell me to paste the real value myself into the file or the app’s field. Never ask me to type a key in chat. 5) Do what we agreed, then check that the beliq tools really show up.

This message has no key in it. If a key is needed, the AI will ask you to paste it yourself into the file or the app’s field.

  1. Install Node.js (if you don’t have it)

    Already installed? Check first · Open Terminal, type this command and press Enter

    node -v
    • A version number such as v26.13.1 = installed, skip this step
    • "command not found" (on Windows: "is not recognized") = not installed yet, or installed but Terminal needs to be closed and reopened
    How to open Terminal

    Mac: press ⌘ + Space, type Terminal, press Enter

    Windows: open Start, type Windows PowerShell, then Open

    Not installed: Open the official download page, pick the LTS version and the click-through installer: .pkg on Mac · .msi on Windows. Double-click and follow it to the end. No curl command needed

    Open the Node.js download page ↗

    When it’s done, close Terminal, open it again and run the same command. You should see a version number: node -v

    Install once; it works for everything that needs Node.js

  2. Sign up and create a beliq key

    Open the maker’s site, sign up and create an API key for the next step. Check the maker’s site for pricing and free plans.

    Open the beliq site ↗

  3. Open Terminal

    Mac: press Command+Space and type Terminal · Windows: open PowerShell

  4. Paste this command and press Enter

    claude mcp add --scope user beliq --env BELIQ_API_KEY=your-value --env BELIQ_AUTH=your-value -- npx -y beliq-mcp

    Replace “your-value” with your key before pressing Enter

    Paste the key only into the app’s field, never into a chat or to anyone

  5. Type /mcp in Claude Code

    You should see beliq listed as connected

  6. Try it

    Use beliq and tell me what you can do for me, then show me one thing

    ✓ If Claude Code says it is using beliq or shows a beliq tool in the answer, you are connected

Menu names checked against Anthropic’s help page on Nov 11, 2026 · your screen may differ slightly by app version

Works with Cursor, with some setup first

You need a beliq key (create it on the maker’s site) · Install Node.js on your computer first (one time)

Let AI install it

Copy this message into a Cursor chat. The AI checks your computer, tells you which file it will change, and waits for your OK every time.

Please install the MCP server beliq for Cursor on this computer, in this order: 1) Check Node.js with node -v. If it is missing, tell me to install it from https://nodejs.org/en/download; do not install it yourself. 2) Use only this config (already checked by PopNx MCP): { "mcpServers": { "beliq": { "command": "npx", "args": [ "-y", "beliq-mcp" ], "env": { "BELIQ_API_KEY": "your-value", "BELIQ_AUTH": "your-value" } } } } 3) Tell me the full path of the file you will change, or the command you will run, and wait for my OK. 4) For BELIQ_API_KEY, BELIQ_AUTH, leave "your-value" in place and tell me to paste the real value myself into the file or the app’s field. Never ask me to type a key in chat. 5) Do what we agreed, then check that the beliq tools really show up.

This message has no key in it. If a key is needed, the AI will ask you to paste it yourself into the file or the app’s field.

  1. Install Node.js (if you don’t have it)

    Already installed? Check first · Open Terminal, type this command and press Enter

    node -v
    • A version number such as v26.13.1 = installed, skip this step
    • "command not found" (on Windows: "is not recognized") = not installed yet, or installed but Terminal needs to be closed and reopened
    How to open Terminal

    Mac: press ⌘ + Space, type Terminal, press Enter

    Windows: open Start, type Windows PowerShell, then Open

    Not installed: Open the official download page, pick the LTS version and the click-through installer: .pkg on Mac · .msi on Windows. Double-click and follow it to the end. No curl command needed

    Open the Node.js download page ↗

    When it’s done, close Terminal, open it again and run the same command. You should see a version number: node -v

    Install once; it works for everything that needs Node.js

  2. Sign up and create a beliq key

    Open the maker’s site, sign up and create an API key for the next step. Check the maker’s site for pricing and free plans.

    Open the beliq site ↗

  3. Click this button to open Cursor

    Open in Cursor

    Cursor asks you to confirm; click Install

  4. Fill in your key

    In the beliq settings, BELIQ_API_KEY, BELIQ_AUTH is empty; add your key and save

    Paste the key only into the app’s field, never into a chat or to anyone

  5. Open the AI chat in Cursor in Agent mode

  6. Try it

    Use beliq and tell me what you can do for me, then show me one thing

    ✓ If Cursor says it is using beliq or shows a beliq tool in the answer, you are connected

Menu names checked against Cursor’s help page on Nov 11, 2026 · your screen may differ slightly by app version

Works with VS Code, with some setup first

You need a beliq key (create it on the maker’s site) · Install Node.js on your computer first (one time)

Let AI install it

Copy this message into a VS Code chat. The AI checks your computer, tells you which file it will change, and waits for your OK every time.

Please install the MCP server beliq for VS Code on this computer, in this order: 1) Check Node.js with node -v. If it is missing, tell me to install it from https://nodejs.org/en/download; do not install it yourself. 2) Use only this config (already checked by PopNx MCP): { "servers": { "beliq": { "type": "stdio", "command": "npx", "args": [ "-y", "beliq-mcp" ], "env": { "BELIQ_API_KEY": "your-value", "BELIQ_AUTH": "your-value" } } } } 3) Tell me the full path of the file you will change, or the command you will run, and wait for my OK. 4) For BELIQ_API_KEY, BELIQ_AUTH, leave "your-value" in place and tell me to paste the real value myself into the file or the app’s field. Never ask me to type a key in chat. 5) Do what we agreed, then check that the beliq tools really show up.

This message has no key in it. If a key is needed, the AI will ask you to paste it yourself into the file or the app’s field.

  1. Install Node.js (if you don’t have it)

    Already installed? Check first · Open Terminal, type this command and press Enter

    node -v
    • A version number such as v26.13.1 = installed, skip this step
    • "command not found" (on Windows: "is not recognized") = not installed yet, or installed but Terminal needs to be closed and reopened
    How to open Terminal

    Mac: press ⌘ + Space, type Terminal, press Enter

    Windows: open Start, type Windows PowerShell, then Open

    Not installed: Open the official download page, pick the LTS version and the click-through installer: .pkg on Mac · .msi on Windows. Double-click and follow it to the end. No curl command needed

    Open the Node.js download page ↗

    When it’s done, close Terminal, open it again and run the same command. You should see a version number: node -v

    Install once; it works for everything that needs Node.js

  2. Sign up and create a beliq key

    Open the maker’s site, sign up and create an API key for the next step. Check the maker’s site for pricing and free plans.

    Open the beliq site ↗

  3. Click this button to open VS Code

    Open in VS Code

    VS Code asks you to confirm; click Install

  4. Fill in your key

    In the beliq settings, BELIQ_API_KEY, BELIQ_AUTH is empty; add your key and save

    Paste the key only into the app’s field, never into a chat or to anyone

  5. Open the AI chat in VS Code in Agent mode

  6. Try it

    Use beliq and tell me what you can do for me, then show me one thing

    ✓ If VS Code says it is using beliq or shows a beliq tool in the answer, you are connected

Menu names checked against VS Code’s help page on Nov 11, 2026 · your screen may differ slightly by app version

Other apps that use MCP, such as Windsurf, Zed or Gemini CLI, each add servers differently. See how in the app list.

See every app that uses MCP →

JSON settings are under “For developers” below

Stuck? Ask people who use beliq💬 Discussion →
For developers: Terminal commands and JSON settings

Installed on your computer

Claude Code

claude mcp add --scope user beliq --env BELIQ_API_KEY=your-value --env BELIQ_AUTH=your-value -- npx -y beliq-mcp

Claude Desktop (claude_desktop_config.json)

{
  "mcpServers": {
    "beliq": {
      "command": "npx",
      "args": [
        "-y",
        "beliq-mcp"
      ],
      "env": {
        "BELIQ_API_KEY": "your-value",
        "BELIQ_AUTH": "your-value"
      }
    }
  }
}

Cursor (~/.cursor/mcp.json)

{
  "mcpServers": {
    "beliq": {
      "command": "npx",
      "args": [
        "-y",
        "beliq-mcp"
      ],
      "env": {
        "BELIQ_API_KEY": "your-value",
        "BELIQ_AUTH": "your-value"
      }
    }
  }
}

VS Code (mcp.json)

{
  "servers": {
    "beliq": {
      "type": "stdio",
      "command": "npx",
      "args": [
        "-y",
        "beliq-mcp"
      ],
      "env": {
        "BELIQ_API_KEY": "your-value",
        "BELIQ_AUTH": "your-value"
      }
    }
  }
}

Values you fill in

  • BELIQ_API_KEY secret required env
    API key from the beliq dashboard (API Keys).
  • BELIQ_AUTH secret required env
    How the key is sent: header (X-API-Key) or bearer (Authorization: Bearer).

Descriptions are as written by the maker.

These settings are generated from the maker’s registry entry. If the README says otherwise, follow the README.

At a glance

Downloads per weeki
18/wk
Connection
Runs on your computer
Latest versioni
0.5.0
Published to registryi
Nov 17, 2026
Code last changedi
Nov 18, 2026
Maker
beliq-eu
Packages
npm: beliq-mcp
Registry status
Active

Which apps can use it

Based on how this server connects and on each app’s own docs, checked Nov 10, 2026.

Run on your computer in

ClaudeGooseLM StudioMsty StudioCherry StudioCursorVS Code + GitHub CopilotVisual StudioWindsurf (Devin Desktop)ZedKiroClineContinueJetBrains AI AssistantClaude CodeCodex CLIGemini CLIOpenCodenodecodeWarpLibreChatRaycast

All apps, with pros and cons →

Related guides

What it can do

Runs on your computer; the tool list appears in your AI app after you install it.

Basic checksi

We check information anyone can see; we have not read the code. Checks that do not apply are left out of the count. · Checked Nov 20, 2026

  • ✓ Pass

    Maker matches the repo

    The registry name was verified with the GitHub account beliq-eu, which owns the repo

  • ✓ Pass

    Still maintained

    Code last changed 2 days ago

  • ✓ Pass

    Has a licence

    Uses MIT

  • – Not applicable

    Endpoint responds

    This one runs on your computer; there is no internet endpoint

  • – Not applicable

    Sign-in with OAuth

    Runs on your computer and uses local settings instead

  • … Not checked yet

    No hidden instructions in tool descriptions

    Runs on your computer; we can only read tool lists from internet endpoints

Published vulnerabilities (OSV.dev)

No entries on OSV.dev for beliq-mcp@0.5.0

Checks only this package version, not every dependency · checked Nov 17, 2026

What we check → · JSON

Makers: ask for a re-check or report wrong info
For makers: add a badge to your README

If you made this, paste this code into your README. The badge links back to this page.

[![Featured on PopNx MCP](https://mcp.popnx.com/badge/beliq-eu-beliq-mcp.svg)](https://mcp.popnx.com/en/servers/beliq-eu-beliq-mcp)

Discussion

Ask, share a tip or report that it does not work. Sorted by what people marked helpful.

No posts yet. Be the first to ask or share.

Posts here are written by users, not the PopNx team.

Sign in to post

User reviews

No reviews yet

Sign in to write a review

Compared with others in Accounting, finance & taxi

  • More stars than 0% of the other 3496 servers in this category
  • Published to the registry more recently than 87% of the other 3496 servers in this category
  • Basic checks equal to or better than 99% of the other 3496 servers in this category

Compared with every active server in this category in the registry. Stars count only when the publisher owns the repo.

Common questions

Is beliq safe?

It passed 3 of 3 applicable basic checks. We have not read the code. Before adding a key or token, see what access the server asks for and use a key with only the permissions you need.

What keys or codes does it need?

You need to fill in: BELIQ_API_KEY, BELIQ_AUTH

Does it run on my computer or in the cloud?

It runs on your computer. Your AI app starts it when needed, and data does not pass through the maker’s servers (unless it calls an online service itself).

Is it still maintained?

The GitHub repo last changed 2 days ago, and the latest version (0.5.0) reached the registry 3 days ago.

Which apps can use it?

Apps that support MCP, such as Claude Desktop, Claude Code, Cursor and VS Code. You also need Node.js on your computer.

What can I use instead?

In the same category: SolidInvoice, Journalit, Beancount.io, Tapetide - Indian Stock Market MCP, Twelve Data

Similar alternatives

Same category, other makers, commands already checked. Official ones first, then by stars.

Reading a card:↓ Downloads per weeki★ GitHub starsiThree pillars: reviews · checks · usageiUpdated = latest version published to the registryi

Journalit

Trading journal in Obsidian. Ask Claude or ChatGPT about your trades; edits are previewed first.

by CursivezGrowing★ 261Updated 12 days ago

Runs in the cloud✓ service owner · journalit.co

Beancount.io

Query, edit, and reconcile a hosted Beancount ledger: BQL, reports, files, and bank imports.

by bex-coGrowing★ 707 Stars for the whole repoUpdated last month

Runs in the cloud✓ service owner · beancount.io

Twelve Data

Real-time and historical market data: stocks, forex, crypto, ETFs, fundamentals and 60+ indicators.

by twelvedataGrowing★ 87Updated 16 days ago

Runs in the cloud✓ service owner · twelvedata.com
Compared with similar ones
This one
beliq
SolidInvoiceJournalitBeancount.ioTapetide - Indian Stock Market MCPTwelve Data
Runs whereInstalls on your computerRuns in the cloud, nothing to installRuns in the cloud, nothing to installRuns in the cloud, nothing to installCloud or install on your computerRuns in the cloud, nothing to install
Needs a keyYesNoNoNoYesNo
Add with + in ClaudeNoNoNoNoNoYes
Basic checks3/34/64/44/45/54/4
LicenseMITMITNOASSERTIONMITMIT–
PriceNo cost listed in the registryNo cost listed in the registryNo cost listed in the registryNo cost listed in the registryNo cost listed in the registryNo cost listed in the registry

README from the maker

Open the README

Copied from the maker’s repo as written. PopNx MCP has not reviewed or endorsed it. HTML, images and scripts are removed. Links lead off this site.

beliq-mcp

An MCP server for the beliq e-invoice API. It lets MCP clients (Claude Desktop, Claude Code, Cursor, and others) validate, parse, generate, and convert electronic invoices (XRechnung, ZUGFeRD, Factur-X, Peppol BIS, and the other formats the API carries), and explain exactly what fails. Every verdict carries the check depth the API states for it, or says that none was stated.

beliq covers three steps of an e-invoice: generate, validate, and deliver (in development). This server runs the first two and also parses and converts documents; no tool sends or files an invoice. Until delivery through beliq is available, transmission (Peppol, plateforme agréée, SDI) and tax-authority reporting stay with your access point. Archiving stays with you, and beliq does not operate KSeF submission.

Tools

  • `beliq_validate_einvoice` - validate an invoice XML (inline or by file path) or a Factur-X/ZUGFeRD PDF (by file path). Returns the verdict, how deep the check went, the detected format and profile, the ruleset versions it was checked against, and every error and warning with its rule id, severity, location, and message. For a PDF the verdict is about the embedded XML; the PDF itself is not checked.
  • `beliq_parse_einvoice` - parse a UBL/CII XML invoice or a Factur-X/ZUGFeRD PDF into a structured EN 16931 invoice (fields such as number, dates, currency, seller, buyer, lines and totals). Returns the detected format and profile, the extracted invoice, and warnings that say what the document holds and the parsed invoice does not.
  • `beliq_generate_einvoice` - generate a document from an EN 16931 invoice object. XML comes back inline; a PDF is written to the outputPath you give. By default (verify) the API validates the document before returning it, and a document that fails comes back as a tool error with the failed rules. The tool description tells the model to ask for missing invoice data instead of making it up.
  • `beliq_convert_einvoice` - convert a document from one EN 16931 format to another. An XML source comes back as XML, inline, for every target, facturx and zugferd included. A hybrid PDF source sent to facturx or zugferd comes back as a PDF, written to outputPath: the PDF as sent, its container not checked, when its embedded XML already is the target; otherwise that PDF re-wrapped around the converted XML and passed by veraPDF against PDF/A-3b. With a test key the PDF is watermarked after any veraPDF check. The convert reference has the detail. Reports how many source elements the engine recorded as having no target equivalent.
  • `beliq_check_account` - verify the configured API key and report the plan, the remaining quota, and whether the key is live or a blq_test_ sandbox key, whose quota is the sandbox allowance. Calls GET /v1/me, which draws no quota; useful as a connection and credential smoke test.

Installation

Requires Node.js >= 20.15. Published to npm, so clients can run it with npx:

npx -y beliq-mcp

It is listed in the official MCP Registry as io.github.beliq-eu/beliq-mcp, which points clients at this npm package.

The server is configured entirely through environment variables (see below).

Configuration

VariableRequiredDefaultDescription
BELIQ_API_KEYyes-API key from the beliq dashboard (API Keys).
BELIQ_AUTHnoheaderHow the key is sent: header (X-API-Key) or bearer (Authorization: Bearer).
BELIQ_BASE_URLnohttps://api.beliq.euThe base URL the server sends its API requests to.

Client setup

Claude Code
claude mcp add beliq -e BELIQ_API_KEY=your-key -- npx -y beliq-mcp
Claude Desktop

Add to claude_desktop_config.json (Settings > Developer > Edit Config):

{

"mcpServers": { "beliq": { "command": "npx", "args": ["-y", "beliq-mcp"], "env": { "BELIQ_API_KEY": "your-key" } } } }

Cursor

Add to ~/.cursor/mcp.json (or a project .cursor/mcp.json) using the same mcpServers block shown for Claude Desktop.

Reading a result

beliq_validate_einvoice returns a short text verdict plus a structured result:

  • valid is the API's verdict: the document passed the rule packs and schemas beliq runs for its format, in the versions this result names. It does not mean every recipient, validation tool or tax authority accepts it. Warnings do not make a document invalid, with one case to read beside it: franceCtcBlockingRuleIds.
  • verificationBadgeLabel is the check depth as English display text, and the text verdict prints it beside VALID or INVALID. How verification works explains each depth. Where the API sends no label, the text says check depth not stated and names no depth. verificationBadge and verificationTier are the ids behind the label.
  • franceCtcBlockingRuleIds lists the French CTC rule ids the API reports as ending a transmission through a French platform. It can be present where valid is true, and the text verdict then leads with it. The result stays a normal result, not a tool error. franceCtcApplied, franceCtcVersion and franceExtendedCtcApplied say which French packs ran.
  • pdfInput is present when the document was a PDF: attachmentName, attachmentFoundBy and attachmentCandidates say which embedded file the verdict is about, and containerChecked is always false because the PDF itself is not checked.
  • format and profileDetected report the detected syntax and business profile.
  • schematronVersion is the ruleset revision the check ran against. The versions of the other packs and schema bundles that ran come in ciusVersion, peppolVersion, facturxProfile, facturxVersion, italyFatturapaXsdBundle, italyFatturapaRuntimeVersion, italySdiMessaggiXsdBundle, italySdiMessaggiXsdVersion, spainFacturaeXsdBundle, spainFacturaeRuntimeVersion, sloveniaEslogXsdBundle, sloveniaEslogRuntimeVersion, polandKsefFa3XsdBundle, polandKsefFa3RuntimeVersion, romaniaRoCiusVersion and netherlandsNlciusVersion, each present only when it applies.
  • rulesetChannel is present when a ruleset channel was selected, which an organisation whose default channel is previous does with no input of this tool. rulesetFellBack, rulesetSunsetsOn and rulesetSupersededOn come with it when they apply. rulesetSupersededOn is the date the authority made the successor of a selected ruleset mandatory, and a RULESET_SUPERSEDED warning names each such ruleset.
  • sha256 is the hash of the document that was checked, rulesetSha256 and rulesetArtifacts fingerprint the rule files that ran, and driftCheckedAt is when the nightly drift check last confirmed those files against their sources: each file's pinned download or, when the file cannot be fetched from there, a mirror the pin names.
  • verified is false only when no ruleset ran, which validate never returns; see generate below.
  • errors and warnings each carry ruleId, severity, location (an XPath when available), and message. errorCount and warningCount are their lengths.
  • livemode is false for a blq_test_ sandbox key and true for any other key. A test key runs the same rules and gives the same verdict as a live key.

The structured result carries every field of the API's validation result. Its shape is checked against the SDK's type, so a field the API adds cannot go missing here without failing the build.

beliq_parse_einvoice returns a text summary plus a structured result:

  • format, profileDetected and profileUrn report the detected syntax and profile; businessProcessId and franceCtcDetected are present when the document states them.
  • invoice is the extracted invoice object, with EN 16931 fields such as number, dates, currency, seller, buyer, lines and totals. The parse reference lists every field. A field the API holds no value for is left out.
  • warnings says what the document holds and the parsed invoice does not: each entry has a code, a message, and, by code, a field, the terms (EN 16931 business groups) or the elements (paths with counts) concerned. The text summary lists them.

beliq_generate_einvoice returns a short text summary (with the XML document appended for XML output) plus a structured result:

  • output is xml or pdf, as requested, and contentType is the matching media type (application/xml or application/pdf).
  • xml is the generated document inline, present only for XML output.
  • outputPath and bytesWritten are set when the document was written to disk: always for a PDF, and for XML when you set outputPath. The call never overwrites an existing file, so pick a path that does not exist. A path that is taken, or whose directory is missing or not writable, is refused before the API is called, so it costs no document.
  • pdfKind is present only for PDF output: hybrid (a PDF/A-3 with the XML embedded, for facturx and zugferd) or visualization (rendered pages with no XML inside, for xrechnung and peppol-bis, whose legal document stays the XML).
  • schematronVersion is the ruleset (Schematron) revision the document was checked against.
  • outputEnvelope is the envelope the document is wrapped in, when the API names one.
  • sha256 is the lowercase-hex SHA-256 of the returned document bytes, so sha256sum on the file at outputPath reproduces it.
  • rulesetSha256 is one combined fingerprint of the rule artifacts the document was checked against, present when a ruleset ran.
  • livemode is true for a blq_live_ key and false for a blq_test_ sandbox key, whose output is marked as a specimen and is not a production invoice. The text summary says so for a test key.
  • validationResult is the API's verdict on the generated document, with every field validate returns, the check depth in verificationBadgeLabel included; the text summary names that depth. The verdict is about the invoice XML, so for a PDF the text says so and names the kind of PDF. With the default verify: true, a document that fails validation comes back as a tool error that lists the failed rules. With verify: false no ruleset runs: verified is false, errors and warnings are empty because nothing checked the document, and the text says not validated.

beliq_convert_einvoice returns a short text summary (with the XML document appended for an XML target) plus a structured result:

  • output is what came back, read from the response: xml for every target when the source is XML, facturx and zugferd included, and pdf when a hybrid PDF source went to a facturx or zugferd target. contentType is the matching media type.
  • xml is the converted document inline, present only when XML came back.
  • outputPath and bytesWritten are set when the document was written to disk: always for a PDF, and for XML when you set outputPath. Like generate, it never overwrites an existing file, and it refuses a path it cannot write before the API is called.
  • sourceFormat is the format the engine read, and targetFormat the format it produced (the targetFormat you asked for when the API does not name one).
  • profileDetected is the profile the engine recognised on the source document, when it recognised one.
  • conversionTools names the toolchain that did the conversion, when the API names one.
  • livemode is true for a blq_live_ key and false for a blq_test_ sandbox key, whose output is marked as a specimen like generate's. The text su

Only the beginning is shown; read the rest in the repo