{ "openapi": "3.0.1", "info": { "title": "Peppol BIS 3.0 / UBL Invoice Validator (EN 16931)", "description": "Validate UBL invoices and credit notes against the official Peppol BIS Billing 3.0 and EN 16931 rules: XSD, CEN Schematron and Peppol Schematron. Returns every failed rule with its ID, message and location, plus an invoice summary.", "version": "1.1", "x-build-id": "LK7hEXmv0d0MGmnqw" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/fetchlab~peppol-invoice-validator/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-fetchlab-peppol-invoice-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/fetchlab~peppol-invoice-validator/runs": { "post": { "operationId": "runs-sync-fetchlab-peppol-invoice-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/fetchlab~peppol-invoice-validator/run-sync": { "post": { "operationId": "run-sync-fetchlab-peppol-invoice-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": { "documents": { "title": "UBL documents (raw XML)", "type": "array", "description": "One complete UBL Invoice or CreditNote XML per item. Paste the whole file content.", "items": { "type": "string" } }, "urls": { "title": "URLs of XML files", "type": "array", "description": "Optional. Public URLs (or Apify key-value store URLs) of UBL XML files to download and validate.", "items": { "type": "string" } }, "ruleSet": { "title": "Rule set", "enum": [ "peppol-bis-billing-3", "en16931-only" ], "type": "string", "description": "Peppol BIS Billing 3.0 = EN 16931 rules + Peppol rules (what a Peppol Access Point enforces). EN 16931 only = the European core invoice rules without the Peppol-specific ones.", "default": "peppol-bis-billing-3" }, "xsdValidation": { "title": "XSD validation", "type": "boolean", "description": "Check the XML structure against the OASIS UBL 2.1 schema before running the business rules.", "default": true }, "includeWarnings": { "title": "Include warnings", "type": "boolean", "description": "Also report non-blocking rule failures (severity 'warning'). They do not make a document invalid.", "default": true }, "includeTestExpressions": { "title": "Include XPath test expressions", "type": "boolean", "description": "Add the Schematron XPath test of each failed rule to the output (useful for developers, verbose).", "default": false }, "maxDocuments": { "title": "Max documents per run", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Safety limit on the number of documents validated in one run.", "default": 500 } } }, "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 } } } } } } } } } }