{ "openapi": "3.0.1", "info": { "title": "Peppol BIS Billing Preflight Validator - UBL & EN 16931", "description": "Validate UBL invoices against active Peppol BIS Billing 3.0.20 rules and preview the mandatory 3.0.21 rules effective 17 August 2026. Offline e-invoice validation for Belgium's B2B einvoicing mandate and any Peppol access point flow, with EN 16931 findings before network submission.", "version": "0.0", "x-build-id": "v8RRWL6pj8cqTyFk7" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/kamerozkan~peppol-bis-preflight-validator/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-kamerozkan-peppol-bis-preflight-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/kamerozkan~peppol-bis-preflight-validator/runs": { "post": { "operationId": "runs-sync-kamerozkan-peppol-bis-preflight-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/kamerozkan~peppol-bis-preflight-validator/run-sync": { "post": { "operationId": "run-sync-kamerozkan-peppol-bis-preflight-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": { "invoiceFiles": { "title": "Upload invoice files", "maxItems": 100, "type": "array", "description": "Upload Peppol BIS Billing UBL 2.1 invoice or credit-note XML files. Source documents are not copied to the output dataset.", "items": { "type": "string" } }, "documents": { "title": "API documents", "maxItems": 100, "type": "array", "description": "Each object needs one XML source: url, xml, or base64. HTTPS URLs only. documentId and fileName are optional.", "items": { "type": "object", "additionalProperties": false, "properties": { "documentId": { "title": "Document ID", "type": "string", "description": "Optional stable identifier returned with this document's result.", "minLength": 1, "maxLength": 128, "pattern": "^[A-Za-z0-9][A-Za-z0-9._-]{0,127}$" }, "fileName": { "title": "File name", "type": "string", "description": "Optional display name returned with the result.", "minLength": 1, "maxLength": 255 }, "url": { "title": "HTTPS URL", "type": "string", "description": "Public or signed HTTPS URL of the UBL XML document.", "minLength": 1 }, "xml": { "title": "Inline XML", "type": "string", "description": "Raw Peppol BIS Billing UBL XML text.", "minLength": 1 }, "base64": { "title": "Base64 invoice", "type": "string", "description": "Base64-encoded UBL invoice XML, with or without a data URL prefix.", "minLength": 1 } } } }, "sourceKeyValueStoreId": { "title": "Source key-value store", "type": "string", "description": "Optional. Select a key-value store that contains UBL XML records, then list the record keys below." }, "keyValueStoreKeys": { "title": "Invoice record keys", "maxItems": 100, "type": "array", "description": "Record keys to read from the selected source key-value store.", "items": { "type": "string", "minLength": 1, "maxLength": 256 } }, "resultDetail": { "title": "Result detail", "enum": [ "FINDINGS", "SUMMARY" ], "type": "string", "description": "FINDINGS returns rule IDs, messages, and locations. SUMMARY returns only status and counts.", "default": "FINDINGS" }, "maxFindingsPerDocument": { "title": "Maximum findings per invoice", "minimum": 1, "maximum": 500, "type": "integer", "description": "Caps the findings array without changing the total severity counts.", "default": 100 }, "storeXmlReport": { "title": "Store raw validation XML reports", "type": "boolean", "description": "Optional. Stores a normalized XML report covering active and preview rule results. Reports can contain invoice values.", "default": false }, "storeHtmlReport": { "title": "Store human-readable HTML reports", "type": "boolean", "description": "Optional. Stores a human-readable findings report in your run key-value store.", "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 } } }, "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 } } } } } } } } } }