{ "openapi": "3.0.1", "info": { "title": "E-Invoice Validator: XRechnung, ZUGFeRD, Factur-X (KoSIT)", "description": "Validate XRechnung, ZUGFeRD and Factur-X e-invoices with the latest official KoSIT rules, for mandatory e-invoicing in Germany from 2027. German fix hints.", "version": "0.3", "x-build-id": "jtQyhWyBN9xS7lE4E" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/app-to-go~e-rechnung-pruefer/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-app-to-go-e-rechnung-pruefer", "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/app-to-go~e-rechnung-pruefer/runs": { "post": { "operationId": "runs-sync-app-to-go-e-rechnung-pruefer", "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/app-to-go~e-rechnung-pruefer/run-sync": { "post": { "operationId": "run-sync-app-to-go-e-rechnung-pruefer", "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": { "documents": { "title": "Documents", "maxItems": 1000, "type": "array", "description": "Invoices to check. Each entry needs exactly one of url, xml (XML text) or base64 (PDF or XML, max. 20 MB). At most 1,000 documents per run (together with keys). Optional: documentId and fileName, both are copied to the output." }, "kvStoreId": { "title": "Key-value store ID", "type": "string", "description": "For bulk runs: read the documents from this key-value store (use together with keys). The Actor gets read access to this store only." }, "keys": { "title": "Keys", "maxItems": 1000, "type": "array", "description": "Record keys in the key-value store above. At most 1,000 per run (together with documents).", "items": { "type": "string" } }, "resultDetail": { "title": "Result detail", "enum": [ "SUMMARY", "FINDINGS" ], "type": "string", "description": "SUMMARY returns conformance and counts only, FINDINGS also lists the individual findings.", "default": "FINDINGS" }, "maxFindingsPerDocument": { "title": "Max findings per document", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Upper limit of listed findings per document (errors first).", "default": 50 }, "language": { "title": "Language", "enum": [ "de", "en" ], "type": "string", "description": "Language of log messages. Findings always contain the original rule message and the German hint (hint_de).", "default": "de" }, "htmlReport": { "title": "HTML report", "type": "boolean", "description": "Store the official KoSIT HTML test report per checked document in the default key-value store (charged as html-report, $0.002 each).", "default": false } } }, "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 } } } } } } } } } }