{ "openapi": "3.0.1", "info": { "title": "ZUGFeRD to XRechnung Converter", "description": "Assess supported ZUGFeRD documents for XRechnung conversion, request missing business terms, and emit target XML only after pinned target validation passes.", "version": "0.0", "x-build-id": "OiVFc4g0LBzdULIQ5" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/kamerozkan~zugferd-to-xrechnung-converter/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-kamerozkan-zugferd-to-xrechnung-converter", "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/kamerozkan~zugferd-to-xrechnung-converter/runs": { "post": { "operationId": "runs-sync-kamerozkan-zugferd-to-xrechnung-converter", "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/kamerozkan~zugferd-to-xrechnung-converter/run-sync": { "post": { "operationId": "run-sync-kamerozkan-zugferd-to-xrechnung-converter", "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": { "invoiceFiles": { "title": "Upload ZUGFeRD files", "maxItems": 100, "type": "array", "description": "Upload hybrid PDF or supported CII XML files, including ZUGFeRD 1.0 documents for a fail-closed automatic upgrade attempt.", "items": { "type": "string" } }, "documents": { "title": "API documents", "maxItems": 100, "type": "array", "description": "Each item must contain exactly one source: url, xml, base64, or keyValueStoreKey.", "items": { "type": "object", "additionalProperties": false, "properties": { "documentId": { "title": "Document ID", "type": "string", "description": "Optional stable identifier used in the Dataset row and artifact keys.", "minLength": 1, "maxLength": 128, "pattern": "^[A-Za-z0-9][A-Za-z0-9._-]{0,127}$" }, "fileName": { "title": "File name", "type": "string", "description": "Original or logical PDF or XML file name used for reporting.", "minLength": 1, "maxLength": 255 }, "url": { "title": "HTTPS URL", "type": "string", "description": "Public or signed HTTPS URL." }, "xml": { "title": "Inline XML", "type": "string", "description": "Inline ZUGFeRD or Factur-X CII XML. ZUGFeRD 1.0 is upgraded only after pinned source validation." }, "base64": { "title": "Base64 document", "type": "string", "description": "Base64 XML or PDF data." }, "keyValueStoreKey": { "title": "Key-value store record key", "type": "string", "description": "Record key in sourceKeyValueStoreId." } } } }, "sourceKeyValueStoreId": { "title": "Source key-value store", "type": "string", "description": "Key-value store ID containing records referenced by keyValueStoreKey." }, "sourceProfile": { "title": "Source profile", "enum": [ "AUTO" ], "type": "string", "description": "The profile is always detected from source evidence and cannot be overridden.", "default": "AUTO" }, "targetSyntax": { "title": "Target XRechnung syntax", "enum": [ "UBL", "CII" ], "type": "string", "description": "Generate a validated XRechnung UBL or CII target.", "default": "UBL" }, "targetRuleset": { "title": "Target ruleset", "enum": [ "LATEST_SUPPORTED", "XRECHNUNG_3_0_2_2026_01_31" ], "type": "string", "description": "LATEST_SUPPORTED resolves to the pinned XRechnung release recorded in the result.", "default": "LATEST_SUPPORTED" }, "overrides": { "title": "Missing business term overrides", "maxItems": 100, "type": "array", "description": "Typed additions for missing target terms only. Existing values can never be replaced, and each value is recorded by hash in provenance.", "items": { "type": "object", "additionalProperties": false, "required": [ "businessTermId", "value", "reason" ], "properties": { "businessTermId": { "title": "Business term ID", "type": "string", "description": "Allowlisted EN 16931 business term.", "editor": "select", "enum": [ "BT-10", "BT-31", "BT-34", "BT-37", "BT-38", "BT-41", "BT-42", "BT-43", "BT-49", "BT-52", "BT-53", "BT-81", "BT-83", "BT-84" ] }, "value": { "title": "Business term value", "type": "string", "description": "Value to add only when the selected business term is missing.", "minLength": 1, "maxLength": 512 }, "schemeId": { "title": "Identifier scheme", "type": "string", "description": "Required for BT-34 and BT-49 electronic addresses.", "minLength": 1, "maxLength": 100, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,99}$" }, "reason": { "title": "Override reason", "type": "string", "description": "Audit explanation for supplying this missing business term.", "minLength": 1, "maxLength": 1000 } } } }, "storeConvertedXml": { "title": "Store converted XML", "type": "boolean", "description": "Store the validated target and, for a successful ZUGFeRD 1.0 upgrade, the D16B intermediate in the run key-value store.", "default": true }, "storeExtractedXml": { "title": "Store extracted source XML", "type": "boolean", "description": "For PDF sources, store the extracted CII XML in the run key-value store.", "default": false }, "storeTechnicalReports": { "title": "Store validation reports", "type": "boolean", "description": "Store source, PDF/A, and target validation reports in the run key-value store. Reports can contain invoice data.", "default": false }, "maxFindingsPerDocument": { "title": "Maximum findings per document", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum number of source and target validation findings returned for each document.", "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 } } } } } } } } } }