{ "openapi": "3.0.1", "info": { "title": "E-Invoice Validator: XRechnung, ZUGFeRD, Peppol BIS 3, EN16931", "description": "Validates e-invoices against the official EU artefacts and returns every failed rule with its id, severity, message and location. XML or hybrid PDF. XRechnung 3.0, Peppol BIS 3, EN 16931, NLCIUS, Factur-X, plus Facturae, FatturaPA and KSeF FA(3). No key, no proxy, no browser.", "version": "0.1", "x-build-id": "b9B1cNNSD35NztnXP" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/fractionalhqforyou~eu-einvoice-validator/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-fractionalhqforyou-eu-einvoice-validator", "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/fractionalhqforyou~eu-einvoice-validator/runs": { "post": { "operationId": "runs-sync-fractionalhqforyou-eu-einvoice-validator", "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/fractionalhqforyou~eu-einvoice-validator/run-sync": { "post": { "operationId": "run-sync-fractionalhqforyou-eu-einvoice-validator", "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", "properties": { "invoices": { "title": "Invoice file URLs", "type": "string", "description": "One URL per line. Each can be an invoice XML or a hybrid PDF with the invoice embedded (Factur-X, ZUGFeRD, XRechnung). Any public URL works, including an Apify key-value store record URL. Leave empty and leave the pasted XML empty too to run the free demo over the bundled sample invoices." }, "inlineXml": { "title": "Or paste one invoice as XML", "type": "string", "description": "A single invoice pasted straight in, instead of a URL. Checked alongside any URLs above." }, "profiles": { "title": "Rule sets to run", "type": "array", "description": "Leave on auto to run the EN 16931 core rules plus whatever profile the document declares. Pick one or more to force them instead. A profile with no official artefact for the document's syntax is reported as skipped, never as a pass.", "items": { "type": "string", "enum": [ "auto", "en16931", "xrechnung", "peppol-bis-3", "nlcius", "facturx-zugferd", "facturae", "fatturapa", "ksef" ], "enumTitles": [ "Auto: core plus the declared profile", "EN 16931 core (UBL and CII)", "XRechnung 3.0 (Germany)", "Peppol BIS Billing 3.0 (UBL)", "NLCIUS / SI-UBL 2.0 (Netherlands)", "Factur-X / ZUGFeRD (embedded CII)", "Facturae 3.2.2 (Spain, XSD)", "FatturaPA 1.2.3 (Italy, XSD)", "KSeF FA(3) (Poland, XSD)" ] }, "default": [ "auto" ] }, "failOnWarning": { "title": "Count warnings against validity", "type": "boolean", "description": "Off by default, so an invoice is valid when it has no fatal rule failures. Switch on and any warning or information-level finding makes it invalid too.", "default": false }, "maxInvoices": { "title": "Maximum invoices", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Cap on how many files to read from the list. Each invoice actually read and checked is one charged event.", "default": 100 } } }, "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 } } }, "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 } } } } } } } } } }