E-invoices

Create an e-invoice XML

Generates a standalone e-invoice from the invoice model: UN/CEFACT CII (every profile) or UBL 2.1 (EN16931, XRECHNUNG), e.g. an XRechnung for German public buyers. The XML is validated with the KoSIT validator (report in result.conformance.einvoice) and delivered as one application/xml file; a model that breaks a profile rule fails with einvoice_invalid and the list of issues. Answers a Render object with input_type: "einvoice" and kind: "einvoice_xml"; delivery, mode, webhook, reference, metadata and test behave as on POST /v1/renders. 1 billed render. Test renders are free, and their XML has a TEST note as its first invoice note (BT-22; every profile but MINIMUM, which has no notes; EXTENDED also sets TestIndicator). To embed the invoice in a PDF instead, use output.einvoice on a render.

post/v1/einvoices

Request

Base URL: https://api-eu.dynamicdocumentapi.com
URL: https://api-eu.dynamicdocumentapi.com/v1/einvoices
Auth: one of:
- HTTP bearer
- API key in header X-API-Key

Headers

Idempotency-Keystring

Replays the stored response for 24 h; a different body with the same key → 422.

Request body

filenamestring nullable

Output filename (.xml is enforced). Default: the invoice number, sanitised, + .xml.

metadataobject nullable

mode'sync' | 'async'

priority'normal' | 'low'

EN 16931 profile of the XML: XRECHNUNG (German public sector), EN16931, or a Factur-X / ZUGFeRD profile (MINIMUM, BASIC_WL, BASIC, EXTENDED; CII only).

referencestring nullable

syntax'cii' | 'ubl'

cii (UN/CEFACT Cross Industry Invoice D16B) or ubl (UBL 2.1 Invoice / CreditNote; EN16931 and XRECHNUNG only).

testboolean nullable

timeout_behavior'continue' | 'cancel'

Response

Sync render finished (status=succeeded). With delivery.type=binary the body is the file.

batch_idstring nullable

billed_rendersinteger

Renders billed for this request (0 for test renders, previews, failed and canceled renders).

completed_atstring date-time nullable

created_atstring date-time required

enginestring

engine_versionstring nullable

expires_atstring date-time nullable

idstring required

kindstring

metadataobject

mode'sync' | 'async' required

object'render' required

output_format'pdf' | 'png' | 'jpeg' | 'webp' | 'html' | 'zip' | 'xml'

pagesinteger nullable

referencestring nullable

regionstring required

sourcestring

testboolean required

timingsobject

Example response

{
  "billed_renders": 1,
  "email": [
    {
      "error": {
        "code": "email_daily_cap_reached"
      },
      "id": "ems_01J9ZM1X3F7R8K2C4V6B8N0P2T",
      "rule_id": "emr_01J9ZK3M7Q8V5W2X4Y6Z8A0B1E"
    }
  ],
  "engine": "2026.4",
  "error": {
    "code": "template_runtime_error"
  },
  "files": [
    {
      "bytes": 48213,
      "content_type": "application/pdf",
      "filename": "invoice-42.pdf",
      "id": "file_01J9ZM1X3F7R8K2C4V6B8N0P2Q"
    }
  ],
  "id": "rnd_01J9ZM1X3F7R8K2C4V6B8N0P2Q",
  "kind": "pdf_template",
  "region": "eu",
  "result": {
    "conformance": {
      "einvoice": {
        "errors": [
          {
            "location": "invoice.seller.contact.email",
            "rule": "BR-DE-15"
          }
        ],
        "scenario": "EN16931 XRechnung (CII)",
        "validator": "KoSIT Validator 1.6.3",
        "warnings": [
          {
            "location": "invoice.seller.contact.email",
            "rule": "BR-DE-15"
          }
        ]
      },
      "pdfa": {
        "errors": [
          {
            "location": "invoice.seller.contact.email",
            "rule": "BR-DE-15"
          }
        ],
        "profile": "PDF/A-3B validation profile",
        "validator": "veraPDF 1.30.2",
        "warnings": [
          {
            "location": "invoice.seller.contact.email",
            "rule": "BR-DE-15"
          }
        ]
      },
      "pdfua": {
        "errors": [
          {
            "location": "invoice.seller.contact.email",
            "rule": "BR-DE-15"
          }
        ],
        "profile": "PDF/UA-1 validation profile",
        "validator": "veraPDF 1.30.2",
        "warnings": [
          {
            "location": "invoice.seller.contact.email",
            "rule": "BR-DE-15"
          }
        ]
      }
    }
  },
  "source": "api",
  "storage": [
    {
      "destination_id": "dst_01J9ZM1X3F7R8K2C4V6B8N0P2Q"
    }
  ],
  "timings": {
    "queued_ms": 3,
    "render_ms": 612,
    "total_ms": 681,
    "upload_ms": 38
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.