{ "openapi": "3.0.1", "info": { "title": "ZUGFeRD & Factur-X PDF to JSON - Invoice Parser & Extractor", "description": "Extract embedded invoice XML from hybrid PDF/A-3 files, normalize EN 16931 data, and return a versioned technical conformance report. E-invoice parser and data extraction for ZUGFeRD and Factur-X: every parsed field ships with validation findings, never silent guesses.", "version": "0.0", "x-build-id": "wwRlBIS9n9VgVGjok" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/kamerozkan~zugferd-facturx-pdf-to-json/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-kamerozkan-zugferd-facturx-pdf-to-json", "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-facturx-pdf-to-json/runs": { "post": { "operationId": "runs-sync-kamerozkan-zugferd-facturx-pdf-to-json", "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-facturx-pdf-to-json/run-sync": { "post": { "operationId": "run-sync-kamerozkan-zugferd-facturx-pdf-to-json", "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 invoice PDFs", "maxItems": 20, "type": "array", "description": "Upload hybrid ZUGFeRD or Factur-X PDF files.", "items": { "type": "string" } }, "documents": { "title": "API documents", "maxItems": 20, "type": "array", "description": "Each item must contain exactly one source: url, 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 file name used for reporting.", "minLength": 1, "maxLength": 255 }, "url": { "title": "HTTPS URL", "type": "string", "description": "Public or signed HTTPS URL." }, "base64": { "title": "Base64 PDF", "type": "string", "description": "Base64 PDF data, with or without a data URL prefix." }, "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." }, "allowPartialNormalization": { "title": "Return partial normalized data", "type": "boolean", "description": "Return safely parsed fields even when the document is technically non-conformant. The report remains non-conformant or indeterminate.", "default": true }, "storeEmbeddedXml": { "title": "Store extracted XML", "type": "boolean", "description": "Store the complete embedded invoice XML in the run key-value store and return only its key and digest in Dataset.", "default": false }, "storeTechnicalReports": { "title": "Store technical reports", "type": "boolean", "description": "Store the sanitized ZUGFeRD rules report and veraPDF report in the run key-value store.", "default": false }, "maxFindingsPerDocument": { "title": "Maximum findings per invoice", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum number of PDF, XML, and business-rule findings returned for each invoice.", "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 } } } } } } } } } }