{ "openapi": "3.0.1", "info": { "title": "Peppol UBL Invoice Generator", "description": "Peppol UBL invoice generator for structured JSON inputs. Generate BIS Billing invoice XML and check it against the bundled EN 16931 and Peppol rule profiles before file delivery. Inspect pinned rule versions for your workflow; Peppol network transport is not included.", "version": "1.0", "x-build-id": "lrFooSMcwYVFI7II4" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/kamerozkan~peppol-ubl-invoice-generator/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-kamerozkan-peppol-ubl-invoice-generator", "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-ubl-invoice-generator/runs": { "post": { "operationId": "runs-sync-kamerozkan-peppol-ubl-invoice-generator", "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-ubl-invoice-generator/run-sync": { "post": { "operationId": "run-sync-kamerozkan-peppol-ubl-invoice-generator", "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": { "invoice": { "title": "Invoice JSON", "required": [ "invoice_number", "issue_date", "seller", "buyer", "lines" ], "type": "object", "description": "One invoice for Peppol BIS Billing 3.0.20-hotfix + 3.0.21 forward gate.", "properties": { "invoice_number": { "maxLength": 60, "minLength": 1, "title": "Invoice Number", "type": "string", "description": "Invoice Number used to generate and validate the invoice." }, "document_kind": { "default": "invoice", "enum": [ "invoice", "credit_note" ], "title": "Document Kind", "type": "string", "description": "Document Kind used to generate and validate the invoice." }, "issue_date": { "title": "Issue Date", "type": "string", "description": "Issue Date used to generate and validate the invoice.", "editor": "datepicker", "dateType": "absolute" }, "due_date": { "type": "string", "title": "Due Date", "nullable": true, "description": "Due Date used to generate and validate the invoice.", "editor": "datepicker", "dateType": "absolute" }, "tax_point_date": { "type": "string", "title": "Tax Point Date", "nullable": true, "description": "Tax Point Date used to generate and validate the invoice.", "editor": "datepicker", "dateType": "absolute" }, "tax_point_date_code": { "maxLength": 35, "minLength": 1, "type": "string", "title": "Tax Point Date Code", "nullable": true, "description": "Tax Point Date Code used to generate and validate the invoice." }, "delivery_date": { "type": "string", "title": "Delivery Date", "nullable": true, "description": "Delivery Date used to generate and validate the invoice.", "editor": "datepicker", "dateType": "absolute" }, "invoice_period": { "additionalProperties": false, "properties": { "start_date": { "type": "string", "title": "Start Date", "nullable": true, "description": "Start Date used to generate and validate the invoice.", "editor": "datepicker", "dateType": "absolute" }, "end_date": { "type": "string", "title": "End Date", "nullable": true, "description": "End Date used to generate and validate the invoice.", "editor": "datepicker", "dateType": "absolute" }, "description_code": { "maxLength": 35, "minLength": 1, "type": "string", "title": "Description Code", "nullable": true, "description": "Description Code used to generate and validate the invoice." } }, "title": "Period", "type": "object", "nullable": true, "description": "Period used to generate and validate the invoice." }, "delivery_period": { "additionalProperties": false, "properties": { "start_date": { "type": "string", "title": "Start Date", "nullable": true, "description": "Start Date used to generate and validate the invoice.", "editor": "datepicker", "dateType": "absolute" }, "end_date": { "type": "string", "title": "End Date", "nullable": true, "description": "End Date used to generate and validate the invoice.", "editor": "datepicker", "dateType": "absolute" }, "description_code": { "maxLength": 35, "minLength": 1, "type": "string", "title": "Description Code", "nullable": true, "description": "Description Code used to generate and validate the invoice." } }, "title": "Period", "type": "object", "nullable": true, "description": "Period used to generate and validate the invoice." }, "currency": { "default": "EUR", "maxLength": 3, "minLength": 3, "title": "Currency", "type": "string", "description": "Currency used to generate and validate the invoice." }, "tax_currency": { "maxLength": 3, "minLength": 3, "type": "string", "title": "Tax Currency", "nullable": true, "description": "Tax Currency used to generate and validate the invoice." }, "tax_currency_tax_amount": { "pattern": "^-?(?:0|[1-9][0-9]*)(?:\\.[0-9]+)?$", "type": "string", "title": "Tax Currency Tax Amount", "nullable": true, "description": "Tax Currency Tax Amount used to generate and validate the invoice." }, "invoice_type_code": { "default": "380", "maxLength": 3, "minLength": 2, "title": "Invoice Type Code", "type": "string", "description": "Invoice Type Code used to generate and validate the invoice." }, "buyer_reference": { "maxLength": 100, "type": "string", "title": "Buyer Reference", "nullable": true, "description": "Buyer Reference used to generate and validate the invoice." }, "purchase_order_reference": { "maxLength": 100, "type": "string", "title": "Purchase Order Reference", "nullable": true, "description": "Purchase Order Reference used to generate and validate the invoice." }, "sales_order_reference": { "maxLength": 100, "type": "string", "title": "Sales Order Reference", "nullable": true, "description": "Sales Order Reference used to generate and validate the invoice." }, "contract_reference": { "maxLength": 100, "type": "string", "title": "Contract Reference", "nullable": true, "description": "Contract Reference used to generate and validate the invoice." }, "project_reference": { "maxLength": 100, "type": "string", "title": "Project Reference", "nullable": true, "description": "Project Reference used to generate and validate the invoice." }, "project_name": { "maxLength": 200, "type": "string", "title": "Project Name", "nullable": true, "description": "Project Name used to generate and validate the invoice." }, "tender_reference": { "maxLength": 100, "type": "string", "title": "Tender Reference", "nullable": true, "description": "Tender Reference used to generate and validate the invoice." }, "receiving_advice_reference": { "maxLength": 100, "type": "string", "title": "Receiving Advice Reference", "nullable": true, "description": "Receiving Advice Reference used to generate and validate the invoice." }, "despatch_advice_reference": { "maxLength": 100, "type": "string", "title": "Despatch Advice Reference", "nullable": true, "description": "Despatch Advice Reference used to generate and validate the invoice." }, "accounting_cost": { "maxLength": 200, "type": "string", "title": "Accounting Cost", "nullable": true, "description": "Accounting Cost used to generate and validate the invoice." }, "seller": { "additionalProperties": false, "properties": { "name": { "maxLength": 200, "minLength": 1, "title": "Name", "type": "string", "description": "Name used to generate and validate the invoice." }, "address": { "additionalProperties": false, "properties": { "line1": { "maxLength": 100, "minLength": 1, "title": "Line1", "type": "string", "description": "Line1 used to generate and validate the invoice." }, "line2": { "maxLength": 100, "type": "string", "title": "Line2", "nullable": true, "description": "Line2 used to generate and validate the invoice." }, "line3": { "maxLength": 100, "type": "string", "title": "Line3", "nullable": true, "description": "Line3 used to generate and validate the invoice." }, "city": { "maxLength": 60, "minLength": 1, "title": "City", "type": "string", "description": "City used to generate and validate the invoice." }, "postal_code": { "maxLength": 20, "minLength": 1, "title": "Postal Code", "type": "string", "description": "Postal Code used to generate and validate the invoice." }, "country_code": { "maxLength": 2, "minLength": 2, "title": "Country Code", "type": "string", "description": "Country Code used to generate and validate the invoice." }, "region": { "maxLength": 60, "type": "string", "title": "Region", "nullable": true, "description": "Region used to generate and validate the invoice." } }, "required": [ "line1", "city", "postal_code", "country_code" ], "title": "Address", "type": "object", "description": "Address used to generate and validate the invoice." }, "trading_name": { "maxLength": 200, "minLength": 1, "type": "string", "title": "Trading Name", "nullable": true, "description": "Trading Name used to generate and validate the invoice." }, "vat_id": { "maxLength": 30, "minLength": 2, "type": "string", "title": "Vat Id", "nullable": true, "description": "Vat Id used to generate and validate the invoice." }, "tax_id": { "maxLength": 40, "minLength": 2, "type": "string", "title": "Tax Id", "nullable": true, "description": "Tax Id used to generate and validate the invoice." }, "registration_id": { "maxLength": 60, "minLength": 1, "type": "string", "title": "Registration Id", "nullable": true, "description": "Registration Id used to generate and validate the invoice." }, "registration_scheme": { "maxLength": 35, "minLength": 1, "type": "string", "title": "Registration Scheme", "nullable": true, "description": "Registration Scheme used to generate and validate the invoice." }, "additional_identifiers": { "items": { "additionalProperties": false, "properties": { "value": { "maxLength": 200, "minLength": 1, "title": "Value", "type": "string", "description": "Value used to generate and validate the invoice." }, "scheme_id": { "maxLength": 35, "minLength": 1, "type": "string", "title": "Scheme Id", "nullable": true, "description": "Scheme Id used to generate and validate the invoice." } }, "required": [ "value" ], "type": "object" }, "maxItems": 20, "title": "Additional Identifiers", "type": "array", "description": "Additional Identifiers used to generate and validate the invoice." }, "endpoint_id": { "maxLength": 200, "minLength": 1, "type": "string", "title": "Endpoint Id", "nullable": true, "description": "Endpoint Id used to generate and validate the invoice." }, "endpoint_scheme": { "maxLength": 35, "minLength": 1, "type": "string", "title": "Endpoint Scheme", "nullable": true, "description": "Endpoint Scheme used to generate and validate the invoice." }, "legal_information": { "maxLength": 500, "minLength": 1, "type": "string", "title": "Legal Information", "nullable": true, "description": "Legal Information used to generate and validate the invoice." }, "contact_name": { "maxLength": 100, "minLength": 1, "type": "string", "title": "Contact Name", "nullable": true, "description": "Contact Name used to generate and validate the invoice." }, "contact_department": { "maxLength": 100, "minLength": 1, "type": "string", "title": "Contact Department", "nullable": true, "description": "Contact Department used to generate and validate the invoice." }, "phone": { "maxLength": 50, "minLength": 3, "type": "string", "title": "Phone", "nullable": true, "description": "Phone used to generate and validate the invoice." }, "email": { "maxLength": 254, "minLength": 3, "type": "string", "title": "Email", "nullable": true, "description": "Email used to generate and validate the invoice." } }, "required": [ "name", "address" ], "title": "Party", "type": "object", "description": "Party used to generate and validate the invoice." }, "buyer": { "additionalProperties": false, "properties": { "name": { "maxLength": 200, "minLength": 1, "title": "Name", "type": "string", "description": "Name used to generate and validate the invoice." }, "address": { "additionalProperties": false, "properties": { "line1": { "maxLength": 100, "minLength": 1, "title": "Line1", "type": "string", "description": "Line1 used to generate and validate the invoice." }, "line2": { "maxLength": 100, "type": "string", "title": "Line2", "nullable": true, "description": "Line2 used to generate and validate the invoice." }, "line3": { "maxLength": 100, "type": "string", "title": "Line3", "nullable": true, "description": "Line3 used to generate and validate the invoice." }, "city": { "maxLength": 60, "minLength": 1, "title": "City", "type": "string", "description": "City used to generate and validate the invoice." }, "postal_code": { "maxLength": 20, "minLength": 1, "title": "Postal Code", "type": "string", "description": "Postal Code used to generate and validate the invoice." }, "country_code": { "maxLength": 2, "minLength": 2, "title": "Country Code", "type": "string", "description": "Country Code used to generate and validate the invoice." }, "region": { "maxLength": 60, "type": "string", "title": "Region", "nullable": true, "description": "Region used to generate and validate the invoice." } }, "required": [ "line1", "city", "postal_code", "country_code" ], "title": "Address", "type": "object", "description": "Address used to generate and validate the invoice." }, "trading_name": { "maxLength": 200, "minLength": 1, "type": "string", "title": "Trading Name", "nullable": true, "description": "Trading Name used to generate and validate the invoice." }, "vat_id": { "maxLength": 30, "minLength": 2, "type": "string", "title": "Vat Id", "nullable": true, "description": "Vat Id used to generate and validate the invoice." }, "tax_id": { "maxLength": 40, "minLength": 2, "type": "string", "title": "Tax Id", "nullable": true, "description": "Tax Id used to generate and validate the invoice." }, "registration_id": { "maxLength": 60, "minLength": 1, "type": "string", "title": "Registration Id", "nullable": true, "description": "Registration Id used to generate and validate the invoice." }, "registration_scheme": { "maxLength": 35, "minLength": 1, "type": "string", "title": "Registration Scheme", "nullable": true, "description": "Registration Scheme used to generate and validate the invoice." }, "additional_identifiers": { "items": { "additionalProperties": false, "properties": { "value": { "maxLength": 200, "minLength": 1, "title": "Value", "type": "string", "description": "Value used to generate and validate the invoice." }, "scheme_id": { "maxLength": 35, "minLength": 1, "type": "string", "title": "Scheme Id", "nullable": true, "description": "Scheme Id used to generate and validate the invoice." } }, "required": [ "value" ], "type": "object" }, "maxItems": 20, "title": "Additional Identifiers", "type": "array", "description": "Additional Identifiers used to generate and validate the invoice." }, "endpoint_id": { "maxLength": 200, "minLength": 1, "type": "string", "title": "Endpoint Id", "nullable": true, "description": "Endpoint Id used to generate and validate the invoice." }, "endpoint_scheme": { "maxLength": 35, "minLength": 1, "type": "string", "title": "Endpoint Scheme", "nullable": true, "description": "Endpoint Scheme used to generate and validate the invoice." }, "legal_information": { "maxLength": 500, "minLength": 1, "type": "string", "title": "Legal Information", "nullable": true, "description": "Legal Information used to generate and validate the invoice." }, "contact_name": { "maxLength": 100, "minLength": 1, "type": "string", "title": "Contact Name", "nullable": true, "description": "Contact Name used to generate and validate the invoice." }, "contact_department": { "maxLength": 100, "minLength": 1, "type": "string", "title": "Contact Department", "nullable": true, "description": "Contact Department used to generate and validate the invoice." }, "phone": { "maxLength": 50, "minLength": 3, "type": "string", "title": "Phone", "nullable": true, "description": "Phone used to generate and validate the invoice." }, "email": { "maxLength": 254, "minLength": 3, "type": "string", "title": "Email", "nullable": true, "description": "Email used to generate and validate the invoice." } }, "required": [ "name", "address" ], "title": "Party", "type": "object", "description": "Party used to generate and validate the invoice." }, "payee": { "additionalProperties": false, "properties": { "name": { "maxLength": 200, "minLength": 1, "title": "Name", "type": "string", "description": "Name used to generate and validate the invoice." }, "address": { "additionalProperties": false, "properties": { "line1": { "maxLength": 100, "minLength": 1, "title": "Line1", "type": "string", "description": "Line1 used to generate and validate the invoice." }, "line2": { "maxLength": 100, "type": "string", "title": "Line2", "nullable": true, "description": "Line2 used to generate and validate the invoice." }, "line3": { "maxLength": 100, "type": "string", "title": "Line3", "nullable": true, "description": "Line3 used to generate and validate the invoice." }, "city": { "maxLength": 60, "minLength": 1, "title": "City", "type": "string", "description": "City used to generate and validate the invoice." }, "postal_code": { "maxLength": 20, "minLength": 1, "title": "Postal Code", "type": "string", "description": "Postal Code used to generate and validate the invoice." }, "country_code": { "maxLength": 2, "minLength": 2, "title": "Country Code", "type": "string", "description": "Country Code used to generate and validate the invoice." }, "region": { "maxLength": 60, "type": "string", "title": "Region", "nullable": true, "description": "Region used to generate and validate the invoice." } }, "required": [ "line1", "city", "postal_code", "country_code" ], "title": "Address", "type": "object", "description": "Address used to generate and validate the invoice." }, "trading_name": { "maxLength": 200, "minLength": 1, "type": "string", "title": "Trading Name", "nullable": true, "description": "Trading Name used to generate and validate the invoice." }, "vat_id": { "maxLength": 30, "minLength": 2, "type": "string", "title": "Vat Id", "nullable": true, "description": "Vat Id used to generate and validate the invoice." }, "tax_id": { "maxLength": 40, "minLength": 2, "type": "string", "title": "Tax Id", "nullable": true, "description": "Tax Id used to generate and validate the invoice." }, "registration_id": { "maxLength": 60, "minLength": 1, "type": "string", "title": "Registration Id", "nullable": true, "description": "Registration Id used to generate and validate the invoice." }, "registration_scheme": { "maxLength": 35, "minLength": 1, "type": "string", "title": "Registration Scheme", "nullable": true, "description": "Registration Scheme used to generate and validate the invoice." }, "additional_identifiers": { "items": { "additionalProperties": false, "properties": { "value": { "maxLength": 200, "minLength": 1, "title": "Value", "type": "string", "description": "Value used to generate and validate the invoice." }, "scheme_id": { "maxLength": 35, "minLength": 1, "type": "string", "title": "Scheme Id", "nullable": true, "description": "Scheme Id used to generate and validate the invoice." } }, "required": [ "value" ], "type": "object" }, "maxItems": 20, "title": "Additional Identifiers", "type": "array", "description": "Additional Identifiers used to generate and validate the invoice." }, "endpoint_id": { "maxLength": 200, "minLength": 1, "type": "string", "title": "Endpoint Id", "nullable": true, "description": "Endpoint Id used to generate and validate the invoice." }, "endpoint_scheme": { "maxLength": 35, "minLength": 1, "type": "string", "title": "Endpoint Scheme", "nullable": true, "description": "Endpoint Scheme used to generate and validate the invoice." }, "legal_information": { "maxLength": 500, "minLength": 1, "type": "string", "title": "Legal Information", "nullable": true, "description": "Legal Information used to generate and validate the invoice." }, "contact_name": { "maxLength": 100, "minLength": 1, "type": "string", "title": "Contact Name", "nullable": true, "description": "Contact Name used to generate and validate the invoice." }, "contact_department": { "maxLength": 100, "minLength": 1, "type": "string", "title": "Contact Department", "nullable": true, "description": "Contact Department used to generate and validate the invoice." }, "phone": { "maxLength": 50, "minLength": 3, "type": "string", "title": "Phone", "nullable": true, "description": "Phone used to generate and validate the invoice." }, "email": { "maxLength": 254, "minLength": 3, "type": "string", "title": "Email", "nullable": true, "description": "Email used to generate and validate the invoice." } }, "required": [ "name", "address" ], "title": "Party", "type": "object", "nullable": true, "description": "Party used to generate and validate the invoice." }, "seller_tax_representative": { "additionalProperties": false, "properties": { "name": { "maxLength": 200, "minLength": 1, "title": "Name", "type": "string", "description": "Name used to generate and validate the invoice." }, "address": { "additionalProperties": false, "properties": { "line1": { "maxLength": 100, "minLength": 1, "title": "Line1", "type": "string", "description": "Line1 used to generate and validate the invoice." }, "line2": { "maxLength": 100, "type": "string", "title": "Line2", "nullable": true, "description": "Line2 used to generate and validate the invoice." }, "line3": { "maxLength": 100, "type": "string", "title": "Line3", "nullable": true, "description": "Line3 used to generate and validate the invoice." }, "city": { "maxLength": 60, "minLength": 1, "title": "City", "type": "string", "description": "City used to generate and validate the invoice." }, "postal_code": { "maxLength": 20, "minLength": 1, "title": "Postal Code", "type": "string", "description": "Postal Code used to generate and validate the invoice." }, "country_code": { "maxLength": 2, "minLength": 2, "title": "Country Code", "type": "string", "description": "Country Code used to generate and validate the invoice." }, "region": { "maxLength": 60, "type": "string", "title": "Region", "nullable": true, "description": "Region used to generate and validate the invoice." } }, "required": [ "line1", "city", "postal_code", "country_code" ], "title": "Address", "type": "object", "description": "Address used to generate and validate the invoice." }, "trading_name": { "maxLength": 200, "minLength": 1, "type": "string", "title": "Trading Name", "nullable": true, "description": "Trading Name used to generate and validate the invoice." }, "vat_id": { "maxLength": 30, "minLength": 2, "type": "string", "title": "Vat Id", "nullable": true, "description": "Vat Id used to generate and validate the invoice." }, "tax_id": { "maxLength": 40, "minLength": 2, "type": "string", "title": "Tax Id", "nullable": true, "description": "Tax Id used to generate and validate the invoice." }, "registration_id": { "maxLength": 60, "minLength": 1, "type": "string", "title": "Registration Id", "nullable": true, "description": "Registration Id used to generate and validate the invoice." }, "registration_scheme": { "maxLength": 35, "minLength": 1, "type": "string", "title": "Registration Scheme", "nullable": true, "description": "Registration Scheme used to generate and validate the invoice." }, "additional_identifiers": { "items": { "additionalProperties": false, "properties": { "value": { "maxLength": 200, "minLength": 1, "title": "Value", "type": "string", "description": "Value used to generate and validate the invoice." }, "scheme_id": { "maxLength": 35, "minLength": 1, "type": "string", "title": "Scheme Id", "nullable": true, "description": "Scheme Id used to generate and validate the invoice." } }, "required": [ "value" ], "type": "object" }, "maxItems": 20, "title": "Additional Identifiers", "type": "array", "description": "Additional Identifiers used to generate and validate the invoice." }, "endpoint_id": { "maxLength": 200, "minLength": 1, "type": "string", "title": "Endpoint Id", "nullable": true, "description": "Endpoint Id used to generate and validate the invoice." }, "endpoint_scheme": { "maxLength": 35, "minLength": 1, "type": "string", "title": "Endpoint Scheme", "nullable": true, "description": "Endpoint Scheme used to generate and validate the invoice." }, "legal_information": { "maxLength": 500, "minLength": 1, "type": "string", "title": "Legal Information", "nullable": true, "description": "Legal Information used to generate and validate the invoice." }, "contact_name": { "maxLength": 100, "minLength": 1, "type": "string", "title": "Contact Name", "nullable": true, "description": "Contact Name used to generate and validate the invoice." }, "contact_department": { "maxLength": 100, "minLength": 1, "type": "string", "title": "Contact Department", "nullable": true, "description": "Contact Department used to generate and validate the invoice." }, "phone": { "maxLength": 50, "minLength": 3, "type": "string", "title": "Phone", "nullable": true, "description": "Phone used to generate and validate the invoice." }, "email": { "maxLength": 254, "minLength": 3, "type": "string", "title": "Email", "nullable": true, "description": "Email used to generate and validate the invoice." } }, "required": [ "name", "address" ], "title": "Party", "type": "object", "nullable": true, "description": "Party used to generate and validate the invoice." }, "delivery_address": { "additionalProperties": false, "properties": { "line1": { "maxLength": 100, "minLength": 1, "title": "Line1", "type": "string", "description": "Line1 used to generate and validate the invoice." }, "line2": { "maxLength": 100, "type": "string", "title": "Line2", "nullable": true, "description": "Line2 used to generate and validate the invoice." }, "line3": { "maxLength": 100, "type": "string", "title": "Line3", "nullable": true, "description": "Line3 used to generate and validate the invoice." }, "city": { "maxLength": 60, "minLength": 1, "title": "City", "type": "string", "description": "City used to generate and validate the invoice." }, "postal_code": { "maxLength": 20, "minLength": 1, "title": "Postal Code", "type": "string", "description": "Postal Code used to generate and validate the invoice." }, "country_code": { "maxLength": 2, "minLength": 2, "title": "Country Code", "type": "string", "description": "Country Code used to generate and validate the invoice." }, "region": { "maxLength": 60, "type": "string", "title": "Region", "nullable": true, "description": "Region used to generate and validate the invoice." } }, "required": [ "line1", "city", "postal_code", "country_code" ], "title": "Address", "type": "object", "nullable": true, "description": "Address used to generate and validate the invoice." }, "delivery_location_id": { "additionalProperties": false, "properties": { "value": { "maxLength": 200, "minLength": 1, "title": "Value", "type": "string", "description": "Value used to generate and validate the invoice." }, "scheme_id": { "maxLength": 35, "minLength": 1, "type": "string", "title": "Scheme Id", "nullable": true, "description": "Scheme Id used to generate and validate the invoice." } }, "required": [ "value" ], "title": "Identifier", "type": "object", "nullable": true, "description": "Identifier used to generate and validate the invoice." }, "delivery_party_name": { "maxLength": 200, "minLength": 1, "type": "string", "title": "Delivery Party Name", "nullable": true, "description": "Delivery Party Name used to generate and validate the invoice." }, "lines": { "items": { "additionalProperties": false, "properties": { "id": { "maxLength": 100, "minLength": 1, "type": "string", "title": "Id", "nullable": true, "description": "Id used to generate and validate the invoice." }, "name": { "maxLength": 200, "minLength": 1, "type": "string", "title": "Name", "nullable": true, "description": "Name used to generate and validate the invoice." }, "description": { "maxLength": 1000, "minLength": 1, "title": "Description", "type": "string", "description": "Description used to generate and validate the invoice." }, "note": { "maxLength": 500, "minLength": 1, "type": "string", "title": "Note", "nullable": true, "description": "Note used to generate and validate the invoice." }, "quantity": { "pattern": "^-?(?:0|[1-9][0-9]*)(?:\\.[0-9]+)?$", "type": "string", "title": "Quantity", "description": "Quantity used to generate and validate the invoice." }, "unit_code": { "default": "C62", "maxLength": 3, "minLength": 2, "title": "Unit Code", "type": "string", "description": "Unit Code used to generate and validate the invoice." }, "unit_price": { "pattern": "^-?(?:0|[1-9][0-9]*)(?:\\.[0-9]+)?$", "type": "string", "title": "Unit Price", "description": "Unit Price used to generate and validate the invoice." }, "price_base_quantity": { "pattern": "^-?(?:0|[1-9][0-9]*)(?:\\.[0-9]+)?$", "type": "string", "default": "1", "title": "Price Base Quantity", "description": "Price Base Quantity used to generate and validate the invoice." }, "price_base_unit_code": { "maxLength": 3, "minLength": 2, "type": "string", "title": "Price Base Unit Code", "nullable": true, "description": "Price Base Unit Code used to generate and validate the invoice." }, "gross_unit_price": { "pattern": "^-?(?:0|[1-9][0-9]*)(?:\\.[0-9]+)?$", "type": "string", "title": "Gross Unit Price", "nullable": true, "description": "Gross Unit Price used to generate and validate the invoice." }, "gross_price_discount": { "pattern": "^-?(?:0|[1-9][0-9]*)(?:\\.[0-9]+)?$", "type": "string", "title": "Gross Price Discount", "nullable": true, "description": "Gross Price Discount used to generate and validate the invoice." }, "tax_rate": { "pattern": "^-?(?:0|[1-9][0-9]*)(?:\\.[0-9]+)?$", "type": "string", "title": "Tax Rate", "description": "Tax Rate used to generate and validate the invoice." }, "tax_category": { "default": "S", "maxLength": 3, "minLength": 1, "title": "Tax Category", "type": "string", "description": "Tax Category used to generate and validate the invoice." }, "tax_exemption_reason": { "maxLength": 500, "type": "string", "title": "Tax Exemption Reason", "nullable": true, "description": "Tax Exemption Reason used to generate and validate the invoice." }, "tax_exemption_reason_code": { "maxLength": 35, "type": "string", "title": "Tax Exemption Reason Code", "nullable": true, "description": "Tax Exemption Reason Code used to generate and validate the invoice." }, "allowances_charges": { "items": { "additionalProperties": false, "properties": { "is_charge": { "title": "Is Charge", "type": "boolean", "description": "Is Charge used to generate and validate the invoice." }, "amount": { "pattern": "^-?(?:0|[1-9][0-9]*)(?:\\.[0-9]+)?$", "type": "string", "title": "Amount", "description": "Amount used to generate and validate the invoice." }, "base_amount": { "pattern": "^-?(?:0|[1-9][0-9]*)(?:\\.[0-9]+)?$", "type": "string", "title": "Base Amount", "nullable": true, "description": "Base Amount used to generate and validate the invoice." }, "percentage": { "pattern": "^-?(?:0|[1-9][0-9]*)(?:\\.[0-9]+)?$", "type": "string", "title": "Percentage", "nullable": true, "description": "Percentage used to generate and validate the invoice." }, "reason": { "maxLength": 500, "minLength": 1, "title": "Reason", "type": "string", "description": "Reason used to generate and validate the invoice." }, "reason_code": { "maxLength": 35, "minLength": 1, "type": "string", "title": "Reason Code", "nullable": true, "description": "Reason Code used to generate and validate the invoice." }, "tax_category": { "maxLength": 3, "minLength": 1, "type": "string", "title": "Tax Category", "nullable": true, "description": "Tax Category used to generate and validate the invoice." }, "tax_rate": { "pattern": "^-?(?:0|[1-9][0-9]*)(?:\\.[0-9]+)?$", "type": "string", "title": "Tax Rate", "nullable": true, "description": "Tax Rate used to generate and validate the invoice." }, "tax_exemption_reason": { "maxLength": 500, "minLength": 1, "type": "string", "title": "Tax Exemption Reason", "nullable": true, "description": "Tax Exemption Reason used to generate and validate the invoice." }, "tax_exemption_reason_code": { "maxLength": 35, "minLength": 1, "type": "string", "title": "Tax Exemption Reason Code", "nullable": true, "description": "Tax Exemption Reason Code used to generate and validate the invoice." } }, "required": [ "is_charge", "amount", "reason" ], "type": "object" }, "maxItems": 100, "title": "Allowances Charges", "type": "array", "description": "Allowances Charges used to generate and validate the invoice." }, "period": { "additionalProperties": false, "properties": { "start_date": { "type": "string", "title": "Start Date", "nullable": true, "description": "Start Date used to generate and validate the invoice.", "editor": "datepicker", "dateType": "absolute" }, "end_date": { "type": "string", "title": "End Date", "nullable": true, "description": "End Date used to generate and validate the invoice.", "editor": "datepicker", "dateType": "absolute" }, "description_code": { "maxLength": 35, "minLength": 1, "type": "string", "title": "Description Code", "nullable": true, "description": "Description Code used to generate and validate the invoice." } }, "title": "Period", "type": "object", "nullable": true, "description": "Period used to generate and validate the invoice." }, "accounting_cost": { "maxLength": 200, "minLength": 1, "type": "string", "title": "Accounting Cost", "nullable": true, "description": "Accounting Cost used to generate and validate the invoice." }, "purchase_order_line_reference": { "maxLength": 100, "minLength": 1, "type": "string", "title": "Purchase Order Line Reference", "nullable": true, "description": "Purchase Order Line Reference used to generate and validate the invoice." }, "object_identifier": { "additionalProperties": false, "properties": { "value": { "maxLength": 200, "minLength": 1, "title": "Value", "type": "string", "description": "Value used to generate and validate the invoice." }, "scheme_id": { "maxLength": 35, "minLength": 1, "type": "string", "title": "Scheme Id", "nullable": true, "description": "Scheme Id used to generate and validate the invoice." } }, "required": [ "value" ], "title": "Identifier", "type": "object", "nullable": true, "description": "Identifier used to generate and validate the invoice." }, "seller_item_id": { "maxLength": 100, "minLength": 1, "type": "string", "title": "Seller Item Id", "nullable": true, "description": "Seller Item Id used to generate and validate the invoice." }, "buyer_item_id": { "maxLength": 100, "minLength": 1, "type": "string", "title": "Buyer Item Id", "nullable": true, "description": "Buyer Item Id used to generate and validate the invoice." }, "standard_item_id": { "additionalProperties": false, "properties": { "value": { "maxLength": 200, "minLength": 1, "title": "Value", "type": "string", "description": "Value used to generate and validate the invoice." }, "scheme_id": { "maxLength": 35, "minLength": 1, "type": "string", "title": "Scheme Id", "nullable": true, "description": "Scheme Id used to generate and validate the invoice." } }, "required": [ "value" ], "title": "Identifier", "type": "object", "nullable": true, "description": "Identifier used to generate and validate the invoice." }, "classifications": { "items": { "additionalProperties": false, "properties": { "value": { "maxLength": 200, "minLength": 1, "title": "Value", "type": "string", "description": "Value used to generate and validate the invoice." }, "scheme_id": { "maxLength": 35, "minLength": 1, "title": "Scheme Id", "type": "string", "description": "Scheme Id used to generate and validate the invoice." }, "scheme_version": { "maxLength": 35, "minLength": 1, "type": "string", "title": "Scheme Version", "nullable": true, "description": "Scheme Version used to generate and validate the invoice." } }, "required": [ "value", "scheme_id" ], "type": "object" }, "maxItems": 20, "title": "Classifications", "type": "array", "description": "Classifications used to generate and validate the invoice." }, "attributes": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 100, "minLength": 1, "title": "Name", "type": "string", "description": "Name used to generate and validate the invoice." }, "value": { "maxLength": 500, "minLength": 1, "title": "Value", "type": "string", "description": "Value used to generate and validate the invoice." } }, "required": [ "name", "value" ], "type": "object" }, "maxItems": 50, "title": "Attributes", "type": "array", "description": "Attributes used to generate and validate the invoice." }, "origin_country_code": { "maxLength": 2, "minLength": 2, "type": "string", "title": "Origin Country Code", "nullable": true, "description": "Origin Country Code used to generate and validate the invoice." } }, "required": [ "description", "quantity", "unit_price", "tax_rate" ], "type": "object" }, "maxItems": 1000, "minItems": 1, "title": "Lines", "type": "array", "description": "Lines used to generate and validate the invoice." }, "document_allowances_charges": { "items": { "additionalProperties": false, "properties": { "is_charge": { "title": "Is Charge", "type": "boolean", "description": "Is Charge used to generate and validate the invoice." }, "amount": { "pattern": "^-?(?:0|[1-9][0-9]*)(?:\\.[0-9]+)?$", "type": "string", "title": "Amount", "description": "Amount used to generate and validate the invoice." }, "base_amount": { "pattern": "^-?(?:0|[1-9][0-9]*)(?:\\.[0-9]+)?$", "type": "string", "title": "Base Amount", "nullable": true, "description": "Base Amount used to generate and validate the invoice." }, "percentage": { "pattern": "^-?(?:0|[1-9][0-9]*)(?:\\.[0-9]+)?$", "type": "string", "title": "Percentage", "nullable": true, "description": "Percentage used to generate and validate the invoice." }, "reason": { "maxLength": 500, "minLength": 1, "title": "Reason", "type": "string", "description": "Reason used to generate and validate the invoice." }, "reason_code": { "maxLength": 35, "minLength": 1, "type": "string", "title": "Reason Code", "nullable": true, "description": "Reason Code used to generate and validate the invoice." }, "tax_category": { "maxLength": 3, "minLength": 1, "type": "string", "title": "Tax Category", "nullable": true, "description": "Tax Category used to generate and validate the invoice." }, "tax_rate": { "pattern": "^-?(?:0|[1-9][0-9]*)(?:\\.[0-9]+)?$", "type": "string", "title": "Tax Rate", "nullable": true, "description": "Tax Rate used to generate and validate the invoice." }, "tax_exemption_reason": { "maxLength": 500, "minLength": 1, "type": "string", "title": "Tax Exemption Reason", "nullable": true, "description": "Tax Exemption Reason used to generate and validate the invoice." }, "tax_exemption_reason_code": { "maxLength": 35, "minLength": 1, "type": "string", "title": "Tax Exemption Reason Code", "nullable": true, "description": "Tax Exemption Reason Code used to generate and validate the invoice." } }, "required": [ "is_charge", "amount", "reason" ], "type": "object" }, "maxItems": 100, "title": "Document Allowances Charges", "type": "array", "description": "Document Allowances Charges used to generate and validate the invoice." }, "payment": { "additionalProperties": false, "properties": { "means_code": { "default": "30", "maxLength": 3, "minLength": 1, "title": "Means Code", "type": "string", "description": "Means Code used to generate and validate the invoice." }, "means_text": { "maxLength": 100, "minLength": 1, "type": "string", "title": "Means Text", "nullable": true, "description": "Means Text used to generate and validate the invoice." }, "reference": { "maxLength": 140, "type": "string", "title": "Reference", "nullable": true, "description": "Reference used to generate and validate the invoice." }, "account_id": { "maxLength": 70, "minLength": 1, "type": "string", "title": "Account Id", "nullable": true, "description": "Account Id used to generate and validate the invoice." }, "account_name": { "maxLength": 200, "minLength": 1, "type": "string", "title": "Account Name", "nullable": true, "description": "Account Name used to generate and validate the invoice." }, "iban": { "maxLength": 34, "minLength": 5, "type": "string", "title": "Iban", "nullable": true, "description": "Iban used to generate and validate the invoice." }, "bic": { "maxLength": 11, "minLength": 8, "type": "string", "title": "Bic", "nullable": true, "description": "Bic used to generate and validate the invoice." }, "bank_name": { "maxLength": 200, "minLength": 1, "type": "string", "title": "Bank Name", "nullable": true, "description": "Bank Name used to generate and validate the invoice." }, "mandate_reference": { "maxLength": 100, "minLength": 1, "type": "string", "title": "Mandate Reference", "nullable": true, "description": "Mandate Reference used to generate and validate the invoice." }, "creditor_identifier": { "maxLength": 100, "minLength": 1, "type": "string", "title": "Creditor Identifier", "nullable": true, "description": "Creditor Identifier used to generate and validate the invoice." }, "payer_account_id": { "maxLength": 70, "minLength": 1, "type": "string", "title": "Payer Account Id", "nullable": true, "description": "Payer Account Id used to generate and validate the invoice." }, "card_primary_account_number": { "maxLength": 6, "minLength": 4, "type": "string", "title": "Card Primary Account Number", "nullable": true, "description": "Card Primary Account Number used to generate and validate the invoice." }, "card_holder_name": { "maxLength": 100, "minLength": 1, "type": "string", "title": "Card Holder Name", "nullable": true, "description": "Card Holder Name used to generate and validate the invoice." } }, "title": "Payment", "type": "object", "description": "Payment used to generate and validate the invoice." }, "payment_terms": { "maxLength": 1000, "minLength": 1, "type": "string", "title": "Payment Terms", "nullable": true, "description": "Payment Terms used to generate and validate the invoice." }, "prepaid_amount": { "pattern": "^-?(?:0|[1-9][0-9]*)(?:\\.[0-9]+)?$", "type": "string", "default": "0", "title": "Prepaid Amount", "description": "Prepaid Amount used to generate and validate the invoice." }, "rounding_amount": { "pattern": "^-?(?:0|[1-9][0-9]*)(?:\\.[0-9]+)?$", "type": "string", "default": "0", "title": "Rounding Amount", "description": "Rounding Amount used to generate and validate the invoice." }, "notes": { "items": { "type": "string" }, "maxItems": 20, "title": "Notes", "type": "array", "description": "Notes used to generate and validate the invoice." }, "preceding_invoices": { "items": { "additionalProperties": false, "properties": { "id": { "maxLength": 200, "minLength": 1, "title": "Id", "type": "string", "description": "Id used to generate and validate the invoice." }, "issue_date": { "type": "string", "title": "Issue Date", "nullable": true, "description": "Issue Date used to generate and validate the invoice.", "editor": "datepicker", "dateType": "absolute" }, "type_code": { "maxLength": 35, "minLength": 1, "type": "string", "title": "Type Code", "nullable": true, "description": "Type Code used to generate and validate the invoice." }, "description": { "maxLength": 500, "minLength": 1, "type": "string", "title": "Description", "nullable": true, "description": "Description used to generate and validate the invoice." }, "id_scheme": { "maxLength": 35, "minLength": 1, "type": "string", "title": "Id Scheme", "nullable": true, "description": "Id Scheme used to generate and validate the invoice." }, "attachment": { "additionalProperties": false, "properties": { "filename": { "maxLength": 200, "minLength": 1, "type": "string", "title": "Filename", "nullable": true, "description": "Filename used to generate and validate the invoice." }, "mime_type": { "maxLength": 100, "minLength": 3, "type": "string", "title": "Mime Type", "nullable": true, "description": "Mime Type used to generate and validate the invoice." }, "description": { "maxLength": 500, "minLength": 1, "type": "string", "title": "Description", "nullable": true, "description": "Description used to generate and validate the invoice." }, "content_base64": { "type": "string", "title": "Content Base64", "nullable": true, "description": "Content Base64 used to generate and validate the invoice." }, "external_uri": { "maxLength": 2000, "minLength": 1, "type": "string", "title": "External Uri", "nullable": true, "description": "External Uri used to generate and validate the invoice." } }, "title": "Attachment", "type": "object", "nullable": true, "description": "Attachment used to generate and validate the invoice." } }, "required": [ "id" ], "type": "object" }, "maxItems": 100, "title": "Preceding Invoices", "type": "array", "description": "Preceding Invoices used to generate and validate the invoice." }, "supporting_documents": { "items": { "additionalProperties": false, "properties": { "id": { "maxLength": 200, "minLength": 1, "title": "Id", "type": "string", "description": "Id used to generate and validate the invoice." }, "issue_date": { "type": "string", "title": "Issue Date", "nullable": true, "description": "Issue Date used to generate and validate the invoice.", "editor": "datepicker", "dateType": "absolute" }, "type_code": { "maxLength": 35, "minLength": 1, "type": "string", "title": "Type Code", "nullable": true, "description": "Type Code used to generate and validate the invoice." }, "description": { "maxLength": 500, "minLength": 1, "type": "string", "title": "Description", "nullable": true, "description": "Description used to generate and validate the invoice." }, "id_scheme": { "maxLength": 35, "minLength": 1, "type": "string", "title": "Id Scheme", "nullable": true, "description": "Id Scheme used to generate and validate the invoice." }, "attachment": { "additionalProperties": false, "properties": { "filename": { "maxLength": 200, "minLength": 1, "type": "string", "title": "Filename", "nullable": true, "description": "Filename used to generate and validate the invoice." }, "mime_type": { "maxLength": 100, "minLength": 3, "type": "string", "title": "Mime Type", "nullable": true, "description": "Mime Type used to generate and validate the invoice." }, "description": { "maxLength": 500, "minLength": 1, "type": "string", "title": "Description", "nullable": true, "description": "Description used to generate and validate the invoice." }, "content_base64": { "type": "string", "title": "Content Base64", "nullable": true, "description": "Content Base64 used to generate and validate the invoice." }, "external_uri": { "maxLength": 2000, "minLength": 1, "type": "string", "title": "External Uri", "nullable": true, "description": "External Uri used to generate and validate the invoice." } }, "title": "Attachment", "type": "object", "nullable": true, "description": "Attachment used to generate and validate the invoice." } }, "required": [ "id" ], "type": "object" }, "maxItems": 100, "title": "Supporting Documents", "type": "array", "description": "Supporting Documents used to generate and validate the invoice." }, "extensions": { "type": "object", "additionalProperties": false, "properties": { "peppol": { "type": "object", "additionalProperties": false, "properties": { "business_process_id": { "type": "string", "minLength": 1, "maxLength": 200, "title": "Business process id", "description": "Business process id used to generate and validate the invoice." } }, "title": "Peppol", "description": "Peppol used to generate and validate the invoice." } }, "required": [ "peppol" ], "description": "Product-specific options. Unknown fields are rejected.", "title": "Extensions" } }, "additionalProperties": false }, "invoices": { "title": "Batch invoices", "minItems": 1, "maxItems": 100, "type": "array", "description": "Optional batch of up to 100 invoices. Do not use with invoice.", "items": { "additionalProperties": false, "properties": { "invoice_number": { "maxLength": 60, "minLength": 1, "title": "Invoice Number", "type": "string", "description": "Invoice Number used to generate and validate the invoice." }, "document_kind": { "default": "invoice", "enum": [ "invoice", "credit_note" ], "title": "Document Kind", "type": "string", "description": "Document Kind used to generate and validate the invoice." }, "issue_date": { "title": "Issue Date", "type": "string", "description": "Issue Date used to generate and validate the invoice.", "editor": "datepicker", "dateType": "absolute" }, "due_date": { "type": "string", "title": "Due Date", "nullable": true, "description": "Due Date used to generate and validate the invoice.", "editor": "datepicker", "dateType": "absolute" }, "tax_point_date": { "type": "string", "title": "Tax Point Date", "nullable": true, "description": "Tax Point Date used to generate and validate the invoice.", "editor": "datepicker", "dateType": "absolute" }, "tax_point_date_code": { "maxLength": 35, "minLength": 1, "type": "string", "title": "Tax Point Date Code", "nullable": true, "description": "Tax Point Date Code used to generate and validate the invoice." }, "delivery_date": { "type": "string", "title": "Delivery Date", "nullable": true, "description": "Delivery Date used to generate and validate the invoice.", "editor": "datepicker", "dateType": "absolute" }, "invoice_period": { "additionalProperties": false, "properties": { "start_date": { "type": "string", "title": "Start Date", "nullable": true, "description": "Start Date used to generate and validate the invoice.", "editor": "datepicker", "dateType": "absolute" }, "end_date": { "type": "string", "title": "End Date", "nullable": true, "description": "End Date used to generate and validate the invoice.", "editor": "datepicker", "dateType": "absolute" }, "description_code": { "maxLength": 35, "minLength": 1, "type": "string", "title": "Description Code", "nullable": true, "description": "Description Code used to generate and validate the invoice." } }, "title": "Period", "type": "object", "nullable": true, "description": "Period used to generate and validate the invoice." }, "delivery_period": { "additionalProperties": false, "properties": { "start_date": { "type": "string", "title": "Start Date", "nullable": true, "description": "Start Date used to generate and validate the invoice.", "editor": "datepicker", "dateType": "absolute" }, "end_date": { "type": "string", "title": "End Date", "nullable": true, "description": "End Date used to generate and validate the invoice.", "editor": "datepicker", "dateType": "absolute" }, "description_code": { "maxLength": 35, "minLength": 1, "type": "string", "title": "Description Code", "nullable": true, "description": "Description Code used to generate and validate the invoice." } }, "title": "Period", "type": "object", "nullable": true, "description": "Period used to generate and validate the invoice." }, "currency": { "default": "EUR", "maxLength": 3, "minLength": 3, "title": "Currency", "type": "string", "description": "Currency used to generate and validate the invoice." }, "tax_currency": { "maxLength": 3, "minLength": 3, "type": "string", "title": "Tax Currency", "nullable": true, "description": "Tax Currency used to generate and validate the invoice." }, "tax_currency_tax_amount": { "pattern": "^-?(?:0|[1-9][0-9]*)(?:\\.[0-9]+)?$", "type": "string", "title": "Tax Currency Tax Amount", "nullable": true, "description": "Tax Currency Tax Amount used to generate and validate the invoice." }, "invoice_type_code": { "default": "380", "maxLength": 3, "minLength": 2, "title": "Invoice Type Code", "type": "string", "description": "Invoice Type Code used to generate and validate the invoice." }, "buyer_reference": { "maxLength": 100, "type": "string", "title": "Buyer Reference", "nullable": true, "description": "Buyer Reference used to generate and validate the invoice." }, "purchase_order_reference": { "maxLength": 100, "type": "string", "title": "Purchase Order Reference", "nullable": true, "description": "Purchase Order Reference used to generate and validate the invoice." }, "sales_order_reference": { "maxLength": 100, "type": "string", "title": "Sales Order Reference", "nullable": true, "description": "Sales Order Reference used to generate and validate the invoice." }, "contract_reference": { "maxLength": 100, "type": "string", "title": "Contract Reference", "nullable": true, "description": "Contract Reference used to generate and validate the invoice." }, "project_reference": { "maxLength": 100, "type": "string", "title": "Project Reference", "nullable": true, "description": "Project Reference used to generate and validate the invoice." }, "project_name": { "maxLength": 200, "type": "string", "title": "Project Name", "nullable": true, "description": "Project Name used to generate and validate the invoice." }, "tender_reference": { "maxLength": 100, "type": "string", "title": "Tender Reference", "nullable": true, "description": "Tender Reference used to generate and validate the invoice." }, "receiving_advice_reference": { "maxLength": 100, "type": "string", "title": "Receiving Advice Reference", "nullable": true, "description": "Receiving Advice Reference used to generate and validate the invoice." }, "despatch_advice_reference": { "maxLength": 100, "type": "string", "title": "Despatch Advice Reference", "nullable": true, "description": "Despatch Advice Reference used to generate and validate the invoice." }, "accounting_cost": { "maxLength": 200, "type": "string", "title": "Accounting Cost", "nullable": true, "description": "Accounting Cost used to generate and validate the invoice." }, "seller": { "additionalProperties": false, "properties": { "name": { "maxLength": 200, "minLength": 1, "title": "Name", "type": "string", "description": "Name used to generate and validate the invoice." }, "address": { "additionalProperties": false, "properties": { "line1": { "maxLength": 100, "minLength": 1, "title": "Line1", "type": "string", "description": "Line1 used to generate and validate the invoice." }, "line2": { "maxLength": 100, "type": "string", "title": "Line2", "nullable": true, "description": "Line2 used to generate and validate the invoice." }, "line3": { "maxLength": 100, "type": "string", "title": "Line3", "nullable": true, "description": "Line3 used to generate and validate the invoice." }, "city": { "maxLength": 60, "minLength": 1, "title": "City", "type": "string", "description": "City used to generate and validate the invoice." }, "postal_code": { "maxLength": 20, "minLength": 1, "title": "Postal Code", "type": "string", "description": "Postal Code used to generate and validate the invoice." }, "country_code": { "maxLength": 2, "minLength": 2, "title": "Country Code", "type": "string", "description": "Country Code used to generate and validate the invoice." }, "region": { "maxLength": 60, "type": "string", "title": "Region", "nullable": true, "description": "Region used to generate and validate the invoice." } }, "required": [ "line1", "city", "postal_code", "country_code" ], "title": "Address", "type": "object", "description": "Address used to generate and validate the invoice." }, "trading_name": { "maxLength": 200, "minLength": 1, "type": "string", "title": "Trading Name", "nullable": true, "description": "Trading Name used to generate and validate the invoice." }, "vat_id": { "maxLength": 30, "minLength": 2, "type": "string", "title": "Vat Id", "nullable": true, "description": "Vat Id used to generate and validate the invoice." }, "tax_id": { "maxLength": 40, "minLength": 2, "type": "string", "title": "Tax Id", "nullable": true, "description": "Tax Id used to generate and validate the invoice." }, "registration_id": { "maxLength": 60, "minLength": 1, "type": "string", "title": "Registration Id", "nullable": true, "description": "Registration Id used to generate and validate the invoice." }, "registration_scheme": { "maxLength": 35, "minLength": 1, "type": "string", "title": "Registration Scheme", "nullable": true, "description": "Registration Scheme used to generate and validate the invoice." }, "additional_identifiers": { "items": { "additionalProperties": false, "properties": { "value": { "maxLength": 200, "minLength": 1, "title": "Value", "type": "string", "description": "Value used to generate and validate the invoice." }, "scheme_id": { "maxLength": 35, "minLength": 1, "type": "string", "title": "Scheme Id", "nullable": true, "description": "Scheme Id used to generate and validate the invoice." } }, "required": [ "value" ], "type": "object" }, "maxItems": 20, "title": "Additional Identifiers", "type": "array", "description": "Additional Identifiers used to generate and validate the invoice." }, "endpoint_id": { "maxLength": 200, "minLength": 1, "type": "string", "title": "Endpoint Id", "nullable": true, "description": "Endpoint Id used to generate and validate the invoice." }, "endpoint_scheme": { "maxLength": 35, "minLength": 1, "type": "string", "title": "Endpoint Scheme", "nullable": true, "description": "Endpoint Scheme used to generate and validate the invoice." }, "legal_information": { "maxLength": 500, "minLength": 1, "type": "string", "title": "Legal Information", "nullable": true, "description": "Legal Information used to generate and validate the invoice." }, "contact_name": { "maxLength": 100, "minLength": 1, "type": "string", "title": "Contact Name", "nullable": true, "description": "Contact Name used to generate and validate the invoice." }, "contact_department": { "maxLength": 100, "minLength": 1, "type": "string", "title": "Contact Department", "nullable": true, "description": "Contact Department used to generate and validate the invoice." }, "phone": { "maxLength": 50, "minLength": 3, "type": "string", "title": "Phone", "nullable": true, "description": "Phone used to generate and validate the invoice." }, "email": { "maxLength": 254, "minLength": 3, "type": "string", "title": "Email", "nullable": true, "description": "Email used to generate and validate the invoice." } }, "required": [ "name", "address" ], "title": "Party", "type": "object", "description": "Party used to generate and validate the invoice." }, "buyer": { "additionalProperties": false, "properties": { "name": { "maxLength": 200, "minLength": 1, "title": "Name", "type": "string", "description": "Name used to generate and validate the invoice." }, "address": { "additionalProperties": false, "properties": { "line1": { "maxLength": 100, "minLength": 1, "title": "Line1", "type": "string", "description": "Line1 used to generate and validate the invoice." }, "line2": { "maxLength": 100, "type": "string", "title": "Line2", "nullable": true, "description": "Line2 used to generate and validate the invoice." }, "line3": { "maxLength": 100, "type": "string", "title": "Line3", "nullable": true, "description": "Line3 used to generate and validate the invoice." }, "city": { "maxLength": 60, "minLength": 1, "title": "City", "type": "string", "description": "City used to generate and validate the invoice." }, "postal_code": { "maxLength": 20, "minLength": 1, "title": "Postal Code", "type": "string", "description": "Postal Code used to generate and validate the invoice." }, "country_code": { "maxLength": 2, "minLength": 2, "title": "Country Code", "type": "string", "description": "Country Code used to generate and validate the invoice." }, "region": { "maxLength": 60, "type": "string", "title": "Region", "nullable": true, "description": "Region used to generate and validate the invoice." } }, "required": [ "line1", "city", "postal_code", "country_code" ], "title": "Address", "type": "object", "description": "Address used to generate and validate the invoice." }, "trading_name": { "maxLength": 200, "minLength": 1, "type": "string", "title": "Trading Name", "nullable": true, "description": "Trading Name used to generate and validate the invoice." }, "vat_id": { "maxLength": 30, "minLength": 2, "type": "string", "title": "Vat Id", "nullable": true, "description": "Vat Id used to generate and validate the invoice." }, "tax_id": { "maxLength": 40, "minLength": 2, "type": "string", "title": "Tax Id", "nullable": true, "description": "Tax Id used to generate and validate the invoice." }, "registration_id": { "maxLength": 60, "minLength": 1, "type": "string", "title": "Registration Id", "nullable": true, "description": "Registration Id used to generate and validate the invoice." }, "registration_scheme": { "maxLength": 35, "minLength": 1, "type": "string", "title": "Registration Scheme", "nullable": true, "description": "Registration Scheme used to generate and validate the invoice." }, "additional_identifiers": { "items": { "additionalProperties": false, "properties": { "value": { "maxLength": 200, "minLength": 1, "title": "Value", "type": "string", "description": "Value used to generate and validate the invoice." }, "scheme_id": { "maxLength": 35, "minLength": 1, "type": "string", "title": "Scheme Id", "nullable": true, "description": "Scheme Id used to generate and validate the invoice." } }, "required": [ "value" ], "type": "object" }, "maxItems": 20, "title": "Additional Identifiers", "type": "array", "description": "Additional Identifiers used to generate and validate the invoice." }, "endpoint_id": { "maxLength": 200, "minLength": 1, "type": "string", "title": "Endpoint Id", "nullable": true, "description": "Endpoint Id used to generate and validate the invoice." }, "endpoint_scheme": { "maxLength": 35, "minLength": 1, "type": "string", "title": "Endpoint Scheme", "nullable": true, "description": "Endpoint Scheme used to generate and validate the invoice." }, "legal_information": { "maxLength": 500, "minLength": 1, "type": "string", "title": "Legal Information", "nullable": true, "description": "Legal Information used to generate and validate the invoice." }, "contact_name": { "maxLength": 100, "minLength": 1, "type": "string", "title": "Contact Name", "nullable": true, "description": "Contact Name used to generate and validate the invoice." }, "contact_department": { "maxLength": 100, "minLength": 1, "type": "string", "title": "Contact Department", "nullable": true, "description": "Contact Department used to generate and validate the invoice." }, "phone": { "maxLength": 50, "minLength": 3, "type": "string", "title": "Phone", "nullable": true, "description": "Phone used to generate and validate the invoice." }, "email": { "maxLength": 254, "minLength": 3, "type": "string", "title": "Email", "nullable": true, "description": "Email used to generate and validate the invoice." } }, "required": [ "name", "address" ], "title": "Party", "type": "object", "description": "Party used to generate and validate the invoice." }, "payee": { "additionalProperties": false, "properties": { "name": { "maxLength": 200, "minLength": 1, "title": "Name", "type": "string", "description": "Name used to generate and validate the invoice." }, "address": { "additionalProperties": false, "properties": { "line1": { "maxLength": 100, "minLength": 1, "title": "Line1", "type": "string", "description": "Line1 used to generate and validate the invoice." }, "line2": { "maxLength": 100, "type": "string", "title": "Line2", "nullable": true, "description": "Line2 used to generate and validate the invoice." }, "line3": { "maxLength": 100, "type": "string", "title": "Line3", "nullable": true, "description": "Line3 used to generate and validate the invoice." }, "city": { "maxLength": 60, "minLength": 1, "title": "City", "type": "string", "description": "City used to generate and validate the invoice." }, "postal_code": { "maxLength": 20, "minLength": 1, "title": "Postal Code", "type": "string", "description": "Postal Code used to generate and validate the invoice." }, "country_code": { "maxLength": 2, "minLength": 2, "title": "Country Code", "type": "string", "description": "Country Code used to generate and validate the invoice." }, "region": { "maxLength": 60, "type": "string", "title": "Region", "nullable": true, "description": "Region used to generate and validate the invoice." } }, "required": [ "line1", "city", "postal_code", "country_code" ], "title": "Address", "type": "object", "description": "Address used to generate and validate the invoice." }, "trading_name": { "maxLength": 200, "minLength": 1, "type": "string", "title": "Trading Name", "nullable": true, "description": "Trading Name used to generate and validate the invoice." }, "vat_id": { "maxLength": 30, "minLength": 2, "type": "string", "title": "Vat Id", "nullable": true, "description": "Vat Id used to generate and validate the invoice." }, "tax_id": { "maxLength": 40, "minLength": 2, "type": "string", "title": "Tax Id", "nullable": true, "description": "Tax Id used to generate and validate the invoice." }, "registration_id": { "maxLength": 60, "minLength": 1, "type": "string", "title": "Registration Id", "nullable": true, "description": "Registration Id used to generate and validate the invoice." }, "registration_scheme": { "maxLength": 35, "minLength": 1, "type": "string", "title": "Registration Scheme", "nullable": true, "description": "Registration Scheme used to generate and validate the invoice." }, "additional_identifiers": { "items": { "additionalProperties": false, "properties": { "value": { "maxLength": 200, "minLength": 1, "title": "Value", "type": "string", "description": "Value used to generate and validate the invoice." }, "scheme_id": { "maxLength": 35, "minLength": 1, "type": "string", "title": "Scheme Id", "nullable": true, "description": "Scheme Id used to generate and validate the invoice." } }, "required": [ "value" ], "type": "object" }, "maxItems": 20, "title": "Additional Identifiers", "type": "array", "description": "Additional Identifiers used to generate and validate the invoice." }, "endpoint_id": { "maxLength": 200, "minLength": 1, "type": "string", "title": "Endpoint Id", "nullable": true, "description": "Endpoint Id used to generate and validate the invoice." }, "endpoint_scheme": { "maxLength": 35, "minLength": 1, "type": "string", "title": "Endpoint Scheme", "nullable": true, "description": "Endpoint Scheme used to generate and validate the invoice." }, "legal_information": { "maxLength": 500, "minLength": 1, "type": "string", "title": "Legal Information", "nullable": true, "description": "Legal Information used to generate and validate the invoice." }, "contact_name": { "maxLength": 100, "minLength": 1, "type": "string", "title": "Contact Name", "nullable": true, "description": "Contact Name used to generate and validate the invoice." }, "contact_department": { "maxLength": 100, "minLength": 1, "type": "string", "title": "Contact Department", "nullable": true, "description": "Contact Department used to generate and validate the invoice." }, "phone": { "maxLength": 50, "minLength": 3, "type": "string", "title": "Phone", "nullable": true, "description": "Phone used to generate and validate the invoice." }, "email": { "maxLength": 254, "minLength": 3, "type": "string", "title": "Email", "nullable": true, "description": "Email used to generate and validate the invoice." } }, "required": [ "name", "address" ], "title": "Party", "type": "object", "nullable": true, "description": "Party used to generate and validate the invoice." }, "seller_tax_representative": { "additionalProperties": false, "properties": { "name": { "maxLength": 200, "minLength": 1, "title": "Name", "type": "string", "description": "Name used to generate and validate the invoice." }, "address": { "additionalProperties": false, "properties": { "line1": { "maxLength": 100, "minLength": 1, "title": "Line1", "type": "string", "description": "Line1 used to generate and validate the invoice." }, "line2": { "maxLength": 100, "type": "string", "title": "Line2", "nullable": true, "description": "Line2 used to generate and validate the invoice." }, "line3": { "maxLength": 100, "type": "string", "title": "Line3", "nullable": true, "description": "Line3 used to generate and validate the invoice." }, "city": { "maxLength": 60, "minLength": 1, "title": "City", "type": "string", "description": "City used to generate and validate the invoice." }, "postal_code": { "maxLength": 20, "minLength": 1, "title": "Postal Code", "type": "string", "description": "Postal Code used to generate and validate the invoice." }, "country_code": { "maxLength": 2, "minLength": 2, "title": "Country Code", "type": "string", "description": "Country Code used to generate and validate the invoice." }, "region": { "maxLength": 60, "type": "string", "title": "Region", "nullable": true, "description": "Region used to generate and validate the invoice." } }, "required": [ "line1", "city", "postal_code", "country_code" ], "title": "Address", "type": "object", "description": "Address used to generate and validate the invoice." }, "trading_name": { "maxLength": 200, "minLength": 1, "type": "string", "title": "Trading Name", "nullable": true, "description": "Trading Name used to generate and validate the invoice." }, "vat_id": { "maxLength": 30, "minLength": 2, "type": "string", "title": "Vat Id", "nullable": true, "description": "Vat Id used to generate and validate the invoice." }, "tax_id": { "maxLength": 40, "minLength": 2, "type": "string", "title": "Tax Id", "nullable": true, "description": "Tax Id used to generate and validate the invoice." }, "registration_id": { "maxLength": 60, "minLength": 1, "type": "string", "title": "Registration Id", "nullable": true, "description": "Registration Id used to generate and validate the invoice." }, "registration_scheme": { "maxLength": 35, "minLength": 1, "type": "string", "title": "Registration Scheme", "nullable": true, "description": "Registration Scheme used to generate and validate the invoice." }, "additional_identifiers": { "items": { "additionalProperties": false, "properties": { "value": { "maxLength": 200, "minLength": 1, "title": "Value", "type": "string", "description": "Value used to generate and validate the invoice." }, "scheme_id": { "maxLength": 35, "minLength": 1, "type": "string", "title": "Scheme Id", "nullable": true, "description": "Scheme Id used to generate and validate the invoice." } }, "required": [ "value" ], "type": "object" }, "maxItems": 20, "title": "Additional Identifiers", "type": "array", "description": "Additional Identifiers used to generate and validate the invoice." }, "endpoint_id": { "maxLength": 200, "minLength": 1, "type": "string", "title": "Endpoint Id", "nullable": true, "description": "Endpoint Id used to generate and validate the invoice." }, "endpoint_scheme": { "maxLength": 35, "minLength": 1, "type": "string", "title": "Endpoint Scheme", "nullable": true, "description": "Endpoint Scheme used to generate and validate the invoice." }, "legal_information": { "maxLength": 500, "minLength": 1, "type": "string", "title": "Legal Information", "nullable": true, "description": "Legal Information used to generate and validate the invoice." }, "contact_name": { "maxLength": 100, "minLength": 1, "type": "string", "title": "Contact Name", "nullable": true, "description": "Contact Name used to generate and validate the invoice." }, "contact_department": { "maxLength": 100, "minLength": 1, "type": "string", "title": "Contact Department", "nullable": true, "description": "Contact Department used to generate and validate the invoice." }, "phone": { "maxLength": 50, "minLength": 3, "type": "string", "title": "Phone", "nullable": true, "description": "Phone used to generate and validate the invoice." }, "email": { "maxLength": 254, "minLength": 3, "type": "string", "title": "Email", "nullable": true, "description": "Email used to generate and validate the invoice." } }, "required": [ "name", "address" ], "title": "Party", "type": "object", "nullable": true, "description": "Party used to generate and validate the invoice." }, "delivery_address": { "additionalProperties": false, "properties": { "line1": { "maxLength": 100, "minLength": 1, "title": "Line1", "type": "string", "description": "Line1 used to generate and validate the invoice." }, "line2": { "maxLength": 100, "type": "string", "title": "Line2", "nullable": true, "description": "Line2 used to generate and validate the invoice." }, "line3": { "maxLength": 100, "type": "string", "title": "Line3", "nullable": true, "description": "Line3 used to generate and validate the invoice." }, "city": { "maxLength": 60, "minLength": 1, "title": "City", "type": "string", "description": "City used to generate and validate the invoice." }, "postal_code": { "maxLength": 20, "minLength": 1, "title": "Postal Code", "type": "string", "description": "Postal Code used to generate and validate the invoice." }, "country_code": { "maxLength": 2, "minLength": 2, "title": "Country Code", "type": "string", "description": "Country Code used to generate and validate the invoice." }, "region": { "maxLength": 60, "type": "string", "title": "Region", "nullable": true, "description": "Region used to generate and validate the invoice." } }, "required": [ "line1", "city", "postal_code", "country_code" ], "title": "Address", "type": "object", "nullable": true, "description": "Address used to generate and validate the invoice." }, "delivery_location_id": { "additionalProperties": false, "properties": { "value": { "maxLength": 200, "minLength": 1, "title": "Value", "type": "string", "description": "Value used to generate and validate the invoice." }, "scheme_id": { "maxLength": 35, "minLength": 1, "type": "string", "title": "Scheme Id", "nullable": true, "description": "Scheme Id used to generate and validate the invoice." } }, "required": [ "value" ], "title": "Identifier", "type": "object", "nullable": true, "description": "Identifier used to generate and validate the invoice." }, "delivery_party_name": { "maxLength": 200, "minLength": 1, "type": "string", "title": "Delivery Party Name", "nullable": true, "description": "Delivery Party Name used to generate and validate the invoice." }, "lines": { "items": { "additionalProperties": false, "properties": { "id": { "maxLength": 100, "minLength": 1, "type": "string", "title": "Id", "nullable": true, "description": "Id used to generate and validate the invoice." }, "name": { "maxLength": 200, "minLength": 1, "type": "string", "title": "Name", "nullable": true, "description": "Name used to generate and validate the invoice." }, "description": { "maxLength": 1000, "minLength": 1, "title": "Description", "type": "string", "description": "Description used to generate and validate the invoice." }, "note": { "maxLength": 500, "minLength": 1, "type": "string", "title": "Note", "nullable": true, "description": "Note used to generate and validate the invoice." }, "quantity": { "pattern": "^-?(?:0|[1-9][0-9]*)(?:\\.[0-9]+)?$", "type": "string", "title": "Quantity", "description": "Quantity used to generate and validate the invoice." }, "unit_code": { "default": "C62", "maxLength": 3, "minLength": 2, "title": "Unit Code", "type": "string", "description": "Unit Code used to generate and validate the invoice." }, "unit_price": { "pattern": "^-?(?:0|[1-9][0-9]*)(?:\\.[0-9]+)?$", "type": "string", "title": "Unit Price", "description": "Unit Price used to generate and validate the invoice." }, "price_base_quantity": { "pattern": "^-?(?:0|[1-9][0-9]*)(?:\\.[0-9]+)?$", "type": "string", "default": "1", "title": "Price Base Quantity", "description": "Price Base Quantity used to generate and validate the invoice." }, "price_base_unit_code": { "maxLength": 3, "minLength": 2, "type": "string", "title": "Price Base Unit Code", "nullable": true, "description": "Price Base Unit Code used to generate and validate the invoice." }, "gross_unit_price": { "pattern": "^-?(?:0|[1-9][0-9]*)(?:\\.[0-9]+)?$", "type": "string", "title": "Gross Unit Price", "nullable": true, "description": "Gross Unit Price used to generate and validate the invoice." }, "gross_price_discount": { "pattern": "^-?(?:0|[1-9][0-9]*)(?:\\.[0-9]+)?$", "type": "string", "title": "Gross Price Discount", "nullable": true, "description": "Gross Price Discount used to generate and validate the invoice." }, "tax_rate": { "pattern": "^-?(?:0|[1-9][0-9]*)(?:\\.[0-9]+)?$", "type": "string", "title": "Tax Rate", "description": "Tax Rate used to generate and validate the invoice." }, "tax_category": { "default": "S", "maxLength": 3, "minLength": 1, "title": "Tax Category", "type": "string", "description": "Tax Category used to generate and validate the invoice." }, "tax_exemption_reason": { "maxLength": 500, "type": "string", "title": "Tax Exemption Reason", "nullable": true, "description": "Tax Exemption Reason used to generate and validate the invoice." }, "tax_exemption_reason_code": { "maxLength": 35, "type": "string", "title": "Tax Exemption Reason Code", "nullable": true, "description": "Tax Exemption Reason Code used to generate and validate the invoice." }, "allowances_charges": { "items": { "additionalProperties": false, "properties": { "is_charge": { "title": "Is Charge", "type": "boolean", "description": "Is Charge used to generate and validate the invoice." }, "amount": { "pattern": "^-?(?:0|[1-9][0-9]*)(?:\\.[0-9]+)?$", "type": "string", "title": "Amount", "description": "Amount used to generate and validate the invoice." }, "base_amount": { "pattern": "^-?(?:0|[1-9][0-9]*)(?:\\.[0-9]+)?$", "type": "string", "title": "Base Amount", "nullable": true, "description": "Base Amount used to generate and validate the invoice." }, "percentage": { "pattern": "^-?(?:0|[1-9][0-9]*)(?:\\.[0-9]+)?$", "type": "string", "title": "Percentage", "nullable": true, "description": "Percentage used to generate and validate the invoice." }, "reason": { "maxLength": 500, "minLength": 1, "title": "Reason", "type": "string", "description": "Reason used to generate and validate the invoice." }, "reason_code": { "maxLength": 35, "minLength": 1, "type": "string", "title": "Reason Code", "nullable": true, "description": "Reason Code used to generate and validate the invoice." }, "tax_category": { "maxLength": 3, "minLength": 1, "type": "string", "title": "Tax Category", "nullable": true, "description": "Tax Category used to generate and validate the invoice." }, "tax_rate": { "pattern": "^-?(?:0|[1-9][0-9]*)(?:\\.[0-9]+)?$", "type": "string", "title": "Tax Rate", "nullable": true, "description": "Tax Rate used to generate and validate the invoice." }, "tax_exemption_reason": { "maxLength": 500, "minLength": 1, "type": "string", "title": "Tax Exemption Reason", "nullable": true, "description": "Tax Exemption Reason used to generate and validate the invoice." }, "tax_exemption_reason_code": { "maxLength": 35, "minLength": 1, "type": "string", "title": "Tax Exemption Reason Code", "nullable": true, "description": "Tax Exemption Reason Code used to generate and validate the invoice." } }, "required": [ "is_charge", "amount", "reason" ], "type": "object" }, "maxItems": 100, "title": "Allowances Charges", "type": "array", "description": "Allowances Charges used to generate and validate the invoice." }, "period": { "additionalProperties": false, "properties": { "start_date": { "type": "string", "title": "Start Date", "nullable": true, "description": "Start Date used to generate and validate the invoice.", "editor": "datepicker", "dateType": "absolute" }, "end_date": { "type": "string", "title": "End Date", "nullable": true, "description": "End Date used to generate and validate the invoice.", "editor": "datepicker", "dateType": "absolute" }, "description_code": { "maxLength": 35, "minLength": 1, "type": "string", "title": "Description Code", "nullable": true, "description": "Description Code used to generate and validate the invoice." } }, "title": "Period", "type": "object", "nullable": true, "description": "Period used to generate and validate the invoice." }, "accounting_cost": { "maxLength": 200, "minLength": 1, "type": "string", "title": "Accounting Cost", "nullable": true, "description": "Accounting Cost used to generate and validate the invoice." }, "purchase_order_line_reference": { "maxLength": 100, "minLength": 1, "type": "string", "title": "Purchase Order Line Reference", "nullable": true, "description": "Purchase Order Line Reference used to generate and validate the invoice." }, "object_identifier": { "additionalProperties": false, "properties": { "value": { "maxLength": 200, "minLength": 1, "title": "Value", "type": "string", "description": "Value used to generate and validate the invoice." }, "scheme_id": { "maxLength": 35, "minLength": 1, "type": "string", "title": "Scheme Id", "nullable": true, "description": "Scheme Id used to generate and validate the invoice." } }, "required": [ "value" ], "title": "Identifier", "type": "object", "nullable": true, "description": "Identifier used to generate and validate the invoice." }, "seller_item_id": { "maxLength": 100, "minLength": 1, "type": "string", "title": "Seller Item Id", "nullable": true, "description": "Seller Item Id used to generate and validate the invoice." }, "buyer_item_id": { "maxLength": 100, "minLength": 1, "type": "string", "title": "Buyer Item Id", "nullable": true, "description": "Buyer Item Id used to generate and validate the invoice." }, "standard_item_id": { "additionalProperties": false, "properties": { "value": { "maxLength": 200, "minLength": 1, "title": "Value", "type": "string", "description": "Value used to generate and validate the invoice." }, "scheme_id": { "maxLength": 35, "minLength": 1, "type": "string", "title": "Scheme Id", "nullable": true, "description": "Scheme Id used to generate and validate the invoice." } }, "required": [ "value" ], "title": "Identifier", "type": "object", "nullable": true, "description": "Identifier used to generate and validate the invoice." }, "classifications": { "items": { "additionalProperties": false, "properties": { "value": { "maxLength": 200, "minLength": 1, "title": "Value", "type": "string", "description": "Value used to generate and validate the invoice." }, "scheme_id": { "maxLength": 35, "minLength": 1, "title": "Scheme Id", "type": "string", "description": "Scheme Id used to generate and validate the invoice." }, "scheme_version": { "maxLength": 35, "minLength": 1, "type": "string", "title": "Scheme Version", "nullable": true, "description": "Scheme Version used to generate and validate the invoice." } }, "required": [ "value", "scheme_id" ], "type": "object" }, "maxItems": 20, "title": "Classifications", "type": "array", "description": "Classifications used to generate and validate the invoice." }, "attributes": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 100, "minLength": 1, "title": "Name", "type": "string", "description": "Name used to generate and validate the invoice." }, "value": { "maxLength": 500, "minLength": 1, "title": "Value", "type": "string", "description": "Value used to generate and validate the invoice." } }, "required": [ "name", "value" ], "type": "object" }, "maxItems": 50, "title": "Attributes", "type": "array", "description": "Attributes used to generate and validate the invoice." }, "origin_country_code": { "maxLength": 2, "minLength": 2, "type": "string", "title": "Origin Country Code", "nullable": true, "description": "Origin Country Code used to generate and validate the invoice." } }, "required": [ "description", "quantity", "unit_price", "tax_rate" ], "type": "object" }, "maxItems": 1000, "minItems": 1, "title": "Lines", "type": "array", "description": "Lines used to generate and validate the invoice." }, "document_allowances_charges": { "items": { "additionalProperties": false, "properties": { "is_charge": { "title": "Is Charge", "type": "boolean", "description": "Is Charge used to generate and validate the invoice." }, "amount": { "pattern": "^-?(?:0|[1-9][0-9]*)(?:\\.[0-9]+)?$", "type": "string", "title": "Amount", "description": "Amount used to generate and validate the invoice." }, "base_amount": { "pattern": "^-?(?:0|[1-9][0-9]*)(?:\\.[0-9]+)?$", "type": "string", "title": "Base Amount", "nullable": true, "description": "Base Amount used to generate and validate the invoice." }, "percentage": { "pattern": "^-?(?:0|[1-9][0-9]*)(?:\\.[0-9]+)?$", "type": "string", "title": "Percentage", "nullable": true, "description": "Percentage used to generate and validate the invoice." }, "reason": { "maxLength": 500, "minLength": 1, "title": "Reason", "type": "string", "description": "Reason used to generate and validate the invoice." }, "reason_code": { "maxLength": 35, "minLength": 1, "type": "string", "title": "Reason Code", "nullable": true, "description": "Reason Code used to generate and validate the invoice." }, "tax_category": { "maxLength": 3, "minLength": 1, "type": "string", "title": "Tax Category", "nullable": true, "description": "Tax Category used to generate and validate the invoice." }, "tax_rate": { "pattern": "^-?(?:0|[1-9][0-9]*)(?:\\.[0-9]+)?$", "type": "string", "title": "Tax Rate", "nullable": true, "description": "Tax Rate used to generate and validate the invoice." }, "tax_exemption_reason": { "maxLength": 500, "minLength": 1, "type": "string", "title": "Tax Exemption Reason", "nullable": true, "description": "Tax Exemption Reason used to generate and validate the invoice." }, "tax_exemption_reason_code": { "maxLength": 35, "minLength": 1, "type": "string", "title": "Tax Exemption Reason Code", "nullable": true, "description": "Tax Exemption Reason Code used to generate and validate the invoice." } }, "required": [ "is_charge", "amount", "reason" ], "type": "object" }, "maxItems": 100, "title": "Document Allowances Charges", "type": "array", "description": "Document Allowances Charges used to generate and validate the invoice." }, "payment": { "additionalProperties": false, "properties": { "means_code": { "default": "30", "maxLength": 3, "minLength": 1, "title": "Means Code", "type": "string", "description": "Means Code used to generate and validate the invoice." }, "means_text": { "maxLength": 100, "minLength": 1, "type": "string", "title": "Means Text", "nullable": true, "description": "Means Text used to generate and validate the invoice." }, "reference": { "maxLength": 140, "type": "string", "title": "Reference", "nullable": true, "description": "Reference used to generate and validate the invoice." }, "account_id": { "maxLength": 70, "minLength": 1, "type": "string", "title": "Account Id", "nullable": true, "description": "Account Id used to generate and validate the invoice." }, "account_name": { "maxLength": 200, "minLength": 1, "type": "string", "title": "Account Name", "nullable": true, "description": "Account Name used to generate and validate the invoice." }, "iban": { "maxLength": 34, "minLength": 5, "type": "string", "title": "Iban", "nullable": true, "description": "Iban used to generate and validate the invoice." }, "bic": { "maxLength": 11, "minLength": 8, "type": "string", "title": "Bic", "nullable": true, "description": "Bic used to generate and validate the invoice." }, "bank_name": { "maxLength": 200, "minLength": 1, "type": "string", "title": "Bank Name", "nullable": true, "description": "Bank Name used to generate and validate the invoice." }, "mandate_reference": { "maxLength": 100, "minLength": 1, "type": "string", "title": "Mandate Reference", "nullable": true, "description": "Mandate Reference used to generate and validate the invoice." }, "creditor_identifier": { "maxLength": 100, "minLength": 1, "type": "string", "title": "Creditor Identifier", "nullable": true, "description": "Creditor Identifier used to generate and validate the invoice." }, "payer_account_id": { "maxLength": 70, "minLength": 1, "type": "string", "title": "Payer Account Id", "nullable": true, "description": "Payer Account Id used to generate and validate the invoice." }, "card_primary_account_number": { "maxLength": 6, "minLength": 4, "type": "string", "title": "Card Primary Account Number", "nullable": true, "description": "Card Primary Account Number used to generate and validate the invoice." }, "card_holder_name": { "maxLength": 100, "minLength": 1, "type": "string", "title": "Card Holder Name", "nullable": true, "description": "Card Holder Name used to generate and validate the invoice." } }, "title": "Payment", "type": "object", "description": "Payment used to generate and validate the invoice." }, "payment_terms": { "maxLength": 1000, "minLength": 1, "type": "string", "title": "Payment Terms", "nullable": true, "description": "Payment Terms used to generate and validate the invoice." }, "prepaid_amount": { "pattern": "^-?(?:0|[1-9][0-9]*)(?:\\.[0-9]+)?$", "type": "string", "default": "0", "title": "Prepaid Amount", "description": "Prepaid Amount used to generate and validate the invoice." }, "rounding_amount": { "pattern": "^-?(?:0|[1-9][0-9]*)(?:\\.[0-9]+)?$", "type": "string", "default": "0", "title": "Rounding Amount", "description": "Rounding Amount used to generate and validate the invoice." }, "notes": { "items": { "type": "string" }, "maxItems": 20, "title": "Notes", "type": "array", "description": "Notes used to generate and validate the invoice." }, "preceding_invoices": { "items": { "additionalProperties": false, "properties": { "id": { "maxLength": 200, "minLength": 1, "title": "Id", "type": "string", "description": "Id used to generate and validate the invoice." }, "issue_date": { "type": "string", "title": "Issue Date", "nullable": true, "description": "Issue Date used to generate and validate the invoice.", "editor": "datepicker", "dateType": "absolute" }, "type_code": { "maxLength": 35, "minLength": 1, "type": "string", "title": "Type Code", "nullable": true, "description": "Type Code used to generate and validate the invoice." }, "description": { "maxLength": 500, "minLength": 1, "type": "string", "title": "Description", "nullable": true, "description": "Description used to generate and validate the invoice." }, "id_scheme": { "maxLength": 35, "minLength": 1, "type": "string", "title": "Id Scheme", "nullable": true, "description": "Id Scheme used to generate and validate the invoice." }, "attachment": { "additionalProperties": false, "properties": { "filename": { "maxLength": 200, "minLength": 1, "type": "string", "title": "Filename", "nullable": true, "description": "Filename used to generate and validate the invoice." }, "mime_type": { "maxLength": 100, "minLength": 3, "type": "string", "title": "Mime Type", "nullable": true, "description": "Mime Type used to generate and validate the invoice." }, "description": { "maxLength": 500, "minLength": 1, "type": "string", "title": "Description", "nullable": true, "description": "Description used to generate and validate the invoice." }, "content_base64": { "type": "string", "title": "Content Base64", "nullable": true, "description": "Content Base64 used to generate and validate the invoice." }, "external_uri": { "maxLength": 2000, "minLength": 1, "type": "string", "title": "External Uri", "nullable": true, "description": "External Uri used to generate and validate the invoice." } }, "title": "Attachment", "type": "object", "nullable": true, "description": "Attachment used to generate and validate the invoice." } }, "required": [ "id" ], "type": "object" }, "maxItems": 100, "title": "Preceding Invoices", "type": "array", "description": "Preceding Invoices used to generate and validate the invoice." }, "supporting_documents": { "items": { "additionalProperties": false, "properties": { "id": { "maxLength": 200, "minLength": 1, "title": "Id", "type": "string", "description": "Id used to generate and validate the invoice." }, "issue_date": { "type": "string", "title": "Issue Date", "nullable": true, "description": "Issue Date used to generate and validate the invoice.", "editor": "datepicker", "dateType": "absolute" }, "type_code": { "maxLength": 35, "minLength": 1, "type": "string", "title": "Type Code", "nullable": true, "description": "Type Code used to generate and validate the invoice." }, "description": { "maxLength": 500, "minLength": 1, "type": "string", "title": "Description", "nullable": true, "description": "Description used to generate and validate the invoice." }, "id_scheme": { "maxLength": 35, "minLength": 1, "type": "string", "title": "Id Scheme", "nullable": true, "description": "Id Scheme used to generate and validate the invoice." }, "attachment": { "additionalProperties": false, "properties": { "filename": { "maxLength": 200, "minLength": 1, "type": "string", "title": "Filename", "nullable": true, "description": "Filename used to generate and validate the invoice." }, "mime_type": { "maxLength": 100, "minLength": 3, "type": "string", "title": "Mime Type", "nullable": true, "description": "Mime Type used to generate and validate the invoice." }, "description": { "maxLength": 500, "minLength": 1, "type": "string", "title": "Description", "nullable": true, "description": "Description used to generate and validate the invoice." }, "content_base64": { "type": "string", "title": "Content Base64", "nullable": true, "description": "Content Base64 used to generate and validate the invoice." }, "external_uri": { "maxLength": 2000, "minLength": 1, "type": "string", "title": "External Uri", "nullable": true, "description": "External Uri used to generate and validate the invoice." } }, "title": "Attachment", "type": "object", "nullable": true, "description": "Attachment used to generate and validate the invoice." } }, "required": [ "id" ], "type": "object" }, "maxItems": 100, "title": "Supporting Documents", "type": "array", "description": "Supporting Documents used to generate and validate the invoice." }, "extensions": { "type": "object", "additionalProperties": false, "properties": { "peppol": { "type": "object", "additionalProperties": false, "properties": { "business_process_id": { "type": "string", "minLength": 1, "maxLength": 200, "title": "Business process id", "description": "Business process id used to generate and validate the invoice." } }, "title": "Peppol", "description": "Peppol used to generate and validate the invoice." } }, "required": [ "peppol" ], "description": "Product-specific options. Unknown fields are rejected.", "title": "Extensions" } }, "required": [ "invoice_number", "issue_date", "seller", "buyer", "lines" ], "type": "object" } } } }, "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 } } } } } } } } } }