{ "openapi": "3.0.1", "info": { "title": "XRechnung Validator and Generator (EN 16931)", "description": "Returns a pass or fail verdict and every failing rule ID for XRechnung 3.0.2 and EN 16931 e-invoices (UBL or CII) and ZUGFeRD or Factur-X PDFs in the EN 16931 profile, using the official KoSIT validator. Also generates XRechnung XML and Factur-X PDFs from JSON, and extracts invoices to JSON.", "version": "0.1", "x-build-id": "K7rAdz7ldr2q087mZ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/omargnagy~einvoice-en16931/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-omargnagy-einvoice-en16931", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/omargnagy~einvoice-en16931/runs": { "post": { "operationId": "runs-sync-omargnagy-einvoice-en16931", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/omargnagy~einvoice-en16931/run-sync": { "post": { "operationId": "run-sync-omargnagy-einvoice-en16931", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "documents" ], "properties": { "operation": { "title": "Operation", "enum": [ "validate", "generate", "generate-pdf", "extract" ], "type": "string", "description": "What to do with each document. validate returns the verdict and every failing rule ID. generate and generate-pdf build an invoice from canonical JSON. extract reads an invoice back into JSON. A document can set its own operation.", "default": "validate" }, "documents": { "title": "Documents", "minItems": 1, "type": "array", "description": "One entry per document. For validate and extract, give url, xml (the XML as a string) or base64 (any file, PDFs included). For generate and generate-pdf, give invoice (the canonical JSON in the README). Optional per entry: name, operation, profile (for generate), pdfProfile, language and visualPdfBase64 (for generate-pdf). Other fields are ignored and named in the log." }, "profile": { "title": "Generation profile (XML)", "enum": [ "xrechnung-ubl", "xrechnung-cii", "en16931-ubl", "en16931-cii" ], "type": "string", "description": "XML profile that generate writes. XRechnung is the German version of EN 16931, required by German public buyers and accepted for B2B. EN 16931 core is the European base. UBL and CII are the two allowed syntaxes.", "default": "xrechnung-ubl" }, "pdfProfile": { "title": "Generation profile (PDF)", "enum": [ "facturx-xrechnung", "facturx-en16931" ], "type": "string", "description": "Factur-X (ZUGFeRD) profile that generate-pdf embeds in the PDF/A-3.", "default": "facturx-xrechnung" }, "language": { "title": "Rendered PDF language", "enum": [ "en", "de", "fr" ], "type": "string", "description": "Language of the PDF page that generate-pdf renders when you do not send your own visual PDF. English is the default; German and French come from the Mustang templates.", "default": "en" } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }