@invowerk-dev/sdk 0.0.0-bootstrap.0 → 1.0.0

package/dist/types.gen.d.ts

@@ -0,0 +1,1301 @@
+export type ClientOptions = {
+    baseUrl: 'https://api.invowerk.dev' | (string & {});
+};
+/**
+ * Body_render_invoice
+ */
+export type BodyRenderInvoice = {
+    /**
+     * File
+     *
+     * The invoice XML as a multipart file part.
+     */
+    file?: Blob | File | null;
+};
+/**
+ * Buyer
+ *
+ * The buyer (BG-7).
+ */
+export type Buyer = {
+    /**
+     * Name
+     *
+     * Buyer name (BT-44).
+     */
+    name: string;
+    /**
+     * Buyer postal address (BG-8).
+     */
+    address: PostalAddress;
+    /**
+     * Electronic Address
+     *
+     * Buyer electronic address (BT-49).
+     */
+    electronic_address?: string | null;
+};
+/**
+ * ContentClass
+ *
+ * Reminder that the content of an invoice cannot be checked by machine.
+ *
+ * It never contains findings. A clean result means the invoice is well-formed
+ * and follows the rules. It does not mean that prices, amounts or the
+ * delivered service are correct.
+ */
+export type ContentClass = {
+    /**
+     * Status
+     *
+     * Always 'not_machine_checkable'.
+     */
+    status?: string;
+    /**
+     * Note
+     *
+     * Fixed note: a format check cannot judge whether the content is correct.
+     */
+    note: string;
+};
+/**
+ * ConvertResponse
+ *
+ * The answer of POST /v1/convert?format=json: the XML and the check result.
+ */
+export type ConvertResponse = {
+    /**
+     * Xml
+     *
+     * The converted e-invoice as XML.
+     */
+    xml: string;
+    /**
+     * Syntax
+     *
+     * The syntax of the XML: 'ubl' or 'cii'.
+     */
+    syntax: string;
+    /**
+     * Flavor
+     *
+     * The rule set of the XML: 'en16931' or 'xrechnung'.
+     */
+    flavor: string;
+    /**
+     * The result of invowerk's own check of the XML.
+     */
+    self_validation: ConvertSelfValidation;
+};
+/**
+ * ConvertSelfValidation
+ *
+ * The result of invowerk's own check of the converted XML.
+ *
+ * It shows that the XML passed the check before it was returned. An invalid
+ * result returns HTTP 500 instead.
+ */
+export type ConvertSelfValidation = {
+    /**
+     * Valid
+     *
+     * Always true. An invalid result returns HTTP 500 instead.
+     */
+    valid: boolean;
+    /**
+     * Finding Count
+     *
+     * Number of findings of the check; all of them are non-fatal.
+     */
+    finding_count: number;
+};
+/**
+ * CreditsInfo
+ *
+ * Your credit balance for the current billing period. `granted` is what
+ * your plan included, `balance` what is still unspent, and `period_end` the
+ * date (ISO 8601) your allowance refills. Present only on plans that are
+ * priced in credits.
+ */
+export type CreditsInfo = {
+    /**
+     * Balance
+     */
+    balance: number;
+    /**
+     * Granted
+     */
+    granted: number;
+    /**
+     * Period End
+     */
+    period_end?: string | null;
+};
+/**
+ * DocumentTotals
+ *
+ * The document totals (BG-22).
+ */
+export type DocumentTotals = {
+    /**
+     * Line Total
+     *
+     * Sum of the line net amounts (BT-106).
+     */
+    line_total: number | string;
+    /**
+     * Tax Exclusive
+     *
+     * Invoice total without VAT (BT-109).
+     */
+    tax_exclusive: number | string;
+    /**
+     * Tax Inclusive
+     *
+     * Invoice total with VAT (BT-112).
+     */
+    tax_inclusive: number | string;
+    /**
+     * Payable
+     *
+     * Amount due for payment (BT-115). Defaults to the total with VAT.
+     */
+    payable?: number | string | null;
+};
+/**
+ * ERechnungDe
+ *
+ * The result mapped onto the categories of the BMF letter of 15.10.2025
+ * (Germany).
+ *
+ * It describes the format check only. It is not a tax assessment (see
+ * ``note``).
+ */
+export type ERechnungDe = {
+    /**
+     * Status
+     *
+     * 'e_rechnung' (no errors), 'e_rechnung_mit_fehlern' (rule errors), 'keine_e_rechnung' (not a structured e-invoice) or 'nicht_pruefbar' (the file could not be checked).
+     */
+    status: string;
+    /**
+     * Reason
+     *
+     * Why this status applies, in German, naming the finding.
+     */
+    reason: string;
+    /**
+     * Basis
+     *
+     * The BMF letter or UStAE passage for the category; null for 'nicht_pruefbar'.
+     */
+    basis?: string | null;
+    /**
+     * Note
+     *
+     * Fixed German note, the same on every answer: invowerk checks the technical format, not whether content and amounts are correct or what tax consequences an error has.
+     */
+    note: string;
+};
+/**
+ * ErrorClasses
+ *
+ * The findings grouped by where the problem is. ``findings`` has the same
+ * findings as one list.
+ */
+export type ErrorClasses = {
+    /**
+     * Format
+     *
+     * Problems with the file or XML structure: unknown format, malformed XML, a forbidden DOCTYPE, XML schema (XSD) errors.
+     */
+    format?: Array<Finding>;
+    /**
+     * Business Rules
+     *
+     * Failed rules of the applied rule set (EN 16931, XRechnung, ZUGFeRD / Factur-X or Peppol BIS).
+     */
+    business_rules?: Array<Finding>;
+    /**
+     * Carrier
+     *
+     * Problems with the PDF of a ZUGFeRD / Factur-X invoice: PDF/A conformance and how the XML is embedded (BR-HYBRID-* rules). Always empty for an XML file.
+     */
+    carrier?: Array<Finding>;
+    /**
+     * Always the not_machine_checkable reminder. Never contains findings.
+     */
+    content: ContentClass;
+};
+/**
+ * Evidence
+ *
+ * Which file was checked, when, and with which software. Keep it with a
+ * saved report: the SHA-256 ties the report to one file.
+ */
+export type Evidence = {
+    /**
+     * Document Sha256
+     *
+     * Hex SHA-256 of the exact bytes you sent (compare with `sha256sum <file>`).
+     */
+    document_sha256: string;
+    /**
+     * Document Bytes
+     *
+     * Size in bytes of what you sent.
+     */
+    document_bytes: number;
+    /**
+     * Checked At
+     *
+     * UTC time of the check, ISO 8601 to the second, e.g. '2026-09-24T10:15:00Z'.
+     */
+    checked_at: string;
+    /**
+     * The software versions.
+     */
+    validator: ValidatorVersions;
+};
+/**
+ * ExplainResponse
+ *
+ * The answer of GET /v1/explain: one explanation per requested code.
+ *
+ * Pass several codes with repeated ``?code=`` parameters. If any code is
+ * unknown, the call returns HTTP 404 and names it; there is no partial
+ * answer.
+ */
+export type ExplainResponse = {
+    /**
+     * Lang
+     *
+     * Language of all explanations: 'de' or 'en'.
+     */
+    lang: string;
+    /**
+     * Explanations
+     *
+     * One explanation per requested code, in request order, duplicates removed.
+     */
+    explanations: Array<RuleExplanation>;
+};
+/**
+ * Finding
+ *
+ * One problem found in the invoice.
+ *
+ * ``error_class`` says where the problem is: in the file or XML structure
+ * (``format``), in a rule of the applied rule set (``business_rules``) or in
+ * the PDF around the invoice data (``carrier``). ``explain_url`` links the
+ * German explanation page for the code. ``explain`` holds the explanation
+ * itself when you call with ``?explain=true``.
+ */
+export type Finding = {
+    /**
+     * Rule Id
+     *
+     * Code of the rule that failed, e.g. 'BR-DE-21', or 'XSD' for a schema error.
+     */
+    rule_id: string;
+    /**
+     * Error Class
+     *
+     * Where the problem is: 'format' (file or XML structure), 'business_rules' (a rule of the applied rule set) or 'carrier' (the PDF around the XML).
+     */
+    error_class: string;
+    /**
+     * Severity
+     *
+     * 'fatal' (the invoice fails the check), 'warning' or 'information'.
+     */
+    severity: string;
+    /**
+     * Xpath
+     *
+     * Where the problem is in the XML (an XPath or a schema line), if known.
+     */
+    xpath?: string | null;
+    /**
+     * Message
+     *
+     * The message of the failed rule or check.
+     */
+    message: string;
+    /**
+     * Explain Url
+     *
+     * Path of the German explanation page /codes/<CODE>, if invowerk has one.
+     */
+    explain_url?: string | null;
+    /**
+     * Explain
+     *
+     * Explanation of the rule (meaning, causes, fixes) in the requested language. Set only with ?explain=true and if invowerk has an entry for the code.
+     */
+    explain?: {
+        [key: string]: unknown;
+    } | null;
+};
+/**
+ * Flavor
+ *
+ * The rule set the invoice follows: plain EN 16931, or XRechnung (German rules).
+ */
+export type Flavor = 'en16931' | 'xrechnung';
+/**
+ * GenerateRequest
+ *
+ * The request body of POST /v1/generate: an EN 16931 invoice, keyed on
+ * Business Terms (BT-*).
+ *
+ * All amounts are your own figures. invowerk writes them into the XML and
+ * checks the result against EN 16931 (and XRechnung, if selected). It does not
+ * compute or correct them.
+ */
+export type GenerateRequest = {
+    /**
+     * XML syntax of the invoice: 'ubl' or 'cii'.
+     */
+    syntax?: Syntax;
+    /**
+     * Rule set: 'en16931' (plain EN 16931) or 'xrechnung' (German rules).
+     */
+    flavor?: Flavor;
+    /**
+     * Invoice Number
+     *
+     * Invoice number (BT-1).
+     */
+    invoice_number: string;
+    /**
+     * Issue Date
+     *
+     * Issue date, 'YYYY-MM-DD' (BT-2).
+     */
+    issue_date: string;
+    /**
+     * Currency
+     *
+     * Currency code, ISO 4217, e.g. 'EUR' (BT-5).
+     */
+    currency?: string;
+    /**
+     * Invoice Type Code
+     *
+     * Invoice type code from UNTDID 1001; '380' is a commercial invoice (BT-3).
+     */
+    invoice_type_code?: string;
+    /**
+     * Buyer Reference
+     *
+     * Buyer reference, in Germany often the Leitweg-ID (BT-10). Required for flavor 'xrechnung' (BR-DE-15), optional for plain EN 16931.
+     */
+    buyer_reference?: string | null;
+    /**
+     * Due Date
+     *
+     * Payment due date, 'YYYY-MM-DD' (BT-9).
+     */
+    due_date?: string | null;
+    /**
+     * Payment Iban
+     *
+     * IBAN of the payee account for a bank transfer (BT-84).
+     */
+    payment_iban?: string | null;
+    seller: Seller;
+    buyer: Buyer;
+    /**
+     * Lines
+     *
+     * One or more invoice lines (BG-25).
+     */
+    lines: Array<InvoiceLine>;
+    /**
+     * Tax Breakdown
+     *
+     * One or more VAT breakdowns, one per VAT category and rate (BG-23).
+     */
+    tax_breakdown: Array<TaxBreakdown>;
+    totals: DocumentTotals;
+};
+/**
+ * GenerateResponse
+ *
+ * The answer of POST /v1/generate?format=json: the XML and the check result.
+ */
+export type GenerateResponse = {
+    /**
+     * Xml
+     *
+     * The generated e-invoice as XML.
+     */
+    xml: string;
+    /**
+     * Syntax
+     *
+     * The syntax of the XML: 'ubl' or 'cii'.
+     */
+    syntax: string;
+    /**
+     * Flavor
+     *
+     * The rule set of the XML: 'en16931' or 'xrechnung'.
+     */
+    flavor: string;
+    /**
+     * The result of invowerk's own check of the XML.
+     */
+    self_validation: SelfValidation;
+};
+/**
+ * HintInfo
+ *
+ * One hint: an extra observation by invowerk. Hints never change the result.
+ */
+export type HintInfo = {
+    /**
+     * Code
+     *
+     * The hint code, e.g. 'IW-IBAN'.
+     */
+    code: string;
+    /**
+     * Severity
+     *
+     * 'warning' or 'information'. A hint is never fatal.
+     */
+    severity: string;
+    /**
+     * Message
+     *
+     * The observation, in the requested language.
+     */
+    message: string;
+    /**
+     * Bt Refs
+     *
+     * The EN 16931 Business Terms the hint is about.
+     */
+    bt_refs?: Array<string>;
+    /**
+     * Explain Url
+     *
+     * Path of the German page /codes/<CODE> that explains the hint.
+     */
+    explain_url?: string | null;
+};
+/**
+ * InvoiceLine
+ *
+ * One invoice line (BG-25).
+ */
+export type InvoiceLine = {
+    /**
+     * Name
+     *
+     * Item name (BT-153).
+     */
+    name: string;
+    /**
+     * Net Price
+     *
+     * Net price per unit (BT-146).
+     */
+    net_price: number | string;
+    /**
+     * Quantity
+     *
+     * Invoiced quantity (BT-129).
+     */
+    quantity: number | string;
+    /**
+     * Unit Code
+     *
+     * Unit code from UN/ECE Recommendation 20; 'C62' means 'one' (BT-130).
+     */
+    unit_code?: string;
+    /**
+     * Line Net Amount
+     *
+     * Line net amount, quantity × net price, as you state it (BT-131).
+     */
+    line_net_amount: number | string;
+    /**
+     * Tax Category
+     *
+     * VAT category code of the line, e.g. 'S' for standard rate (BT-151).
+     */
+    tax_category?: string;
+    /**
+     * Tax Rate
+     *
+     * VAT rate of the line in percent, e.g. 19.00 (BT-152).
+     */
+    tax_rate?: number | string;
+};
+/**
+ * MeResponse
+ *
+ * The `GET /v1/me` payload: who the request is authenticated as, what is
+ * left of your request and credit allowances, and which features your plan
+ * includes.
+ */
+export type MeResponse = {
+    /**
+     * Tier
+     *
+     * The plan this request is served on.
+     */
+    tier: string;
+    /**
+     * Is Keyed
+     *
+     * Whether the request carried a valid API key. Without an `X-API-Key`, the call runs anonymously at the rate limit for calls without a key.
+     */
+    is_keyed: boolean;
+    rate_limit: RateLimitInfo;
+    /**
+     * Null on plans that are not priced in credits.
+     */
+    credits?: CreditsInfo | null;
+    /**
+     * Features
+     *
+     * The features your plan includes.
+     */
+    features: Array<string>;
+};
+/**
+ * ParseDetection
+ *
+ * What invowerk detected about the source document, from its bytes.
+ */
+export type ParseDetection = {
+    /**
+     * Syntax
+     *
+     * Syntax of the source document: 'ubl' or 'cii'.
+     */
+    syntax: string;
+    /**
+     * Flavor
+     *
+     * Rule set of the source, read from its CustomizationID: 'xrechnung', 'peppol_bis', 'factur_x', 'en16931' or 'unknown'.
+     */
+    flavor: string;
+    /**
+     * Customization Id
+     *
+     * The CustomizationID (specification identifier, BT-24) of the source, if any.
+     */
+    customization_id: string | null;
+};
+/**
+ * ParseResponse
+ *
+ * The answer of POST /v1/parse: the invoice as JSON and what invowerk detected.
+ */
+export type ParseResponse = {
+    /**
+     * Model
+     *
+     * The invoice as JSON keyed on Business Terms. It has the schema of the POST /v1/generate request body (GenerateRequest), so you can edit it and create the invoice again.
+     */
+    model: {
+        [key: string]: unknown;
+    };
+    /**
+     * What invowerk detected: syntax, rule set and CustomizationID.
+     */
+    detection: ParseDetection;
+    /**
+     * Source
+     *
+     * Where the XML came from: 'xml' (you sent XML) or 'pdf-embedded' (taken from a ZUGFeRD / Factur-X PDF).
+     */
+    source: string;
+};
+/**
+ * PostalAddress
+ *
+ * A postal address (BG-5 seller, BG-8 buyer).
+ *
+ * EN 16931 requires only the country. XRechnung also requires city and post
+ * code for the seller. invowerk does not check that the address exists.
+ */
+export type PostalAddress = {
+    /**
+     * City
+     *
+     * City (BT-37 seller, BT-52 buyer).
+     */
+    city?: string | null;
+    /**
+     * Post Code
+     *
+     * Post code (BT-38 seller, BT-53 buyer).
+     */
+    post_code?: string | null;
+    /**
+     * Country Code
+     *
+     * Country code, ISO 3166-1 alpha-2, e.g. 'DE' (BT-40 seller, BT-55 buyer).
+     */
+    country_code: string;
+};
+/**
+ * RateLimitInfo
+ *
+ * How many requests you may still make in the current window. These are the
+ * same numbers as the `X-RateLimit-*` response headers. `limit` is the size of the
+ * window, `remaining` what is left of it, and `reset` how many seconds until
+ * it refills (not a timestamp). All three are `null` in the rare case the
+ * counter cannot be read; treat that as "unknown", not zero.
+ */
+export type RateLimitInfo = {
+    /**
+     * Limit
+     */
+    limit?: number | null;
+    /**
+     * Remaining
+     */
+    remaining?: number | null;
+    /**
+     * Reset
+     */
+    reset?: number | null;
+};
+/**
+ * RenderResponse
+ *
+ * The answer of POST /v1/render?format=json: the HTML and what invowerk detected.
+ */
+export type RenderResponse = {
+    /**
+     * Html
+     *
+     * The rendered invoice as a complete HTML document.
+     */
+    html: string;
+    /**
+     * Lang
+     *
+     * The label language used: 'de' or 'en'.
+     */
+    lang: string;
+    /**
+     * Flavor
+     *
+     * The detected rule set, e.g. 'xrechnung', 'peppol_bis' or 'unknown'.
+     */
+    flavor: string;
+    /**
+     * Syntax
+     *
+     * The detected XML syntax, e.g. 'ubl_invoice' or 'cii'.
+     */
+    syntax: string;
+};
+/**
+ * RuleExplanation
+ *
+ * The explanation of one rule code in the requested language.
+ *
+ * It explains the format rule and how to fix the invoice data. It is not tax
+ * advice. ``explain_url`` links the German page for the code.
+ */
+export type RuleExplanation = {
+    /**
+     * Code
+     *
+     * The rule code, e.g. 'BR-DE-21'.
+     */
+    code: string;
+    /**
+     * Lang
+     *
+     * Language of the explanation: 'de' or 'en'.
+     */
+    lang: string;
+    /**
+     * Severity
+     *
+     * Severity of the rule: 'fatal', 'warning' or 'information'.
+     */
+    severity: string;
+    /**
+     * Standard
+     *
+     * Source of the rule: 'EN16931', 'XRechnung', 'ZUGFeRD' or 'invowerk' (IW-* hints).
+     */
+    standard: string;
+    /**
+     * Bt Refs
+     *
+     * The EN 16931 Business Terms the rule is about, e.g. 'BT-10'.
+     */
+    bt_refs: Array<string>;
+    /**
+     * Title
+     *
+     * Short title of the rule.
+     */
+    title: string;
+    /**
+     * Meaning
+     *
+     * What the rule requires.
+     */
+    meaning: string;
+    /**
+     * Causes
+     *
+     * Common reasons why the rule fails.
+     */
+    causes: Array<string>;
+    /**
+     * Fixes
+     *
+     * How to fix the invoice data.
+     */
+    fixes: Array<string>;
+    /**
+     * Xpath Hints
+     *
+     * XPaths of the fields the rule checks.
+     */
+    xpath_hints: Array<string>;
+    /**
+     * Explain Url
+     *
+     * Path of the German explanation page /codes/<CODE>.
+     */
+    explain_url: string;
+};
+/**
+ * ScenarioInfo
+ *
+ * The rule set that was applied: its configuration and scenario.
+ */
+export type ScenarioInfo = {
+    /**
+     * Config
+     *
+     * 'kosit-xrechnung' (the KoSIT configuration for XRechnung and EN 16931) or 'zugferd' (the FeRD rules for ZUGFeRD / Factur-X).
+     */
+    config: string;
+    /**
+     * Name
+     *
+     * The scenario name as the configuration states it.
+     */
+    name: string;
+};
+/**
+ * SelfValidation
+ *
+ * The result of invowerk's own check of the generated XML.
+ *
+ * Only in the ?format=json answer. It shows that the XML passed the check
+ * before it was returned.
+ */
+export type SelfValidation = {
+    /**
+     * Valid
+     *
+     * Always true. An invalid result returns HTTP 500 instead.
+     */
+    valid: boolean;
+    /**
+     * Lane
+     *
+     * Which check ran; always 'local' (invowerk's own check).
+     */
+    lane: string;
+    /**
+     * Finding Count
+     *
+     * Number of findings of the check; all of them are non-fatal.
+     */
+    finding_count: number;
+};
+/**
+ * Seller
+ *
+ * The seller (BG-4).
+ */
+export type Seller = {
+    /**
+     * Name
+     *
+     * Seller name, the registered name (BT-27).
+     */
+    name: string;
+    /**
+     * Seller postal address (BG-5).
+     */
+    address: PostalAddress;
+    /**
+     * Vat Id
+     *
+     * Seller VAT ID, e.g. 'DE123456789' (BT-31). Needed when a line has VAT category 'S' (BR-S-02).
+     */
+    vat_id?: string | null;
+    /**
+     * Contact Name
+     *
+     * Seller contact name; required for XRechnung (BT-41).
+     */
+    contact_name?: string | null;
+    /**
+     * Contact Phone
+     *
+     * Seller contact phone; required for XRechnung (BT-42).
+     */
+    contact_phone?: string | null;
+    /**
+     * Contact Email
+     *
+     * Seller contact email; required for XRechnung (BT-43).
+     */
+    contact_email?: string | null;
+    /**
+     * Electronic Address
+     *
+     * Seller electronic address, e.g. an email address (BT-34).
+     */
+    electronic_address?: string | null;
+};
+/**
+ * Syntax
+ *
+ * The XML syntax of the invoice: UBL or CII.
+ */
+export type Syntax = 'cii' | 'ubl';
+/**
+ * TaxBreakdown
+ *
+ * One VAT breakdown: the totals for one VAT category and rate (BG-23).
+ */
+export type TaxBreakdown = {
+    /**
+     * Taxable Amount
+     *
+     * Taxable amount of the category (BT-116).
+     */
+    taxable_amount: number | string;
+    /**
+     * Tax Amount
+     *
+     * VAT amount of the category (BT-117).
+     */
+    tax_amount: number | string;
+    /**
+     * Category
+     *
+     * VAT category code, e.g. 'S' for standard rate (BT-118).
+     */
+    category?: string;
+    /**
+     * Rate
+     *
+     * VAT rate of the category in percent (BT-119).
+     */
+    rate?: number | string;
+};
+/**
+ * ValidationResponse
+ *
+ * The result of POST /v1/validate. Always HTTP 200: a failed check is data,
+ * not an error.
+ */
+export type ValidationResponse = {
+    /**
+     * Valid
+     *
+     * The overall result. For the XML, the KoSIT validator decides when it answered (verdict_source 'official'); otherwise invowerk's own check decides (no fatal finding). A fatal problem with the PDF of a ZUGFeRD / Factur-X invoice always makes it false.
+     */
+    valid: boolean;
+    /**
+     * Verdict Source
+     *
+     * 'official' when the KoSIT validator decided the XML result, 'local' when invowerk's own check did (ZUGFeRD or Peppol rules, or KoSIT did not answer).
+     */
+    verdict_source: string;
+    /**
+     * Local Verdict
+     *
+     * invowerk's own result, 'valid' or 'invalid': 'invalid' when any format, business rule or PDF finding is fatal.
+     */
+    local_verdict: string;
+    /**
+     * Disagreement
+     *
+     * True when the KoSIT validator and invowerk's own check reach different results for the XML. The KoSIT result decides; the findings explain the difference.
+     */
+    disagreement: boolean;
+    /**
+     * Lane
+     *
+     * 'official' when invowerk asked the KoSIT validator (even if it did not answer), else 'local'.
+     */
+    lane: string;
+    /**
+     * Official Verdict
+     *
+     * The KoSIT validator's result: 'valid', 'invalid' or 'unavailable' (it did not answer). Null when it was not asked, e.g. for ZUGFeRD or Peppol.
+     */
+    official_verdict?: string | null;
+    /**
+     * The rule set that was applied, or null when no rule set matched.
+     */
+    scenario?: ScenarioInfo | null;
+    /**
+     * Pdfa Verdict
+     *
+     * PDF/A check of a ZUGFeRD / Factur-X PDF with veraPDF: 'valid', 'invalid' or 'unavailable'. Null when not checked (always for XML). Null does not mean the PDF is fine.
+     */
+    pdfa_verdict?: string | null;
+    /**
+     * Detection
+     *
+     * What invowerk detected from the bytes: kind, syntax, flavor, customization_id, is_hybrid_pdf. For a PDF it describes the embedded XML.
+     */
+    detection: {
+        [key: string]: unknown;
+    };
+    /**
+     * The findings grouped by where the problem is.
+     */
+    errors: ErrorClasses;
+    /**
+     * Findings
+     *
+     * All format, business rule and PDF findings as one ordered list.
+     */
+    findings?: Array<Finding>;
+    /**
+     * Rulesets
+     *
+     * The rule set versions used for this check, as {name: version}.
+     */
+    rulesets?: {
+        [key: string]: string;
+    };
+    /**
+     * SHA-256 and size of the file, time of the check, software versions.
+     */
+    evidence: Evidence;
+    /**
+     * The result mapped onto the e-invoice categories of the German BMF. Describes the format only, not a tax assessment.
+     */
+    e_rechnung_de: ERechnungDe;
+    /**
+     * Hints
+     *
+     * Extra observations by invowerk (IW-* codes), e.g. a wrong IBAN check digit. They never change valid, verdict_source or e_rechnung_de.
+     */
+    hints?: Array<HintInfo>;
+};
+/**
+ * ValidatorVersions
+ *
+ * The software versions that produced the result.
+ */
+export type ValidatorVersions = {
+    /**
+     * Invowerk
+     *
+     * The invowerk version, or 'unknown'.
+     */
+    invowerk: string;
+    /**
+     * Appkit
+     *
+     * The version of the platform invowerk runs on, or 'unknown'.
+     */
+    appkit: string;
+};
+/**
+ * Problem
+ *
+ * The RFC 9457 error body. Every error response uses it.
+ */
+export type Problem = {
+    /**
+     * Type
+     *
+     * Problem type URI (RFC 9457).
+     */
+    type?: string;
+    /**
+     * Title
+     *
+     * Short human-readable summary of the status.
+     */
+    title: string;
+    /**
+     * Status
+     *
+     * The HTTP status code, repeated in the body.
+     */
+    status: number;
+    /**
+     * Detail
+     *
+     * What went wrong with this request.
+     */
+    detail: string;
+    /**
+     * Instance
+     *
+     * The request path that produced the error.
+     */
+    instance: string;
+    /**
+     * Code
+     *
+     * Stable machine-readable error code. Branch on this, not on the text.
+     */
+    code: string;
+    /**
+     * Request Id
+     *
+     * Correlation id for this request; quote it when asking for support.
+     */
+    request_id?: string | null;
+    /**
+     * Errors
+     *
+     * Per-field validation failures. Present on 422 only.
+     */
+    errors?: Array<{
+        [key: string]: unknown;
+    }> | null;
+    /**
+     * Upgrade Url
+     *
+     * Where to add credits or move to a larger plan. Present on 402/403/429.
+     */
+    upgrade_url?: string | null;
+};
+export type GetMeData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/v1/me';
+};
+export type GetMeResponses = {
+    /**
+     * Successful Response
+     */
+    200: MeResponse;
+};
+export type GetMeResponse = GetMeResponses[keyof GetMeResponses];
+export type ParseInvoiceData = {
+    /**
+     * The invoice: XML (UBL or CII, e.g. XRechnung) or a ZUGFeRD / Factur-X PDF, as the raw body or as a multipart file part. At most 20 MB.
+     */
+    body: {
+        /**
+         * The invoice file (XML or PDF).
+         */
+        file: Blob | File;
+    };
+    path?: never;
+    query?: never;
+    url: '/v1/parse';
+};
+export type ParseInvoiceResponses = {
+    /**
+     * Successful Response
+     */
+    200: ParseResponse;
+};
+export type ParseInvoiceResponse = ParseInvoiceResponses[keyof ParseInvoiceResponses];
+export type ConvertInvoiceData = {
+    /**
+     * The invoice: XML (UBL or CII, e.g. XRechnung) or a ZUGFeRD / Factur-X PDF, as the raw body or as a multipart file part. At most 20 MB.
+     */
+    body: {
+        /**
+         * The invoice file (XML or PDF).
+         */
+        file: Blob | File;
+    };
+    path?: never;
+    query: {
+        /**
+         * The XML syntax to convert to: 'cii' or 'ubl'.
+         */
+        target_syntax: Syntax;
+        /**
+         * Target Flavor
+         *
+         * Optional rule set of the result: 'en16931' or 'xrechnung'. Without it the flavor of the source is kept.
+         */
+        target_flavor?: Flavor | null;
+        /**
+         * Format
+         *
+         * 'json' returns {xml, syntax, flavor, self_validation}; omitted returns raw application/xml.
+         */
+        format?: string | null;
+    };
+    url: '/v1/convert';
+};
+export type ConvertInvoiceErrors = {
+    /**
+     * Validation Error
+     */
+    422: Problem;
+    /**
+     * The converted XML failed invowerk's own check. No document is returned and the credits are refunded.
+     */
+    500: Problem;
+};
+export type ConvertInvoiceError = ConvertInvoiceErrors[keyof ConvertInvoiceErrors];
+export type ConvertInvoiceResponses = {
+    /**
+     * The converted XML (default) or the JSON object (?format=json).
+     */
+    200: ConvertResponse;
+};
+export type ConvertInvoiceResponse = ConvertInvoiceResponses[keyof ConvertInvoiceResponses];
+export type GenerateInvoiceData = {
+    body: GenerateRequest;
+    path?: never;
+    query?: {
+        /**
+         * Format
+         *
+         * 'json' returns {xml, syntax, flavor, self_validation}; omitted returns raw application/xml.
+         */
+        format?: string | null;
+    };
+    url: '/v1/generate';
+};
+export type GenerateInvoiceErrors = {
+    /**
+     * Validation Error
+     */
+    422: Problem;
+    /**
+     * The generated XML failed invowerk's own check. No document is returned and the credits are refunded.
+     */
+    500: Problem;
+};
+export type GenerateInvoiceError = GenerateInvoiceErrors[keyof GenerateInvoiceErrors];
+export type GenerateInvoiceResponses = {
+    /**
+     * The generated XML (default) or the JSON object (?format=json).
+     */
+    200: GenerateResponse;
+};
+export type GenerateInvoiceResponse = GenerateInvoiceResponses[keyof GenerateInvoiceResponses];
+export type ExplainCodesData = {
+    body?: never;
+    path?: never;
+    query: {
+        /**
+         * Code
+         *
+         * One or more codes; repeat the parameter: ?code=BR-DE-21&code=IW-IBAN.
+         */
+        code: Array<string>;
+        /**
+         * Lang
+         *
+         * Language of the explanation, `de` or `en`. Without it, the Accept-Language header decides, otherwise German.
+         */
+        lang?: string | null;
+    };
+    url: '/v1/explain';
+};
+export type ExplainCodesErrors = {
+    /**
+     * Validation Error
+     */
+    422: Problem;
+};
+export type ExplainCodesError = ExplainCodesErrors[keyof ExplainCodesErrors];
+export type ExplainCodesResponses = {
+    /**
+     * Successful Response
+     */
+    200: ExplainResponse;
+};
+export type ExplainCodesResponse = ExplainCodesResponses[keyof ExplainCodesResponses];
+export type RenderInvoiceData = {
+    body?: BodyRenderInvoice;
+    path?: never;
+    query?: {
+        /**
+         * Lang
+         *
+         * Label language, 'de' or 'en'. Default: Accept-Language, then 'de'.
+         */
+        lang?: string | null;
+        /**
+         * Format
+         *
+         * 'json' returns {html, lang, flavor, syntax}; omitted returns raw text/html.
+         */
+        format?: string | null;
+    };
+    url: '/v1/render';
+};
+export type RenderInvoiceErrors = {
+    /**
+     * Validation Error
+     */
+    422: Problem;
+};
+export type RenderInvoiceError = RenderInvoiceErrors[keyof RenderInvoiceErrors];
+export type RenderInvoiceResponses = {
+    /**
+     * The rendered HTML (default) or the JSON object (?format=json).
+     */
+    200: RenderResponse;
+};
+export type RenderInvoiceResponse = RenderInvoiceResponses[keyof RenderInvoiceResponses];
+export type ValidateInvoiceData = {
+    /**
+     * The invoice: XML (UBL or CII, e.g. XRechnung) or a ZUGFeRD / Factur-X PDF, as the raw body or as a multipart file part. At most 20 MB.
+     */
+    body: {
+        /**
+         * The invoice file (XML or PDF).
+         */
+        file: Blob | File;
+    };
+    path?: never;
+    query?: {
+        /**
+         * Explain
+         */
+        explain?: boolean;
+        /**
+         * Lang
+         */
+        lang?: string;
+    };
+    url: '/v1/validate';
+};
+export type ValidateInvoiceErrors = {
+    /**
+     * Validation Error
+     */
+    422: Problem;
+};
+export type ValidateInvoiceError = ValidateInvoiceErrors[keyof ValidateInvoiceErrors];
+export type ValidateInvoiceResponses = {
+    /**
+     * Successful Response
+     */
+    200: ValidationResponse;
+};
+export type ValidateInvoiceResponse = ValidateInvoiceResponses[keyof ValidateInvoiceResponses];