{ "openapi": "3.0.0", "info": { "title": "A-Cube PL API", "description": "A-Cube PL API set to manage electronic invoices with KSeF", "version": "3.0.0", "x-logo": { "url": "https://assets.acubeapi.com/logo_rect_white.png" } }, "servers": [ { "url": "https://pl-sandbox.api.acubeapi.com", "description": "Sandbox environment - using KSeF Demo or Test environment" }, { "url": "https://pl.api.acubeapi.com", "description": "Production environment - using KSeF Production environment" } ], "paths": { "/authorization-flows": { "get": { "operationId": "getAuthorizationFlowCollection", "tags": [ "AuthorizationFlow" ], "responses": { "200": { "description": "AuthorizationFlow collection", "content": { "application/ld+json": { "schema": { "type": "object", "properties": { "hydra:member": { "type": "array", "items": { "$ref": "#/components/schemas/AuthorizationFlow.AuthorizationFlowOutput.jsonld" } }, "hydra:totalItems": { "type": "integer", "minimum": 0 }, "hydra:view": { "type": "object", "properties": { "@id": { "type": "string", "format": "iri-reference" }, "@type": { "type": "string" }, "hydra:first": { "type": "string", "format": "iri-reference" }, "hydra:last": { "type": "string", "format": "iri-reference" }, "hydra:previous": { "type": "string", "format": "iri-reference" }, "hydra:next": { "type": "string", "format": "iri-reference" } }, "example": { "@id": "string", "type": "string", "hydra:first": "string", "hydra:last": "string", "hydra:previous": "string", "hydra:next": "string" } }, "hydra:search": { "type": "object", "properties": { "@type": { "type": "string" }, "hydra:template": { "type": "string" }, "hydra:variableRepresentation": { "type": "string" }, "hydra:mapping": { "type": "array", "items": { "type": "object", "properties": { "@type": { "type": "string" }, "variable": { "type": "string" }, "property": { "type": "string", "nullable": true }, "required": { "type": "boolean" } } } } } } }, "required": [ "hydra:member" ] } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AuthorizationFlow.AuthorizationFlowOutput" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AuthorizationFlow.AuthorizationFlowOutput" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Resource not Found" } }, "summary": "Retrieve the collection of AuthorizationFlow resources.", "description": "Retrieve the collection of AuthorizationFlow resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/authorization-flows/{uuid}": { "get": { "operationId": "getAuthorizationFlowItem", "tags": [ "AuthorizationFlow" ], "responses": { "200": { "description": "AuthorizationFlow resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/AuthorizationFlow.AuthorizationFlowOutput.jsonld" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AuthorizationFlow.AuthorizationFlowOutput" } }, "text/html": { "schema": { "$ref": "#/components/schemas/AuthorizationFlow.AuthorizationFlowOutput" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieve a AuthorizationFlow resource.", "description": "Retrieve a AuthorizationFlow resource.", "parameters": [ { "name": "uuid", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/authorization-flows/{uuid}/onboard/signature-file/{hash}": { "get": { "operationId": "onboard-fileAuthorizationFlowItem", "tags": [ "AuthorizationFlow" ], "responses": { "204": { "description": "AuthorizationFlow resource", "content": { "application/json": { "schema": {} }, "application/xml": { "schema": {} } } }, "404": { "description": "Resource not found" } }, "summary": "Download XML file for signature procedure.", "description": "Download XML file for signature procedure.", "parameters": [ { "name": "uuid", "in": "path", "description": "Authorization Flow UUID", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "hash", "in": "path", "description": "Special Hash", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/invoice-extract": { "get": { "operationId": "getInvoiceExtractCollection", "tags": [ "InvoiceExtract" ], "responses": { "200": { "description": "OK" } }, "summary": "Retrieves the collection of InvoiceExtract resources.", "description": "Retrieves the collection of InvoiceExtract resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "post": { "operationId": "postInvoiceExtractCollection", "tags": [ "InvoiceExtract" ], "responses": { "201": { "description": "InvoiceExtract resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceExtract.InvoiceExtractOutput" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/InvoiceExtract.InvoiceExtractOutput.jsonld" } } }, "links": { "GetInvoiceExtractItem": { "operationId": "getInvoiceExtractItem", "parameters": { "uuid": "$response.body#/uuid" }, "description": "The `uuid` value returned in the response can be used as the `uuid` parameter in `GET /invoice-extract/{uuid}`." } } }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" }, "200": { "description": "OK" } }, "summary": "Extract information from a PDF invoice", "description": "Upload a PDF invoice and get back the invoice converted to XML.\n\nThe received XML may not contain all the necessary information and the filled data must be validated before sending to the tax authority.", "parameters": [], "requestBody": { "description": "", "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary", "description": "The PDF invoice to upload" }, "conversion_configuration": { "type": "string", "description": "Conversion configuration as JSON string", "example": "{\"default_vat_rate\": \"23\"}" } }, "required": [ "file" ] } } }, "required": true }, "deprecated": false }, "parameters": [] }, "/invoice-extract/{uuid}": { "get": { "operationId": "getInvoiceExtractItem", "tags": [ "InvoiceExtract" ], "responses": { "200": { "description": "InvoiceExtract resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceExtract" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a InvoiceExtract resource.", "description": "Retrieves a InvoiceExtract resource.", "parameters": [ { "name": "uuid", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/invoice-extract/{uuid}/raw": { "get": { "operationId": "rawInvoiceExtractItem", "tags": [ "InvoiceExtract" ], "responses": { "200": { "description": "Job done" }, "404": { "description": "Resource not found" }, "102": { "description": "Not ready yet" }, "500": { "description": "Elaboration error" } }, "summary": "Get the raw extracted information", "description": "Retrieve the information extracted from the PDF in a raw JSON format", "parameters": [ { "name": "uuid", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/invoice-extract/{uuid}/result": { "get": { "operationId": "resultInvoiceExtractItem", "tags": [ "InvoiceExtract" ], "responses": { "200": { "description": "Job done" }, "404": { "description": "Resource not found" }, "102": { "description": "Not ready yet" }, "500": { "description": "Elaboration error" } }, "summary": "Get the converted invoice", "description": "Retrieve the converted invoice. If still elaborating you will receive status code 102, otherwise 200 and the XML or JSON Invoice as the response content.", "parameters": [ { "name": "uuid", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/invoice-transfers": { "get": { "operationId": "getInvoiceTransferCollection", "tags": [ "InvoiceTransfer" ], "responses": { "200": { "description": "InvoiceTransfer collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceTransfer.InvoiceTransferOutput" } } }, "application/ld+json": { "schema": { "type": "object", "properties": { "hydra:member": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceTransfer.InvoiceTransferOutput.jsonld" } }, "hydra:totalItems": { "type": "integer", "minimum": 0 }, "hydra:view": { "type": "object", "properties": { "@id": { "type": "string", "format": "iri-reference" }, "@type": { "type": "string" }, "hydra:first": { "type": "string", "format": "iri-reference" }, "hydra:last": { "type": "string", "format": "iri-reference" }, "hydra:previous": { "type": "string", "format": "iri-reference" }, "hydra:next": { "type": "string", "format": "iri-reference" } }, "example": { "@id": "string", "type": "string", "hydra:first": "string", "hydra:last": "string", "hydra:previous": "string", "hydra:next": "string" } }, "hydra:search": { "type": "object", "properties": { "@type": { "type": "string" }, "hydra:template": { "type": "string" }, "hydra:variableRepresentation": { "type": "string" }, "hydra:mapping": { "type": "array", "items": { "type": "object", "properties": { "@type": { "type": "string" }, "variable": { "type": "string" }, "property": { "type": "string", "nullable": true }, "required": { "type": "boolean" } } } } } } }, "required": [ "hydra:member" ] } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceTransfer.InvoiceTransferOutput" } } } } } }, "summary": "Get a collection of invoice transfer resources.", "description": "Retrieves the collection of invoice transfer resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "createdAt[before]", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "createdAt[strictly_before]", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "createdAt[after]", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "createdAt[strictly_after]", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "exists[violations]", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "boolean" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "originalFileName", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "invoiceNumber", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "order[createdAt]", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "style": "form", "explode": false, "allowReserved": false }, { "name": "order[invoiceDate]", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "style": "form", "explode": false, "allowReserved": false }, { "name": "order[invoiceNumber]", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/invoice-transfers/{uuid}": { "get": { "operationId": "getInvoiceTransferItem", "tags": [ "InvoiceTransfer" ], "responses": { "200": { "description": "InvoiceTransfer resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceTransfer.InvoiceTransferOutput" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/InvoiceTransfer.InvoiceTransferOutput.jsonld" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/InvoiceTransfer.InvoiceTransferOutput" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a invoice transfer resource.", "description": "Retrieves a InvoiceTransfer resource.", "parameters": [ { "name": "uuid", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/invoice-transfers/{uuid}/download": { "get": { "operationId": "download-resultInvoiceTransferItem", "tags": [ "InvoiceTransfer" ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not found" } }, "summary": "Download invoice transfer result file", "description": "Download the source invoice transfer result file", "parameters": [ { "name": "uuid", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/invoices": { "get": { "operationId": "getInvoiceCollection", "tags": [ "Invoice" ], "responses": { "200": { "description": "Invoice collection", "content": { "application/ld+json": { "schema": { "type": "object", "properties": { "hydra:member": { "type": "array", "items": { "$ref": "#/components/schemas/Invoice.InvoiceOutput.jsonld" } }, "hydra:totalItems": { "type": "integer", "minimum": 0 }, "hydra:view": { "type": "object", "properties": { "@id": { "type": "string", "format": "iri-reference" }, "@type": { "type": "string" }, "hydra:first": { "type": "string", "format": "iri-reference" }, "hydra:last": { "type": "string", "format": "iri-reference" }, "hydra:previous": { "type": "string", "format": "iri-reference" }, "hydra:next": { "type": "string", "format": "iri-reference" } }, "example": { "@id": "string", "type": "string", "hydra:first": "string", "hydra:last": "string", "hydra:previous": "string", "hydra:next": "string" } }, "hydra:search": { "type": "object", "properties": { "@type": { "type": "string" }, "hydra:template": { "type": "string" }, "hydra:variableRepresentation": { "type": "string" }, "hydra:mapping": { "type": "array", "items": { "type": "object", "properties": { "@type": { "type": "string" }, "variable": { "type": "string" }, "property": { "type": "string", "nullable": true }, "required": { "type": "boolean" } } } } } } }, "required": [ "hydra:member" ] } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Invoice.InvoiceOutput" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Invoice.InvoiceOutput" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Resource not Found" } }, "summary": "Retrieve the collection of Invoice resources.", "description": "Retrieve the collection of Invoice resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "createdAt[before]", "in": "query", "description": "Search by equal or greater value of \"createdAt\" property.", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "createdAt[after]", "in": "query", "description": "Search by equal or less value of \"createdAt\" property.", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "invoiceDate[before]", "in": "query", "description": "Search by equal or greater value of \"invoiceDate\" property.", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "invoiceDate[after]", "in": "query", "description": "Search by equal or less value of \"invoiceDate\" property.", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "invoiceDate", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "invoiceDate[]", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "invoiceCreatorNip", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "invoiceCreatorNip[]", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": true, "allowReserved": false }, { "name": "invoiceRecipientNip", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "invoiceRecipientNip[]", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": true, "allowReserved": false }, { "name": "invoiceType", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "invoiceType[]", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": true, "allowReserved": false }, { "name": "invoiceNumber", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "invoiceNumber[]", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": true, "allowReserved": false }, { "name": "status", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "status[]", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": true, "allowReserved": false }, { "name": "downloaded", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "boolean" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "downloaded[]", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "array", "items": { "type": "boolean" } }, "style": "form", "explode": true, "allowReserved": false }, { "name": "direction", "in": "query", "description": "Search by direction property.", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "string", "enum": [ "outgoing", "incoming" ] }, "style": "form", "explode": false, "allowReserved": false }, { "name": "invoiceStatus", "in": "query", "description": "Search by invoice status property.", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "string", "enum": [ "draft", "blocked", "approved", "rejected", "in_queue", "processing", "valid", "invalid" ] }, "style": "form", "explode": false, "allowReserved": false }, { "name": "order[createdAt]", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "style": "form", "explode": false, "allowReserved": false }, { "name": "order[invoiceDate]", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "style": "form", "explode": false, "allowReserved": false }, { "name": "order[invoiceCreatorNip]", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "style": "form", "explode": false, "allowReserved": false }, { "name": "order[invoiceRecipientNip]", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "style": "form", "explode": false, "allowReserved": false }, { "name": "order[invoiceType]", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "style": "form", "explode": false, "allowReserved": false }, { "name": "order[invoiceNumber]", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "style": "form", "explode": false, "allowReserved": false }, { "name": "order[status]", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/invoices/downloaded": { "post": { "operationId": "downloadedInvoiceCollection", "tags": [ "Invoice" ], "responses": { "200": { "description": "Invoice resource created", "content": { "application/json": { "schema": {} } }, "links": { "GetInvoiceItem": { "operationId": "getInvoiceItem", "parameters": { "uuid": "$response.body#/uuid" }, "description": "The `uuid` value returned in the response can be used as the `uuid` parameter in `GET /invoices/{uuid}`." } } }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" } }, "summary": "Setup the downloaded flag for a collection of invoices.", "description": "Setup the downloaded flag for a collection of invoices.", "parameters": [], "requestBody": { "description": "Setup the downloaded flag for a collection of invoices", "content": { "application/json": { "schema": { "type": "object", "properties": { "uuids": { "type": "array", "description": "Invoice UUIDs", "items": { "type": "string" } }, "downloaded": { "type": "boolean", "description": "Downloaded status" } }, "required": [ "uuids", "downloaded" ] } } }, "required": true }, "deprecated": false }, "parameters": [] }, "/invoices/v3": { "post": { "operationId": "post_v3InvoiceCollection", "tags": [ "Invoice" ], "responses": { "201": { "description": "Invoice resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invoice.InvoiceOutput" } } }, "links": { "GetInvoiceItem": { "operationId": "getInvoiceItem", "parameters": { "uuid": "$response.body#/uuid" }, "description": "The `uuid` value returned in the response can be used as the `uuid` parameter in `GET /invoices/{uuid}`." } } }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" } }, "summary": "Send Invoice (Fa3).", "description": "This endpoint allows you to send an invoice v3 (json or XML format based on the Content-Type header) to the KSeF.", "parameters": [ { "name": "skipValidateNip", "in": "query", "description": "Skip validation of NIP (default: false)", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "boolean" }, "style": "form", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new KSeF Invoice resource", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/KsefInvoiceV3.Faktura" } }, "application/xml": { "example": "\n\n \n FA\n 3\n 2025-11-14T13:54:35.3250835+02:00\n Aplikacja Podatnika KSeF\n \n \n \n ENTER-NIP-HERE\n test\n \n \n PL\n test sender\n \n \n \n \n ENTER-NIP-HERE\n \n \n PL\n test recipient\n \n 2\n 2\n \n \n PLN\n 2025-11-14\n FA/001/11/2025\n 2025-11-14\n 1000\n 230\n 1230\n \n 2\n 2\n 2\n 2\n \n 1\n \n \n 1\n \n 2\n \n 1\n \n \n VAT\n \n 1\n test\n 1\n 1000\n 1000\n 23\n \n \n", "schema": { "type": "object", "$ref": "#/components/schemas/KsefInvoiceV3.Faktura" } } }, "required": true }, "deprecated": false }, "parameters": [] }, "/invoices/v3/attachments": { "post": { "operationId": "post_v3_attachmentsInvoiceAttachmentsCollection", "tags": [ "InvoiceAttachments" ], "responses": { "201": { "description": "InvoiceAttachments resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceAttachments.InvoiceAttachmentOutput" } } }, "links": { "GetInvoiceAttachmentsItem": { "operationId": "getInvoiceAttachmentsItem", "parameters": { "uuid": "$response.body#/uuid" }, "description": "The `uuid` value returned in the response can be used as the `uuid` parameter in `GET /invoices/{invoice}/attachments/{uuid}`." } } }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" } }, "summary": "Send Invoice (Fa3).", "description": "This endpoint allows you to send an invoice Fa3 (json or xml format based on the Content-Type header) to the KSeF.", "parameters": [], "requestBody": { "description": "The new InvoiceAttachments resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceAttachments.Root" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/InvoiceAttachments.Root" } } }, "required": true }, "deprecated": false }, "parameters": [] }, "/invoices/v3/convert": { "post": { "operationId": "convert_v3InvoiceCollection", "tags": [ "Invoice" ], "responses": { "201": { "description": "Invoice resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invoice.InvoiceOutput" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Invoice.InvoiceOutput" } } }, "links": { "GetInvoiceItem": { "operationId": "getInvoiceItem", "parameters": { "uuid": "$response.body#/uuid" }, "description": "The `uuid` value returned in the response can be used as the `uuid` parameter in `GET /invoices/{uuid}`." } } }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" } }, "summary": "Convert Invoice format (Fa3).", "description": "GET XML or JSON version of an invoice document.\n\nHTTP Header `Content-Type` must be set to `application/json` or `application/xml` accordingly with the invoice source sent to the API.", "parameters": [], "requestBody": { "description": "The new Invoice resource", "content": { "application/json": { "schema": {} }, "application/xml": { "schema": {} } }, "required": true }, "deprecated": false }, "parameters": [] }, "/invoices/v3/validate": { "post": { "operationId": "validate_3InvoiceCollection", "tags": [ "Invoice" ], "responses": { "200": { "description": "Validation response", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/Invoice.InvoiceValidatorOutput" } } } }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" } }, "summary": "Validate invoice (Fa3).", "description": "This endpoint allows to validate the invoice Fa3.", "parameters": [ { "name": "skipValidateNip", "in": "query", "description": "Skip validation of NIP (default: false)", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "boolean" }, "style": "form", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The KSeF Invoice resource", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/KsefInvoiceV3.Faktura" } }, "application/xml": { "schema": { "type": "object", "$ref": "#/components/schemas/KsefInvoiceV3.Faktura" } } }, "required": false }, "deprecated": false }, "parameters": [] }, "/invoices/{invoice}/attachments": { "get": { "operationId": "getInvoiceAttachmentsCollection", "tags": [ "InvoiceAttachments" ], "responses": { "200": { "description": "InvoiceAttachments collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceAttachments.InvoiceAttachmentOutput" } } }, "application/ld+json": { "schema": { "type": "object", "properties": { "hydra:member": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceAttachments.InvoiceAttachmentOutput.jsonld" } }, "hydra:totalItems": { "type": "integer", "minimum": 0 }, "hydra:view": { "type": "object", "properties": { "@id": { "type": "string", "format": "iri-reference" }, "@type": { "type": "string" }, "hydra:first": { "type": "string", "format": "iri-reference" }, "hydra:last": { "type": "string", "format": "iri-reference" }, "hydra:previous": { "type": "string", "format": "iri-reference" }, "hydra:next": { "type": "string", "format": "iri-reference" } }, "example": { "@id": "string", "type": "string", "hydra:first": "string", "hydra:last": "string", "hydra:previous": "string", "hydra:next": "string" } }, "hydra:search": { "type": "object", "properties": { "@type": { "type": "string" }, "hydra:template": { "type": "string" }, "hydra:variableRepresentation": { "type": "string" }, "hydra:mapping": { "type": "array", "items": { "type": "object", "properties": { "@type": { "type": "string" }, "variable": { "type": "string" }, "property": { "type": "string", "nullable": true }, "required": { "type": "boolean" } } } } } } }, "required": [ "hydra:member" ] } }, "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceAttachments.InvoiceAttachmentOutput" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Resource not Found" } }, "summary": "Retrieve the collection of InvoiceAttachments resources.", "description": "Retrieve the collection of InvoiceAttachments resources.", "parameters": [ { "name": "invoice", "in": "path", "description": "Invoice uuid", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/invoices/{invoice}/attachments/download/{uuid}/{access_code}": { "get": { "operationId": "get_with_codeInvoiceAttachmentsItem", "tags": [ "InvoiceAttachments" ], "responses": { "200": { "description": "InvoiceAttachments resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceAttachments.InvoiceAttachmentOutput" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/InvoiceAttachments.InvoiceAttachmentOutput" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/InvoiceAttachments.InvoiceAttachmentOutput" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/InvoiceAttachments.InvoiceAttachmentOutput" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieve a InvoiceAttachments resource by access code.", "description": "Retrieve a InvoiceAttachments resource by access code.", "parameters": [ { "name": "invoice", "in": "path", "description": "Invoice uuid", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "uuid", "in": "path", "description": "Invoice attachment uuid", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "access_code", "in": "path", "description": "Access code", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/invoices/{invoice}/attachments/{uuid}": { "get": { "operationId": "getInvoiceAttachmentsItem", "tags": [ "InvoiceAttachments" ], "responses": { "200": { "description": "InvoiceAttachments resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceAttachments.InvoiceAttachmentOutput" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/InvoiceAttachments.InvoiceAttachmentOutput.jsonld" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/InvoiceAttachments.InvoiceAttachmentOutput" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/InvoiceAttachments.InvoiceAttachmentOutput" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/InvoiceAttachments.InvoiceAttachmentOutput" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieve a InvoiceAttachments resource.", "description": "Retrieve a InvoiceAttachments resource.", "parameters": [ { "name": "invoice", "in": "path", "description": "Invoice uuid", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "uuid", "in": "path", "description": "Invoice attachment uuid", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/invoices/{uuid}": { "get": { "operationId": "getInvoiceItem", "tags": [ "Invoice" ], "responses": { "200": { "description": "Invoice resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invoice.InvoiceOutput" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Invoice.InvoiceOutput" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Invoice.InvoiceOutput" } }, "application/pdf": { "schema": { "$ref": "#/components/schemas/Invoice.InvoiceOutput" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieve a Invoice resource.", "description": "You can get an invoice in many different formats just specifying a different Accept header:\n\n- **application/json**, default, you get some metadata information together with the json payload that represent the invoice\n\n- **application/xml**, you get the XML format\n\n- **application/pdf**, you get invoice as a PDF file with representation format used by KSeF", "parameters": [ { "name": "rawContent", "in": "query", "description": "Return raw content of the invoice file as a response content.", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "boolean", "default": false }, "style": "form", "explode": false, "allowReserved": false }, { "name": "uuid", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "post": { "operationId": "discardInvoiceItem", "tags": [ "Invoice" ], "responses": { "201": { "description": "Invoice resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invoice.InvoiceOutput" } } }, "links": { "GetInvoiceItem": { "operationId": "getInvoiceItem", "parameters": { "uuid": "$response.body#/uuid" }, "description": "The `uuid` value returned in the response can be used as the `uuid` parameter in `GET /invoices/{uuid}`." } } }, "400": { "description": "Can't discard" }, "422": { "description": "Unprocessable entity" }, "404": { "description": "Not found" }, "200": { "description": "OK" } }, "summary": "Discard the Invoice draft resource.", "description": "Discard the Invoice draft resource.", "parameters": [ { "name": "uuid", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new Invoice resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invoice" } } }, "required": true }, "deprecated": false }, "delete": { "operationId": "deleteInvoiceItem", "tags": [ "Invoice" ], "responses": { "204": { "description": "Invoice resource deleted" }, "404": { "description": "Resource not found" }, "200": { "description": "OK" }, "400": { "description": "Can't delete" } }, "summary": "Remove the Invoice resource.", "description": "Remove the Invoice resource.", "parameters": [ { "name": "uuid", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/invoices/{uuid}/activate-access-code": { "post": { "operationId": "activate_access_codeInvoiceItem", "tags": [ "Invoice" ], "responses": { "201": { "description": "Invoice resource created", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Invoice.InvoiceOutput.jsonld" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Invoice.InvoiceOutput" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Invoice.InvoiceOutput" } } }, "links": { "GetInvoiceItem": { "operationId": "getInvoiceItem", "parameters": { "uuid": "$response.body#/uuid" }, "description": "The `uuid` value returned in the response can be used as the `uuid` parameter in `GET /invoices/{uuid}`." } } }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" }, "404": { "description": "Resource not found" } }, "summary": "Activate access code.", "description": "Activate access code.", "parameters": [ { "name": "uuid", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new Invoice resource", "content": { "application/ld+json": { "schema": {} }, "application/json": { "schema": {} }, "text/html": { "schema": {} } }, "required": true }, "deprecated": false }, "parameters": [] }, "/invoices/{uuid}/code/{access_code}": { "get": { "operationId": "get_with_codeInvoiceItem", "tags": [ "Invoice" ], "responses": { "200": { "description": "Invoice resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invoice.InvoiceOutput" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Invoice.InvoiceOutput" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Invoice.InvoiceOutput" } }, "application/pdf": { "schema": { "$ref": "#/components/schemas/Invoice.InvoiceOutput" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieve a Invoice resource with access code.", "description": "Retrieve a Invoice resource with access code.", "parameters": [ { "name": "access_code", "in": "path", "description": "Access code", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "uuid", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/invoices/{uuid}/code/{access_code}/upo": { "get": { "operationId": "upo_with_codeInvoiceItem", "tags": [ "Invoice" ], "responses": { "200": { "description": "Invoice resource", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/Invoice.InvoiceOutput" } } } }, "404": { "description": "Resource not found" } }, "summary": "Get invoice upo with code", "description": "Get invoice upo with code", "parameters": [ { "name": "access_code", "in": "path", "description": "Access code", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "uuid", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/invoices/{uuid}/send-access-code": { "post": { "operationId": "send_access_codeInvoiceItem", "tags": [ "Invoice" ], "responses": { "200": { "description": "Invoice OTC Code request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/Invoice.InvoiceOtcOutput" } } } }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" }, "404": { "description": "Resource not found" } }, "summary": "Send access code to recipient email.", "description": "Send access code to recipient email.", "parameters": [ { "name": "uuid", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new Invoice resource", "content": { "application/ld+json": { "schema": {} }, "application/json": { "schema": {} }, "text/html": { "schema": {} } }, "required": true }, "deprecated": false }, "parameters": [] }, "/invoices/{uuid}/status": { "get": { "operationId": "statusInvoiceItem", "tags": [ "Invoice" ], "responses": { "200": { "description": "Invoice resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invoice.InvoiceOutput" } } } }, "404": { "description": "Resource not found" } }, "summary": "Get invoice status.", "description": "Get invoice status.", "parameters": [ { "name": "uuid", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/invoices/{uuid}/upo": { "get": { "operationId": "upoInvoiceItem", "tags": [ "Invoice" ], "responses": { "200": { "description": "Invoice resource", "content": { "application/xml": { "schema": {} } } }, "404": { "description": "Resource not found" } }, "summary": "Get invoice upo", "description": "Get invoice upo", "parameters": [ { "name": "uuid", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/legal-entities": { "get": { "operationId": "getLegalEntityCollection", "tags": [ "LegalEntity" ], "responses": { "200": { "description": "LegalEntity collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LegalEntity.LegalEntityOutput" } } }, "application/ld+json": { "schema": { "type": "object", "properties": { "hydra:member": { "type": "array", "items": { "$ref": "#/components/schemas/LegalEntity.LegalEntityOutput.jsonld" } }, "hydra:totalItems": { "type": "integer", "minimum": 0 }, "hydra:view": { "type": "object", "properties": { "@id": { "type": "string", "format": "iri-reference" }, "@type": { "type": "string" }, "hydra:first": { "type": "string", "format": "iri-reference" }, "hydra:last": { "type": "string", "format": "iri-reference" }, "hydra:previous": { "type": "string", "format": "iri-reference" }, "hydra:next": { "type": "string", "format": "iri-reference" } }, "example": { "@id": "string", "type": "string", "hydra:first": "string", "hydra:last": "string", "hydra:previous": "string", "hydra:next": "string" } }, "hydra:search": { "type": "object", "properties": { "@type": { "type": "string" }, "hydra:template": { "type": "string" }, "hydra:variableRepresentation": { "type": "string" }, "hydra:mapping": { "type": "array", "items": { "type": "object", "properties": { "@type": { "type": "string" }, "variable": { "type": "string" }, "property": { "type": "string", "nullable": true }, "required": { "type": "boolean" } } } } } } }, "required": [ "hydra:member" ] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Resource not Found" } }, "summary": "Retrieve the collection of LegalEntity resources.", "description": "Retrieve the collection of LegalEntity resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "post": { "operationId": "postLegalEntityCollection", "tags": [ "LegalEntity" ], "responses": { "201": { "description": "LegalEntity resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntityOutput" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntityOutput.jsonld" } } }, "links": { "GetLegalEntityItem": { "operationId": "getLegalEntityItem", "parameters": { "uuid": "$response.body#/uuid" }, "description": "The `uuid` value returned in the response can be used as the `uuid` parameter in `GET /legal-entities/{uuid}`." } } }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" } }, "summary": "Create a LegalEntity resource.", "description": "Create a LegalEntity resource.", "parameters": [], "requestBody": { "description": "The new LegalEntity resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntityInput" } } }, "required": true }, "deprecated": false }, "parameters": [] }, "/legal-entities/setup-for-testing": { "post": { "operationId": "test_legal_entity_setupLegalEntityCollection", "tags": [ "LegalEntity" ], "responses": { "204": { "description": "LegalEntity resource created", "content": { "application/json": { "schema": {} }, "application/ld+json": { "schema": {} } }, "links": { "GetLegalEntityItem": { "operationId": "getLegalEntityItem", "parameters": { "uuid": "$response.body#/uuid" }, "description": "The `uuid` value returned in the response can be used as the `uuid` parameter in `GET /legal-entities/{uuid}`." } } }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" }, "201": { "description": "Test legal entity with KSeF connection created.", "content": { "application/json": { "schema": { "type": "object", "properties": { "jpgNip": { "type": "string" }, "jpgPesel": { "type": "string" }, "enforcementNip": { "type": "string" } } } } } }, "403": { "description": "Current user is not allowed to setup legal entity." }, "404": { "description": "Cannot use this endpoint in selected environment." } }, "summary": "Create a new legal entity connected to the KSeF test environment (not available for production API)", "description": "This endpoint provisions a new legal entity within the KSeF TEST environment.\nIt is intended exclusively for testing and integration‑validation scenarios and has no equivalent in the production & pre-production API.\n\nThe operation may require several seconds to complete due to multiple background interactions with the KSeF TEST infrastructure.\n\nUpon successful execution, the endpoint returns the following identifiers:\n- jpgNip — a randomly generated NIP representing a sole proprietorship (jednoosobowa działalność gospodarcza) registered in the TEST KSeF environment.\n- jpgPesel — a randomly generated PESEL associated with the above sole proprietorship, intended primarily for edge‑case and identity‑linking tests.\n- enforcementNip — a randomly generated NIP representing a standard legal entity, configured with appropriate permissions over the entities listed above (e.g., read or supervisory access).\n\nAll generated identifiers are permanently bound to the KSeF TEST environment.\nTheir associations, permissions, and registration metadata cannot be modified or migrated to different environment.", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "example": "{}" } }, "required": false }, "deprecated": false }, "parameters": [] }, "/legal-entities/{legalEntityUuid}/sub-accounts": { "get": { "operationId": "legal_entity_list_sub_accountsLegalEntityCollection", "tags": [ "LegalEntity" ], "responses": { "200": { "description": "LegalEntity collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LegalEntity.SubAccountOutput" } } }, "application/ld+json": { "schema": { "type": "object", "properties": { "hydra:member": { "type": "array", "items": { "$ref": "#/components/schemas/LegalEntity.SubAccountOutput.jsonld" } }, "hydra:totalItems": { "type": "integer", "minimum": 0 }, "hydra:view": { "type": "object", "properties": { "@id": { "type": "string", "format": "iri-reference" }, "@type": { "type": "string" }, "hydra:first": { "type": "string", "format": "iri-reference" }, "hydra:last": { "type": "string", "format": "iri-reference" }, "hydra:previous": { "type": "string", "format": "iri-reference" }, "hydra:next": { "type": "string", "format": "iri-reference" } }, "example": { "@id": "string", "type": "string", "hydra:first": "string", "hydra:last": "string", "hydra:previous": "string", "hydra:next": "string" } }, "hydra:search": { "type": "object", "properties": { "@type": { "type": "string" }, "hydra:template": { "type": "string" }, "hydra:variableRepresentation": { "type": "string" }, "hydra:mapping": { "type": "array", "items": { "type": "object", "properties": { "@type": { "type": "string" }, "variable": { "type": "string" }, "property": { "type": "string", "nullable": true }, "required": { "type": "boolean" } } } } } } }, "required": [ "hydra:member" ] } } } } }, "summary": "List all sub accounts connected to the provided legal entity", "description": "List all sub accounts connected to the provided legal entity", "parameters": [ { "name": "legalEntityUuid", "in": "path", "description": "The legal entity UUID", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "post": { "operationId": "legal_entity_create_sub_accountLegalEntityCollection", "tags": [ "LegalEntity" ], "responses": { "201": { "description": "LegalEntity resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LegalEntity.SubAccountOutput" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/LegalEntity.SubAccountOutput.jsonld" } } }, "links": { "GetLegalEntityItem": { "operationId": "getLegalEntityItem", "parameters": { "uuid": "$response.body#/uuid" }, "description": "The `uuid` value returned in the response can be used as the `uuid` parameter in `GET /legal-entities/{uuid}`." } } }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" } }, "summary": "Add a new sub account to the provided legal entity", "description": "Add a new sub account to the provided legal entity", "parameters": [ { "name": "legalEntityUuid", "in": "path", "description": "The legal entity UUID", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new LegalEntity resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LegalEntity.SubAccountInput" } } }, "required": true }, "deprecated": false }, "parameters": [] }, "/legal-entities/{legalEntityUuid}/sub-accounts/{email}": { "delete": { "operationId": "legal_entity_remove_sub_accountLegalEntityItem", "tags": [ "LegalEntity" ], "responses": { "204": { "description": "LegalEntity resource deleted" }, "404": { "description": "Resource not found" } }, "summary": "Remove a sub account from the provided legal entity", "description": "Remove a sub account from the provided legal entity", "parameters": [ { "name": "legalEntityUuid", "in": "path", "description": "The legal entity UUID", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "email", "in": "path", "description": "The sub account email", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "uuid", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/legal-entities/{legalEntity}/block": { "post": { "operationId": "legal_entity_blockLegalEntityCollection", "tags": [ "LegalEntity" ], "responses": { "201": { "description": "LegalEntity resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntityOutput" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntityOutput.jsonld" } } }, "links": { "GetLegalEntityItem": { "operationId": "getLegalEntityItem", "parameters": { "uuid": "$response.body#/uuid" }, "description": "The `uuid` value returned in the response can be used as the `uuid` parameter in `GET /legal-entities/{uuid}`." } } }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" } }, "summary": "Changing status legal entity to block", "description": "Changing status legal entity to block", "parameters": [ { "name": "legalEntity", "in": "path", "description": "Legal Entity UUID", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new LegalEntity resource", "content": { "application/json": { "schema": {} } }, "required": true }, "deprecated": false }, "parameters": [] }, "/legal-entities/{legalEntity}/ksef-token/create": { "post": { "operationId": "ksef_token_createAuthorizationFlowCollection", "tags": [ "AuthorizationFlow" ], "responses": { "201": { "description": "ksefToken resource created", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/AuthorizationFlow.KsefTokenOutput" } }, "application/xml": { "schema": { "type": "object", "$ref": "#/components/schemas/AuthorizationFlow.KsefTokenOutput" } } } }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" } }, "summary": "[DEPRECATED] Create a ksefToken resource.", "description": "Create a ksefToken resource.", "parameters": [ { "name": "legalEntity", "in": "path", "description": "Legal Entity UUID", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new ksef Token resource", "content": { "application/json": { "schema": { "type": "object", "properties": { "authorizationToken": { "minLength": 64, "maxLength": 64, "description": "KSeF authorization token.", "example": "UCTJO3VK6VYNC2YS968RE3NAO9KQ39JW71PMOM5G98BVUVZ5DCVFWXU4NHEFOGHS", "type": "string" }, "autoSelect": { "description": "KSeF authorization token.", "example": false, "type": "boolean" } } } }, "application/xml": { "schema": { "type": "object", "properties": { "authorizationToken": { "minLength": 64, "maxLength": 64, "description": "KSeF authorization token.", "example": "UCTJO3VK6VYNC2YS968RE3NAO9KQ39JW71PMOM5G98BVUVZ5DCVFWXU4NHEFOGHS", "type": "string" }, "autoSelect": { "description": "KSeF authorization token.", "example": false, "type": "boolean" } } } } }, "required": false }, "deprecated": true }, "parameters": [] }, "/legal-entities/{legalEntity}/ksef-token/remove": { "post": { "operationId": "ksef_revoke_tokenAuthorizationFlowCollection", "tags": [ "AuthorizationFlow" ], "responses": { "200": { "description": "AuthorizationFlow resource created", "content": { "application/json": { "schema": {} } }, "links": { "GetAuthorizationFlowItem": { "operationId": "getAuthorizationFlowItem", "parameters": { "uuid": "$response.body#/uuid" }, "description": "The `uuid` value returned in the response can be used as the `uuid` parameter in `GET /authorization-flows/{uuid}`." } } }, "400": { "description": "Bad Request" }, "422": { "description": "Unprocessable entity" }, "401": { "description": "Unauthorized" }, "404": { "description": "Resource not Found" } }, "summary": "[DEPRECATED] Remove the ksefToken resource.", "description": "Remove the ksefToken resource.", "parameters": [ { "name": "legalEntity", "in": "path", "description": "Legal Entity UUID", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "Remove the ksefToken resource.", "content": { "application/json": { "schema": { "type": "object", "properties": { "uuid": { "type": "string", "description": "KSeF token uuid.", "example": "00000000-0000-0000-0000-000000000000" } } } }, "application/xml": { "schema": { "type": "object", "properties": { "uuid": { "type": "string", "description": "KSeF token uuid.", "example": "00000000-0000-0000-0000-000000000000" } } } } }, "required": false }, "deprecated": true }, "parameters": [] }, "/legal-entities/{legalEntity}/ksef-token/select": { "post": { "operationId": "ksef_token_selectAuthorizationFlowCollection", "tags": [ "AuthorizationFlow" ], "responses": { "200": { "description": "ksefToken resource activated", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/AuthorizationFlow.KsefTokenOutput" } }, "application/xml": { "schema": { "type": "object", "$ref": "#/components/schemas/AuthorizationFlow.KsefTokenOutput" } } } }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" } }, "summary": "[DEPRECATED] Select a ksefToken resource.", "description": "Select a ksefToken resource.", "parameters": [ { "name": "legalEntity", "in": "path", "description": "Legal Entity UUID", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "Select a KSeF Token resource", "content": { "application/json": { "schema": { "type": "object", "properties": { "uuid": { "type": "string", "description": "KSeF token uuid.", "example": "00000000-0000-0000-0000-000000000000" } } } }, "application/xml": { "schema": { "type": "object", "properties": { "uuid": { "type": "string", "description": "KSeF token uuid.", "example": "00000000-0000-0000-0000-000000000000" } } } } }, "required": false }, "deprecated": true }, "parameters": [] }, "/legal-entities/{legalEntity}/offline": { "post": { "operationId": "legal_entity_offline_settingsLegalEntityCollection", "tags": [ "LegalEntity" ], "responses": { "204": { "description": "Offline settings updated" }, "400": { "description": "Bad Request" }, "422": { "description": "Unprocessable entity" } }, "summary": "Changing offline invoicing features for legal entity", "description": "Changing offline invoicing features for legal entity", "parameters": [ { "name": "legalEntity", "in": "path", "description": "Legal Entity UUID", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new LegalEntity resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LegalEntity.OfflineSettingsInput" } } }, "required": true }, "deprecated": false }, "parameters": [] }, "/legal-entities/{legalEntity}/settings": { "get": { "operationId": "legal_entity_settings_getLegalEntityCollection", "tags": [ "LegalEntity" ], "responses": { "200": { "description": "Legal entity settings", "content": { "application/json": { "schema": { "type": "object", "properties": { "defaultTax": { "type": "string" }, "invoiceSettings": { "type": "object", "additionalProperties": { "type": "object", "properties": { "defaultPaymentType": { "type": "integer", "nullable": true }, "defaultBankAccountNumber": { "type": "string", "nullable": true }, "defaultBankName": { "type": "string", "nullable": true }, "defaultSwiftCode": { "type": "string", "nullable": true }, "defaultPaymentTimeInDays": { "type": "integer", "nullable": true } } } }, "invoiceAutomation": { "type": "object", "properties": { "sendingInvoices": { "type": "boolean", "description": "Enable/disable invoice sending to the KSeF" }, "downloadingOutgoingInvoices": { "type": "boolean", "description": "Enable/disable downloading outgoing invoices from the KSeF" }, "downloadingIncomingInvoices": { "type": "boolean", "description": "Enable/disable downloading incoming invoices from the KSeF" } } }, "invoiceAccessCodeEnabled": { "type": "boolean", "description": "Enable/disable OTC invoice access code" }, "rejectPersonalInvoices": { "type": "boolean", "description": "Require buyer (Podmiot2) to provide a tax identifier (NIP or NrVatUE)" } } }, "example": { "defaultTax": "23", "invoiceSettings": { "PLN": { "defaultPaymentType": 1, "defaultBankAccountNumber": "PL61109010140000071219812874", "defaultBankName": "Santander", "defaultSwiftCode": "WBKPPLPP", "defaultPaymentTimeInDays": 14 }, "EUR": { "defaultPaymentType": 1, "defaultBankAccountNumber": "DE89370400440532013000", "defaultBankName": "Deutsche Bank", "defaultSwiftCode": "DEUTDEFF", "defaultPaymentTimeInDays": 30 } }, "invoiceAutomation": { "sendingInvoices": false, "downloadingOutgoingInvoices": false, "downloadingIncomingInvoices": false }, "invoiceAccessCodeEnabled": true, "rejectPersonalInvoices": false } } } } }, "summary": "Show settings for legal entity", "description": "Show legal entity settings", "parameters": [ { "name": "legalEntity", "in": "path", "description": "Legal Entity UUID", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "put": { "operationId": "legal_entity_settings_updateLegalEntityCollection", "tags": [ "LegalEntity" ], "responses": { "204": { "description": "LegalEntity resource updated", "content": { "application/json": { "schema": {} }, "application/ld+json": { "schema": {} } }, "links": { "GetLegalEntityItem": { "operationId": "getLegalEntityItem", "parameters": { "uuid": "$response.body#/uuid" }, "description": "The `uuid` value returned in the response can be used as the `uuid` parameter in `GET /legal-entities/{uuid}`." } } }, "400": { "description": "Bad Request" }, "422": { "description": "Unprocessable entity" }, "200": { "description": "Legal entity settings updated", "content": { "application/json": { "schema": { "type": "object", "properties": { "defaultTax": { "type": "string" }, "invoiceSettings": { "type": "object", "additionalProperties": { "type": "object", "properties": { "defaultPaymentType": { "type": "integer", "nullable": true }, "defaultBankAccountNumber": { "type": "string", "nullable": true }, "defaultBankName": { "type": "string", "nullable": true }, "defaultSwiftCode": { "type": "string", "nullable": true }, "defaultPaymentTimeInDays": { "type": "integer", "nullable": true } } } }, "invoiceAutomation": { "type": "object", "properties": { "sendingInvoices": { "type": "boolean", "description": "Enable/disable invoice sending to the KSeF" }, "downloadingOutgoingInvoices": { "type": "boolean", "description": "Enable/disable downloading outgoing invoices from the KSeF" }, "downloadingIncomingInvoices": { "type": "boolean", "description": "Enable/disable downloading incoming invoices from the KSeF" } } }, "invoiceAccessCodeEnabled": { "type": "boolean", "description": "Enable/disable OTC invoice access code" }, "rejectPersonalInvoices": { "type": "boolean", "description": "Require buyer (Podmiot2) to provide a tax identifier (NIP or NrVatUE)" } } }, "example": { "defaultTax": "23", "invoiceSettings": { "PLN": { "defaultPaymentType": 1, "defaultBankAccountNumber": "PL61109010140000071219812874", "defaultBankName": "Santander", "defaultSwiftCode": "WBKPPLPP", "defaultPaymentTimeInDays": 14 }, "EUR": { "defaultPaymentType": 1, "defaultBankAccountNumber": "DE89370400440532013000", "defaultBankName": "Deutsche Bank", "defaultSwiftCode": "DEUTDEFF", "defaultPaymentTimeInDays": 30 } }, "invoiceAutomation": { "sendingInvoices": false, "downloadingOutgoingInvoices": false, "downloadingIncomingInvoices": false }, "invoiceAccessCodeEnabled": true, "rejectPersonalInvoices": false } } } } }, "summary": "Update settings for legal entity", "description": "Update legal entity settings", "parameters": [ { "name": "legalEntity", "in": "path", "description": "Legal Entity UUID", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "defaultTax": { "type": "string" }, "invoiceSettings": { "type": "object", "additionalProperties": { "type": "object", "properties": { "defaultPaymentType": { "type": "integer", "nullable": true }, "defaultBankAccountNumber": { "type": "string", "nullable": true }, "defaultBankName": { "type": "string", "nullable": true }, "defaultSwiftCode": { "type": "string", "nullable": true }, "defaultPaymentTimeInDays": { "type": "integer", "nullable": true } } } }, "invoiceAutomation": { "type": "object", "properties": { "sendingInvoices": { "type": "boolean", "description": "Enable/disable invoice sending to the KSeF" }, "downloadingOutgoingInvoices": { "type": "boolean", "description": "Enable/disable downloading outgoing invoices from the KSeF" }, "downloadingIncomingInvoices": { "type": "boolean", "description": "Enable/disable downloading incoming invoices from the KSeF" } } }, "invoiceAccessCodeEnabled": { "type": "boolean", "description": "Enable/disable OTC invoice access code" }, "rejectPersonalInvoices": { "type": "boolean", "description": "Require buyer (Podmiot2) to provide a tax identifier (NIP or NrVatUE)" } } }, "example": { "defaultTax": "23", "invoiceSettings": { "PLN": { "defaultPaymentType": 1, "defaultBankAccountNumber": "PL61109010140000071219812874", "defaultBankName": "Santander", "defaultSwiftCode": "WBKPPLPP", "defaultPaymentTimeInDays": 14 }, "EUR": { "defaultPaymentType": 1, "defaultBankAccountNumber": "DE89370400440532013000", "defaultBankName": "Deutsche Bank", "defaultSwiftCode": "DEUTDEFF", "defaultPaymentTimeInDays": 30 } }, "invoiceAutomation": { "sendingInvoices": false, "downloadingOutgoingInvoices": false, "downloadingIncomingInvoices": false }, "invoiceAccessCodeEnabled": true, "rejectPersonalInvoices": false } } }, "required": false }, "deprecated": false }, "parameters": [] }, "/legal-entities/{uuid}": { "get": { "operationId": "getLegalEntityItem", "tags": [ "LegalEntity" ], "responses": { "200": { "description": "LegalEntity resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntityOutput" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntityOutput.jsonld" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieve the details of the LegalEntity.", "description": "Retrieve the details of the LegalEntity.", "parameters": [ { "name": "uuid", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "put": { "operationId": "putLegalEntityItem", "tags": [ "LegalEntity" ], "responses": { "200": { "description": "LegalEntity resource updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntityOutput" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntityOutput.jsonld" } } }, "links": { "GetLegalEntityItem": { "operationId": "getLegalEntityItem", "parameters": { "uuid": "$response.body#/uuid" }, "description": "The `uuid` value returned in the response can be used as the `uuid` parameter in `GET /legal-entities/{uuid}`." } } }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" }, "404": { "description": "Resource not found" } }, "summary": "Replace the LegalEntity resource.", "description": "Replace the LegalEntity resource.", "parameters": [ { "name": "uuid", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The updated LegalEntity resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntityInput" } } }, "required": true }, "deprecated": false }, "parameters": [] }, "/legal-entities/{uuid}/onboard/activate/{hash}": { "post": { "operationId": "onboard-activateAuthorizationFlowCollection", "tags": [ "AuthorizationFlow" ], "responses": { "204": { "description": "", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "422": { "description": "Unprocessable entity" }, "401": { "description": "Unauthorized" }, "404": { "description": "Resource not Found" } }, "summary": "Activates account for the Legal Entity and create authorization token.", "description": "Activates account for the Legal Entity and create authorization token.", "parameters": [ { "name": "uuid", "in": "path", "description": "Legal Entity UUID", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "hash", "in": "path", "description": "Special Hash", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "Finish onboarding of the Legal Entity", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "description": "Legal entity identifier type", "example": "nip", "type": "string" }, "identifier": { "description": "Legal entity identifier", "example": 11111111, "type": "integer" }, "signedFile": { "type": "string", "description": "Base64 encoded signed KSeF challenge XML" } } } } }, "required": false }, "deprecated": false }, "parameters": [] }, "/legal-entities/{uuid}/onboard/init": { "post": { "operationId": "onboard-initAuthorizationFlowCollection", "tags": [ "AuthorizationFlow" ], "responses": { "201": { "description": "AuthorizationFlow resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthorizationFlow.OnboardInitOutput" } } }, "links": { "GetAuthorizationFlowItem": { "operationId": "getAuthorizationFlowItem", "parameters": { "uuid": "$response.body#/uuid" }, "description": "The `uuid` value returned in the response can be used as the `uuid` parameter in `GET /authorization-flows/{uuid}`." } } }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" } }, "summary": "Initialize Authorization Flow for the Company", "description": "As an operator, you can trigger flow to GET your customer onboard and authorize their account. You will receive special URL that should be provided to the customer for further steps.", "parameters": [ { "name": "uuid", "in": "path", "description": "Legal Entity UUID", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "Initialize Authorization Flow for the Legal Entity", "content": { "application/json": { "schema": { "type": "object" } } }, "required": false }, "deprecated": false }, "parameters": [] }, "/legal-entities/{uuid}/onboard/start/{hash}": { "post": { "operationId": "onboard-startAuthorizationFlowCollection", "tags": [ "AuthorizationFlow" ], "responses": { "201": { "description": "AuthorizationFlow resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthorizationFlow.OnboardStartOutput" } } }, "links": { "GetAuthorizationFlowItem": { "operationId": "getAuthorizationFlowItem", "parameters": { "uuid": "$response.body#/uuid" }, "description": "The `uuid` value returned in the response can be used as the `uuid` parameter in `GET /authorization-flows/{uuid}`." } } }, "400": { "description": "Authorization Flow is already in progress or KSeF challenge failed" }, "422": { "description": "Unprocessable entity" }, "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "authFlowUuid": { "description": "Authentication Flow UUID", "type": "string" }, "time": { "description": "Time of Authentication Flow start", "example": "2026-05-15T12:34:56Z", "type": "string" } } } } } }, "403": { "description": "Unauthorized" }, "404": { "description": "Resource not found or legal entity is not in onboarding state" }, "410": { "description": "Authorization Flow has expired, trigger new initialization" } }, "summary": "Start Authorization Flow for the Legal Entity.", "description": "This will start onboarding procedure for your customer", "parameters": [ { "name": "uuid", "in": "path", "description": "Legal Entity UUID", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "hash", "in": "path", "description": "Special Hash", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "Start the Authorization Flow for the Legal Entity", "content": { "application/json": { "schema": { "type": "object", "properties": { "authenticationType": { "description": "Authentication type \"token\" or \"certificate\"", "example": "certificate", "type": "string" } } } } }, "required": false }, "deprecated": false }, "parameters": [] }, "/legal-entities/{uuid}/onboard/upload-certificate/{hash}": { "post": { "operationId": "upload-certificateAuthorizationFlowCollection", "tags": [ "AuthorizationFlow" ], "responses": { "204": { "description": "", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "422": { "description": "Unprocessable entity" }, "401": { "description": "Unauthorized" }, "404": { "description": "Resource not Found" } }, "summary": "Uploads existing KSeF certificate and start authorization flow.", "description": "Uploads existing KSeF certificate and start authorization flow.", "parameters": [ { "name": "uuid", "in": "path", "description": "Legal Entity UUID", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "hash", "in": "path", "description": "Special Hash", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "Uploads existing KSeF certificate and start authorization flow.", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "description": "Certificate name", "example": "My certificate", "type": "string" }, "password": { "description": "Password for private key", "example": "bZBLS6uO8Xa7U12", "type": "string" }, "certificate": { "type": "string", "description": "Certificate in DER format base64 encoded", "example": "YmFzZTY0IHByaXZhdGUga2V5IHN0cmluZw==" }, "privateKey": { "type": "string", "description": "Private Key in DER format base64 encoded", "example": "YmFzZTY0IHByaXZhdGUga2V5IHN0cmluZw==" } } } } }, "required": false }, "deprecated": false }, "parameters": [] }, "/nip/validate": { "post": { "operationId": "nip_validateLegalEntityCollection", "tags": [ "LegalEntity" ], "responses": { "200": { "description": "LegalEntity resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LegalEntity.NipValidateOutput" } } }, "links": { "GetLegalEntityItem": { "operationId": "getLegalEntityItem", "parameters": { "uuid": "$response.body#/uuid" }, "description": "The `uuid` value returned in the response can be used as the `uuid` parameter in `GET /legal-entities/{uuid}`." } } }, "400": { "description": "Bad Request" }, "422": { "description": "Unprocessable entity" }, "403": { "description": "Forbidden" } }, "summary": "Validate nips.", "description": "Validate nips.", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "nips": { "type": "array", "items": { "type": "string" } } } } } }, "required": false }, "deprecated": false }, "parameters": [] }, "/numbering-sequences": { "get": { "operationId": "getNumberingSequenceCollection", "tags": [ "NumberingSequence" ], "responses": { "200": { "description": "NumberingSequence collection", "content": { "application/ld+json": { "schema": { "type": "object", "properties": { "hydra:member": { "type": "array", "items": { "$ref": "#/components/schemas/NumberingSequence.NumberingSequenceOutput.jsonld" } }, "hydra:totalItems": { "type": "integer", "minimum": 0 }, "hydra:view": { "type": "object", "properties": { "@id": { "type": "string", "format": "iri-reference" }, "@type": { "type": "string" }, "hydra:first": { "type": "string", "format": "iri-reference" }, "hydra:last": { "type": "string", "format": "iri-reference" }, "hydra:previous": { "type": "string", "format": "iri-reference" }, "hydra:next": { "type": "string", "format": "iri-reference" } }, "example": { "@id": "string", "type": "string", "hydra:first": "string", "hydra:last": "string", "hydra:previous": "string", "hydra:next": "string" } }, "hydra:search": { "type": "object", "properties": { "@type": { "type": "string" }, "hydra:template": { "type": "string" }, "hydra:variableRepresentation": { "type": "string" }, "hydra:mapping": { "type": "array", "items": { "type": "object", "properties": { "@type": { "type": "string" }, "variable": { "type": "string" }, "property": { "type": "string", "nullable": true }, "required": { "type": "boolean" } } } } } } }, "required": [ "hydra:member" ] } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NumberingSequence.NumberingSequenceOutput" } } } } } }, "summary": "Retrieve the details of the numbering sequences.", "description": "Retrieve the details of the numbering sequences.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "post": { "operationId": "postNumberingSequenceCollection", "tags": [ "NumberingSequence" ], "responses": { "201": { "description": "NumberingSequence resource created", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/NumberingSequence.NumberingSequenceOutput.jsonld" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NumberingSequence.NumberingSequenceOutput" } } }, "links": { "GetNumberingSequenceItem": { "operationId": "getNumberingSequenceItem", "parameters": { "uuid": "$response.body#/uuid" }, "description": "The `uuid` value returned in the response can be used as the `uuid` parameter in `GET /numbering-sequences/{uuid}`." } } }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" } }, "summary": "Replace the numbering sequence resource.", "description": "Replace the numbering sequence resource.", "parameters": [], "requestBody": { "description": "The new NumberingSequence resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/NumberingSequence.NumberingSequenceCreateInput.jsonld" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NumberingSequence.NumberingSequenceCreateInput" } } }, "required": true }, "deprecated": false }, "parameters": [] }, "/numbering-sequences/current/{name}": { "get": { "operationId": "get_currentNumberingSequenceCollection", "tags": [ "NumberingSequence" ], "responses": { "200": { "description": "The current numbering sequence." }, "404": { "description": "No numbering sequence found." } }, "summary": "Get current numbering sequence.", "description": "Get the numbering sequence that is used now for the given sequence name.", "parameters": [ { "name": "name", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "put": { "operationId": "put_currentNumberingSequenceCollection", "tags": [ "NumberingSequence" ], "responses": { "200": { "description": "Numbering sequence created or updated." }, "400": { "description": "Request is invalid." }, "422": { "description": "Unprocessable entity" } }, "summary": "Create or update the current numbering sequence.", "description": "Create or update the numbering sequence that is used now for the given sequence name.", "parameters": [ { "name": "name", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The updated NumberingSequence resource", "content": { "application/ld+json": { "schema": { "type": "object", "properties": { "hydra:member": { "type": "array", "items": { "$ref": "#/components/schemas/NumberingSequence.jsonld" } }, "hydra:totalItems": { "type": "integer", "minimum": 0 }, "hydra:view": { "type": "object", "properties": { "@id": { "type": "string", "format": "iri-reference" }, "@type": { "type": "string" }, "hydra:first": { "type": "string", "format": "iri-reference" }, "hydra:last": { "type": "string", "format": "iri-reference" }, "hydra:previous": { "type": "string", "format": "iri-reference" }, "hydra:next": { "type": "string", "format": "iri-reference" } }, "example": { "@id": "string", "type": "string", "hydra:first": "string", "hydra:last": "string", "hydra:previous": "string", "hydra:next": "string" } }, "hydra:search": { "type": "object", "properties": { "@type": { "type": "string" }, "hydra:template": { "type": "string" }, "hydra:variableRepresentation": { "type": "string" }, "hydra:mapping": { "type": "array", "items": { "type": "object", "properties": { "@type": { "type": "string" }, "variable": { "type": "string" }, "property": { "type": "string", "nullable": true }, "required": { "type": "boolean" } } } } } } }, "required": [ "hydra:member" ] } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NumberingSequence" } } } }, "required": true }, "deprecated": false }, "parameters": [] }, "/numbering-sequences/{uuid}": { "get": { "operationId": "getNumberingSequenceItem", "tags": [ "NumberingSequence" ], "responses": { "200": { "description": "NumberingSequence resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/NumberingSequence.NumberingSequenceOutput.jsonld" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NumberingSequence.NumberingSequenceOutput" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieve the current numbering sequence.", "description": "Retrieve the numbering sequence that is used now for the given sequence name.", "parameters": [ { "name": "uuid", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "put": { "operationId": "putNumberingSequenceItem", "tags": [ "NumberingSequence" ], "responses": { "200": { "description": "NumberingSequence resource updated", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/NumberingSequence.NumberingSequenceOutput.jsonld" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NumberingSequence.NumberingSequenceOutput" } } }, "links": { "GetNumberingSequenceItem": { "operationId": "getNumberingSequenceItem", "parameters": { "uuid": "$response.body#/uuid" }, "description": "The `uuid` value returned in the response can be used as the `uuid` parameter in `GET /numbering-sequences/{uuid}`." } } }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" }, "404": { "description": "Resource not found" } }, "summary": "Replace the numbering sequence.", "description": "Replace the numbering sequence that is used now for the given sequence name.", "parameters": [ { "name": "uuid", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The updated NumberingSequence resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/NumberingSequence.jsonld" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NumberingSequence" } } }, "required": true }, "deprecated": false }, "delete": { "operationId": "deleteNumberingSequenceItem", "tags": [ "NumberingSequence" ], "responses": { "204": { "description": "NumberingSequence resource deleted" }, "404": { "description": "Resource not found" } }, "summary": "Removes the NumberingSequence resource.", "description": "Removes the NumberingSequence resource.", "parameters": [ { "name": "uuid", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/onboarding/{uuid}/{hash}": { "get": { "operationId": "onboardingAuthorizationFlowCollection", "tags": [ "AuthorizationFlow" ], "responses": { "200": { "description": "AuthorizationFlow collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AuthorizationFlow.OnboardingOutput" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Resource not Found" } }, "summary": "Onboarding data for the Legal Entity.", "description": "Onboarding have parameters to use for full onboard flow.", "parameters": [ { "name": "uuid", "in": "path", "description": "Legal Entity UUID", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "hash", "in": "path", "description": "Special Hash", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/webhooks": { "get": { "operationId": "getWebhookCollection", "tags": [ "Webhook" ], "responses": { "200": { "description": "Webhook collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Webhook.WebhookOutput" } } }, "application/ld+json": { "schema": { "type": "object", "properties": { "hydra:member": { "type": "array", "items": { "$ref": "#/components/schemas/Webhook.WebhookOutput.jsonld" } }, "hydra:totalItems": { "type": "integer", "minimum": 0 }, "hydra:view": { "type": "object", "properties": { "@id": { "type": "string", "format": "iri-reference" }, "@type": { "type": "string" }, "hydra:first": { "type": "string", "format": "iri-reference" }, "hydra:last": { "type": "string", "format": "iri-reference" }, "hydra:previous": { "type": "string", "format": "iri-reference" }, "hydra:next": { "type": "string", "format": "iri-reference" } }, "example": { "@id": "string", "type": "string", "hydra:first": "string", "hydra:last": "string", "hydra:previous": "string", "hydra:next": "string" } }, "hydra:search": { "type": "object", "properties": { "@type": { "type": "string" }, "hydra:template": { "type": "string" }, "hydra:variableRepresentation": { "type": "string" }, "hydra:mapping": { "type": "array", "items": { "type": "object", "properties": { "@type": { "type": "string" }, "variable": { "type": "string" }, "property": { "type": "string", "nullable": true }, "required": { "type": "boolean" } } } } } } }, "required": [ "hydra:member" ] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Resource not Found" } }, "summary": "Retrieve the collection of Webhook resources.", "description": "Retrieve the collection of Webhook resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "post": { "operationId": "postWebhookCollection", "tags": [ "Webhook" ], "responses": { "201": { "description": "Webhook resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Webhook.WebhookOutput" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/Webhook.WebhookOutput.jsonld" } } }, "links": { "GetWebhookItem": { "operationId": "getWebhookItem", "parameters": { "uuid": "$response.body#/uuid" }, "description": "The `uuid` value returned in the response can be used as the `uuid` parameter in `GET /webhooks/{uuid}`." } } }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" } }, "summary": "Create a Webhook resource.", "description": "Create a Webhook resource.", "parameters": [], "requestBody": { "description": "The new Webhook resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Webhook.WebhookInput" } } }, "required": true }, "deprecated": false }, "parameters": [] }, "/webhooks/{uuid}": { "get": { "operationId": "getWebhookItem", "tags": [ "Webhook" ], "responses": { "200": { "description": "Webhook resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Webhook.WebhookOutput" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/Webhook.WebhookOutput.jsonld" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieve a Webhook resource.", "description": "Retrieve a Webhook resource.", "parameters": [ { "name": "uuid", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "put": { "operationId": "putWebhookItem", "tags": [ "Webhook" ], "responses": { "200": { "description": "Webhook resource updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Webhook.WebhookOutput" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/Webhook.WebhookOutput.jsonld" } } }, "links": { "GetWebhookItem": { "operationId": "getWebhookItem", "parameters": { "uuid": "$response.body#/uuid" }, "description": "The `uuid` value returned in the response can be used as the `uuid` parameter in `GET /webhooks/{uuid}`." } } }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" }, "404": { "description": "Resource not found" } }, "summary": "Replace the Webhook resource.", "description": "Replace the Webhook resource.", "parameters": [ { "name": "uuid", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The updated Webhook resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Webhook.WebhookInput" } } }, "required": true }, "deprecated": false }, "delete": { "operationId": "deleteWebhookItem", "tags": [ "Webhook" ], "responses": { "204": { "description": "Webhook resource deleted" }, "404": { "description": "Resource not found" } }, "summary": "Remove the Webhook resource.", "description": "Remove the Webhook resource.", "parameters": [ { "name": "uuid", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] } }, "components": { "schemas": { "AdnotacjeAType": { "type": "object", "description": "", "properties": { "p16": {}, "p17": {}, "p18": {}, "p18A": {}, "zwolnienie": { "$ref": "#/components/schemas/ZwolnienieAType" }, "noweSrodkiTransportu": { "$ref": "#/components/schemas/NoweSrodkiTransportuAType" }, "p23": {}, "pMarzy": { "$ref": "#/components/schemas/PMarzyAType" } } }, "AdresKorespAType": { "type": "object", "description": "", "properties": { "kodKraju": {}, "adresL1": {}, "adresL2": {}, "gLN": {} } }, "AuthorizationFlow.AuthorizationFlowOutput": { "type": "object", "description": "", "properties": { "uuid": { "description": "Authorization flow UUID.", "type": "string" }, "status": { "enum": [ "new", "in-progress", "used", "waiting-for-certificate", "completed", "failed", "cancelled" ], "description": "Authorization flow status.", "type": "string" }, "statusDetails": { "description": "Authorization flow status details.", "type": "string", "nullable": true }, "legalEntityUuid": { "description": "Legal entity UUID.", "type": "string" }, "legalEntityName": { "description": "Legal entity name.", "type": "string" }, "legalEntityNip": { "description": "Legal entity NIP.", "type": "string" }, "createdAt": { "description": "Datetime create legal entity.", "type": "string" } } }, "AuthorizationFlow.AuthorizationFlowOutput.jsonld": { "type": "object", "description": "", "properties": { "@id": { "readOnly": true, "type": "string" }, "@type": { "readOnly": true, "type": "string" }, "@context": { "readOnly": true, "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "@vocab": { "type": "string" }, "hydra": { "type": "string", "enum": [ "http://www.w3.org/ns/hydra/core#" ] } }, "required": [ "@vocab", "hydra" ], "additionalProperties": true } ] }, "uuid": { "description": "Authorization flow UUID.", "type": "string" }, "status": { "enum": [ "new", "in-progress", "used", "waiting-for-certificate", "completed", "failed", "cancelled" ], "description": "Authorization flow status.", "type": "string" }, "statusDetails": { "description": "Authorization flow status details.", "type": "string", "nullable": true }, "legalEntityUuid": { "description": "Legal entity UUID.", "type": "string" }, "legalEntityName": { "description": "Legal entity name.", "type": "string" }, "legalEntityNip": { "description": "Legal entity NIP.", "type": "string" }, "createdAt": { "description": "Datetime create legal entity.", "type": "string" } } }, "AuthorizationFlow.KsefTokenOutput": { "type": "object", "description": "", "properties": { "uuid": { "description": "ksef token uuid.", "example": "0000x0x0-00x0-0000-xx00-0x0x0xx0000", "type": "string" }, "token": { "description": "ksef authorization token.", "example": "UCTJO3VK6VYNC2YS968RE3NAO9KQ39JW71PMOM5G98BVUVZ5DCVFWXU4NHEFOGHS", "type": "string" }, "isActive": { "description": "ksef token is active.", "example": true, "type": "boolean" }, "isSelected": { "description": "ksef token selected.", "type": "boolean" } } }, "AuthorizationFlow.OnboardInitOutput": { "type": "object", "description": "", "properties": { "authFlowUuid": { "description": "UUID of the authorization flow.", "type": "string" }, "url": { "description": "URL for the End-User initiating the start of the flow.", "type": "string" }, "message": { "description": "Message.", "type": "string" } } }, "AuthorizationFlow.OnboardStartOutput": { "type": "object", "description": "", "properties": { "authFlowUuid": { "description": "UUID of the authorization flow.", "type": "string" }, "time": { "description": "Start of the process.", "type": "string" }, "message": { "description": "Message.", "type": "string" } } }, "AuthorizationFlow.OnboardingOutput": { "type": "object", "description": "", "properties": { "nip": { "description": "Legal Entity NIP.", "type": "string" }, "environment": { "description": "Legal Entity KSeF environment.", "type": "string" }, "authFlowUuid": { "description": "Authorization flow UUID.", "type": "string", "nullable": true }, "authFlowStatus": { "enum": [ "new", "in-progress", "used", "waiting-for-certificate", "completed", "failed", "cancelled" ], "description": "Authorization flow status.", "type": "string", "nullable": true }, "authFlowType": { "enum": [ "token", "certificate" ], "description": "Authorization flow type.", "type": "string", "nullable": true }, "authFlowIsValid": { "description": "Authorization flow is valid (is not expired).", "type": "boolean", "nullable": true }, "authFlowUrl": { "description": "Url to activate legal entity.", "type": "string", "nullable": true }, "authFlowDeadline": { "description": "Authorization flow deadline.", "type": "string", "nullable": true }, "authFlowCreatedAt": { "description": "Authorization flow created at.", "type": "string", "nullable": true }, "authFlowUpdatedAt": { "description": "Authorization flow updated at.", "type": "string", "nullable": true }, "customer": { "$ref": "#/components/schemas/CustomerOutput" } } }, "Batch": { "type": "object", "description": "", "properties": { "uuid": { "type": "string", "format": "uuid" }, "referenceNumber": { "type": "string" }, "legalEntity": { "type": "string", "format": "iri-reference", "nullable": true }, "processingCode": { "anyOf": [ { "$ref": "#/components/schemas/BatchProcessingCode" } ], "nullable": true }, "status": { "$ref": "#/components/schemas/BatchStatus" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "symmetricKey": { "type": "string" }, "initializationVector": { "type": "string" } } }, "BatchProcessingCode": { "type": "object", "description": "", "properties": { "name": { "readOnly": true, "type": "string" }, "value": { "readOnly": true, "type": "integer" } } }, "BatchStatus": { "type": "object", "description": "", "properties": { "name": { "readOnly": true, "type": "string" }, "value": { "readOnly": true, "type": "string" } } }, "CustomerOutput": { "type": "object", "description": "", "properties": { "customerName": { "type": "string", "nullable": true }, "addressLine": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "countryCode": { "type": "string", "nullable": true }, "nip": { "type": "string", "nullable": true } } }, "CustomerOutput.jsonld": { "type": "object", "description": "", "properties": { "@context": { "readOnly": true, "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "@vocab": { "type": "string" }, "hydra": { "type": "string", "enum": [ "http://www.w3.org/ns/hydra/core#" ] } }, "required": [ "@vocab", "hydra" ], "additionalProperties": true } ] }, "@id": { "readOnly": true, "type": "string" }, "@type": { "readOnly": true, "type": "string" }, "customerName": { "type": "string", "nullable": true }, "addressLine": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "countryCode": { "type": "string", "nullable": true }, "nip": { "type": "string", "nullable": true } } }, "ExtractionJobStatus": { "type": "object", "description": "", "properties": { "name": { "readOnly": true, "type": "string" }, "value": { "readOnly": true, "type": "string" } } }, "ExtractionJobStatus.jsonld": { "type": "object", "description": "", "properties": { "@context": { "readOnly": true, "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "@vocab": { "type": "string" }, "hydra": { "type": "string", "enum": [ "http://www.w3.org/ns/hydra/core#" ] } }, "required": [ "@vocab", "hydra" ], "additionalProperties": true } ] }, "@id": { "readOnly": true, "type": "string" }, "@type": { "readOnly": true, "type": "string" }, "name": { "readOnly": true, "type": "string" }, "value": { "readOnly": true, "type": "string" } } }, "FaAType": { "type": "object", "description": "", "properties": { "kodWaluty": {}, "p1": { "type": "string", "format": "date-time" }, "p1M": {}, "p2": {}, "wZ": { "type": "array", "items": { "type": "string" }, "nullable": true }, "p6": { "type": "string", "format": "date-time", "nullable": true }, "okresFa": { "anyOf": [ { "$ref": "#/components/schemas/OkresFaAType" } ], "nullable": true }, "p131": {}, "p141": {}, "p141W": {}, "p132": {}, "p142": {}, "p142W": {}, "p133": {}, "p143": {}, "p143W": {}, "p134": {}, "p144": {}, "p144W": {}, "p135": {}, "p145": {}, "p1361": {}, "p1362": {}, "p1363": {}, "p137": {}, "p138": {}, "p139": {}, "p1310": {}, "p1311": {}, "p15": {}, "kursWalutyZ": {}, "adnotacje": { "$ref": "#/components/schemas/AdnotacjeAType" }, "rodzajFaktury": {}, "przyczynaKorekty": {}, "typKorekty": {}, "daneFaKorygowanej": { "type": "array", "items": { "type": "string" }, "nullable": true }, "okresFaKorygowanej": {}, "nrFaKorygowany": {}, "podmiot1K": { "anyOf": [ { "$ref": "#/components/schemas/Podmiot1KAType" } ], "nullable": true }, "podmiot2K": { "type": "array", "items": { "type": "string" }, "nullable": true }, "p15ZK": {}, "kursWalutyZK": {}, "zaliczkaCzesciowa": { "type": "array", "items": { "type": "string" }, "nullable": true }, "fP": {}, "tP": {}, "dodatkowyOpis": { "type": "array", "items": { "type": "string" }, "nullable": true }, "fakturaZaliczkowa": { "type": "array", "items": { "type": "string" }, "nullable": true }, "zwrotAkcyzy": {}, "faWiersz": { "type": "array", "items": { "type": "string" }, "nullable": true }, "rozliczenie": { "anyOf": [ { "$ref": "#/components/schemas/RozliczenieAType" } ], "nullable": true }, "platnosc": { "anyOf": [ { "$ref": "#/components/schemas/PlatnoscAType" } ], "nullable": true }, "warunkiTransakcji": { "anyOf": [ { "$ref": "#/components/schemas/WarunkiTransakcjiAType" } ], "nullable": true }, "zamowienie": { "anyOf": [ { "$ref": "#/components/schemas/ZamowienieAType" } ], "nullable": true }, "setWZ": { "readOnly": true }, "setDaneFaKorygowanej": { "readOnly": true }, "setPodmiot2K": { "readOnly": true }, "setZaliczkaCzesciowa": { "readOnly": true }, "setDodatkowyOpis": { "readOnly": true }, "setFakturaZaliczkowa": { "readOnly": true }, "setFaWiersz": { "readOnly": true } } }, "Faktura": { "type": "object", "description": "", "properties": { "naglowek": { "$ref": "#/components/schemas/TNaglowekType" }, "podmiot1": { "$ref": "#/components/schemas/Podmiot1AType" }, "podmiot2": { "$ref": "#/components/schemas/Podmiot2AType" }, "podmiot3": { "type": "array", "items": { "type": "string" }, "nullable": true }, "podmiotUpowazniony": { "anyOf": [ { "$ref": "#/components/schemas/PodmiotUpowaznionyAType" } ], "nullable": true }, "fa": { "$ref": "#/components/schemas/FaAType" }, "stopka": { "anyOf": [ { "$ref": "#/components/schemas/StopkaAType" } ], "nullable": true }, "zalacznik": { "type": "array", "items": { "type": "string" }, "nullable": true }, "setPodmiot3": { "readOnly": true }, "setZalacznik": { "readOnly": true } } }, "Invoice": { "type": "object", "description": "", "properties": { "uuid": { "type": "string", "nullable": true }, "ownerId": { "type": "integer" }, "legalEntity": { "type": "string", "format": "iri-reference", "nullable": true }, "batch": { "anyOf": [ { "$ref": "#/components/schemas/Batch" } ], "nullable": true }, "status": { "default": { "name": "New", "value": "new" }, "example": { "name": "New", "value": "new" }, "$ref": "#/components/schemas/InvoiceStatus" }, "invoiceNumber": { "type": "string" }, "invoiceType": { "$ref": "#/components/schemas/InvoiceType" }, "invoiceProducedAt": { "type": "string", "format": "date-time" }, "xmlFilePath": { "type": "string" }, "invoiceCreatorNip": { "type": "string" }, "processingCode": { "anyOf": [ { "$ref": "#/components/schemas/InvoiceProcessingCode" } ], "nullable": true }, "invoiceDate": { "type": "string", "format": "date-time" }, "invoiceRecipientNip": { "type": "string", "nullable": true }, "invoiceRecipientCompanyName": { "type": "string", "nullable": true }, "invoiceRecipientCustomerId": { "type": "string", "nullable": true }, "invoiceRecipientEmail": { "type": "string", "nullable": true }, "ksefReferenceNumber": { "type": "string", "nullable": true }, "upo": { "type": "string", "nullable": true }, "acquisition": { "type": "string", "format": "date-time", "nullable": true }, "invoicingMode": { "anyOf": [ { "$ref": "#/components/schemas/InvoicingMode" } ], "nullable": true }, "invoiceTransfer": { "type": "string", "format": "iri-reference", "nullable": true }, "jsonFilePath": { "type": "string", "nullable": true }, "senderName": { "type": "string" }, "isDemo": { "type": "boolean", "nullable": true }, "originType": { "default": { "name": "Default", "value": "default" }, "example": { "name": "Default", "value": "default" }, "anyOf": [ { "$ref": "#/components/schemas/OriginType" } ], "nullable": true }, "accessCode": { "type": "string" }, "downloaded": { "type": "boolean", "nullable": true }, "downloadedAt": { "type": "string", "format": "date-time", "nullable": true }, "hash": { "type": "string", "nullable": true }, "ksefInvoiceUrl": { "type": "string", "nullable": true }, "ksefValidationUrl": { "type": "string", "nullable": true }, "currency": { "type": "string", "nullable": true }, "amount": { "type": "string", "nullable": true }, "amountNet": { "type": "string", "nullable": true }, "amountInCurrency": { "type": "string", "nullable": true }, "exchangeRate": { "type": "string", "nullable": true }, "hasMultilines": { "type": "boolean" }, "dueDate": { "type": "string", "format": "date-time", "nullable": true }, "lastWebhookStatus": { "anyOf": [ { "$ref": "#/components/schemas/InvoiceProcessingCode" } ], "nullable": true }, "lastWebhookDate": { "type": "string", "format": "date-time", "nullable": true }, "invoiceSchemaType": { "default": { "name": "V3", "value": "v3" }, "example": { "name": "V3", "value": "v3" }, "$ref": "#/components/schemas/InvoiceSchemaType" }, "subjectType": { "default": { "name": "Subject1", "value": "Subject1" }, "example": { "name": "Subject1", "value": "Subject1" }, "$ref": "#/components/schemas/SubjectType" }, "invoiceProvider": { "anyOf": [ { "$ref": "#/components/schemas/InvoiceProvider" } ], "nullable": true }, "originGatewayUuid": { "type": "string", "nullable": true }, "otcCode": { "type": "string", "nullable": true }, "otcIsUsed": { "type": "boolean" }, "otcExpiredAt": { "type": "string", "format": "date-time", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true }, "invoiceAttachments": { "type": "array", "items": { "type": "string", "format": "iri-reference" } }, "fileName": { "readOnly": true, "type": "string" }, "workflowStatus": { "type": "string" } } }, "Invoice.Faktura": { "type": "object", "description": "", "properties": { "naglowek": { "$ref": "#/components/schemas/TNaglowekType" }, "podmiot1": { "$ref": "#/components/schemas/Podmiot1AType" }, "podmiot2": { "$ref": "#/components/schemas/Podmiot2AType" }, "podmiot3": { "type": "array", "items": { "type": "string" }, "nullable": true }, "podmiotUpowazniony": { "anyOf": [ { "$ref": "#/components/schemas/PodmiotUpowaznionyAType" } ], "nullable": true }, "fa": { "$ref": "#/components/schemas/FaAType" }, "stopka": { "anyOf": [ { "$ref": "#/components/schemas/StopkaAType" } ], "nullable": true }, "zalacznik": { "type": "array", "items": { "type": "string" }, "nullable": true }, "setPodmiot3": { "readOnly": true }, "setZalacznik": { "readOnly": true } } }, "Invoice.InvoiceOtcOutput": { "type": "object", "description": "", "properties": { "otcCode": { "description": "One Time Code", "type": "string", "nullable": true }, "otcLifetime": { "description": "OTC lifetime", "type": "integer", "nullable": true } } }, "Invoice.InvoiceOutput": { "type": "object", "description": "", "properties": { "uuid": { "description": "Invoice UUID.", "type": "string" }, "filename": { "description": "File name.", "type": "string" }, "legalEntityUuid": { "description": "Legal entity UUID.", "type": "string", "nullable": true }, "environment": { "description": "Legal entity KSeF environment.", "type": "string", "nullable": true }, "createdAt": { "description": "Invoice created at.", "type": "string" }, "invoiceDate": { "description": "Invoice date.", "type": "string" }, "invoiceNumber": { "description": "Invoice number.", "type": "string" }, "senderName": { "description": "Sender name.", "type": "string", "nullable": true }, "recipientName": { "description": "Recipient name.", "type": "string", "nullable": true }, "invoiceCreatorNip": { "description": "Invoice creator NIP.", "type": "string" }, "invoiceRecipientNip": { "description": "Invoice recipient NIP.", "type": "string", "nullable": true }, "invoiceType": { "enum": [ "VAT", "KOR", "ZAL", "ROZ", "UPR", "KOR_ZAL", "KOR_ROZ" ], "description": "Invoice type.", "type": "string" }, "status": { "type": "string", "enum": [ "draft", "blocked", "approved", "rejected", "in_queue", "processing", "valid", "invalid" ], "description": "Invoice status. Possible values:\n- `draft` – Invoice is editable and waiting for approval.\n- `blocked` – Sending the invoice is blocked due to invoice transfer validation or KSeF permission issues.\n- `approved` – Invoice is approved and waiting for manual publish.\n- `rejected` – Invoice has been manually rejected.\n- `in_queue` – Invoice is published and waiting in queue to be sent to KSeF.\n- `processing` – Invoice has been sent to KSeF and waiting for KSeF status update.\n- `valid` – Invoice has been successfully sent to / received from KSeF and has a KSeF reference number.\n- `invalid` – Invoice has been sent to KSeF but was rejected due to a semantic or business error." }, "subjectType": { "enum": [ "outgoing", "incoming" ], "description": "Subject Type", "type": "string" }, "acquisition": { "description": "Invoice acquisition.", "type": "string", "nullable": true }, "ksefReferenceNumber": { "description": "Invoice ksef reference number.", "type": "string", "nullable": true }, "hasUpo": { "description": "Invoice has upo.", "type": "boolean" }, "attachments": { "description": "Invoice attachments.", "type": "array", "items": { "type": "string" } }, "payload": { "description": "Payload from invoice.", "type": "string", "nullable": true }, "currency": { "description": "Invoice currency.", "type": "string", "nullable": true }, "amount": { "description": "Invoice amount.", "type": "number", "nullable": true }, "amountNet": { "description": "Invoice amount net.", "type": "number", "nullable": true }, "amountInCurrency": { "description": "Invoice amount in currency.", "type": "number", "nullable": true }, "exchangeRate": { "description": "Exchange rate.", "type": "number", "nullable": true }, "hasMultilines": { "description": "Has multilines.", "type": "boolean" }, "dueDate": { "description": "Invoice currency.", "type": "string", "nullable": true }, "hash": { "description": "Invoice hash", "type": "string", "nullable": true }, "ksefInvoiceUrl": { "description": "Invoice KSeF preview url", "type": "string", "nullable": true }, "ksefValidationUrl": { "description": "Invoice KSeF url for offline validation", "type": "string", "nullable": true }, "invoiceVersion": { "enum": [ "v3" ], "description": "KSeF invoice schema version.", "type": "string" }, "originType": { "enum": [ "default", "extraction", "ftp", "api", "ksef" ], "description": "Invoice origin type.", "type": "string" }, "downloaded": { "description": "Invoice downloaded.", "type": "boolean" }, "downloadedAt": { "description": "Invoice downloaded at.", "type": "string", "nullable": true } } }, "Invoice.InvoiceOutput.jsonld": { "type": "object", "description": "", "properties": { "@id": { "readOnly": true, "type": "string" }, "@type": { "readOnly": true, "type": "string" }, "@context": { "readOnly": true, "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "@vocab": { "type": "string" }, "hydra": { "type": "string", "enum": [ "http://www.w3.org/ns/hydra/core#" ] } }, "required": [ "@vocab", "hydra" ], "additionalProperties": true } ] }, "uuid": { "description": "Invoice UUID.", "type": "string" }, "filename": { "description": "File name.", "type": "string" }, "legalEntityUuid": { "description": "Legal entity UUID.", "type": "string", "nullable": true }, "environment": { "description": "Legal entity KSeF environment.", "type": "string", "nullable": true }, "createdAt": { "description": "Invoice created at.", "type": "string" }, "invoiceDate": { "description": "Invoice date.", "type": "string" }, "invoiceNumber": { "description": "Invoice number.", "type": "string" }, "senderName": { "description": "Sender name.", "type": "string", "nullable": true }, "recipientName": { "description": "Recipient name.", "type": "string", "nullable": true }, "invoiceCreatorNip": { "description": "Invoice creator NIP.", "type": "string" }, "invoiceRecipientNip": { "description": "Invoice recipient NIP.", "type": "string", "nullable": true }, "invoiceType": { "enum": [ "VAT", "KOR", "ZAL", "ROZ", "UPR", "KOR_ZAL", "KOR_ROZ" ], "description": "Invoice type.", "type": "string" }, "status": { "type": "string", "enum": [ "draft", "blocked", "approved", "rejected", "in_queue", "processing", "valid", "invalid" ], "description": "Invoice status. Possible values:\n- `draft` – Invoice is editable and waiting for approval.\n- `blocked` – Sending the invoice is blocked due to invoice transfer validation or KSeF permission issues.\n- `approved` – Invoice is approved and waiting for manual publish.\n- `rejected` – Invoice has been manually rejected.\n- `in_queue` – Invoice is published and waiting in queue to be sent to KSeF.\n- `processing` – Invoice has been sent to KSeF and waiting for KSeF status update.\n- `valid` – Invoice has been successfully sent to / received from KSeF and has a KSeF reference number.\n- `invalid` – Invoice has been sent to KSeF but was rejected due to a semantic or business error." }, "subjectType": { "enum": [ "outgoing", "incoming" ], "description": "Subject Type", "type": "string" }, "acquisition": { "description": "Invoice acquisition.", "type": "string", "nullable": true }, "ksefReferenceNumber": { "description": "Invoice ksef reference number.", "type": "string", "nullable": true }, "hasUpo": { "description": "Invoice has upo.", "type": "boolean" }, "attachments": { "description": "Invoice attachments.", "type": "array", "items": { "type": "string" } }, "payload": { "description": "Payload from invoice.", "type": "string", "nullable": true }, "currency": { "description": "Invoice currency.", "type": "string", "nullable": true }, "amount": { "description": "Invoice amount.", "type": "number", "nullable": true }, "amountNet": { "description": "Invoice amount net.", "type": "number", "nullable": true }, "amountInCurrency": { "description": "Invoice amount in currency.", "type": "number", "nullable": true }, "exchangeRate": { "description": "Exchange rate.", "type": "number", "nullable": true }, "hasMultilines": { "description": "Has multilines.", "type": "boolean" }, "dueDate": { "description": "Invoice currency.", "type": "string", "nullable": true }, "hash": { "description": "Invoice hash", "type": "string", "nullable": true }, "ksefInvoiceUrl": { "description": "Invoice KSeF preview url", "type": "string", "nullable": true }, "ksefValidationUrl": { "description": "Invoice KSeF url for offline validation", "type": "string", "nullable": true }, "invoiceVersion": { "enum": [ "v3" ], "description": "KSeF invoice schema version.", "type": "string" }, "originType": { "enum": [ "default", "extraction", "ftp", "api", "ksef" ], "description": "Invoice origin type.", "type": "string" }, "downloaded": { "description": "Invoice downloaded.", "type": "boolean" }, "downloadedAt": { "description": "Invoice downloaded at.", "type": "string", "nullable": true } } }, "Invoice.InvoiceValidatorOutput": { "type": "object", "description": "", "properties": { "isValid": { "description": "Is valid.", "default": true, "example": true, "type": "boolean" }, "errors": { "description": "Error descriptions.", "type": "array", "items": { "type": "string" } } } }, "InvoiceAttachments.InvoiceAttachmentOutput": { "type": "object", "description": "", "properties": { "uuid": { "description": "Invoice attachment uuid.", "type": "string" }, "filename": { "description": "Invoice attachment filename.", "type": "string" }, "filesize": { "description": "Invoice attachment filesize.", "type": "integer", "nullable": true } } }, "InvoiceAttachments.InvoiceAttachmentOutput.jsonld": { "type": "object", "description": "", "properties": { "@id": { "readOnly": true, "type": "string" }, "@type": { "readOnly": true, "type": "string" }, "@context": { "readOnly": true, "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "@vocab": { "type": "string" }, "hydra": { "type": "string", "enum": [ "http://www.w3.org/ns/hydra/core#" ] } }, "required": [ "@vocab", "hydra" ], "additionalProperties": true } ] }, "uuid": { "description": "Invoice attachment uuid.", "type": "string" }, "filename": { "description": "Invoice attachment filename.", "type": "string" }, "filesize": { "description": "Invoice attachment filesize.", "type": "integer", "nullable": true } } }, "InvoiceAttachments.Root": { "type": "object", "description": "", "properties": { "faktura": { "$ref": "#/components/schemas/Faktura" }, "zalacznik": { "type": "array", "items": { "type": "string" } } } }, "InvoiceExtract": { "type": "object", "description": "", "properties": { "uuid": { "type": "string", "format": "uuid" }, "filePath": { "type": "string" }, "resultPath": { "type": "string", "nullable": true }, "fileName": { "type": "string" }, "jobStatus": { "default": { "name": "WAITING", "value": "waiting" }, "example": { "name": "WAITING", "value": "waiting" }, "$ref": "#/components/schemas/ExtractionJobStatus" }, "ownerId": { "type": "integer" }, "errorMessage": { "type": "string", "nullable": true }, "conversionConfiguration": { "type": "array", "items": { "type": "string" }, "nullable": true }, "pages": { "type": "integer", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true } } }, "InvoiceExtract.InvoiceExtractOutput": { "type": "object", "description": "", "properties": { "uuid": { "type": "string" }, "acquisitionDate": { "type": "string" }, "filename": { "type": "string" }, "jobStatus": { "type": "string" }, "pages": { "type": "integer", "nullable": true }, "errorMessage": { "type": "string", "nullable": true } } }, "InvoiceExtract.InvoiceExtractOutput.jsonld": { "type": "object", "description": "", "properties": { "@context": { "readOnly": true, "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "@vocab": { "type": "string" }, "hydra": { "type": "string", "enum": [ "http://www.w3.org/ns/hydra/core#" ] } }, "required": [ "@vocab", "hydra" ], "additionalProperties": true } ] }, "@id": { "readOnly": true, "type": "string" }, "@type": { "readOnly": true, "type": "string" }, "uuid": { "type": "string" }, "acquisitionDate": { "type": "string" }, "filename": { "type": "string" }, "jobStatus": { "type": "string" }, "pages": { "type": "integer", "nullable": true }, "errorMessage": { "type": "string", "nullable": true } } }, "InvoiceExtract.jsonld": { "type": "object", "description": "", "properties": { "@context": { "readOnly": true, "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "@vocab": { "type": "string" }, "hydra": { "type": "string", "enum": [ "http://www.w3.org/ns/hydra/core#" ] } }, "required": [ "@vocab", "hydra" ], "additionalProperties": true } ] }, "@id": { "readOnly": true, "type": "string" }, "@type": { "readOnly": true, "type": "string" }, "uuid": { "type": "string", "format": "uuid" }, "filePath": { "type": "string" }, "resultPath": { "type": "string", "nullable": true }, "fileName": { "type": "string" }, "jobStatus": { "default": { "name": "WAITING", "value": "waiting" }, "example": { "name": "WAITING", "value": "waiting" }, "$ref": "#/components/schemas/ExtractionJobStatus.jsonld" }, "ownerId": { "type": "integer" }, "errorMessage": { "type": "string", "nullable": true }, "conversionConfiguration": { "type": "array", "items": { "type": "string" }, "nullable": true }, "pages": { "type": "integer", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true } } }, "InvoiceProcessingCode": { "type": "object", "description": "", "properties": { "name": { "readOnly": true, "type": "string" }, "value": { "readOnly": true, "type": "integer" }, "error": { "readOnly": true, "type": "boolean" } } }, "InvoiceProvider": { "type": "object", "description": "", "properties": { "name": { "readOnly": true, "type": "string" }, "value": { "readOnly": true, "type": "string" } } }, "InvoiceSchemaType": { "type": "object", "description": "", "properties": { "name": { "readOnly": true, "type": "string" }, "value": { "readOnly": true, "type": "string" } } }, "InvoiceStatus": { "type": "object", "description": "", "properties": { "name": { "readOnly": true, "type": "string" }, "value": { "readOnly": true, "type": "string" } } }, "InvoiceTransfer.InvoiceTransferOutput": { "type": "object", "description": "", "properties": { "uuid": { "type": "string" }, "senderName": { "type": "string", "nullable": true }, "senderVatNumber": { "type": "string", "nullable": true }, "receiverName": { "type": "string", "nullable": true }, "receiverVatNumber": { "type": "string", "nullable": true }, "invoiceNumber": { "type": "string", "nullable": true }, "invoiceDate": { "type": "string", "nullable": true }, "invoiceType": { "type": "string", "nullable": true }, "invoiceNetAmount": { "type": "number", "nullable": true }, "invoiceVatAmount": { "type": "number", "nullable": true }, "invoiceTotAmount": { "type": "number", "nullable": true }, "originalFileName": { "type": "string", "nullable": true }, "reference": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "nullable": true }, "violations": { "type": "string", "nullable": true }, "sentAt": { "type": "string", "nullable": true }, "invoiceUuid": { "type": "string", "nullable": true } } }, "InvoiceTransfer.InvoiceTransferOutput.jsonld": { "type": "object", "description": "", "properties": { "@id": { "readOnly": true, "type": "string" }, "@type": { "readOnly": true, "type": "string" }, "@context": { "readOnly": true, "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "@vocab": { "type": "string" }, "hydra": { "type": "string", "enum": [ "http://www.w3.org/ns/hydra/core#" ] } }, "required": [ "@vocab", "hydra" ], "additionalProperties": true } ] }, "uuid": { "type": "string" }, "senderName": { "type": "string", "nullable": true }, "senderVatNumber": { "type": "string", "nullable": true }, "receiverName": { "type": "string", "nullable": true }, "receiverVatNumber": { "type": "string", "nullable": true }, "invoiceNumber": { "type": "string", "nullable": true }, "invoiceDate": { "type": "string", "nullable": true }, "invoiceType": { "type": "string", "nullable": true }, "invoiceNetAmount": { "type": "number", "nullable": true }, "invoiceVatAmount": { "type": "number", "nullable": true }, "invoiceTotAmount": { "type": "number", "nullable": true }, "originalFileName": { "type": "string", "nullable": true }, "reference": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "nullable": true }, "violations": { "type": "string", "nullable": true }, "sentAt": { "type": "string", "nullable": true }, "invoiceUuid": { "type": "string", "nullable": true } } }, "InvoiceType": { "type": "object", "description": "", "properties": { "name": { "readOnly": true, "type": "string" }, "value": { "readOnly": true, "type": "string" }, "correction": { "readOnly": true, "type": "boolean" } } }, "InvoicingMode": { "type": "object", "description": "", "properties": { "name": { "readOnly": true, "type": "string" }, "value": { "readOnly": true, "type": "string" } } }, "KodFormularzaAType": { "type": "object", "description": "", "properties": { "__value": { "readOnly": true }, "kodSystemowy": {}, "wersjaSchemy": {} } }, "LegalEntity.LegalEntityInput": { "type": "object", "description": "", "required": [ "name", "nip", "email", "addressLine1", "addressLine2", "postcode", "city", "countryIso2" ], "properties": { "name": { "description": "Name used to register the End User in the business registry of the jurisdiction where it is legally based.", "example": "Company name", "type": "string" }, "nip": { "description": "Legal entity NIP.", "example": "0000000000", "type": "string" }, "email": { "format": "email", "description": "Legal entity email.", "externalDocs": { "url": "http://schema.org/email" }, "type": "string" }, "url": { "description": "Legal entity URL.", "externalDocs": { "url": "http://schema.org/url" }, "example": "https://example.com", "type": "string", "nullable": true }, "addressLine1": { "description": "Legal entity address line 1.", "example": "ul. Street", "type": "string" }, "addressLine2": { "description": "Legal entity address line 2.", "example": "10/1", "type": "string" }, "postcode": { "description": "Legal entity postcode.", "example": "00-000", "type": "string" }, "province": { "description": "Legal entity province.", "example": "Province", "type": "string", "nullable": true }, "city": { "description": "Legal entity city.", "example": "City", "type": "string" }, "countryIso2": { "minLength": 2, "maxLength": 2, "description": "Country code ISO 3166-1 alpha-2 codes.", "example": "PL", "type": "string" }, "environment": { "enum": [ "DEMO", "PREPRODUCTION", "PRE-PRODUCTION", "PRE_PRODUCTION", "PRODUCTION", "SANDBOX", "TEST", "demo", "preproduction", "pre-production", "pre_production", "production", "sandbox", "test" ], "description": "KSeF environment for legal entity.", "example": "test", "type": "string", "nullable": true } } }, "LegalEntity.LegalEntityOutput": { "type": "object", "description": "", "properties": { "uuid": { "description": "Legal entity uuid.", "type": "string" }, "status": { "enum": [ "pending", "active", "blocked" ], "description": "Legal Entity status.", "type": "string" }, "name": { "description": "Name used to register the End User in the business registry of the jurisdiction where it is legally based.", "type": "string" }, "nip": { "description": "Legal entity NIP.", "type": "string" }, "email": { "description": "Legal entity email.", "type": "string" }, "url": { "description": "Legal entity url.", "type": "string", "nullable": true }, "addressLine1": { "description": "Legal entity address line 1.", "type": "string" }, "addressLine2": { "description": "Legal entity address line 2.", "type": "string" }, "postcode": { "description": "Legal entity zip code.", "type": "string" }, "province": { "description": "Legal entity province.", "type": "string", "nullable": true }, "city": { "description": "Legal entity city.", "type": "string" }, "countryIso2": { "description": "Country code ISO 3166-1 alpha-2 codes.", "type": "string" }, "authenticationType": { "enum": [ "token", "certificate" ], "description": "Authentication type.", "type": "string", "nullable": true }, "createdAt": { "description": "Legal entity created at.", "type": "string" }, "updatedAt": { "description": "Legal entity updated at.", "type": "string" }, "blockedAt": { "description": "Legal entity blocked at.", "type": "string", "nullable": true }, "authFlowUuid": { "description": "Authorization flow UUID.", "type": "string", "nullable": true }, "authFlowStatus": { "enum": [ "new", "in-progress", "used", "waiting-for-certificate", "completed", "failed", "cancelled" ], "description": "Authorization flow status.", "type": "string", "nullable": true }, "authFlowStatusDetails": { "description": "Authorization flow status details.", "type": "string", "nullable": true }, "authFlowIsValid": { "description": "Authorization flow is valid (is not expired).", "type": "boolean", "nullable": true }, "authFlowUrl": { "description": "Url to activate legal entity.", "type": "string", "nullable": true }, "authFlowDeadline": { "description": "Authorization flow deadline.", "type": "string", "nullable": true }, "authFlowCreatedAt": { "description": "Authorization flow created at.", "type": "string", "nullable": true }, "authFlowUpdatedAt": { "description": "Authorization flow updated at.", "type": "string", "nullable": true }, "isOfflineInvoicingEnabled": { "description": "Offline invoicing features enabled", "type": "boolean" }, "customer": { "description": "Customer data.", "$ref": "#/components/schemas/CustomerOutput" }, "environment": { "description": "KSeF Environment.", "type": "string" } } }, "LegalEntity.LegalEntityOutput.jsonld": { "type": "object", "description": "", "properties": { "@id": { "readOnly": true, "type": "string" }, "@type": { "readOnly": true, "type": "string" }, "@context": { "readOnly": true, "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "@vocab": { "type": "string" }, "hydra": { "type": "string", "enum": [ "http://www.w3.org/ns/hydra/core#" ] } }, "required": [ "@vocab", "hydra" ], "additionalProperties": true } ] }, "uuid": { "description": "Legal entity uuid.", "type": "string" }, "status": { "enum": [ "pending", "active", "blocked" ], "description": "Legal Entity status.", "type": "string" }, "name": { "description": "Name used to register the End User in the business registry of the jurisdiction where it is legally based.", "type": "string" }, "nip": { "description": "Legal entity NIP.", "type": "string" }, "email": { "description": "Legal entity email.", "type": "string" }, "url": { "description": "Legal entity url.", "type": "string", "nullable": true }, "addressLine1": { "description": "Legal entity address line 1.", "type": "string" }, "addressLine2": { "description": "Legal entity address line 2.", "type": "string" }, "postcode": { "description": "Legal entity zip code.", "type": "string" }, "province": { "description": "Legal entity province.", "type": "string", "nullable": true }, "city": { "description": "Legal entity city.", "type": "string" }, "countryIso2": { "description": "Country code ISO 3166-1 alpha-2 codes.", "type": "string" }, "authenticationType": { "enum": [ "token", "certificate" ], "description": "Authentication type.", "type": "string", "nullable": true }, "createdAt": { "description": "Legal entity created at.", "type": "string" }, "updatedAt": { "description": "Legal entity updated at.", "type": "string" }, "blockedAt": { "description": "Legal entity blocked at.", "type": "string", "nullable": true }, "authFlowUuid": { "description": "Authorization flow UUID.", "type": "string", "nullable": true }, "authFlowStatus": { "enum": [ "new", "in-progress", "used", "waiting-for-certificate", "completed", "failed", "cancelled" ], "description": "Authorization flow status.", "type": "string", "nullable": true }, "authFlowStatusDetails": { "description": "Authorization flow status details.", "type": "string", "nullable": true }, "authFlowIsValid": { "description": "Authorization flow is valid (is not expired).", "type": "boolean", "nullable": true }, "authFlowUrl": { "description": "Url to activate legal entity.", "type": "string", "nullable": true }, "authFlowDeadline": { "description": "Authorization flow deadline.", "type": "string", "nullable": true }, "authFlowCreatedAt": { "description": "Authorization flow created at.", "type": "string", "nullable": true }, "authFlowUpdatedAt": { "description": "Authorization flow updated at.", "type": "string", "nullable": true }, "isOfflineInvoicingEnabled": { "description": "Offline invoicing features enabled", "type": "boolean" }, "customer": { "description": "Customer data.", "$ref": "#/components/schemas/CustomerOutput.jsonld" }, "environment": { "description": "KSeF Environment.", "type": "string" } } }, "LegalEntity.NipValidateOutput": { "type": "object", "description": "", "properties": { "nips": { "description": "Array of nips.", "type": "array", "items": { "type": "string" } } } }, "LegalEntity.OfflineSettingsInput": { "type": "object", "description": "", "properties": { "enabled": { "description": "Enable or disable offline invoicing features", "example": true, "type": "boolean" }, "name": { "description": "Certificate name", "example": "My certificate for A-Cube", "type": "string", "nullable": true }, "serialNumber": { "description": "Certificate Serial Number", "example": "ABC123456789", "type": "string", "nullable": true }, "certificate": { "description": "Certificate in DER format base64 encoded", "example": "YmFzZTY0IGNlcnRpZmljYXRlIHN0cmluZw==", "type": "string", "nullable": true }, "privateKey": { "description": "Private Key in DER format base64 encoded", "example": "YmFzZTY0IHByaXZhdGUga2V5IHN0cmluZw==", "type": "string", "nullable": true }, "password": { "description": "Password for private key", "example": "bZBLS6uO8Xa7U12", "type": "string", "nullable": true } } }, "LegalEntity.SubAccountInput": { "type": "object", "description": "", "properties": { "email": { "format": "email", "description": "Email address of the sub-account user", "externalDocs": { "url": "http://schema.org/email" }, "type": "string" }, "fullname": { "description": "Full name of the sub-account user", "type": "string" }, "password": { "minLength": 10, "maxLength": 255, "pattern": "^((?=.*[A-Z])(?=.*[a-z])(?=.*[0-9])(?=.*[!@#\\$%\\^&\\*])(?=.{10,}).*)$", "description": "Password for the sub-account user. If the sub-account is already present on the system, the password this value will be ignored", "type": "string" } } }, "LegalEntity.SubAccountOutput": { "type": "object", "description": "", "properties": { "email": { "type": "string" } } }, "LegalEntity.SubAccountOutput.jsonld": { "type": "object", "description": "", "properties": { "@context": { "readOnly": true, "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "@vocab": { "type": "string" }, "hydra": { "type": "string", "enum": [ "http://www.w3.org/ns/hydra/core#" ] } }, "required": [ "@vocab", "hydra" ], "additionalProperties": true } ] }, "@id": { "readOnly": true, "type": "string" }, "@type": { "readOnly": true, "type": "string" }, "email": { "type": "string" } } }, "NoweSrodkiTransportuAType": { "type": "object", "description": "", "properties": { "p22": {}, "p425": {}, "nowySrodekTransportu": { "type": "array", "items": { "type": "string" }, "nullable": true }, "p22N": {}, "setNowySrodekTransportu": { "readOnly": true } } }, "NumberingSequence": { "type": "object", "description": "", "properties": { "uuid": { "type": "string", "nullable": true }, "ownerId": { "type": "integer" }, "sequenceName": { "type": "string" }, "year": { "type": "integer" }, "sequenceNumber": { "type": "integer" }, "sequenceFormat": { "default": "%s", "example": "%s", "type": "string" }, "lastDate": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, "NumberingSequence.NumberingSequenceCreateInput": { "type": "object", "description": "", "required": [ "name", "format" ], "properties": { "name": { "minLength": 3, "maxLength": 30, "type": "string" }, "format": { "pattern": "^(.*(%s|%0[1-9]s).*)$", "type": "string" }, "number": { "type": "string", "nullable": true } } }, "NumberingSequence.NumberingSequenceCreateInput.jsonld": { "type": "object", "description": "", "required": [ "name", "format" ], "properties": { "@context": { "readOnly": true, "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "@vocab": { "type": "string" }, "hydra": { "type": "string", "enum": [ "http://www.w3.org/ns/hydra/core#" ] } }, "required": [ "@vocab", "hydra" ], "additionalProperties": true } ] }, "@id": { "readOnly": true, "type": "string" }, "@type": { "readOnly": true, "type": "string" }, "name": { "minLength": 3, "maxLength": 30, "type": "string" }, "format": { "pattern": "^(.*(%s|%0[1-9]s).*)$", "type": "string" }, "number": { "type": "string", "nullable": true } } }, "NumberingSequence.NumberingSequenceOutput": { "type": "object", "description": "", "properties": { "uuid": { "type": "string" }, "name": { "type": "string" }, "year": { "type": "integer" }, "format": { "type": "string" }, "number": { "type": "integer" }, "last_date": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } } }, "NumberingSequence.NumberingSequenceOutput.jsonld": { "type": "object", "description": "", "properties": { "@id": { "readOnly": true, "type": "string" }, "@type": { "readOnly": true, "type": "string" }, "@context": { "readOnly": true, "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "@vocab": { "type": "string" }, "hydra": { "type": "string", "enum": [ "http://www.w3.org/ns/hydra/core#" ] } }, "required": [ "@vocab", "hydra" ], "additionalProperties": true } ] }, "uuid": { "type": "string" }, "name": { "type": "string" }, "year": { "type": "integer" }, "format": { "type": "string" }, "number": { "type": "integer" }, "last_date": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } } }, "NumberingSequence.jsonld": { "type": "object", "description": "", "properties": { "@id": { "readOnly": true, "type": "string" }, "@type": { "readOnly": true, "type": "string" }, "@context": { "readOnly": true, "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "@vocab": { "type": "string" }, "hydra": { "type": "string", "enum": [ "http://www.w3.org/ns/hydra/core#" ] } }, "required": [ "@vocab", "hydra" ], "additionalProperties": true } ] }, "uuid": { "type": "string", "nullable": true }, "ownerId": { "type": "integer" }, "sequenceName": { "type": "string" }, "year": { "type": "integer" }, "sequenceNumber": { "type": "integer" }, "sequenceFormat": { "default": "%s", "example": "%s", "type": "string" }, "lastDate": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, "OkresFaAType": { "type": "object", "description": "", "properties": { "p6Od": { "type": "string", "format": "date-time", "nullable": true }, "p6Do": { "type": "string", "format": "date-time", "nullable": true } } }, "OriginType": { "type": "object", "description": "", "properties": { "name": { "readOnly": true, "type": "string" }, "value": { "readOnly": true, "type": "string" } } }, "PMarzyAType": { "type": "object", "description": "", "properties": { "pPMarzy": {}, "pPMarzy2": {}, "pPMarzy31": {}, "pPMarzy32": {}, "pPMarzy33": {}, "pPMarzyN": {} } }, "PlatnoscAType": { "type": "object", "description": "", "properties": { "zaplacono": {}, "dataZaplaty": { "type": "string", "format": "date-time", "nullable": true }, "znacznikZaplatyCzesciowej": {}, "zaplataCzesciowa": { "type": "array", "items": { "type": "string" }, "nullable": true }, "terminPlatnosci": { "type": "array", "items": { "type": "string" }, "nullable": true }, "formaPlatnosci": {}, "platnoscInna": {}, "opisPlatnosci": {}, "rachunekBankowy": { "type": "array", "items": { "type": "string" }, "nullable": true }, "rachunekBankowyFaktora": { "type": "array", "items": { "type": "string" }, "nullable": true }, "skonto": { "anyOf": [ { "$ref": "#/components/schemas/SkontoAType" } ], "nullable": true }, "linkDoPlatnosci": {}, "iPKSeF": {}, "setZaplataCzesciowa": { "readOnly": true }, "setTerminPlatnosci": { "readOnly": true }, "setRachunekBankowy": { "readOnly": true }, "setRachunekBankowyFaktora": { "readOnly": true } } }, "Podmiot1AType": { "type": "object", "description": "", "properties": { "prefiksPodatnika": {}, "nrEORI": {}, "daneIdentyfikacyjne": { "$ref": "#/components/schemas/TPodmiot1Type" }, "adres": { "$ref": "#/components/schemas/TAdresType" }, "adresKoresp": { "anyOf": [ { "$ref": "#/components/schemas/AdresKorespAType" } ], "nullable": true }, "daneKontaktowe": { "type": "array", "items": { "type": "string" }, "nullable": true }, "statusInfoPodatnika": {}, "setDaneKontaktowe": { "readOnly": true } } }, "Podmiot1KAType": { "type": "object", "description": "", "properties": { "prefiksPodatnika": {}, "daneIdentyfikacyjne": { "$ref": "#/components/schemas/TPodmiot1Type" }, "adres": { "$ref": "#/components/schemas/TAdresType" } } }, "Podmiot2AType": { "type": "object", "description": "", "properties": { "nrEORI": {}, "daneIdentyfikacyjne": { "$ref": "#/components/schemas/TPodmiot2Type" }, "adres": { "anyOf": [ { "$ref": "#/components/schemas/TAdresType" } ], "nullable": true }, "adresKoresp": { "anyOf": [ { "$ref": "#/components/schemas/TAdresType" } ], "nullable": true }, "daneKontaktowe": { "type": "array", "items": { "type": "string" }, "nullable": true }, "nrKlienta": {}, "iDNabywcy": {}, "jST": {}, "gV": {}, "setDaneKontaktowe": { "readOnly": true } } }, "PodmiotUpowaznionyAType": { "type": "object", "description": "", "properties": { "nrEORI": {}, "daneIdentyfikacyjne": { "$ref": "#/components/schemas/TPodmiot1Type" }, "adres": { "$ref": "#/components/schemas/TAdresType" }, "adresKoresp": { "anyOf": [ { "$ref": "#/components/schemas/TAdresType" } ], "nullable": true }, "daneKontaktowe": { "type": "array", "items": { "type": "string" }, "nullable": true }, "rolaPU": {}, "setDaneKontaktowe": { "readOnly": true } } }, "RozliczenieAType": { "type": "object", "description": "", "properties": { "obciazenia": { "type": "array", "items": { "type": "string" }, "nullable": true }, "sumaObciazen": {}, "odliczenia": { "type": "array", "items": { "type": "string" }, "nullable": true }, "sumaOdliczen": {}, "doZaplaty": {}, "doRozliczenia": {}, "setObciazenia": { "readOnly": true }, "setOdliczenia": { "readOnly": true } } }, "SkontoAType": { "type": "object", "description": "", "properties": { "warunkiSkonta": {}, "wysokoscSkonta": {} } }, "StopkaAType": { "type": "object", "description": "", "properties": { "informacje": { "type": "array", "items": { "type": "string" }, "nullable": true }, "rejestry": { "type": "array", "items": { "type": "string" }, "nullable": true }, "setInformacje": { "readOnly": true }, "setRejestry": { "readOnly": true } } }, "SubjectType": { "type": "object", "description": "", "properties": { "name": { "readOnly": true, "type": "string" }, "value": { "readOnly": true, "type": "string" } } }, "TAdresType": { "type": "object", "description": "", "properties": { "kodKraju": {}, "adresL1": {}, "adresL2": {}, "gLN": {} } }, "TNaglowekType": { "type": "object", "description": "", "properties": { "kodFormularza": { "$ref": "#/components/schemas/KodFormularzaAType" }, "wariantFormularza": {}, "dataWytworzeniaFa": { "type": "string", "format": "date-time" }, "systemInfo": {} } }, "TPodmiot1Type": { "type": "object", "description": "", "properties": { "nIP": {}, "nazwa": {} } }, "TPodmiot2Type": { "type": "object", "description": "", "properties": { "nIP": {}, "kodUE": {}, "nrVatUE": {}, "kodKraju": {}, "nrID": {}, "brakID": {}, "nazwa": {} } }, "User.UserCheckOutput": { "type": "object", "description": "", "properties": { "result": { "enum": [ "OK", "already_existent_email" ], "description": "Check result", "default": "OK", "example": "OK", "type": "string" } } }, "User.UserCheckOutput.jsonld": { "type": "object", "description": "", "properties": { "@context": { "readOnly": true, "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "@vocab": { "type": "string" }, "hydra": { "type": "string", "enum": [ "http://www.w3.org/ns/hydra/core#" ] } }, "required": [ "@vocab", "hydra" ], "additionalProperties": true } ] }, "@id": { "readOnly": true, "type": "string" }, "@type": { "readOnly": true, "type": "string" }, "result": { "enum": [ "OK", "already_existent_email" ], "description": "Check result", "default": "OK", "example": "OK", "type": "string" } } }, "User.UserSetupInput": { "type": "object", "description": "", "properties": { "userId": { "description": "User ID", "type": "integer" }, "email": { "format": "email", "description": "User email", "externalDocs": { "url": "http://schema.org/email" }, "type": "string" } } }, "User.UserSetupInput.jsonld": { "type": "object", "description": "", "properties": { "@context": { "readOnly": true, "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "@vocab": { "type": "string" }, "hydra": { "type": "string", "enum": [ "http://www.w3.org/ns/hydra/core#" ] } }, "required": [ "@vocab", "hydra" ], "additionalProperties": true } ] }, "@id": { "readOnly": true, "type": "string" }, "@type": { "readOnly": true, "type": "string" }, "userId": { "description": "User ID", "type": "integer" }, "email": { "format": "email", "description": "User email", "externalDocs": { "url": "http://schema.org/email" }, "type": "string" } } }, "WarunkiTransakcjiAType": { "type": "object", "description": "", "properties": { "umowy": { "type": "array", "items": { "type": "string" }, "nullable": true }, "zamowienia": { "type": "array", "items": { "type": "string" }, "nullable": true }, "nrPartiiTowaru": { "type": "array", "items": { "type": "string" }, "nullable": true }, "warunkiDostawy": {}, "kursUmowny": {}, "walutaUmowna": {}, "transport": { "type": "array", "items": { "type": "string" }, "nullable": true }, "podmiotPosredniczacy": {}, "setUmowy": { "readOnly": true }, "setZamowienia": { "readOnly": true }, "setNrPartiiTowaru": { "readOnly": true }, "setTransport": { "readOnly": true } } }, "Webhook.WebhookInput": { "type": "object", "description": "", "required": [ "legalEntity", "webhookType", "webhookUrl" ], "properties": { "legalEntity": { "description": "Legal entity uuid.", "type": "string" }, "webhookType": { "enum": [ "onboarding", "invoice_receiving", "invoice_sending" ], "description": "Webhook type.", "type": "string" }, "webhookUrl": { "description": "Webhook url.", "type": "string" }, "authenticationType": { "enum": [ "header", "query" ], "description": "Webhook authentication type.", "type": "string", "nullable": true }, "authenticationKey": { "description": "The authentication key, in case of type header used as `Authorization: authentication_key authentication_token `", "type": "string", "nullable": true }, "authenticationToken": { "description": "The authentication token, in case of type header used as `Authorization: authentication_key authentication_token `", "type": "string", "nullable": true } } }, "Webhook.WebhookOutput": { "type": "object", "description": "", "properties": { "uuid": { "description": "Webhook UUID.", "type": "string" }, "legalEntityUuid": { "description": "Legal entity UUID.", "type": "string" }, "legalEntityName": { "description": "Legal entity name.", "type": "string" }, "webhookType": { "description": "Webhook type.", "type": "string" }, "webhookUrl": { "description": "Webhook URL.", "type": "string" }, "authenticationType": { "enum": [ "header", "query" ], "description": "Webhook authentication type.", "type": "string", "nullable": true }, "authenticationKey": { "description": "The authentication key, in case of type header used as `Authorization: authentication_key authentication_token `", "type": "string", "nullable": true }, "authenticationToken": { "description": "The authentication token, in case of type header used as `Authorization: authentication_key authentication_token `", "type": "string", "nullable": true } } }, "Webhook.WebhookOutput.jsonld": { "type": "object", "description": "", "properties": { "@context": { "readOnly": true, "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "@vocab": { "type": "string" }, "hydra": { "type": "string", "enum": [ "http://www.w3.org/ns/hydra/core#" ] } }, "required": [ "@vocab", "hydra" ], "additionalProperties": true } ] }, "@id": { "readOnly": true, "type": "string" }, "@type": { "readOnly": true, "type": "string" }, "uuid": { "description": "Webhook UUID.", "type": "string" }, "legalEntityUuid": { "description": "Legal entity UUID.", "type": "string" }, "legalEntityName": { "description": "Legal entity name.", "type": "string" }, "webhookType": { "description": "Webhook type.", "type": "string" }, "webhookUrl": { "description": "Webhook URL.", "type": "string" }, "authenticationType": { "enum": [ "header", "query" ], "description": "Webhook authentication type.", "type": "string", "nullable": true }, "authenticationKey": { "description": "The authentication key, in case of type header used as `Authorization: authentication_key authentication_token `", "type": "string", "nullable": true }, "authenticationToken": { "description": "The authentication token, in case of type header used as `Authorization: authentication_key authentication_token `", "type": "string", "nullable": true } } }, "ZamowienieAType": { "type": "object", "description": "", "properties": { "wartoscZamowienia": {}, "zamowienieWiersz": { "type": "array", "items": { "type": "string" } }, "setZamowienieWiersz": { "readOnly": true } } }, "ZwolnienieAType": { "type": "object", "description": "", "properties": { "p19": {}, "p19A": {}, "p19B": {}, "p19C": {}, "p19N": {} } }, "KsefInvoiceV3.Faktura": { "type": "object", "properties": { "Naglowek": { "description": "Nagłówek", "type": "object", "$ref": "#/components/schemas/KsefInvoiceV3.TNaglowekType" }, "Podmiot1": { "description": "Dane podatnika. Imię i nazwisko lub nazwa sprzedawcy towarów lub usług", "type": "object", "$ref": "#/components/schemas/KsefInvoiceV3FakturaFakturaAType.Podmiot1AType" }, "Podmiot2": { "description": "Dane nabywcy", "type": "object", "$ref": "#/components/schemas/KsefInvoiceV3FakturaFakturaAType.Podmiot2AType" }, "Podmiot3": { "description": "Dane podmiotu/-ów trzeciego/-ich (innego/-ych niż sprzedawca i nabywca wymieniony w części Podmiot2), związanego/-ych z fakturą", "type": "array", "items": { "$ref": "#/components/schemas/KsefInvoiceV3FakturaFakturaAType.Podmiot3AType" } }, "PodmiotUpowazniony": { "description": "Dane podmiotu upoważnionego, związanego z fakturą", "type": "object", "$ref": "#/components/schemas/KsefInvoiceV3FakturaFakturaAType.PodmiotUpowaznionyAType" }, "Fa": { "description": "Na podstawie art. 106a - 106q ustawy. Pola dotyczące wartości sprzedaży i podatku wypełnia się w walucie, w której wystawiono fakturę, z wyjątkiem pól dotyczących podatku przeliczonego zgodnie z przepisami działu VI w związku z art. 106e ust. 11 ustawy. W przypadku wystawienia faktury korygującej wypełnia się wszystkie pola wg stanu po korekcie, a pola dotyczące podstaw opodatkowania, podatku oraz należności ogółem wypełnia się poprzez różnicę", "type": "object", "$ref": "#/components/schemas/KsefInvoiceV3FakturaFakturaAType.FaAType" }, "Stopka": { "description": "Pozostałe dane na fakturze", "type": "object", "$ref": "#/components/schemas/KsefInvoiceV3FakturaFakturaAType.StopkaAType" }, "Zalacznik": { "description": "Załącznik do faktury VAT", "type": "array", "items": { "$ref": "#/components/schemas/KsefInvoiceV3FakturaFakturaATypeZalacznikAType.BlokDanychAType" } }, "xmlns": { "type": "string", "example": "http://crd.gov.pl/wzor/2025/06/25/13775/", "xml": { "attribute": true } } }, "xml": { "name": "Faktura" } }, "KsefInvoiceV3.Zalacznik": { "type": "object", "properties": { "Base64": { "description": "Treść base64.", "type": "string" }, "Filename": { "description": "Nazwa pliku.", "type": "string" }, "Extension": { "description": "Rozszerzenie.", "type": "string" }, "Filesize": { "description": "Rozmiar.", "type": "integer" } } }, "KsefInvoiceV3.TNaglowekType": { "type": "object", "properties": { "KodFormularza": { "description": "", "type": "object", "$ref": "#/components/schemas/KsefInvoiceV3TNaglowekType.KodFormularzaAType" }, "WariantFormularza": { "description": "", "type": "string" }, "DataWytworzeniaFa": { "description": "Data i czas wytworzenia faktury", "type": "string", "format": "date-time" }, "SystemInfo": { "description": "Nazwa systemu teleinformatycznego, z którego korzysta podatnik", "type": "string" } } }, "KsefInvoiceV3FakturaFakturaAType.Podmiot1AType": { "type": "object", "properties": { "PrefiksPodatnika": { "description": "Kod (prefiks) podatnika VAT UE dla przypadków określonych w art. 97 ust. 10 pkt 2 i 3 ustawy oraz w przypadku, o którym mowa w art. 136 ust. 1 pkt 3 ustawy", "type": "string" }, "NrEORI": { "description": "Numer EORI podatnika (sprzedawcy)", "type": "string" }, "DaneIdentyfikacyjne": { "description": "Dane identyfikujące podatnika", "type": "object", "$ref": "#/components/schemas/KsefInvoiceV3.TPodmiot1Type" }, "Adres": { "description": "Adres podatnika", "type": "object", "$ref": "#/components/schemas/KsefInvoiceV3.TAdresType" }, "AdresKoresp": { "description": "Adres korespondencyjny podatnika", "type": "object", "$ref": "#/components/schemas/KsefInvoiceV3FakturaFakturaATypePodmiot1AType.AdresKorespAType" }, "DaneKontaktowe": { "description": "Dane kontaktowe podatnika", "type": "array", "items": { "$ref": "#/components/schemas/KsefInvoiceV3FakturaFakturaATypePodmiot1AType.DaneKontaktoweAType" } }, "StatusInfoPodatnika": { "description": "Status podatnika", "type": "integer" } } }, "KsefInvoiceV3FakturaFakturaAType.Podmiot2AType": { "type": "object", "properties": { "NrEORI": { "description": "Numer EORI nabywcy towarów", "type": "string" }, "DaneIdentyfikacyjne": { "description": "Dane identyfikujące nabywcę", "type": "object", "$ref": "#/components/schemas/KsefInvoiceV3.TPodmiot2Type" }, "Adres": { "description": "Adres nabywcy. Pola opcjonalne dla przypadków określonych w art. 106e ust. 5 pkt 3 ustawy", "type": "object", "$ref": "#/components/schemas/KsefInvoiceV3.TAdresType" }, "AdresKoresp": { "description": "Adres korespondencyjny nabywcy", "type": "object", "$ref": "#/components/schemas/KsefInvoiceV3.TAdresType" }, "DaneKontaktowe": { "description": "Dane kontaktowe nabywcy", "type": "array", "items": { "$ref": "#/components/schemas/KsefInvoiceV3FakturaFakturaATypePodmiot2AType.DaneKontaktoweAType" } }, "NrKlienta": { "description": "Numer klienta dla przypadków, w których nabywca posługuje się nim w umowie lub zamówieniu", "type": "string" }, "IDNabywcy": { "description": "Unikalny klucz powiązania danych nabywcy na fakturach korygujących, w przypadku gdy dane nabywcy na fakturze korygującej zmieniły się w stosunku do danych na fakturze korygowanej", "type": "string" }, "JST": { "description": "Znacznik jednostki podrzędnej JST.Wartość \"1\" oznacza, że faktura dotyczy jednostki podrzędnej JST. W takim przypadku, aby udostępnić fakturę jednostce podrzędnej JST, należy wypełnić sekcję Podmiot3, w szczególności podać NIP lub ID-Wew i określić rolę jako 8. Wartość \"2\" oznacza, że faktura nie dotyczy jednostki podrzędnej JST", "type": "integer" }, "GV": { "description": "Znacznik członka grupy VAT. Wartość \"1\" oznacza, że faktura dotyczy członka grupy VAT. W takim przypadku, aby udostępnić fakturę członkowi grupy VAT, należy wypełnić sekcję Podmiot3, w szczególności podać NIP lub ID-Wew i określić rolę jako 10.Wartość \"2\" oznacza, że faktura nie dotyczy członka grupy VAT", "type": "integer" } } }, "KsefInvoiceV3FakturaFakturaAType.Podmiot3AType": { "type": "object", "properties": { "IDNabywcy": { "description": "Unikalny klucz powiązania danych nabywcy na fakturach korygujących, w przypadku gdy dane nabywcy na fakturze korygującej zmieniły się w stosunku do danych na fakturze korygowanej", "type": "string" }, "NrEORI": { "description": "Numer EORI podmiotu trzeciego", "type": "string" }, "DaneIdentyfikacyjne": { "description": "Dane identyfikujące podmiot trzeci", "type": "object", "$ref": "#/components/schemas/KsefInvoiceV3.TPodmiot3Type" }, "Adres": { "description": "Adres podmiotu trzeciego", "type": "object", "$ref": "#/components/schemas/KsefInvoiceV3.TAdresType" }, "AdresKoresp": { "description": "Adres korespondencyjny podmiotu trzeciego", "type": "object", "$ref": "#/components/schemas/KsefInvoiceV3.TAdresType" }, "DaneKontaktowe": { "description": "Dane kontaktowe podmiotu trzeciego", "type": "array", "items": { "$ref": "#/components/schemas/KsefInvoiceV3FakturaFakturaATypePodmiot3AType.DaneKontaktoweAType" } }, "Rola": { "description": "Rola podmiotu", "type": "integer" }, "RolaInna": { "description": "Znacznik innego podmiotu: 1 - Inny podmiot", "type": "string" }, "OpisRoli": { "description": "Opis roli podmiotu - w przypadku wyboru roli jako Inny podmiot", "type": "string" }, "Udzial": { "description": "Udział - procentowy udział dodatkowego nabywcy. Różnica pomiędzy wartością 100% a sumą udziałów dodatkowych nabywców jest udziałem nabywcy wymienionego w części Podmiot2. W przypadku niewypełnienia pola przyjmuje się, że udziały występujących na fakturze nabywców są równe", "type": "number" }, "NrKlienta": { "description": "Numer klienta dla przypadków, w których podmiot wymieniony jako podmiot trzeci posługuje się nim w umowie lub zamówieniu", "type": "string" } } }, "KsefInvoiceV3FakturaFakturaAType.PodmiotUpowaznionyAType": { "type": "object", "properties": { "NrEORI": { "description": "Numer EORI podmiotu upoważnionego", "type": "string" }, "DaneIdentyfikacyjne": { "description": "Dane identyfikujące podmiotu upoważnionego", "type": "object", "$ref": "#/components/schemas/KsefInvoiceV3.TPodmiot1Type" }, "Adres": { "description": "Adres podmiotu upoważnionego", "type": "object", "$ref": "#/components/schemas/KsefInvoiceV3.TAdresType" }, "AdresKoresp": { "description": "Adres korespondencyjny podmiotu upoważnionego", "type": "object", "$ref": "#/components/schemas/KsefInvoiceV3.TAdresType" }, "DaneKontaktowe": { "description": "Dane kontaktowe podmiotu upoważnionego", "type": "array", "items": { "$ref": "#/components/schemas/KsefInvoiceV3FakturaFakturaATypePodmiotUpowaznionyAType.DaneKontaktoweAType" } }, "RolaPU": { "description": "Rola podmiotu upoważnionego", "type": "integer" } } }, "KsefInvoiceV3FakturaFakturaAType.FaAType": { "type": "object", "properties": { "KodWaluty": { "description": "Kod waluty (ISO 4217)", "type": "string" }, "P1": { "description": "Data wystawienia, z zastrzeżeniem art. 106na ust. 1 ustawy", "type": "string", "format": "date-time" }, "P1M": { "description": "Miejsce wystawienia faktury", "type": "string" }, "P2": { "description": "Kolejny numer faktury, nadany w ramach jednej lub więcej serii, który w sposób jednoznaczny identyfikuje fakturę", "type": "string" }, "WZ": { "description": "Numery dokumentów magazynowych WZ (wydanie na zewnątrz) związane z fakturą", "type": "array", "items": { "type": "string" } }, "P6": { "description": "Data dokonania lub zakończenia dostawy towarów lub wykonania usługi lub data otrzymania zapłaty, o której mowa w art. 106b ust. 1 pkt 4 ustawy, o ile taka data jest określona i różni się od daty wystawienia faktury. Pole wypełnia się w przypadku, gdy dla wszystkich pozycji faktury data jest wspólna", "type": "string", "format": "date-time" }, "OkresFa": { "description": "Okres, którego dotyczy faktura - w przypadkach, o których mowa w art. 19a ust. 3 zdanie pierwsze i ust. 4 oraz ust. 5 pkt 4 ustawy", "type": "object", "$ref": "#/components/schemas/KsefInvoiceV3FakturaFakturaATypeFaAType.OkresFaAType" }, "P131": { "description": "Suma wartości sprzedaży netto objętej stawką podstawową - aktualnie 23% albo 22%. W przypadku faktur zaliczkowych - wartość zaliczki netto. W przypadku faktur korygujących - kwota różnicy, o której mowa w art. 106j ust. 2 pkt 5 ustawy", "type": "number" }, "P141": { "description": "Kwota podatku od sumy wartości sprzedaży netto objętej stawką podstawową - aktualnie 23% albo 22%. W przypadku faktur zaliczkowych - kwota podatku wyliczona według wzoru, o którym mowa w art. 106f ust. 1 pkt 3 ustawy. W przypadku faktur korygujących - kwota różnicy, o której mowa w art. 106j ust. 2 pkt 5 ustawy", "type": "number" }, "P141W": { "description": "W przypadku gdy faktura jest wystawiona w walucie obcej - kwota podatku od sumy wartości sprzedaży netto objętej stawką podstawową, przeliczona zgodnie z przepisami działu VI w związku z art. 106e ust. 11 ustawy - aktualnie 23% albo 22%. W przypadku faktur zaliczkowych - kwota podatku wyliczona według wzoru, o którym mowa w art. 106f ust. 1 pkt 3 ustawy. W przypadku faktur korygujących - kwota różnicy, o której mowa w art. 106j ust. 2 pkt 5 ustawy", "type": "number" }, "P132": { "description": "Suma wartości sprzedaży netto objętej stawką obniżoną pierwszą - aktualnie 8 % albo 7%. W przypadku faktur zaliczkowych - wartość zaliczki netto. W przypadku faktur korygujących - kwota różnicy, o której mowa w art. 106j ust. 2 pkt 5 ustawy", "type": "number" }, "P142": { "description": "Kwota podatku od sumy wartości sprzedaży netto objętej stawką obniżoną pierwszą - aktualnie 8% albo 7%. W przypadku faktur zaliczkowych - kwota podatku wyliczona według wzoru, o którym mowa w art. 106f ust. 1 pkt 3 ustawy. W przypadku faktur korygujących - kwota różnicy, o której mowa w art. 106j ust. 2 pkt 5 ustawy", "type": "number" }, "P142W": { "description": "W przypadku gdy faktura jest wystawiona w walucie obcej - kwota podatku od sumy wartości sprzedaży netto objętej stawką obniżoną pierwszą, przeliczona zgodnie z przepisami działu VI w związku z art. 106e ust. 11 ustawy - aktualnie 8% albo 7%. W przypadku faktur zaliczkowych - kwota podatku wyliczona według wzoru, o którym mowa w art. 106f ust. 1 pkt 3 ustawy. W przypadku faktur korygujących - kwota różnicy, o której mowa w art. 106j ust. 2 pkt 5 ustawy", "type": "number" }, "P133": { "description": "Suma wartości sprzedaży netto objętej stawką obniżoną drugą - aktualnie 5%. W przypadku faktur zaliczkowych - wartość zaliczki netto. W przypadku faktur korygujących - kwota różnicy, o której mowa w art. 106j ust. 2 pkt 5 ustawy", "type": "number" }, "P143": { "description": "Kwota podatku od sumy wartości sprzedaży netto objętej stawką obniżoną drugą - aktualnie 5%. W przypadku faktur zaliczkowych - kwota podatku wyliczona według wzoru, o którym mowa w art. 106f ust. 1 pkt 3 ustawy. W przypadku faktur korygujących - kwota różnicy, o której mowa w art. 106j ust. 2 pkt 5 ustawy", "type": "number" }, "P143W": { "description": "W przypadku gdy faktura jest wystawiona w walucie obcej - kwota podatku od sumy wartości sprzedaży netto objętej stawką obniżoną drugą, przeliczona zgodnie z przepisami działu VI w związku z art. 106e ust. 11 ustawy - aktualnie 5%. W przypadku faktur zaliczkowych - kwota podatku wyliczona według wzoru, o którym mowa w art. 106f ust. 1 pkt 3 ustawy. W przypadku faktur korygujących - kwota różnicy, o której mowa w art. 106j ust. 2 pkt 5 ustawy", "type": "number" }, "P134": { "description": "Suma wartości sprzedaży netto objętej ryczałtem dla taksówek osobowych. W przypadku faktur zaliczkowych - wartość zaliczki netto. W przypadku faktur korygujących - kwota różnicy, o której mowa w art. 106j ust. 2 pkt 5 ustawy", "type": "number" }, "P144": { "description": "Kwota podatku od sumy wartości sprzedaży netto w przypadku ryczałtu dla taksówek osobowych. W przypadku faktur zaliczkowych - kwota podatku wyliczona według wzoru, o którym mowa w art. 106f ust. 1 pkt 3 ustawy. W przypadku faktur korygujących - kwota różnicy, o której mowa w art. 106j ust. 2 pkt 5 ustawy", "type": "number" }, "P144W": { "description": "W przypadku gdy faktura jest wystawiona w walucie obcej - wysokość ryczałtu dla taksówek osobowych, przeliczona zgodnie z przepisami działu VI w związku z art. 106e ust. 11 ustawy. W przypadku faktur zaliczkowych - kwota podatku wyliczona według wzoru, o którym mowa w art. 106f ust. 1 pkt 3 ustawy. W przypadku faktur korygujących - kwota różnicy, o której mowa w art. 106j ust. 2 pkt 5 ustawy", "type": "number" }, "P135": { "description": "Suma wartości sprzedaży netto w przypadku procedury szczególnej, o której mowa w dziale XII w rozdziale 6a ustawy. W przypadku faktur zaliczkowych - wartość zaliczki netto. W przypadku faktur korygujących - kwota różnicy, o której mowa w art. 106j ust. 2 pkt 5 ustawy", "type": "number" }, "P145": { "description": "Kwota podatku od wartości dodanej w przypadku procedury szczególnej, o której mowa w dziale XII w rozdziale 6a ustawy. W przypadku faktur zaliczkowych - kwota podatku wyliczona według wzoru, o którym mowa w art. 106f ust. 1 pkt 3 ustawy. W przypadku faktur korygujących - kwota różnicy, o której mowa w art. 106j ust. 2 pkt 5 ustawy", "type": "number" }, "P1361": { "description": "Suma wartości sprzedaży objętej stawką 0% z wyłączeniem wewnątrzwspólnotowej dostawy towarów i eksportu. W przypadku faktur zaliczkowych - wartość zaliczki. W przypadku faktur korygujących - kwota różnicy, o której mowa w art. 106j ust. 2 pkt 5 ustawy", "type": "number" }, "P1362": { "description": "Suma wartości sprzedaży objętej stawką 0% w przypadku wewnątrzwspólnotowej dostawy towarów. W przypadku faktur korygujących - kwota różnicy, o której mowa w art. 106j ust. 2 pkt 5 ustawy", "type": "number" }, "P1363": { "description": "Suma wartości sprzedaży objętej stawką 0% w przypadku eksportu. W przypadku faktur zaliczkowych - wartość zaliczki. W przypadku faktur korygujących - kwota różnicy, o której mowa w art. 106j ust. 2 pkt 5 ustawy", "type": "number" }, "P137": { "description": "Suma wartości sprzedaży zwolnionej od podatku. W przypadku faktur zaliczkowych - wartość zaliczki. W przypadku faktur korygujących - kwota różnicy wartości sprzedaży", "type": "number" }, "P138": { "description": "Suma wartości sprzedaży w przypadku dostawy towarów oraz świadczenia usług poza terytorium kraju, z wyłączeniem kwot wykazanych w polach P_13_5 i P_13_9. W przypadku faktur zaliczkowych - wartość zaliczki. W przypadku faktur korygujących - kwota różnicy wartości sprzedaży", "type": "number" }, "P139": { "description": "Suma wartości świadczenia usług, o których mowa w art. 100 ust. 1 pkt 4 ustawy. W przypadku faktur zaliczkowych - wartość zaliczki. W przypadku faktur korygujących - kwota różnicy wartości sprzedaży", "type": "number" }, "P1310": { "description": "Suma wartości sprzedaży w procedurze odwrotnego obciążenia, dla której podatnikiem jest nabywca zgodnie z art. 17 ust. 1 pkt 7 i 8 ustawy oraz innych przypadków odwrotnego obciążenia występujących w obrocie krajowym. W przypadku faktur zaliczkowych - wartość zaliczki. W przypadku faktur korygujących - kwota różnicy, o której mowa w art. 106j ust. 2 pkt 5 ustawy", "type": "number" }, "P1311": { "description": "Suma wartości sprzedaży w procedurze marży, o której mowa w art. 119 i art. 120 ustawy. W przypadku faktur zaliczkowych - wartość zaliczki. W przypadku faktur korygujących - kwota różnicy wartości sprzedaży", "type": "number" }, "P15": { "description": "Kwota należności ogółem. W przypadku faktur zaliczkowych - kwota zapłaty dokumentowana fakturą. W przypadku faktur, o których mowa w art. 106f ust. 3 ustawy - kwota pozostała do zapłaty. W przypadku faktur korygujących - korekta kwoty wynikającej z faktury korygowanej. W przypadku, o którym mowa w art. 106j ust. 3 ustawy - korekta kwot wynikających z faktur korygowanych", "type": "number" }, "KursWalutyZ": { "description": "Kurs waluty stosowany do wyliczenia kwoty podatku w przypadkach, o których mowa w dziale VI ustawy na fakturach, o których mowa w art. 106b ust. 1 pkt 4 ustawy", "type": "number" }, "Adnotacje": { "description": "Inne adnotacje na fakturze", "type": "object", "$ref": "#/components/schemas/KsefInvoiceV3FakturaFakturaATypeFaAType.AdnotacjeAType" }, "RodzajFaktury": { "description": "Rodzaj faktury", "type": "string" }, "PrzyczynaKorekty": { "description": "Przyczyna korekty dla faktur korygujących", "type": "string" }, "TypKorekty": { "description": "Typ skutku korekty w ewidencji dla podatku od towarów i usług", "type": "integer" }, "DaneFaKorygowanej": { "description": "Dane faktury korygowanej", "type": "array", "items": { "$ref": "#/components/schemas/KsefInvoiceV3FakturaFakturaATypeFaAType.DaneFaKorygowanejAType" } }, "OkresFaKorygowanej": { "description": "Dla faktury korygującej, o której mowa w art. 106j ust. 3 ustawy - okres, do którego odnosi się udzielany opust lub udzielana obniżka, w przypadku gdy podatnik udziela opustu lub obniżki ceny w odniesieniu do dostaw towarów lub usług dokonanych lub świadczonych na rzecz jednego odbiorcy w danym okresie", "type": "string" }, "NrFaKorygowany": { "description": "Poprawny numer faktury korygowanej w przypadku, gdy przyczyną korekty jest błędny numer faktury korygowanej. W takim przypadku błędny numer faktury należy wskazać w polu NrFaKorygowanej", "type": "string" }, "Podmiot1K": { "description": "W przypadku korekty danych sprzedawcy należy podać pełne dane sprzedawcy występujące na fakturze korygowanej. Pole nie dotyczy przypadku korekty błędnego NIP występującego na fakturze pierwotnej - wówczas wymagana jest korekta faktury do wartości zerowych", "type": "object", "$ref": "#/components/schemas/KsefInvoiceV3FakturaFakturaATypeFaAType.Podmiot1KAType" }, "Podmiot2K": { "description": "W przypadku korekty danych nabywcy występującego jako Podmiot2 lub dodatkowego nabywcy występującego jako Podmiot3 należy podać pełne dane tego podmiotu występujące na fakturze korygowanej. Korekcie nie podlegają błędne numery NIP identyfikujące nabywcę oraz dodatkowego nabywcę - wówczas wymagana jest korekta faktury do wartości zerowych. W przypadku korygowania pozostałych danych nabywcy lub dodatkowego nabywcy wskazany numer identyfikacyjny ma być tożsamy z numerem w części Podmiot2 względnie Podmiot3 faktury korygującej", "type": "array", "items": { "$ref": "#/components/schemas/KsefInvoiceV3FakturaFakturaATypeFaAType.Podmiot2KAType" } }, "P15ZK": { "description": "W przypadku korekt faktur zaliczkowych - kwota zapłaty przed korektą. W przypadku korekt faktur, o których mowa w art. 106f ust. 3 ustawy - kwota pozostała do zapłaty przed korektą", "type": "number" }, "KursWalutyZK": { "description": "Kurs waluty stosowany do wyliczenia kwoty podatku w przypadkach, o których mowa w dziale VI ustawy przed korektą", "type": "number" }, "ZaliczkaCzesciowa": { "description": "Dane dla przypadków faktur dokumentujących otrzymanie więcej niż jednej płatności, o której mowa w art. 106b ust. 1 pkt 4 ustawy. W przypadku, gdy faktura, o której mowa w art. 106f ust. 3 ustawy dokumentuje jednocześnie otrzymanie części zapłaty przed dokonaniem czynności, różnica kwoty w polu P_15 i sumy poszczególnych pól P_15Z stanowi kwotę pozostałą ponad płatności otrzymane przed wykonaniem czynności udokumentowanej fakturą", "type": "array", "items": { "$ref": "#/components/schemas/KsefInvoiceV3FakturaFakturaATypeFaAType.ZaliczkaCzesciowaAType" } }, "FP": { "description": "Faktura, o której mowa w art. 109 ust. 3d ustawy", "type": "string" }, "TP": { "description": "Istniejące powiązania między nabywcą a dokonującym dostawy towarów lub usługodawcą, zgodnie z § 10 ust. 4 pkt 3, z zastrzeżeniem ust. 4b rozporządzenia w sprawie szczegółowego zakresu danych zawartych w deklaracjach podatkowych i w ewidencji w zakresie podatku od towarów i usług", "type": "string" }, "DodatkowyOpis": { "description": "Pola przeznaczone dla wykazywania dodatkowych danych na fakturze, w tym wymaganych przepisami prawa, dla których nie przewidziano innych pól/elementów", "type": "array", "items": { "$ref": "#/components/schemas/KsefInvoiceV3.TKluczWartoscType" } }, "FakturaZaliczkowa": { "description": "Numery faktur zaliczkowych lub ich numery KSeF, jeśli zostały wystawione z użyciem KSeF", "type": "array", "items": { "$ref": "#/components/schemas/KsefInvoiceV3FakturaFakturaATypeFaAType.FakturaZaliczkowaAType" } }, "ZwrotAkcyzy": { "description": "Informacja dodatkowa niezbędna dla rolników ubiegających się o zwrot podatku akcyzowego zawartego w cenie oleju napędowego", "type": "string" }, "FaWiersz": { "description": "Szczegółowe pozycje faktury w walucie, w której wystawiono fakturę - węzeł opcjonalny dla faktury zaliczkowej, faktury korygującej fakturę zaliczkową oraz faktur korygujących dotyczących wszystkich dostaw towarów lub usług dokonanych lub świadczonych w danym okresie, o których mowa w art. 106j ust. 3 ustawy, dla których należy podać dane dotyczące opustu lub obniżki w podziale na stawki podatku i procedury w części Fa. W przypadku faktur korygujących, o których mowa w art. 106j ust. 3 ustawy, gdy opust lub obniżka ceny odnosi się do części dostaw towarów lub usług dokonanych lub świadczonych w danym okresie w części FaWiersz należy podać nazwy (rodzaje) towarów lub usług objętych korektą. W przypadku faktur, o których mowa w art. 106f ust. 3 ustawy, należy wykazać pełne wartości zamówienia lub umowy. W przypadku faktur korygujących pozycje faktury (w tym faktur korygujących faktury, o których mowa w art. 106f ust. 3 ustawy, jeśli korekta dotyczy wartości zamówienia) należy wykazać różnice wynikające z korekty poszczególnych pozycji lub dane pozycji korygowanych wg stanu przed korektą i po korekcie jako osobne wiersze. W przypadku faktur korygujących faktury, o których mowa w art. 106f ust. 3 ustawy, jeśli korekta nie dotyczy wartości zamówienia i jednocześnie zmienia wysokość podstawy opodatkowania lub podatku, należy wprowadzić zapis wg stanu przed korektą i zapis wg stanu po korekcie w celu potwierdzenia braku zmiany wartości danej pozycji faktury", "type": "array", "items": { "$ref": "#/components/schemas/KsefInvoiceV3FakturaFakturaATypeFaAType.FaWierszAType" } }, "Rozliczenie": { "description": "Dodatkowe rozliczenia na fakturze", "type": "object", "$ref": "#/components/schemas/KsefInvoiceV3FakturaFakturaATypeFaAType.RozliczenieAType" }, "Platnosc": { "description": "Warunki płatności", "type": "object", "$ref": "#/components/schemas/KsefInvoiceV3FakturaFakturaATypeFaAType.PlatnoscAType" }, "WarunkiTransakcji": { "description": "Warunki transakcji, o ile występują", "type": "object", "$ref": "#/components/schemas/KsefInvoiceV3FakturaFakturaATypeFaAType.WarunkiTransakcjiAType" }, "Zamowienie": { "description": "Zamówienie lub umowa, o których mowa w art. 106f ust. 1 pkt 4 ustawy (dla faktur zaliczkowych), w walucie, w której wystawiono fakturę zaliczkową. W przypadku faktury korygującej fakturę zaliczkową należy wykazać różnice wynikające z korekty poszczególnych pozycji zamówienia lub umowy lub dane pozycji korygowanych wg stanu przed korektą i po korekcie jako osobne wiersze, jeśli korekta dotyczy wartości zamówienia lub umowy. W przypadku faktur korygujących faktury zaliczkowe, jeśli korekta nie dotyczy wartości zamówienia lub umowy i jednocześnie zmienia wysokość podstawy opodatkowania lub podatku, należy wprowadzić zapis wg stanu przed korektą i zapis wg stanu po korekcie w celu potwierdzenia braku zmiany wartości danej pozycji", "type": "object", "$ref": "#/components/schemas/KsefInvoiceV3FakturaFakturaATypeFaAType.ZamowienieAType" } } }, "KsefInvoiceV3FakturaFakturaAType.StopkaAType": { "type": "object", "properties": { "Informacje": { "description": "Pozostałe dane", "type": "array", "items": { "$ref": "#/components/schemas/KsefInvoiceV3FakturaFakturaATypeStopkaAType.InformacjeAType" } }, "Rejestry": { "description": "Numery podmiotu lub grupy podmiotów w innych rejestrach i bazach danych", "type": "array", "items": { "$ref": "#/components/schemas/KsefInvoiceV3FakturaFakturaATypeStopkaAType.RejestryAType" } } } }, "KsefInvoiceV3FakturaFakturaATypeZalacznikAType.BlokDanychAType": { "type": "object", "properties": { "ZNaglowek": { "description": "Nagłówek bloku danych", "type": "string" }, "MetaDane": { "description": "Dane opisowe", "type": "array", "items": { "$ref": "#/components/schemas/KsefInvoiceV3FakturaFakturaATypeZalacznikATypeBlokDanychAType.MetaDaneAType" } }, "Tekst": { "description": "Część tekstowa bloku danych", "type": "array", "items": { "type": "string" } }, "Tabela": { "description": "Tabele", "type": "array", "items": { "$ref": "#/components/schemas/KsefInvoiceV3FakturaFakturaATypeZalacznikATypeBlokDanychAType.TabelaAType" } } } }, "KsefInvoiceV3TNaglowekType.KodFormularzaAType": { "type": "object", "properties": { "__value": { "description": "", "type": "string" }, "KodSystemowy": { "description": "", "type": "string" }, "WersjaSchemy": { "description": "", "type": "string" } } }, "KsefInvoiceV3.TPodmiot1Type": { "type": "object", "properties": { "NIP": { "description": "Identyfikator podatkowy NIP", "type": "string" }, "Nazwa": { "description": "Imię i nazwisko lub nazwa", "type": "string" } } }, "KsefInvoiceV3.TAdresType": { "type": "object", "properties": { "KodKraju": { "description": "Kod Kraju [Country Code]", "type": "string" }, "AdresL1": { "description": "Adres [Address]", "type": "string" }, "AdresL2": { "description": "Adres [Address]", "type": "string" }, "GLN": { "description": "Globalny Numer Lokalizacyjny [Global Location Number]", "type": "string" } } }, "KsefInvoiceV3FakturaFakturaATypePodmiot1AType.AdresKorespAType": { "type": "object", "properties": { "KodKraju": { "description": "Kod Kraju [Country Code]", "type": "string" }, "AdresL1": { "description": "Adres [Address]", "type": "string" }, "AdresL2": { "description": "Adres [Address]", "type": "string" }, "GLN": { "description": "Globalny Numer Lokalizacyjny [Global Location Number]", "type": "string" } } }, "KsefInvoiceV3FakturaFakturaATypePodmiot1AType.DaneKontaktoweAType": { "type": "object", "properties": { "Email": { "description": "Adres e-mail podatnika", "type": "string" }, "Telefon": { "description": "Numer telefonu podatnika", "type": "string" } } }, "KsefInvoiceV3.TPodmiot2Type": { "type": "object", "properties": { "NIP": { "description": "Identyfikator podatkowy NIP", "type": "string" }, "KodUE": { "description": "Kod (prefiks) nabywcy VAT UE, o którym mowa w art. 106e ust. 1 pkt 24 ustawy oraz w przypadku, o którym mowa w art. 136 ust. 1 pkt 4 ustawy", "type": "string" }, "NrVatUE": { "description": "Numer Identyfikacyjny VAT kontrahenta UE", "type": "string" }, "KodKraju": { "description": "Kod kraju nadania identyfikatora podatkowego", "type": "string" }, "NrID": { "description": "Identyfikator podatkowy inny", "type": "string" }, "BrakID": { "description": "Podmiot nie posiada identyfikatora podatkowego lub identyfikator nie występuje na fakturze: 1- tak", "type": "string" }, "Nazwa": { "description": "Imię i nazwisko lub nazwa", "type": "string" } } }, "KsefInvoiceV3FakturaFakturaATypePodmiot2AType.DaneKontaktoweAType": { "type": "object", "properties": { "Email": { "description": "Adres e-mail nabywcy", "type": "string" }, "Telefon": { "description": "Numer telefonu nabywcy", "type": "string" } } }, "KsefInvoiceV3.TPodmiot3Type": { "type": "object", "properties": { "NIP": { "description": "Identyfikator podatkowy NIP", "type": "string" }, "IDWew": { "description": "Identyfikator wewnętrzny z NIP", "type": "string" }, "KodUE": { "description": "Kod (prefiks) nabywcy VAT UE, o którym mowa w art. 106e ust. 1 pkt 24 ustawy oraz w przypadku, o którym mowa w art. 136 ust. 1 pkt 4 ustawy", "type": "string" }, "NrVatUE": { "description": "Numer Identyfikacyjny VAT kontrahenta UE", "type": "string" }, "KodKraju": { "description": "Kod kraju nadania identyfikatora podatkowego", "type": "string" }, "NrID": { "description": "Identyfikator podatkowy inny", "type": "string" }, "BrakID": { "description": "Podmiot nie posiada identyfikatora podatkowego lub identyfikator nie występuje na fakturze: 1- tak", "type": "string" }, "Nazwa": { "description": "Imię i nazwisko lub nazwa", "type": "string" } } }, "KsefInvoiceV3FakturaFakturaATypePodmiot3AType.DaneKontaktoweAType": { "type": "object", "properties": { "Email": { "description": "Adres e-mail podmiotu trzeciego", "type": "string" }, "Telefon": { "description": "Numer telefonu podmiotu trzeciego", "type": "string" } } }, "KsefInvoiceV3FakturaFakturaATypePodmiotUpowaznionyAType.DaneKontaktoweAType": { "type": "object", "properties": { "EmailPU": { "description": "Adres e-mail podmiotu upoważnionego", "type": "string" }, "TelefonPU": { "description": "Numer telefonu podmiotu upoważnionego", "type": "string" } } }, "KsefInvoiceV3FakturaFakturaATypeFaAType.OkresFaAType": { "type": "object", "properties": { "P6Od": { "description": "Data początkowa okresu, którego dotyczy faktura", "type": "string", "format": "date-time" }, "P6Do": { "description": "Data końcowa okresu, którego dotyczy faktura - data dokonania lub zakończenia dostawy towarów lub wykonania usługi", "type": "string", "format": "date-time" } } }, "KsefInvoiceV3FakturaFakturaATypeFaAType.AdnotacjeAType": { "type": "object", "properties": { "P16": { "description": "W przypadku dostawy towarów lub świadczenia usług, w odniesieniu do których obowiązek podatkowy powstaje zgodnie z art. 19a ust. 5 pkt 1 lub art. 21 ust. 1 ustawy - wyrazy \"metoda kasowa\"; należy podać wartość \"1\", w przeciwnym przypadku - wartość \"2\"", "type": "string" }, "P17": { "description": "W przypadku faktur, o których mowa w art. 106d ust. 1 ustawy - wyraz \"samofakturowanie\"; należy podać wartość \"1\", w przeciwnym przypadku - wartość \"2\"", "type": "string" }, "P18": { "description": "W przypadku dostawy towarów lub wykonania usługi, dla których obowiązanym do rozliczenia podatku od wartości dodanej lub podatku o podobnym charakterze jest nabywca towaru lub usługi - wyrazy \"odwrotne obciążenie\"; należy podać wartość \"1\", w przeciwnym przypadku - wartość \"2\"", "type": "string" }, "P18A": { "description": "W przypadku faktur, w których kwota należności ogółem przekracza kwotę 15 000 zł lub jej równowartość wyrażoną w walucie obcej, obejmującychdokonaną na rzecz podatnika dostawę towarów lub świadczenie usług, o których mowa w załączniku nr 15 do ustawy - wyrazy \"mechanizm podzielonej płatności\", przy czym do przeliczania na złote kwot wyrażonych w walucie obcej stosuje się zasady przeliczania kwot stosowane w celu określenia podstawy opodatkowania; należy podać wartość \"1\", w przeciwnym przypadku - wartość \"2\"", "type": "string" }, "Zwolnienie": { "description": "", "type": "object", "$ref": "#/components/schemas/KsefInvoiceV3FakturaFakturaATypeFaATypeAdnotacjeAType.ZwolnienieAType" }, "NoweSrodkiTransportu": { "description": "", "type": "object", "$ref": "#/components/schemas/KsefInvoiceV3FakturaFakturaATypeFaATypeAdnotacjeAType.NoweSrodkiTransportuAType" }, "P23": { "description": "W przypadku faktur wystawianych w procedurze uproszczonej przez drugiego w kolejności podatnika, o którym mowa w art. 135 ust. 1 pkt 4 lit. b i c oraz ust. 2 ustawy, zawierającej adnotację, o której mowa w art. 136 ust. 1 pkt 1 ustawy i stwierdzenie, o którym mowa w art. 136 ust. 1 pkt 2 ustawy, należy podać wartość \"1\", w przeciwnym przypadku - wartość \"2\"", "type": "string" }, "PMarzy": { "description": "", "type": "object", "$ref": "#/components/schemas/KsefInvoiceV3FakturaFakturaATypeFaATypeAdnotacjeAType.PMarzyAType" } } }, "KsefInvoiceV3FakturaFakturaATypeFaAType.DaneFaKorygowanejAType": { "type": "object", "properties": { "DataWystFaKorygowanej": { "description": "Data wystawienia faktury korygowanej", "type": "string", "format": "date-time" }, "NrFaKorygowanej": { "description": "Numer faktury korygowanej", "type": "string" }, "NrKSeF": { "description": "Znacznik numeru KSeF faktury korygowanej", "type": "string" }, "NrKSeFFaKorygowanej": { "description": "Numer identyfikujący fakturę korygowaną w KSeF", "type": "string" }, "NrKSeFN": { "description": "Znacznik faktury korygowanej wystawionej poza KSeF", "type": "string" } } }, "KsefInvoiceV3FakturaFakturaATypeFaAType.Podmiot1KAType": { "type": "object", "properties": { "PrefiksPodatnika": { "description": "Kod (prefiks) podatnika VAT UE dla przypadków określonych w art. 97 ust. 10 pkt 2 i 3 ustawy oraz w przypadku, o którym mowa w art. 136 ust. 1 pkt 3 ustawy", "type": "string" }, "DaneIdentyfikacyjne": { "description": "Dane identyfikujące podatnika", "type": "object", "$ref": "#/components/schemas/KsefInvoiceV3.TPodmiot1Type" }, "Adres": { "description": "Adres podatnika", "type": "object", "$ref": "#/components/schemas/KsefInvoiceV3.TAdresType" } } }, "KsefInvoiceV3FakturaFakturaATypeFaAType.Podmiot2KAType": { "type": "object", "properties": { "DaneIdentyfikacyjne": { "description": "Dane identyfikujące nabywcę", "type": "object", "$ref": "#/components/schemas/KsefInvoiceV3.TPodmiot2Type" }, "Adres": { "description": "Adres nabywcy. Pola opcjonalne dla przypadków określonych w art. 106e ust. 5 pkt 3 ustawy", "type": "object", "$ref": "#/components/schemas/KsefInvoiceV3.TAdresType" }, "IDNabywcy": { "description": "Unikalny klucz powiązania danych nabywcy na fakturach korygujących, w przypadku gdy dane nabywcy na fakturze korygującej zmieniły się w stosunku do danych na fakturze korygowanej", "type": "string" } } }, "KsefInvoiceV3FakturaFakturaATypeFaAType.ZaliczkaCzesciowaAType": { "type": "object", "properties": { "P6Z": { "description": "Data otrzymania płatności, o której mowa w art. 106b ust. 1 pkt 4 ustawy", "type": "string", "format": "date-time" }, "P15Z": { "description": "Kwota płatności, o której mowa w art. 106b ust. 1 pkt 4 ustawy, składająca się na kwotę w polu P_15. W przypadku faktur korygujących - korekta kwoty wynikającej z faktury korygowanej", "type": "number" }, "KursWalutyZW": { "description": "Kurs waluty stosowany do wyliczenia kwoty podatku w przypadkach, o których mowa w dziale VI ustawy", "type": "number" } } }, "KsefInvoiceV3.TKluczWartoscType": { "type": "object", "properties": { "NrWiersza": { "description": "Numer wiersza podany w polu NrWierszaFa lub NrWierszaZam, jeśli informacja odnosi się wyłącznie do danej pozycji faktury", "type": "integer" }, "Klucz": { "description": "Klucz", "type": "string" }, "Wartosc": { "description": "Wartość", "type": "string" } } }, "KsefInvoiceV3FakturaFakturaATypeFaAType.FakturaZaliczkowaAType": { "type": "object", "properties": { "NrKSeFZN": { "description": "Znacznik faktury zaliczkowej wystawionej poza KSeF", "type": "string" }, "NrFaZaliczkowej": { "description": "Numer faktury zaliczkowej wystawionej poza KSeF. Pole obowiązkowe dla faktury wystawianej po wydaniu towaru lub wykonaniu usługi, o której mowa w art. 106f ust. 3 ustawy i ostatniej z faktur, o której mowa w art. 106f ust. 4 ustawy", "type": "string" }, "NrKSeFFaZaliczkowej": { "description": "Numer identyfikujący fakturę zaliczkową w KSeF. Pole obowiązkowe w przypadku, gdy faktura zaliczkowa była wystawiona za pomocą KSeF", "type": "string" } } }, "KsefInvoiceV3FakturaFakturaATypeFaAType.FaWierszAType": { "type": "object", "properties": { "NrWierszaFa": { "description": "Kolejny numer wiersza faktury", "type": "integer" }, "UUID": { "description": "Uniwersalny unikalny numer wiersza faktury", "type": "string" }, "P6A": { "description": "Data dokonania lub zakończenia dostawy towarów lub wykonania usługi lub data otrzymania zapłaty, o której mowa w art. 106b ust. 1 pkt 4 ustawy, o ile taka data jest określona i różni się od daty wystawienia faktury. Pole wypełnia się w przypadku gdy dla poszczególnych pozycji faktury występują różne daty", "type": "string", "format": "date-time" }, "P7": { "description": "Nazwa (rodzaj) towaru lub usługi. Pole opcjonalne wyłącznie dla przypadku określonego w art 106j ust. 3 pkt 2 ustawy (faktura korygująca)", "type": "string" }, "Indeks": { "description": "Pole przeznaczone do wpisania wewnętrznego kodu towaru lub usługi nadanego przez podatnika albo dodatkowego opisu", "type": "string" }, "GTIN": { "description": "Globalny numer jednostki handlowej", "type": "string" }, "PKWiU": { "description": "Symbol Polskiej Klasyfikacji Wyrobów i Usług", "type": "string" }, "CN": { "description": "Symbol Nomenklatury Scalonej", "type": "string" }, "PKOB": { "description": "Symbol Polskiej Klasyfikacji Obiektów Budowlanych", "type": "string" }, "P8A": { "description": "Miara dostarczonych towarów lub zakres wykonanych usług. Pole opcjonalne dla przypadku określonego w art. 106e ust. 5 pkt 3 ustawy", "type": "string" }, "P8B": { "description": "Ilość (liczba) dostarczonych towarów lub zakres wykonanych usług. Pole opcjonalne dla przypadku określonego w art. 106e ust. 5 pkt 3 ustawy", "type": "number" }, "P9A": { "description": "Cena jednostkowa towaru lub usługi bez kwoty podatku (cena jednostkowa netto). Pole opcjonalne dla przypadków określonych w art. 106e ust. 2 i 3 oraz ust. 5 pkt 3 ustawy", "type": "number" }, "P9B": { "description": "Cena wraz z kwotą podatku (cena jednostkowa brutto), w przypadku zastosowania art. 106e ust. 7 i 8 ustawy", "type": "number" }, "P10": { "description": "Kwoty wszelkich opustów lub obniżek cen, w tym w formie rabatu z tytułu wcześniejszej zapłaty, o ile nie zostały one uwzględnione w cenie jednostkowej netto, a w przypadku stosowania art. 106e ust. 7 ustawy w cenie jednostkowej brutto. Pole opcjonalne dla przypadków określonych w art. 106e ust. 2 i 3 oraz ust. 5 pkt 1 ustawy", "type": "number" }, "P11": { "description": "Wartość dostarczonych towarów lub wykonanych usług, objętych transakcją, bez kwoty podatku (wartość sprzedaży netto). Pole opcjonalne dla przypadków określonych w art. 106e ust. 2 i 3 oraz ust. 5 pkt 3 ustawy", "type": "number" }, "P11A": { "description": "Wartość sprzedaży brutto, w przypadku zastosowania art. 106e ust. 7 i 8 ustawy", "type": "number" }, "P11Vat": { "description": "Kwota podatku w przypadku, o którym mowa w art. 106e ust. 10 ustawy", "type": "number" }, "P12": { "description": "Stawka podatku. Pole opcjonalne dla przypadków określonych w art. 106e ust. 2, 3, ust. 4 pkt 3 i ust. 5 pkt 3 ustawy", "type": "string" }, "P12XII": { "description": "Stawka podatku od wartości dodanej w przypadku, o którym mowa w dziale XII w rozdziale 6a ustawy", "type": "number" }, "P12Zal15": { "description": "Znacznik dla towaru lub usługi wymienionych w załączniku nr 15 do ustawy - wartość \"1\"", "type": "string" }, "KwotaAkcyzy": { "description": "Kwota podatku akcyzowego zawarta w cenie towaru", "type": "number" }, "GTU": { "description": "Oznaczenie dotyczące dostawy towarów i świadczenia usług", "type": "string" }, "Procedura": { "description": "Oznaczenie dotyczące procedury", "type": "string" }, "KursWaluty": { "description": "Kurs waluty stosowany do wyliczenia kwoty podatku w przypadkach, o których mowa w dziale VI ustawy", "type": "number" }, "StanPrzed": { "description": "Znacznik stanu przed korektą w przypadku faktury korygującej lub faktury korygującej fakturę wystawioną w związku z art. 106f ust. 3 ustawy, w przypadku gdy korekta dotyczy danych wykazanych w pozycjach faktury i jest dokonywana w sposób polegający na wykazaniu danych przed korektą i po korekcie jako osobnych wierszy z odrębną numeracją oraz w przypadku potwierdzania braku zmiany wartości danej pozycji", "type": "string" } } }, "KsefInvoiceV3FakturaFakturaATypeFaAType.RozliczenieAType": { "type": "object", "properties": { "Obciazenia": { "description": "Obciążenia", "type": "array", "items": { "$ref": "#/components/schemas/KsefInvoiceV3FakturaFakturaATypeFaATypeRozliczenieAType.ObciazeniaAType" } }, "SumaObciazen": { "description": "Suma obciążeń", "type": "number" }, "Odliczenia": { "description": "Odliczenia", "type": "array", "items": { "$ref": "#/components/schemas/KsefInvoiceV3FakturaFakturaATypeFaATypeRozliczenieAType.OdliczeniaAType" } }, "SumaOdliczen": { "description": "Suma odliczeń", "type": "number" }, "DoZaplaty": { "description": "Kwota należności do zapłaty równa polu P_15 powiększonemu o Obciazenia i pomniejszonemu o Odliczenia", "type": "number" }, "DoRozliczenia": { "description": "Kwota nadpłacona do rozliczenia/zwrotu", "type": "number" } } }, "KsefInvoiceV3FakturaFakturaATypeFaAType.PlatnoscAType": { "type": "object", "properties": { "Zaplacono": { "description": "Znacznik informujący, że należność wynikająca z faktury została zapłacona: 1 - zapłacono", "type": "string" }, "DataZaplaty": { "description": "Data zapłaty, jeśli do wystawienia faktury płatność została dokonana", "type": "string", "format": "date-time" }, "ZnacznikZaplatyCzesciowej": { "description": "Znacznik informujący, że należność wynikająca z faktury została zapłacona w części lub w całości: 1 - zapłacono w części; 2 - zapłacono w całości, jeśli należność wynikająca z faktury została zapłacona w dwóch lub więcej częściach, a ostatnia płatność jest płatnością końcową", "type": "string" }, "ZaplataCzesciowa": { "description": "Dane zapłat częściowych", "type": "array", "items": { "$ref": "#/components/schemas/KsefInvoiceV3FakturaFakturaATypeFaATypePlatnoscAType.ZaplataCzesciowaAType" } }, "TerminPlatnosci": { "description": "", "type": "array", "items": { "$ref": "#/components/schemas/KsefInvoiceV3FakturaFakturaATypeFaATypePlatnoscAType.TerminPlatnosciAType" } }, "FormaPlatnosci": { "description": "Forma płatności", "type": "integer" }, "PlatnoscInna": { "description": "Znacznik innej formy płatności: 1 - inna forma płatności", "type": "string" }, "OpisPlatnosci": { "description": "Uszczegółowienie innej formy płatności", "type": "string" }, "RachunekBankowy": { "description": "Numer rachunku", "type": "array", "items": { "$ref": "#/components/schemas/KsefInvoiceV3.TRachunekBankowyType" } }, "RachunekBankowyFaktora": { "description": "Rachunek faktora", "type": "array", "items": { "$ref": "#/components/schemas/KsefInvoiceV3.TRachunekBankowyType" } }, "Skonto": { "description": "Skonto", "type": "object", "$ref": "#/components/schemas/KsefInvoiceV3FakturaFakturaATypeFaATypePlatnoscAType.SkontoAType" }, "LinkDoPlatnosci": { "description": "Link do płatności bezgotówkowej", "type": "string" }, "IPKSeF": { "description": "Identyfikator płatności Krajowego Systemu e-Faktur", "type": "string" } } }, "KsefInvoiceV3FakturaFakturaATypeFaAType.WarunkiTransakcjiAType": { "type": "object", "properties": { "Umowy": { "description": "", "type": "array", "items": { "$ref": "#/components/schemas/KsefInvoiceV3FakturaFakturaATypeFaATypeWarunkiTransakcjiAType.UmowyAType" } }, "Zamowienia": { "description": "", "type": "array", "items": { "$ref": "#/components/schemas/KsefInvoiceV3FakturaFakturaATypeFaATypeWarunkiTransakcjiAType.ZamowieniaAType" } }, "NrPartiiTowaru": { "description": "Numery partii towaru", "type": "array", "items": { "type": "string" } }, "WarunkiDostawy": { "description": "Warunki dostawy towarów - w przypadku istnienia pomiędzy stronami transakcji, umowy określającej warunki dostawy tzw. Incoterms", "type": "string" }, "KursUmowny": { "description": "Kurs umowny - w przypadkach, gdy na fakturze znajduje się informacja o kursie, po którym zostały przeliczone kwoty wykazane na fakturze w złotych. Nie dotyczy przypadków, o których mowa w dziale VI ustawy", "type": "number" }, "WalutaUmowna": { "description": "Waluta umowna - kod waluty (ISO-4217) w przypadkach gdy na fakturze znajduje się informacja o kursie, po którym zostały przeliczone kwoty wykazane na fakturze w złotych. Nie dotyczy przypadków, o których mowa w dziale VI ustawy", "type": "string" }, "Transport": { "description": "", "type": "array", "items": { "$ref": "#/components/schemas/KsefInvoiceV3FakturaFakturaATypeFaATypeWarunkiTransakcjiAType.TransportAType" } }, "PodmiotPosredniczacy": { "description": "Wartość \"1\" oznacza dostawę dokonaną przez podmiot, o którym mowa w art. 22 ust. 2d ustawy. Pole dotyczy przypadku, w którym podmiot uczestniczy w transakcji łańcuchowej innej niż procedura trójstronna uproszczona, o której mowa w art. 135 ust. 1 pkt 4 ustawy", "type": "string" } } }, "KsefInvoiceV3FakturaFakturaATypeFaAType.ZamowienieAType": { "type": "object", "properties": { "WartoscZamowienia": { "description": "Wartość zamówienia lub umowy z uwzględnieniem kwoty podatku", "type": "number" }, "ZamowienieWiersz": { "description": "Szczegółowe pozycje zamówienia lub umowy w walucie, w której wystawiono fakturę zaliczkową", "type": "array", "items": { "$ref": "#/components/schemas/KsefInvoiceV3FakturaFakturaATypeFaATypeZamowienieAType.ZamowienieWierszAType" } } } }, "KsefInvoiceV3FakturaFakturaATypeStopkaAType.InformacjeAType": { "type": "object", "properties": { "StopkaFaktury": { "description": "Stopka faktury", "type": "string" } } }, "KsefInvoiceV3FakturaFakturaATypeStopkaAType.RejestryAType": { "type": "object", "properties": { "PelnaNazwa": { "description": "Pełna nazwa", "type": "string" }, "KRS": { "description": "KRS", "type": "string" }, "REGON": { "description": "REGON", "type": "string" }, "BDO": { "description": "BDO", "type": "string" } } }, "KsefInvoiceV3FakturaFakturaATypeZalacznikATypeBlokDanychAType.MetaDaneAType": { "type": "object", "properties": { "ZKlucz": { "description": "Klucz", "type": "string" }, "ZWartosc": { "description": "Wartość", "type": "string" } } }, "KsefInvoiceV3FakturaFakturaATypeZalacznikATypeBlokDanychAType.TabelaAType": { "type": "object", "properties": { "TMetaDane": { "description": "Dane opisowe dotyczące tabeli", "type": "array", "items": { "$ref": "#/components/schemas/KsefInvoiceV3FakturaFakturaATypeZalacznikATypeBlokDanychATypeTabelaAType.TMetaDaneAType" } }, "Opis": { "description": "Opis", "type": "string" }, "TNaglowek": { "description": "Nagłówek tabeli", "type": "array", "items": { "$ref": "#/components/schemas/KsefInvoiceV3FakturaFakturaATypeZalacznikATypeBlokDanychATypeTabelaATypeTNaglowekAType.KolAType" } }, "Wiersz": { "description": "Wiersze tabeli", "type": "array", "items": { "type": "string" } }, "Suma": { "description": "Podsumowania tabeli", "type": "array", "items": { "type": "string" } } } }, "KsefInvoiceV3FakturaFakturaATypeFaATypeAdnotacjeAType.ZwolnienieAType": { "type": "object", "properties": { "P19": { "description": "Znacznik dostawy towarów lub świadczenia usług zwolnionych od podatku na podstawie art. 43 ust. 1 ustawy, art. 113 ust. 1 i 9 ustawy albo przepisów wydanych na podstawie art. 82 ust. 3 ustawy lub na podstawie innych przepisów", "type": "string" }, "P19A": { "description": "Jeśli pole P_19 równa się \"1\" - należy wskazać przepis ustawy albo aktu wydanego na podstawie ustawy, na podstawie którego podatnik stosuje zwolnienie od podatku", "type": "string" }, "P19B": { "description": "Jeśli pole P_19 równa się \"1\" - należy wskazać przepis dyrektywy 2006/112/WE, który zwalnia od podatku taką dostawę towarów lub takie świadczenie usług", "type": "string" }, "P19C": { "description": "Jeśli pole P_19 równa się \"1\" - należy wskazać inną podstawę prawną wskazującą na to, że dostawa towarów lub świadczenie usług korzysta ze zwolnienia od podatku", "type": "string" }, "P19N": { "description": "Znacznik braku dostawy towarów lub świadczenia usług zwolnionych od podatku na podstawie art. 43 ust. 1 ustawy, art. 113 ust. 1 i 9 ustawy albo przepisów wydanych na podstawie art. 82 ust. 3 ustawy lub na podstawie innych przepisów", "type": "string" } } }, "KsefInvoiceV3FakturaFakturaATypeFaATypeAdnotacjeAType.NoweSrodkiTransportuAType": { "type": "object", "properties": { "P22": { "description": "Znacznik wewnątrzwspólnotowej dostawy nowych środków transportu", "type": "string" }, "P425": { "description": "Jeśli występuje obowiązek, o którym mowa w art. 42 ust. 5 ustawy, należy podać wartość \"1\", w przeciwnym przypadku - wartość \"2\"", "type": "string" }, "NowySrodekTransportu": { "description": "", "type": "array", "items": { "$ref": "#/components/schemas/KsefInvoiceV3FakturaFakturaATypeFaATypeAdnotacjeATypeNoweSrodkiTransportuAType.NowySrodekTransportuAType" } }, "P22N": { "description": "Znacznik braku wewnątrzwspólnotowej dostawy nowych środków transportu", "type": "string" } } }, "KsefInvoiceV3FakturaFakturaATypeFaATypeAdnotacjeAType.PMarzyAType": { "type": "object", "properties": { "PPMarzy": { "description": "Znacznik wystąpienia procedur marży, o których mowa w art. 119 lub art. 120 ustawy", "type": "string" }, "PPMarzy2": { "description": "Znacznik świadczenia usług turystyki, dla których podstawę opodatkowania stanowi marża, zgodnie z art. 119 ust. 1 ustawy, a faktura dokumentująca świadczenie zawiera wyrazy \"procedura marży dla biur podróży\"", "type": "string" }, "PPMarzy31": { "description": "Znacznik dostawy towarów używanych, dla których podstawę opodatkowania stanowi marża, zgodnie z art. 120 ustawy, a faktura dokumentująca dostawę zawiera wyrazy \"procedura marży - towary używane\"", "type": "string" }, "PPMarzy32": { "description": "Znacznik dostawy dzieł sztuki, dla których podstawę opodatkowania stanowi marża, zgodnie z art. 120 ustawy, a faktura dokumentująca dostawę zawiera wyrazy \"procedura marży - dzieła sztuki\"", "type": "string" }, "PPMarzy33": { "description": "Znacznik dostawy przedmiotów kolekcjonerskich i antyków, dla których podstawę opodatkowania stanowi marża, zgodnie z art. 120 ustawy, a faktura dokumentująca dostawę zawiera wyrazy \"procedura marży - przedmioty kolekcjonerskie i antyki\"", "type": "string" }, "PPMarzyN": { "description": "Znacznik braku wystąpienia procedur marży, o których mowa w art. 119 lub art. 120 ustawy", "type": "string" } } }, "KsefInvoiceV3FakturaFakturaATypeFaATypeRozliczenieAType.ObciazeniaAType": { "type": "object", "properties": { "Kwota": { "description": "Kwota doliczona do kwoty wykazanej w polu P_15", "type": "number" }, "Powod": { "description": "Powód obciążenia", "type": "string" } } }, "KsefInvoiceV3FakturaFakturaATypeFaATypeRozliczenieAType.OdliczeniaAType": { "type": "object", "properties": { "Kwota": { "description": "Kwota odliczona od kwoty wykazanej w polu P_15", "type": "number" }, "Powod": { "description": "Powód odliczenia", "type": "string" } } }, "KsefInvoiceV3FakturaFakturaATypeFaATypePlatnoscAType.ZaplataCzesciowaAType": { "type": "object", "properties": { "KwotaZaplatyCzesciowej": { "description": "Kwota zapłaty częściowej", "type": "number" }, "DataZaplatyCzesciowej": { "description": "Data zapłaty częściowej, jeśli do wystawienia faktury płatność częściowa została dokonana", "type": "string", "format": "date-time" }, "FormaPlatnosci": { "description": "Forma płatności", "type": "integer" }, "PlatnoscInna": { "description": "Znacznik innej formy płatności: 1 - inna forma płatności", "type": "string" }, "OpisPlatnosci": { "description": "Uszczegółowienie innej formy płatności", "type": "string" } } }, "KsefInvoiceV3FakturaFakturaATypeFaATypePlatnoscAType.TerminPlatnosciAType": { "type": "object", "properties": { "Termin": { "description": "Termin płatności", "type": "string", "format": "date-time" }, "TerminOpis": { "description": "Opis terminu płatności", "type": "object", "$ref": "#/components/schemas/KsefInvoiceV3FakturaFakturaATypeFaATypePlatnoscATypeTerminPlatnosciAType.TerminOpisAType" } } }, "KsefInvoiceV3.TRachunekBankowyType": { "type": "object", "properties": { "NrRB": { "description": "Pełny numer rachunku", "type": "string" }, "SWIFT": { "description": "Kod SWIFT", "type": "string" }, "RachunekWlasnyBanku": { "description": "Rachunek własny", "type": "integer" }, "NazwaBanku": { "description": "Nazwa", "type": "string" }, "OpisRachunku": { "description": "Opis rachunku", "type": "string" } } }, "KsefInvoiceV3FakturaFakturaATypeFaATypePlatnoscAType.SkontoAType": { "type": "object", "properties": { "WarunkiSkonta": { "description": "Warunki, które nabywca powinien spełnić, aby skorzystać ze skonta", "type": "string" }, "WysokoscSkonta": { "description": "Wysokość skonta", "type": "string" } } }, "KsefInvoiceV3FakturaFakturaATypeFaATypeWarunkiTransakcjiAType.UmowyAType": { "type": "object", "properties": { "DataUmowy": { "description": "Data umowy", "type": "string", "format": "date-time" }, "NrUmowy": { "description": "Numer umowy", "type": "string" } } }, "KsefInvoiceV3FakturaFakturaATypeFaATypeWarunkiTransakcjiAType.ZamowieniaAType": { "type": "object", "properties": { "DataZamowienia": { "description": "Data zamówienia", "type": "string", "format": "date-time" }, "NrZamowienia": { "description": "Numer zamówienia", "type": "string" } } }, "KsefInvoiceV3FakturaFakturaATypeFaATypeWarunkiTransakcjiAType.TransportAType": { "type": "object", "properties": { "RodzajTransportu": { "description": "Rodzaj zastosowanego transportu w przypadku dokonanej dostawy towarów", "type": "integer" }, "TransportInny": { "description": "Znacznik innego rodzaju transportu: 1 - inny rodzaj transportu", "type": "string" }, "OpisInnegoTransportu": { "description": "Opis innego rodzaju transportu", "type": "string" }, "Przewoznik": { "description": "", "type": "object", "$ref": "#/components/schemas/KsefInvoiceV3FakturaFakturaATypeFaATypeWarunkiTransakcjiATypeTransportAType.PrzewoznikAType" }, "NrZleceniaTransportu": { "description": "Numer zlecenia transportu", "type": "string" }, "OpisLadunku": { "description": "Rodzaj ładunku", "type": "integer" }, "LadunekInny": { "description": "Znacznik innego ładunku: 1 - inny ładunek", "type": "string" }, "OpisInnegoLadunku": { "description": "Opis innego ładunku, w tym ładunek mieszany", "type": "string" }, "JednostkaOpakowania": { "description": "Jednostka opakowania", "type": "string" }, "DataGodzRozpTransportu": { "description": "Data i godzina rozpoczęcia transportu", "type": "string", "format": "date-time" }, "DataGodzZakTransportu": { "description": "Data i godzina zakończenia transportu", "type": "string", "format": "date-time" }, "WysylkaZ": { "description": "Adres miejsca wysyłki", "type": "object", "$ref": "#/components/schemas/KsefInvoiceV3.TAdresType" }, "WysylkaPrzez": { "description": "Adres pośredni wysyłki", "type": "array", "items": { "$ref": "#/components/schemas/KsefInvoiceV3.TAdresType" } }, "WysylkaDo": { "description": "Adres miejsca docelowego, do którego został zlecony transport", "type": "object", "$ref": "#/components/schemas/KsefInvoiceV3.TAdresType" } } }, "KsefInvoiceV3FakturaFakturaATypeFaATypeZamowienieAType.ZamowienieWierszAType": { "type": "object", "properties": { "NrWierszaZam": { "description": "Kolejny numer wiersza zamówienia lub umowy", "type": "integer" }, "UUIDZ": { "description": "Uniwersalny unikalny numer wiersza zamówienia lub umowy", "type": "string" }, "P7Z": { "description": "Nazwa (rodzaj) towaru lub usługi", "type": "string" }, "IndeksZ": { "description": "Pole przeznaczone do wpisania wewnętrznego kodu towaru lub usługi nadanego przez podatnika albo dodatkowego opisu", "type": "string" }, "GTINZ": { "description": "Globalny numer jednostki handlowej", "type": "string" }, "PKWiUZ": { "description": "Symbol Polskiej Klasyfikacji Wyrobów i Usług", "type": "string" }, "CNZ": { "description": "Symbol Nomenklatury Scalonej", "type": "string" }, "PKOBZ": { "description": "Symbol Polskiej Klasyfikacji Obiektów Budowlanych", "type": "string" }, "P8AZ": { "description": "Miara zamówionego towaru lub zakres usługi", "type": "string" }, "P8BZ": { "description": "Ilość zamówionego towaru lub zakres usługi", "type": "number" }, "P9AZ": { "description": "Cena jednostkowa netto", "type": "number" }, "P11NettoZ": { "description": "Wartość zamówionego towaru lub usługi bez kwoty podatku", "type": "number" }, "P11VatZ": { "description": "Kwota podatku od zamówionego towaru lub usługi", "type": "number" }, "P12Z": { "description": "Stawka podatku", "type": "string" }, "P12ZXII": { "description": "Stawka podatku od wartości dodanej w przypadku, o którym mowa w dziale XII w rozdziale 6a ustawy", "type": "number" }, "P12ZZal15": { "description": "Znacznik dla towaru lub usługi wymienionych w załączniku nr 15 do ustawy - wartość \"1\"", "type": "string" }, "GTUZ": { "description": "Oznaczenie dotyczące dostawy towarów i świadczenia usług", "type": "string" }, "ProceduraZ": { "description": "Oznaczenia dotyczące procedur", "type": "string" }, "KwotaAkcyzyZ": { "description": "Kwota podatku akcyzowego zawarta w cenie towaru", "type": "number" }, "StanPrzedZ": { "description": "Znacznik stanu przed korektą w przypadku faktury korygującej fakturę dokumentującą otrzymanie zapłaty lub jej części przed dokonaniem czynności oraz fakturę wystawioną w związku z art. 106f ust. 4 ustawy (faktura korygująca fakturę zaliczkową), w przypadku gdy korekta dotyczy danych wykazanych w pozycjach zamówienia i jest dokonywana w sposób polegający na wykazaniu danych przed korektą i po korekcie jako osobnych wierszy z odrębną numeracją oraz w przypadku potwierdzania braku zmiany wartości danej pozycji", "type": "string" } } }, "KsefInvoiceV3FakturaFakturaATypeZalacznikATypeBlokDanychATypeTabelaAType.TMetaDaneAType": { "type": "object", "properties": { "TKlucz": { "description": "Klucz", "type": "string" }, "TWartosc": { "description": "Wartość", "type": "string" } } }, "KsefInvoiceV3FakturaFakturaATypeZalacznikATypeBlokDanychATypeTabelaATypeTNaglowekAType.KolAType": { "type": "object", "properties": { "Typ": { "description": "", "type": "string" }, "NKom": { "description": "Zawartość pola", "type": "string" } } }, "KsefInvoiceV3FakturaFakturaATypeFaATypeAdnotacjeATypeNoweSrodkiTransportuAType.NowySrodekTransportuAType": { "type": "object", "properties": { "P22A": { "description": "Data dopuszczenia nowego środka transportu do użytku", "type": "string", "format": "date-time" }, "PNrWierszaNST": { "description": "Numer wiersza faktury, w którym wykazano dostawę nowego środka transportu", "type": "integer" }, "P22BMK": { "description": "Marka nowego środka transportu", "type": "string" }, "P22BMD": { "description": "Model nowego środka transportu", "type": "string" }, "P22BK": { "description": "Kolor nowego środka transportu", "type": "string" }, "P22BNR": { "description": "Numer rejestracyjny nowego środka transportu", "type": "string" }, "P22BRP": { "description": "Rok produkcji nowego środka transportu", "type": "string" }, "P22B": { "description": "Jeśli dostawa dotyczy pojazdów lądowych, o których mowa w art. 2 pkt 10 lit. a ustawy, należy podać przebieg pojazdu", "type": "string" }, "P22B1": { "description": "Jeśli dostawa dotyczy pojazdów lądowych, o których mowa w art. 2 pkt 10 lit. a ustawy, można podać numer VIN", "type": "string" }, "P22B2": { "description": "Jeśli dostawa dotyczy pojazdów lądowych, o których mowa w art. 2 pkt 10 lit. a ustawy, można podać numer nadwozia", "type": "string" }, "P22B3": { "description": "Jeśli dostawa dotyczy pojazdów lądowych, o których mowa w art. 2 pkt 10 lit. a ustawy, można podać numer podwozia", "type": "string" }, "P22B4": { "description": "Jeśli dostawa dotyczy pojazdów lądowych, o których mowa w art. 2 pkt 10 lit. a ustawy, można podać numer ramy", "type": "string" }, "P22BT": { "description": "Jeśli dostawa dotyczy pojazdów lądowych, o których mowa w art. 2 pkt 10 lit. a ustawy, można podać typ nowego środka transportu", "type": "string" }, "P22C": { "description": "Jeśli dostawa dotyczy jednostek pływających, o których mowa w art. 2 pkt 10 lit. b ustawy, należy podać liczbę godzin roboczych używania nowego środka transportu", "type": "string" }, "P22C1": { "description": "Jeśli dostawa dotyczy jednostek pływających, o których mowa w art. 2 pkt 10 lit. b ustawy, można podać numer kadłuba nowego środka transportu", "type": "string" }, "P22D": { "description": "Jeśli dostawa dotyczy statków powietrznych, o których mowa w art. 2 pkt 10 lit. c ustawy, należy podać liczbę godzin roboczych używania nowego środka transportu", "type": "string" }, "P22D1": { "description": "Jeśli dostawa dotyczy statków powietrznych, o których mowa w art. 2 pkt 10 lit. c ustawy, można podać numer fabryczny nowego środka transportu", "type": "string" } } }, "KsefInvoiceV3FakturaFakturaATypeFaATypePlatnoscATypeTerminPlatnosciAType.TerminOpisAType": { "type": "object", "properties": { "Ilosc": { "description": "", "type": "integer" }, "Jednostka": { "description": "", "type": "string" }, "ZdarzeniePoczatkowe": { "description": "", "type": "string" } } }, "KsefInvoiceV3FakturaFakturaATypeFaATypeWarunkiTransakcjiATypeTransportAType.PrzewoznikAType": { "type": "object", "properties": { "DaneIdentyfikacyjne": { "description": "Dane identyfikacyjne przewoźnika", "type": "object", "$ref": "#/components/schemas/KsefInvoiceV3.TPodmiot2Type" }, "AdresPrzewoznika": { "description": "Adres przewoźnika", "type": "object", "$ref": "#/components/schemas/KsefInvoiceV3.TAdresType" } } }, "KsefInvoiceV3.Root": { "type": "object", "properties": { "Faktura": { "description": "Obiekt faktury.", "type": "object", "$ref": "#/components/schemas/KsefInvoiceV3.Faktura" }, "Zalacznik": { "description": "Lista załączników.", "type": "array", "items": { "$ref": "#/components/schemas/KsefInvoiceV3.Zalacznik" } } } } }, "responses": {}, "parameters": {}, "examples": {}, "requestBodies": {}, "headers": {}, "securitySchemes": { "bearerAuth": { "type": "http", "description": "Received from Platform Authentication.", "scheme": "bearer", "bearerFormat": "JWT" } } }, "security": [ { "Bearer": [] } ], "tags": [] }