{ "openapi": "3.1.0", "info": { "title": "A-Cube SK Api", "description": "A-Cube SK API set to manage electronic invoices for Slovak taxpayers", "version": "1.0.0-beta.1", "x-logo": { "url": "https://assets.acubeapi.com/logo_rect_white.png" } }, "servers": [ { "url": "https://sk-sandbox.api.acubeapi.com", "description": "A-Cube GOV SK API sandbox environment" }, { "url": "https://sk.api.acubeapi.com", "description": "A-Cube GOV SK API production environment", "x-production": "hide" } ], "paths": { "/credit-notes": { "get": { "operationId": "api_credit-notes_get_collection", "tags": [ "CreditNote" ], "responses": { "200": { "description": "CreditNote collection", "content": { "application/ld+json": { "schema": { "type": "object", "description": "CreditNote.CreditNoteOutput.jsonld collection.", "allOf": [ { "$ref": "#/components/schemas/HydraCollectionBaseSchema" }, { "type": "object", "required": [ "hydra:member" ], "properties": { "hydra:member": { "type": "array", "items": { "$ref": "#/components/schemas/CreditNote.CreditNoteOutput.jsonld" } } } } ] } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CreditNote.CreditNoteOutput" } } } } }, "403": { "description": "Forbidden", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} } }, "summary": "Retrieves the collection of CreditNote resources.", "description": "Retrieves the collection of CreditNote resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": true }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "schema": { "type": "integer", "default": 30, "minimum": 0, "maximum": 30 }, "style": "form", "explode": true }, { "name": "createdAt[gt]", "in": "query", "description": "CreditNote createdAt", "required": false, "deprecated": false, "schema": { "type": "object", "properties": { "gt": { "type": "string" }, "gte": { "type": "string" }, "lt": { "type": "string" }, "lte": { "type": "string" }, "ne": { "type": "string" } } }, "style": "form", "explode": true }, { "name": "createdAt[gte]", "in": "query", "description": "CreditNote createdAt", "required": false, "deprecated": false, "schema": { "type": "object", "properties": { "gt": { "type": "string" }, "gte": { "type": "string" }, "lt": { "type": "string" }, "lte": { "type": "string" }, "ne": { "type": "string" } } }, "style": "form", "explode": true }, { "name": "createdAt[lt]", "in": "query", "description": "CreditNote createdAt", "required": false, "deprecated": false, "schema": { "type": "object", "properties": { "gt": { "type": "string" }, "gte": { "type": "string" }, "lt": { "type": "string" }, "lte": { "type": "string" }, "ne": { "type": "string" } } }, "style": "form", "explode": true }, { "name": "createdAt[lte]", "in": "query", "description": "CreditNote createdAt", "required": false, "deprecated": false, "schema": { "type": "object", "properties": { "gt": { "type": "string" }, "gte": { "type": "string" }, "lt": { "type": "string" }, "lte": { "type": "string" }, "ne": { "type": "string" } } }, "style": "form", "explode": true }, { "name": "createdAt[ne]", "in": "query", "description": "CreditNote createdAt", "required": false, "deprecated": false, "schema": { "type": "object", "properties": { "gt": { "type": "string" }, "gte": { "type": "string" }, "lt": { "type": "string" }, "lte": { "type": "string" }, "ne": { "type": "string" } } }, "style": "form", "explode": true }, { "name": "creditNoteDate[gt]", "in": "query", "description": "CreditNote creditNoteDate", "required": false, "deprecated": false, "schema": { "type": "object", "properties": { "gt": { "type": "string" }, "gte": { "type": "string" }, "lt": { "type": "string" }, "lte": { "type": "string" }, "ne": { "type": "string" } } }, "style": "form", "explode": true }, { "name": "creditNoteDate[gte]", "in": "query", "description": "CreditNote creditNoteDate", "required": false, "deprecated": false, "schema": { "type": "object", "properties": { "gt": { "type": "string" }, "gte": { "type": "string" }, "lt": { "type": "string" }, "lte": { "type": "string" }, "ne": { "type": "string" } } }, "style": "form", "explode": true }, { "name": "creditNoteDate[lt]", "in": "query", "description": "CreditNote creditNoteDate", "required": false, "deprecated": false, "schema": { "type": "object", "properties": { "gt": { "type": "string" }, "gte": { "type": "string" }, "lt": { "type": "string" }, "lte": { "type": "string" }, "ne": { "type": "string" } } }, "style": "form", "explode": true }, { "name": "creditNoteDate[lte]", "in": "query", "description": "CreditNote creditNoteDate", "required": false, "deprecated": false, "schema": { "type": "object", "properties": { "gt": { "type": "string" }, "gte": { "type": "string" }, "lt": { "type": "string" }, "lte": { "type": "string" }, "ne": { "type": "string" } } }, "style": "form", "explode": true }, { "name": "creditNoteDate[ne]", "in": "query", "description": "CreditNote creditNoteDate", "required": false, "deprecated": false, "schema": { "type": "object", "properties": { "gt": { "type": "string" }, "gte": { "type": "string" }, "lt": { "type": "string" }, "lte": { "type": "string" }, "ne": { "type": "string" } } }, "style": "form", "explode": true }, { "name": "creditNoteNumber", "in": "query", "description": "CreditNote creditNoteNumber", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "status", "in": "query", "description": "CreditNote status", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "status[]", "in": "query", "description": "CreditNote status", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "deepObject", "explode": true }, { "name": "direction", "in": "query", "description": "CreditNote direction", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "direction[]", "in": "query", "description": "CreditNote direction", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "deepObject", "explode": true }, { "name": "downloaded", "in": "query", "description": "CreditNote downloaded", "required": false, "deprecated": false, "schema": { "type": "boolean" }, "style": "form", "explode": true }, { "name": "senderName", "in": "query", "description": "CreditNote senderName", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "senderName[]", "in": "query", "description": "CreditNote senderName", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "deepObject", "explode": true }, { "name": "ownerTaxId", "in": "query", "description": "CreditNote ownerTaxId", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "senderParticipantId", "in": "query", "description": "CreditNote senderParticipantId", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "senderParticipantId[]", "in": "query", "description": "CreditNote senderParticipantId", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "deepObject", "explode": true }, { "name": "recipientName", "in": "query", "description": "CreditNote recipientName", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "recipientName[]", "in": "query", "description": "CreditNote recipientName", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "deepObject", "explode": true }, { "name": "recipientParticipantId", "in": "query", "description": "CreditNote recipientParticipantId", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "recipientParticipantId[]", "in": "query", "description": "CreditNote recipientParticipantId", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "deepObject", "explode": true }, { "name": "order[creditNoteDate]", "in": "query", "description": "CreditNote order[creditNoteDate]", "required": false, "deprecated": false, "schema": { "type": "string", "enum": [ "asc", "desc", "ASC", "DESC" ] }, "style": "form", "explode": true }, { "name": "order[creditNoteNumber]", "in": "query", "description": "CreditNote order[creditNoteNumber]", "required": false, "deprecated": false, "schema": { "type": "string", "enum": [ "asc", "desc", "ASC", "DESC" ] }, "style": "form", "explode": true }, { "name": "order[uuid]", "in": "query", "description": "CreditNote order[uuid]", "required": false, "deprecated": false, "schema": { "type": "string", "enum": [ "asc", "desc", "ASC", "DESC" ] }, "style": "form", "explode": true } ] }, "post": { "operationId": "api_credit-notes_post", "tags": [ "CreditNote" ], "responses": { "202": { "description": "The credit note has been accepted and will be processed and sent shortly", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/CreditNote.CreditNoteOutput.jsonld" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreditNote.CreditNoteOutput" } } }, "links": {} }, "400": { "description": "Invalid request format or missing fields", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} }, "415": { "description": "Unsupported request format" }, "422": { "description": "Credit note validation failed or business rule violation", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } } }, "links": {} }, "403": { "description": "Forbidden", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} } }, "summary": "Create an outgoing credit note", "description": "Accepts a Peppol BIS XML credit note directly as request body or a JSON object containing the credit note data. In case a JSON representation of the credit note is sent, it will be validated and converted in a valid Peppol BIS XML credit note.", "parameters": [] } }, "/credit-notes/{uuid}": { "get": { "operationId": "api_credit-notes_uuid_get", "tags": [ "CreditNote" ], "responses": { "200": { "description": "CreditNote resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/CreditNote.CreditNoteOutput.jsonld" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreditNote.CreditNoteOutput" } } } }, "403": { "description": "Forbidden", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} }, "404": { "description": "Not found", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} } }, "summary": "Retrieves a CreditNote resource.", "description": "Retrieves a CreditNote resource.", "parameters": [ { "name": "uuid", "in": "path", "description": "CreditNote identifier", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ] } }, "/credit-notes/{uuid}/source": { "get": { "operationId": "api_credit-notes_uuidsource_get", "tags": [ "CreditNote" ], "responses": { "200": { "description": "The credit note will be downloaded" }, "404": { "description": "The credit note does not exist" }, "406": { "description": "The requested format is not supported." }, "403": { "description": "Forbidden", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} } }, "summary": "Download a credit note", "description": "Download a credit note in xml format. The credit note can also be downloaded in json format only when sent by the A-Cube customer in that format.", "parameters": [ { "name": "uuid", "in": "path", "description": "CreditNote identifier", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ] } }, "/initiate-onboarding/{uuid}": { "get": { "operationId": "api_initiate-onboarding_uuid_get", "tags": [ "InitiateOnboarding" ], "responses": { "404": { "description": "Onboarding for the Legal Entity selected by the uuid cannot be initiated." }, "302": { "description": "You will be automatically redirected to the Finan\u010dn\u00e1 spr\u00e1va portal to complete the onboarding process." } }, "summary": "Complete onboarding process on the Finan\u010dn\u00e1 spr\u00e1va portal.", "description": "Complete the onboarding process on the Finan\u010dn\u00e1 spr\u00e1va portal for the Legal Entity selected by the uuid. If the Legal Entity has not already completed the process, or isn't blocked by an error, the user will be automatically redirected to the Finan\u010dn\u00e1 spr\u00e1va portal to complete the onboarding process. This link has to be opened in a browser to complete the process.", "parameters": [ { "name": "uuid", "in": "path", "description": "uuid of the Legal Entity within the A-Cube Slovak Invoicing system.", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ] } }, "/invoices": { "get": { "operationId": "api_invoices_get_collection", "tags": [ "Invoice" ], "responses": { "200": { "description": "Invoice collection", "content": { "application/ld+json": { "schema": { "type": "object", "description": "Invoice.InvoiceOutput.jsonld collection.", "allOf": [ { "$ref": "#/components/schemas/HydraCollectionBaseSchema" }, { "type": "object", "required": [ "hydra:member" ], "properties": { "hydra:member": { "type": "array", "items": { "$ref": "#/components/schemas/Invoice.InvoiceOutput.jsonld" } } } } ] } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Invoice.InvoiceOutput" } } } } } }, "summary": "Retrieves the collection of Invoice resources.", "description": "Retrieves the collection of Invoice resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": true }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "schema": { "type": "integer", "default": 30, "minimum": 0, "maximum": 30 }, "style": "form", "explode": true }, { "name": "createdAt[gt]", "in": "query", "description": "Invoice createdAt", "required": false, "deprecated": false, "schema": { "type": "object", "properties": { "gt": { "type": "string" }, "gte": { "type": "string" }, "lt": { "type": "string" }, "lte": { "type": "string" }, "ne": { "type": "string" } } }, "style": "form", "explode": true }, { "name": "createdAt[gte]", "in": "query", "description": "Invoice createdAt", "required": false, "deprecated": false, "schema": { "type": "object", "properties": { "gt": { "type": "string" }, "gte": { "type": "string" }, "lt": { "type": "string" }, "lte": { "type": "string" }, "ne": { "type": "string" } } }, "style": "form", "explode": true }, { "name": "createdAt[lt]", "in": "query", "description": "Invoice createdAt", "required": false, "deprecated": false, "schema": { "type": "object", "properties": { "gt": { "type": "string" }, "gte": { "type": "string" }, "lt": { "type": "string" }, "lte": { "type": "string" }, "ne": { "type": "string" } } }, "style": "form", "explode": true }, { "name": "createdAt[lte]", "in": "query", "description": "Invoice createdAt", "required": false, "deprecated": false, "schema": { "type": "object", "properties": { "gt": { "type": "string" }, "gte": { "type": "string" }, "lt": { "type": "string" }, "lte": { "type": "string" }, "ne": { "type": "string" } } }, "style": "form", "explode": true }, { "name": "createdAt[ne]", "in": "query", "description": "Invoice createdAt", "required": false, "deprecated": false, "schema": { "type": "object", "properties": { "gt": { "type": "string" }, "gte": { "type": "string" }, "lt": { "type": "string" }, "lte": { "type": "string" }, "ne": { "type": "string" } } }, "style": "form", "explode": true }, { "name": "invoiceDate[gt]", "in": "query", "description": "Invoice invoiceDate", "required": false, "deprecated": false, "schema": { "type": "object", "properties": { "gt": { "type": "string" }, "gte": { "type": "string" }, "lt": { "type": "string" }, "lte": { "type": "string" }, "ne": { "type": "string" } } }, "style": "form", "explode": true }, { "name": "invoiceDate[gte]", "in": "query", "description": "Invoice invoiceDate", "required": false, "deprecated": false, "schema": { "type": "object", "properties": { "gt": { "type": "string" }, "gte": { "type": "string" }, "lt": { "type": "string" }, "lte": { "type": "string" }, "ne": { "type": "string" } } }, "style": "form", "explode": true }, { "name": "invoiceDate[lt]", "in": "query", "description": "Invoice invoiceDate", "required": false, "deprecated": false, "schema": { "type": "object", "properties": { "gt": { "type": "string" }, "gte": { "type": "string" }, "lt": { "type": "string" }, "lte": { "type": "string" }, "ne": { "type": "string" } } }, "style": "form", "explode": true }, { "name": "invoiceDate[lte]", "in": "query", "description": "Invoice invoiceDate", "required": false, "deprecated": false, "schema": { "type": "object", "properties": { "gt": { "type": "string" }, "gte": { "type": "string" }, "lt": { "type": "string" }, "lte": { "type": "string" }, "ne": { "type": "string" } } }, "style": "form", "explode": true }, { "name": "invoiceDate[ne]", "in": "query", "description": "Invoice invoiceDate", "required": false, "deprecated": false, "schema": { "type": "object", "properties": { "gt": { "type": "string" }, "gte": { "type": "string" }, "lt": { "type": "string" }, "lte": { "type": "string" }, "ne": { "type": "string" } } }, "style": "form", "explode": true }, { "name": "invoiceNumber", "in": "query", "description": "Invoice invoiceNumber", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "status", "in": "query", "description": "Invoice status", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "status[]", "in": "query", "description": "Invoice status", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "deepObject", "explode": true }, { "name": "direction", "in": "query", "description": "Invoice direction", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "direction[]", "in": "query", "description": "Invoice direction", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "deepObject", "explode": true }, { "name": "downloaded", "in": "query", "description": "Invoice downloaded", "required": false, "deprecated": false, "schema": { "type": "boolean" }, "style": "form", "explode": true }, { "name": "senderName", "in": "query", "description": "Invoice senderName", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "senderName[]", "in": "query", "description": "Invoice senderName", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "deepObject", "explode": true }, { "name": "ownerTaxId", "in": "query", "description": "Invoice ownerTaxId", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "senderParticipantId", "in": "query", "description": "Invoice senderParticipantId", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "senderParticipantId[]", "in": "query", "description": "Invoice senderParticipantId", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "deepObject", "explode": true }, { "name": "recipientName", "in": "query", "description": "Invoice recipientName", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "recipientName[]", "in": "query", "description": "Invoice recipientName", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "deepObject", "explode": true }, { "name": "recipientParticipantId", "in": "query", "description": "Invoice recipientParticipantId", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "recipientParticipantId[]", "in": "query", "description": "Invoice recipientParticipantId", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "deepObject", "explode": true }, { "name": "order[invoiceDate]", "in": "query", "description": "Invoice order[invoiceDate]", "required": false, "deprecated": false, "schema": { "type": "string", "enum": [ "asc", "desc", "ASC", "DESC" ] }, "style": "form", "explode": true }, { "name": "order[invoiceNumber]", "in": "query", "description": "Invoice order[invoiceNumber]", "required": false, "deprecated": false, "schema": { "type": "string", "enum": [ "asc", "desc", "ASC", "DESC" ] }, "style": "form", "explode": true }, { "name": "order[uuid]", "in": "query", "description": "Invoice order[uuid]", "required": false, "deprecated": false, "schema": { "type": "string", "enum": [ "asc", "desc", "ASC", "DESC" ] }, "style": "form", "explode": true } ] }, "post": { "operationId": "api_invoices_post", "tags": [ "Invoice" ], "responses": { "202": { "description": "The invoice has been accepted and will be processed and sent shortly", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Invoice.InvoiceOutput.jsonld" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Invoice.InvoiceOutput" } } }, "links": {} }, "400": { "description": "Invalid request format or missing fields", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} }, "415": { "description": "Unsupported request format" }, "422": { "description": "Invoice validation failed or business rule violation", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } } }, "links": {} }, "403": { "description": "Forbidden", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} } }, "summary": "Create an outgoing invoice", "description": "Accepts a Peppol BIS XML invoice directly as request body or a JSON object containing the invoice data. In case a JSON representation of the invoice is sent, it will be validated and converted in a valid Peppol BIS XML invoice.", "parameters": [], "requestBody": { "description": "The payload of the invoice to send. Must be a valid Peppol BIS Billing or Self-Billing 3.0 UBL invoice.", "content": { "application/xml": { "schema": "{}", "example": "\n\n urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0\n \n" }, "application/json": { "schema": "{}", "example": "{\n \"UBLExtensions\": [],\n \"CustomizationID\": {\n \"__value\": \"urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0\"\n }\n // ...\n}" } }, "required": true } } }, "/invoices/{uuid}": { "get": { "operationId": "api_invoices_uuid_get", "tags": [ "Invoice" ], "responses": { "200": { "description": "Invoice resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Invoice.InvoiceOutput.jsonld" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Invoice.InvoiceOutput" } } } }, "403": { "description": "Forbidden", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} }, "404": { "description": "Not found", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} } }, "summary": "Retrieves a Invoice resource.", "description": "Retrieves a Invoice resource.", "parameters": [ { "name": "uuid", "in": "path", "description": "Invoice identifier", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ] } }, "/invoices/{uuid}/source": { "get": { "operationId": "api_invoices_uuidsource_get", "tags": [ "Invoice" ], "responses": { "200": { "description": "The invoice will be downloaded" }, "404": { "description": "The invoice does not exist" }, "406": { "description": "The requested format is not supported." }, "403": { "description": "Forbidden", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} } }, "summary": "Download an invoice", "description": "Download an invoice in xml format. The invoice can also be downloaded in json format only when sent by the A-Cube customer in that format.", "parameters": [ { "name": "uuid", "in": "path", "description": "Invoice identifier", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ] } }, "/legal-entities": { "get": { "operationId": "api_legal-entities_get_collection", "tags": [ "LegalEntity" ], "responses": { "200": { "description": "LegalEntity collection", "content": { "application/ld+json": { "schema": { "type": "object", "description": "LegalEntity.LegalEntityOutput.jsonld collection.", "allOf": [ { "$ref": "#/components/schemas/HydraCollectionBaseSchema" }, { "type": "object", "required": [ "hydra:member" ], "properties": { "hydra:member": { "type": "array", "items": { "$ref": "#/components/schemas/LegalEntity.LegalEntityOutput.jsonld" } } } } ] } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LegalEntity.LegalEntityOutput" } } } } } }, "summary": "Retrieves the collection of LegalEntity resources.", "description": "Retrieves the collection of LegalEntity resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": true }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "schema": { "type": "integer", "default": 30, "minimum": 0, "maximum": 30 }, "style": "form", "explode": true } ] }, "post": { "operationId": "api_legal-entities_post", "tags": [ "LegalEntity" ], "responses": { "201": { "description": "LegalEntity resource created", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntityOutput.jsonld" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntityOutput" } } }, "links": {} }, "400": { "description": "Invalid input", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} }, "422": { "description": "An error occurred", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } } }, "links": {} }, "403": { "description": "Forbidden", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} } }, "summary": "Creates a LegalEntity resource.", "description": "Creates a LegalEntity resource.", "parameters": [], "requestBody": { "description": "The new LegalEntity resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntityCreateInput" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntityCreateInput" } } }, "required": true } } }, "/legal-entities/{uuid}": { "get": { "operationId": "api_legal-entities_uuid_get", "tags": [ "LegalEntity" ], "responses": { "200": { "description": "LegalEntity resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntityOutput.jsonld" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntityOutput" } } } }, "404": { "description": "Not found", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} } }, "summary": "Retrieves a LegalEntity resource.", "description": "Retrieves a LegalEntity resource.", "parameters": [ { "name": "uuid", "in": "path", "description": "LegalEntity identifier", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ] }, "put": { "operationId": "api_legal-entities_uuid_put", "tags": [ "LegalEntity" ], "responses": { "200": { "description": "LegalEntity resource updated", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntityOutput.jsonld" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntityOutput" } } }, "links": {} }, "400": { "description": "Invalid input", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} }, "422": { "description": "An error occurred", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } } }, "links": {} }, "403": { "description": "Forbidden", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} }, "404": { "description": "Not found", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} } }, "summary": "Replaces the LegalEntity resource.", "description": "Replaces the LegalEntity resource.", "parameters": [ { "name": "uuid", "in": "path", "description": "LegalEntity identifier", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ], "requestBody": { "description": "The updated LegalEntity resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntityUpdateInput" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntityUpdateInput" } } }, "required": true } }, "delete": { "operationId": "api_legal-entities_uuid_delete", "tags": [ "LegalEntity" ], "responses": { "204": { "description": "LegalEntity resource deleted" }, "403": { "description": "Forbidden", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} }, "404": { "description": "Not found", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} } }, "summary": "Removes the LegalEntity resource.", "description": "Removes the LegalEntity resource.", "parameters": [ { "name": "uuid", "in": "path", "description": "LegalEntity identifier", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ] } }, "/legal-entities/{legalEntityUuid}/sub-accounts": { "get": { "operationId": "api_legal-entities_legalEntityUuidsub-accounts_get_collection", "tags": [ "LegalEntitySubAccount" ], "responses": { "200": { "description": "LegalEntitySubAccount collection", "content": { "application/ld+json": { "schema": { "type": "object", "description": "LegalEntitySubAccount.jsonld collection.", "allOf": [ { "$ref": "#/components/schemas/HydraCollectionBaseSchema" }, { "type": "object", "required": [ "hydra:member" ], "properties": { "hydra:member": { "type": "array", "items": { "$ref": "#/components/schemas/LegalEntitySubAccount.jsonld" } } } } ] } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LegalEntitySubAccount" } } } } } }, "summary": "Retrieves the collection of LegalEntitySubAccount resources.", "description": "Retrieves the collection of LegalEntitySubAccount resources.", "parameters": [ { "name": "legalEntityUuid", "in": "path", "description": "LegalEntity identifier", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false }, { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": true }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "schema": { "type": "integer", "default": 30, "minimum": 0, "maximum": 30 }, "style": "form", "explode": true } ] }, "post": { "operationId": "api_legal-entities_legalEntityUuidsub-accounts_post", "tags": [ "LegalEntitySubAccount" ], "responses": { "201": { "description": "LegalEntitySubAccount resource created", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/LegalEntitySubAccount.jsonld" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LegalEntitySubAccount" } } }, "links": {} }, "400": { "description": "Invalid input", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} }, "422": { "description": "An error occurred", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } } }, "links": {} } }, "summary": "Creates a LegalEntitySubAccount resource.", "description": "Creates a LegalEntitySubAccount resource.", "parameters": [ { "name": "legalEntityUuid", "in": "path", "description": "LegalEntity identifier", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ], "requestBody": { "description": "The new LegalEntitySubAccount resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/LegalEntitySubAccount.LegalEntitySubAccountCreateInput" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LegalEntitySubAccount.LegalEntitySubAccountCreateInput" } } }, "required": true } } }, "/legal-entities/{legalEntityUuid}/sub-accounts/{uuid}": { "get": { "operationId": "api_legal-entities_legalEntityUuidsub-accounts_uuid_get", "tags": [ "LegalEntitySubAccount" ], "responses": { "200": { "description": "LegalEntitySubAccount resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/LegalEntitySubAccount.jsonld" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LegalEntitySubAccount" } } } }, "404": { "description": "Not found", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} } }, "summary": "Retrieves a LegalEntitySubAccount resource.", "description": "Retrieves a LegalEntitySubAccount resource.", "parameters": [ { "name": "legalEntityUuid", "in": "path", "description": "LegalEntity identifier", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false }, { "name": "uuid", "in": "path", "description": "LegalEntitySubAccount identifier", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ] }, "delete": { "operationId": "api_legal-entities_legalEntityUuidsub-accounts_uuid_delete", "tags": [ "LegalEntitySubAccount" ], "responses": { "204": { "description": "LegalEntitySubAccount resource deleted" }, "404": { "description": "Not found", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} } }, "summary": "Removes the LegalEntitySubAccount resource.", "description": "Removes the LegalEntitySubAccount resource.", "parameters": [ { "name": "legalEntityUuid", "in": "path", "description": "LegalEntity identifier", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false }, { "name": "uuid", "in": "path", "description": "LegalEntitySubAccount identifier", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ] } }, "/mls": { "get": { "operationId": "api_mls_get_collection", "tags": [ "MessageLevelStatus" ], "responses": { "200": { "description": "MessageLevelStatus collection", "content": { "application/ld+json": { "schema": { "type": "object", "description": "MessageLevelStatus.MessageLevelStatusOutput.jsonld collection.", "allOf": [ { "$ref": "#/components/schemas/HydraCollectionBaseSchema" }, { "type": "object", "required": [ "hydra:member" ], "properties": { "hydra:member": { "type": "array", "items": { "$ref": "#/components/schemas/MessageLevelStatus.MessageLevelStatusOutput.jsonld" } } } } ] } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MessageLevelStatus.MessageLevelStatusOutput" } } } } }, "403": { "description": "Forbidden", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} } }, "summary": "Retrieves the collection of MessageLevelStatus resources.", "description": "Retrieves the collection of MessageLevelStatus resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": true }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "schema": { "type": "integer", "default": 30, "minimum": 0, "maximum": 30 }, "style": "form", "explode": true }, { "name": "createdAt[gt]", "in": "query", "description": "MessageLevelStatus createdAt", "required": false, "deprecated": false, "schema": { "type": "object", "properties": { "gt": { "type": "string" }, "gte": { "type": "string" }, "lt": { "type": "string" }, "lte": { "type": "string" }, "ne": { "type": "string" } } }, "style": "form", "explode": true }, { "name": "createdAt[gte]", "in": "query", "description": "MessageLevelStatus createdAt", "required": false, "deprecated": false, "schema": { "type": "object", "properties": { "gt": { "type": "string" }, "gte": { "type": "string" }, "lt": { "type": "string" }, "lte": { "type": "string" }, "ne": { "type": "string" } } }, "style": "form", "explode": true }, { "name": "createdAt[lt]", "in": "query", "description": "MessageLevelStatus createdAt", "required": false, "deprecated": false, "schema": { "type": "object", "properties": { "gt": { "type": "string" }, "gte": { "type": "string" }, "lt": { "type": "string" }, "lte": { "type": "string" }, "ne": { "type": "string" } } }, "style": "form", "explode": true }, { "name": "createdAt[lte]", "in": "query", "description": "MessageLevelStatus createdAt", "required": false, "deprecated": false, "schema": { "type": "object", "properties": { "gt": { "type": "string" }, "gte": { "type": "string" }, "lt": { "type": "string" }, "lte": { "type": "string" }, "ne": { "type": "string" } } }, "style": "form", "explode": true }, { "name": "createdAt[ne]", "in": "query", "description": "MessageLevelStatus createdAt", "required": false, "deprecated": false, "schema": { "type": "object", "properties": { "gt": { "type": "string" }, "gte": { "type": "string" }, "lt": { "type": "string" }, "lte": { "type": "string" }, "ne": { "type": "string" } } }, "style": "form", "explode": true }, { "name": "mls_code", "in": "query", "description": "MessageLevelStatus mls_code", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "mls_code[]", "in": "query", "description": "MessageLevelStatus mls_code", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "deepObject", "explode": true }, { "name": "status", "in": "query", "description": "MessageLevelStatus status", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "status[]", "in": "query", "description": "MessageLevelStatus status", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "deepObject", "explode": true }, { "name": "direction", "in": "query", "description": "MessageLevelStatus direction", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "direction[]", "in": "query", "description": "MessageLevelStatus direction", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "deepObject", "explode": true }, { "name": "downloaded", "in": "query", "description": "MessageLevelStatus downloaded", "required": false, "deprecated": false, "schema": { "type": "boolean" }, "style": "form", "explode": true }, { "name": "invoiceUuid", "in": "query", "description": "MessageLevelStatus invoiceUuid", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "invoiceUuid[]", "in": "query", "description": "MessageLevelStatus invoiceUuid", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "deepObject", "explode": true }, { "name": "creditNoteUuid", "in": "query", "description": "MessageLevelStatus creditNoteUuid", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "creditNoteUuid[]", "in": "query", "description": "MessageLevelStatus creditNoteUuid", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "deepObject", "explode": true }, { "name": "taxDataDocumentUuid", "in": "query", "description": "MessageLevelStatus taxDataDocumentUuid", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "taxDataDocumentUuid[]", "in": "query", "description": "MessageLevelStatus taxDataDocumentUuid", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "deepObject", "explode": true }, { "name": "order[createdAt]", "in": "query", "description": "MessageLevelStatus order[createdAt]", "required": false, "deprecated": false, "schema": { "type": "string", "enum": [ "asc", "desc", "ASC", "DESC" ] }, "style": "form", "explode": true }, { "name": "order[uuid]", "in": "query", "description": "MessageLevelStatus order[uuid]", "required": false, "deprecated": false, "schema": { "type": "string", "enum": [ "asc", "desc", "ASC", "DESC" ] }, "style": "form", "explode": true } ] } }, "/mls/{uuid}": { "get": { "operationId": "api_mls_uuid_get", "tags": [ "MessageLevelStatus" ], "responses": { "200": { "description": "MessageLevelStatus resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/MessageLevelStatus.MessageLevelStatusOutput.jsonld" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MessageLevelStatus.MessageLevelStatusOutput" } } } }, "403": { "description": "Forbidden", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} }, "404": { "description": "Not found", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} } }, "summary": "Retrieves a MessageLevelStatus resource.", "description": "Retrieves a MessageLevelStatus resource.", "parameters": [ { "name": "uuid", "in": "path", "description": "MessageLevelStatus identifier", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ] } }, "/mls/{uuid}/source": { "get": { "operationId": "api_mls_uuidsource_get", "tags": [ "MessageLevelStatus" ], "responses": { "200": { "description": "The Message Level Status (MLS) will be downloaded" }, "404": { "description": "The Message Level Status (MLS) does not exist" }, "406": { "description": "The requested format is not supported." }, "403": { "description": "Forbidden", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} } }, "summary": "Download a Message Level Status (MLS)", "description": "Download a Message Level Status (MLS) in xml format.", "parameters": [ { "name": "uuid", "in": "path", "description": "MessageLevelStatus identifier", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ] } }, "/tax-data-documents": { "get": { "operationId": "api_tax-data-documents_get_collection", "tags": [ "TaxDataDocument" ], "responses": { "200": { "description": "TaxDataDocument collection", "content": { "application/ld+json": { "schema": { "type": "object", "description": "TaxDataDocument.TaxDataDocumentOutput.jsonld collection.", "allOf": [ { "$ref": "#/components/schemas/HydraCollectionBaseSchema" }, { "type": "object", "required": [ "hydra:member" ], "properties": { "hydra:member": { "type": "array", "items": { "$ref": "#/components/schemas/TaxDataDocument.TaxDataDocumentOutput.jsonld" } } } } ] } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TaxDataDocument.TaxDataDocumentOutput" } } } } }, "403": { "description": "Forbidden", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} } }, "summary": "Retrieves the collection of TaxDataDocument resources.", "description": "Retrieves the collection of TaxDataDocument resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": true }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "schema": { "type": "integer", "default": 30, "minimum": 0, "maximum": 30 }, "style": "form", "explode": true }, { "name": "createdAt[gt]", "in": "query", "description": "TaxDataDocument createdAt", "required": false, "deprecated": false, "schema": { "type": "object", "properties": { "gt": { "type": "string" }, "gte": { "type": "string" }, "lt": { "type": "string" }, "lte": { "type": "string" }, "ne": { "type": "string" } } }, "style": "form", "explode": true }, { "name": "createdAt[gte]", "in": "query", "description": "TaxDataDocument createdAt", "required": false, "deprecated": false, "schema": { "type": "object", "properties": { "gt": { "type": "string" }, "gte": { "type": "string" }, "lt": { "type": "string" }, "lte": { "type": "string" }, "ne": { "type": "string" } } }, "style": "form", "explode": true }, { "name": "createdAt[lt]", "in": "query", "description": "TaxDataDocument createdAt", "required": false, "deprecated": false, "schema": { "type": "object", "properties": { "gt": { "type": "string" }, "gte": { "type": "string" }, "lt": { "type": "string" }, "lte": { "type": "string" }, "ne": { "type": "string" } } }, "style": "form", "explode": true }, { "name": "createdAt[lte]", "in": "query", "description": "TaxDataDocument createdAt", "required": false, "deprecated": false, "schema": { "type": "object", "properties": { "gt": { "type": "string" }, "gte": { "type": "string" }, "lt": { "type": "string" }, "lte": { "type": "string" }, "ne": { "type": "string" } } }, "style": "form", "explode": true }, { "name": "createdAt[ne]", "in": "query", "description": "TaxDataDocument createdAt", "required": false, "deprecated": false, "schema": { "type": "object", "properties": { "gt": { "type": "string" }, "gte": { "type": "string" }, "lt": { "type": "string" }, "lte": { "type": "string" }, "ne": { "type": "string" } } }, "style": "form", "explode": true }, { "name": "scope", "in": "query", "description": "TaxDataDocument scope", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "scope[]", "in": "query", "description": "TaxDataDocument scope", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "deepObject", "explode": true }, { "name": "reporterRole", "in": "query", "description": "TaxDataDocument reporterRole", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "reporterRole[]", "in": "query", "description": "TaxDataDocument reporterRole", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "deepObject", "explode": true }, { "name": "status", "in": "query", "description": "TaxDataDocument status", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "status[]", "in": "query", "description": "TaxDataDocument status", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "deepObject", "explode": true }, { "name": "downloaded", "in": "query", "description": "TaxDataDocument downloaded", "required": false, "deprecated": false, "schema": { "type": "boolean" }, "style": "form", "explode": true }, { "name": "invoiceUuid", "in": "query", "description": "TaxDataDocument invoiceUuid", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "invoiceUuid[]", "in": "query", "description": "TaxDataDocument invoiceUuid", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "deepObject", "explode": true }, { "name": "creditNoteUuid", "in": "query", "description": "TaxDataDocument creditNoteUuid", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "creditNoteUuid[]", "in": "query", "description": "TaxDataDocument creditNoteUuid", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "deepObject", "explode": true }, { "name": "order[createdAt]", "in": "query", "description": "TaxDataDocument order[createdAt]", "required": false, "deprecated": false, "schema": { "type": "string", "enum": [ "asc", "desc", "ASC", "DESC" ] }, "style": "form", "explode": true }, { "name": "order[uuid]", "in": "query", "description": "TaxDataDocument order[uuid]", "required": false, "deprecated": false, "schema": { "type": "string", "enum": [ "asc", "desc", "ASC", "DESC" ] }, "style": "form", "explode": true } ] } }, "/tax-data-documents/{uuid}": { "get": { "operationId": "api_tax-data-documents_uuid_get", "tags": [ "TaxDataDocument" ], "responses": { "200": { "description": "TaxDataDocument resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/TaxDataDocument.TaxDataDocumentOutput.jsonld" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TaxDataDocument.TaxDataDocumentOutput" } } } }, "403": { "description": "Forbidden", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} }, "404": { "description": "Not found", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} } }, "summary": "Retrieves a TaxDataDocument resource.", "description": "Retrieves a TaxDataDocument resource.", "parameters": [ { "name": "uuid", "in": "path", "description": "TaxDataDocument identifier", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ] } }, "/tax-data-documents/{uuid}/source": { "get": { "operationId": "api_tax-data-documents_uuidsource_get", "tags": [ "TaxDataDocument" ], "responses": { "200": { "description": "The Tax Data Document (TDD) will be downloaded" }, "404": { "description": "The Tax Data Document (TDD) does not exist" }, "406": { "description": "The requested format is not supported." }, "403": { "description": "Forbidden", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} } }, "summary": "Download a Tax Data Document (TDD)", "description": "Download a Tax Data Document (TDD) in xml format.", "parameters": [ { "name": "uuid", "in": "path", "description": "TaxDataDocument identifier", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ] } }, "/event-destinations": { "get": { "operationId": "api_event-destinations_get_collection", "tags": [ "Webhooks" ], "responses": { "200": { "description": "Webhooks collection", "content": { "application/ld+json": { "schema": { "type": "object", "description": "Webhooks.EventDestinationOutput.jsonld collection.", "allOf": [ { "$ref": "#/components/schemas/HydraCollectionBaseSchema" }, { "type": "object", "required": [ "hydra:member" ], "properties": { "hydra:member": { "type": "array", "items": { "$ref": "#/components/schemas/Webhooks.EventDestinationOutput.jsonld" } } } } ] } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Webhooks.EventDestinationOutput" } } } } } }, "summary": "List your event destinations", "description": "Returns the paginated list of your event destinations, each routing one event type to one target", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": true }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "schema": { "type": "integer", "default": 30, "minimum": 0, "maximum": 30 }, "style": "form", "explode": true } ] }, "post": { "operationId": "api_event-destinations_post", "tags": [ "Webhooks" ], "responses": { "201": { "description": "Webhooks resource created", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Webhooks.EventDestinationOutput.jsonld" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Webhooks.EventDestinationOutput" } } }, "links": {} }, "400": { "description": "Invalid input", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} }, "422": { "description": "An error occurred", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } } }, "links": {} } }, "summary": "Create an event destination", "description": "Creates a new event destination with dedicated configuration", "parameters": [], "requestBody": { "description": "The new Webhooks resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Webhooks.EventDestinationCreateInput" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Webhooks.EventDestinationCreateInput" } } }, "required": true } } }, "/event-destinations/{uuid}": { "get": { "operationId": "api_event-destinations_uuid_get", "tags": [ "Webhooks" ], "responses": { "200": { "description": "Webhooks resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Webhooks.EventDestinationOutput.jsonld" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Webhooks.EventDestinationOutput" } } } }, "404": { "description": "Not found", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} } }, "summary": "Get an event destination", "description": "Returns the corresponding event destination by UUID", "parameters": [ { "name": "uuid", "in": "path", "description": "Webhooks identifier", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ] }, "put": { "operationId": "api_event-destinations_uuid_put", "tags": [ "Webhooks" ], "responses": { "200": { "description": "Webhooks resource updated", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Webhooks.EventDestinationOutput.jsonld" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Webhooks.EventDestinationOutput" } } }, "links": {} }, "400": { "description": "Invalid input", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} }, "422": { "description": "An error occurred", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } } }, "links": {} }, "404": { "description": "Not found", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} } }, "summary": "Update an event destination", "description": "Update the configuration of the event destination matching UUID", "parameters": [ { "name": "uuid", "in": "path", "description": "Webhooks identifier", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ], "requestBody": { "description": "The updated Webhooks resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Webhooks.EventDestinationUpdateInput" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Webhooks.EventDestinationUpdateInput" } } }, "required": true } }, "delete": { "operationId": "api_event-destinations_uuid_delete", "tags": [ "Webhooks" ], "responses": { "204": { "description": "Webhooks resource deleted" }, "404": { "description": "Not found", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} } }, "summary": "Delete an event destination", "description": "Deletes the event destination matching UUID. This is a hard delete, the record will be removed and cannot be recovered.", "parameters": [ { "name": "uuid", "in": "path", "description": "Webhooks identifier", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ] } } }, "components": { "schemas": { "ConstraintViolation": { "type": "object", "description": "Unprocessable entity", "properties": { "status": { "default": 422, "type": "integer" }, "violations": { "type": "array", "items": { "type": "object", "properties": { "propertyPath": { "type": "string", "description": "The property path of the violation" }, "message": { "type": "string", "description": "The message associated with the violation" }, "code": { "type": "string", "description": "The code of the violation" }, "hint": { "type": "string", "description": "An extra hint to understand the violation" }, "payload": { "type": "object", "additionalProperties": true, "description": "The serialized payload of the violation" } }, "required": [ "propertyPath", "message" ] } }, "detail": { "readOnly": true, "type": "string" }, "type": { "readOnly": true, "type": "string" }, "title": { "readOnly": true, "type": [ "string", "null" ] }, "instance": { "readOnly": true, "type": [ "string", "null" ] } } }, "ConstraintViolation.jsonld": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "status": { "default": 422, "type": "integer" }, "violations": { "type": "array", "items": { "type": "object", "properties": { "propertyPath": { "type": "string", "description": "The property path of the violation" }, "message": { "type": "string", "description": "The message associated with the violation" }, "code": { "type": "string", "description": "The code of the violation" }, "hint": { "type": "string", "description": "An extra hint to understand the violation" }, "payload": { "type": "object", "additionalProperties": true, "description": "The serialized payload of the violation" } }, "required": [ "propertyPath", "message" ] } }, "detail": { "readOnly": true, "type": "string" }, "description": { "readOnly": true, "type": "string" }, "type": { "readOnly": true, "type": "string" }, "title": { "readOnly": true, "type": [ "string", "null" ] }, "instance": { "readOnly": true, "type": [ "string", "null" ] } } } ], "description": "Unprocessable entity" }, "CreditNote.CreditNoteOutput": { "type": "object", "properties": { "uuid": { "example": "01a03984-4d8b-74de-a445-083c0defe92c", "type": "string", "description": "Internal identifier of the Credit note." }, "creditNoteNumber": { "example": "CreditNote-Number-1", "type": "string", "description": "Credit note number as assigned by the issuer." }, "creditNoteDate": { "example": "2026-08-24", "type": "string", "description": "Date the Credit note was issued." }, "dueDate": { "example": "2026-09-07", "type": [ "string", "null" ], "description": "Payment due date of the Credit note." }, "currency": { "example": "EUR", "type": "string", "description": "Currency of the Credit note." }, "totalAmount": { "example": "1656.25", "type": "string", "description": "Total payable amount of the Credit note, tax included." }, "netAmount": { "example": "1325.00", "type": "string", "description": "Net amount of the Credit note, tax excluded." }, "direction": { "example": "incoming", "type": "string", "description": "Direction of the Credit note: whether it was sent (outgoing) or received (incoming) by the Legal entity.", "enum": [ "outgoing", "incoming" ] }, "sender": { "$ref": "#/components/schemas/InvoicePartyOutput" }, "recipient": { "$ref": "#/components/schemas/InvoicePartyOutput" }, "status": { "example": "received", "type": "string", "description": "The status of the Credit note in the system.", "enum": [ "created", "processing", "sent", "received", "rejected", "failed" ] }, "documentType": { "example": "credit_note", "type": "string", "enum": [ "credit_note", "self_billing_credit_note" ], "description": "The type of the Credit note document." }, "downloaded": { "example": true, "type": "boolean", "description": "Whether the Credit note document has already been downloaded." }, "downloadedAt": { "example": "2026-08-24T10:15:30+00:00", "type": [ "string", "null" ], "description": "Date and time the Credit note document was downloaded, in ATOM format." }, "createdAt": { "example": "2026-08-24T09:00:00+00:00", "type": "string", "description": "Date and time the Credit note was created in the system, in ATOM format." }, "updatedAt": { "example": "2026-08-24T09:05:00+00:00", "type": [ "string", "null" ], "description": "Date and time the Credit note was last updated in the system, in ATOM format." } } }, "CreditNote.CreditNoteOutput.jsonld": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "uuid": { "example": "01a03984-4d8b-74de-a445-083c0defe92c", "type": "string", "description": "Internal identifier of the Credit note." }, "creditNoteNumber": { "example": "CreditNote-Number-1", "type": "string", "description": "Credit note number as assigned by the issuer." }, "creditNoteDate": { "example": "2026-08-24", "type": "string", "description": "Date the Credit note was issued." }, "dueDate": { "example": "2026-09-07", "type": [ "string", "null" ], "description": "Payment due date of the Credit note." }, "currency": { "example": "EUR", "type": "string", "description": "Currency of the Credit note." }, "totalAmount": { "example": "1656.25", "type": "string", "description": "Total payable amount of the Credit note, tax included." }, "netAmount": { "example": "1325.00", "type": "string", "description": "Net amount of the Credit note, tax excluded." }, "direction": { "example": "incoming", "type": "string", "description": "Direction of the Credit note: whether it was sent (outgoing) or received (incoming) by the Legal entity.", "enum": [ "outgoing", "incoming" ] }, "sender": { "$ref": "#/components/schemas/InvoicePartyOutput.jsonld" }, "recipient": { "$ref": "#/components/schemas/InvoicePartyOutput.jsonld" }, "status": { "example": "received", "type": "string", "description": "The status of the Credit note in the system.", "enum": [ "created", "processing", "sent", "received", "rejected", "failed" ] }, "documentType": { "example": "credit_note", "type": "string", "enum": [ "credit_note", "self_billing_credit_note" ], "description": "The type of the Credit note document." }, "downloaded": { "example": true, "type": "boolean", "description": "Whether the Credit note document has already been downloaded." }, "downloadedAt": { "example": "2026-08-24T10:15:30+00:00", "type": [ "string", "null" ], "description": "Date and time the Credit note document was downloaded, in ATOM format." }, "createdAt": { "example": "2026-08-24T09:00:00+00:00", "type": "string", "description": "Date and time the Credit note was created in the system, in ATOM format." }, "updatedAt": { "example": "2026-08-24T09:05:00+00:00", "type": [ "string", "null" ], "description": "Date and time the Credit note was last updated in the system, in ATOM format." } } } ] }, "Error": { "type": "object", "description": "A representation of common errors.", "properties": { "title": { "readOnly": true, "description": "A short, human-readable summary of the problem.", "type": [ "string", "null" ] }, "detail": { "readOnly": true, "description": "A human-readable explanation specific to this occurrence of the problem.", "type": [ "string", "null" ] }, "status": { "type": [ "integer", "null" ], "examples": [ 404 ], "default": 400 }, "instance": { "readOnly": true, "description": "A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.", "type": [ "string", "null" ] }, "type": { "readOnly": true, "description": "A URI reference that identifies the problem type", "type": "string" } } }, "Error.jsonld": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "title": { "readOnly": true, "description": "A short, human-readable summary of the problem.", "type": [ "string", "null" ] }, "detail": { "readOnly": true, "description": "A human-readable explanation specific to this occurrence of the problem.", "type": [ "string", "null" ] }, "status": { "type": [ "integer", "null" ], "examples": [ 404 ], "default": 400 }, "instance": { "readOnly": true, "description": "A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.", "type": [ "string", "null" ] }, "type": { "readOnly": true, "description": "A URI reference that identifies the problem type", "type": "string" }, "description": { "readOnly": true, "type": [ "string", "null" ] } } } ], "description": "A representation of common errors." }, "HydraCollectionBaseSchema": { "allOf": [ { "$ref": "#/components/schemas/HydraCollectionBaseSchemaNoPagination" }, { "type": "object", "properties": { "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" } } } } ] }, "HydraCollectionBaseSchemaNoPagination": { "type": "object", "properties": { "hydra:totalItems": { "type": "integer", "minimum": 0 }, "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", "null" ] }, "required": { "type": "boolean" } } } } } } } }, "HydraItemBaseSchema": { "type": "object", "properties": { "@context": { "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": { "type": "string" }, "@type": { "type": "string" } }, "required": [ "@id", "@type" ] }, "Invoice.InvoiceOutput": { "type": "object", "properties": { "uuid": { "example": "019ebad8-fa53-7419-8b74-481567a36fc1", "type": "string", "description": "Internal identifier of the Invoice." }, "invoiceNumber": { "example": "Invoice-Number-1", "type": "string", "description": "Invoice number as assigned by the issuer." }, "invoiceDate": { "example": "2017-11-13", "type": "string", "description": "Date the Invoice was issued." }, "dueDate": { "example": "2017-12-01", "type": [ "string", "null" ], "description": "Payment due date of the Invoice." }, "currency": { "example": "EUR", "type": "string", "description": "Currency of the Invoice." }, "totalAmount": { "example": "1656.25", "type": "string", "description": "Total payable amount of the Invoice, tax included." }, "netAmount": { "example": "1325.00", "type": "string", "description": "Net amount of the Invoice, tax excluded." }, "direction": { "example": "outgoing", "type": "string", "description": "Direction of the Invoice: whether it was sent (outgoing) or received (incoming) by the Legal entity.", "enum": [ "outgoing", "incoming" ] }, "sender": { "$ref": "#/components/schemas/InvoicePartyOutput" }, "recipient": { "$ref": "#/components/schemas/InvoicePartyOutput" }, "status": { "example": "sent", "type": "string", "description": "The status of the Invoice in the system.", "enum": [ "created", "processing", "sent", "received", "rejected", "failed" ] }, "documentType": { "example": "invoice", "type": "string", "enum": [ "invoice", "self_billing_invoice" ], "description": "The type of the Invoice document." }, "downloaded": { "example": true, "type": "boolean", "description": "Whether the Invoice document has already been downloaded." }, "downloadedAt": { "example": "2017-11-13T10:15:30+00:00", "type": [ "string", "null" ], "description": "Date and time the Invoice document was downloaded, in ATOM format." }, "createdAt": { "example": "2017-11-13T09:00:00+00:00", "type": "string", "description": "Date and time the Invoice was created in the system, in ATOM format." }, "updatedAt": { "example": "2017-11-13T09:05:00+00:00", "type": [ "string", "null" ], "description": "Date and time the Invoice was last updated in the system, in ATOM format." } } }, "Invoice.InvoiceOutput.jsonld": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "uuid": { "example": "019ebad8-fa53-7419-8b74-481567a36fc1", "type": "string", "description": "Internal identifier of the Invoice." }, "invoiceNumber": { "example": "Invoice-Number-1", "type": "string", "description": "Invoice number as assigned by the issuer." }, "invoiceDate": { "example": "2017-11-13", "type": "string", "description": "Date the Invoice was issued." }, "dueDate": { "example": "2017-12-01", "type": [ "string", "null" ], "description": "Payment due date of the Invoice." }, "currency": { "example": "EUR", "type": "string", "description": "Currency of the Invoice." }, "totalAmount": { "example": "1656.25", "type": "string", "description": "Total payable amount of the Invoice, tax included." }, "netAmount": { "example": "1325.00", "type": "string", "description": "Net amount of the Invoice, tax excluded." }, "direction": { "example": "outgoing", "type": "string", "description": "Direction of the Invoice: whether it was sent (outgoing) or received (incoming) by the Legal entity.", "enum": [ "outgoing", "incoming" ] }, "sender": { "$ref": "#/components/schemas/InvoicePartyOutput.jsonld" }, "recipient": { "$ref": "#/components/schemas/InvoicePartyOutput.jsonld" }, "status": { "example": "sent", "type": "string", "description": "The status of the Invoice in the system.", "enum": [ "created", "processing", "sent", "received", "rejected", "failed" ] }, "documentType": { "example": "invoice", "type": "string", "enum": [ "invoice", "self_billing_invoice" ], "description": "The type of the Invoice document." }, "downloaded": { "example": true, "type": "boolean", "description": "Whether the Invoice document has already been downloaded." }, "downloadedAt": { "example": "2017-11-13T10:15:30+00:00", "type": [ "string", "null" ], "description": "Date and time the Invoice document was downloaded, in ATOM format." }, "createdAt": { "example": "2017-11-13T09:00:00+00:00", "type": "string", "description": "Date and time the Invoice was created in the system, in ATOM format." }, "updatedAt": { "example": "2017-11-13T09:05:00+00:00", "type": [ "string", "null" ], "description": "Date and time the Invoice was last updated in the system, in ATOM format." } } } ] }, "InvoicePartyOutput": { "type": "object", "properties": { "name": { "example": "Example Company a.s.", "type": "string", "description": "Name of the party extracted from the document." }, "address": { "example": "0245:5554444445", "type": "string", "description": "Peppol participant identifier of the party, composed of the International Code Designator (ICD, e.g. 0245 for Slovakia) and the identifier value (for a Slovak party is its DI\u010c), separated by a colon." }, "country": { "example": "SK", "type": "string", "description": "Country code ISO 3166-1 alpha-2 codes of the party." } } }, "InvoicePartyOutput.jsonld": { "type": "object", "properties": { "name": { "example": "Example Company a.s.", "type": "string", "description": "Name of the party extracted from the document." }, "address": { "example": "0245:5554444445", "type": "string", "description": "Peppol participant identifier of the party, composed of the International Code Designator (ICD, e.g. 0245 for Slovakia) and the identifier value (for a Slovak party is its DI\u010c), separated by a colon." }, "country": { "example": "SK", "type": "string", "description": "Country code ISO 3166-1 alpha-2 codes of the party." } } }, "LegalEntity.LegalEntityCreateInput": { "type": "object", "required": [ "taxId", "name", "address", "city", "zipCode" ], "properties": { "taxId": { "minLength": 10, "maxLength": 10, "pattern": "^([0-9]{10})$", "example": "1234567890", "type": "string", "description": "Tax identifier (DI\u010c) of the Legal entity." }, "ico": { "example": "12345678", "type": [ "string", "null" ], "description": "I\u010cO of the Legal entity." }, "icDph": { "example": "SK1234567890", "type": [ "string", "null" ], "description": "I\u010c DPH of the Legal entity." }, "name": { "example": "Example Company a.s.", "type": "string", "description": "Name used to register the Legal entity in the business registry of the jurisdiction where it is legally based." }, "email": { "format": "email", "externalDocs": { "url": "https://schema.org/email" }, "example": "example@company.com", "type": [ "string", "null" ], "description": "Email address of the Legal entity." }, "phoneNumber": { "pattern": "^(\\+?[1-9]\\d{1,14})$", "example": "+421777123456", "type": [ "string", "null" ], "description": "Phone number of the Legal entity." }, "country": { "minLength": 2, "maxLength": 2, "example": "SK", "type": "string", "description": "Country code ISO 3166-1 alpha-2 codes" }, "address": { "example": "Example Street 123", "type": "string", "description": "Legal entity address" }, "city": { "example": "Bratislava", "type": "string", "description": "Legal entity city" }, "stateOrProvince": { "example": "Bratislava", "type": [ "string", "null" ], "description": "Legal entity state or province" }, "zipCode": { "example": "84101", "type": "string", "description": "Legal entity zip code" }, "config": { "$ref": "#/components/schemas/LegalEntityConfigInput" } } }, "LegalEntity.LegalEntityOutput": { "type": "object", "properties": { "uuid": { "example": "019ebad8-fa53-7419-8b74-481567a36fc1", "type": "string", "description": "Internal identifier of the Legal entity." }, "taxId": { "example": "1234567890", "type": "string", "description": "Tax identifier (DI\u010c) of the Legal entity." }, "ico": { "example": "12345678", "type": [ "string", "null" ], "description": "I\u010cO of the Legal entity." }, "icDph": { "example": "SK1234567890", "type": [ "string", "null" ], "description": "I\u010c DPH of the Legal entity." }, "status": { "example": "active", "type": "string", "description": "The status of the Legal entity in the system.", "enum": [ "active", "pending", "waiting_user_interaction", "waiting_user_interaction_after_fail", "blocked" ] }, "name": { "example": "Example Company a.s.", "type": "string", "description": "Name used to register the Legal entity in the business registry of the jurisdiction where it is legally based." }, "email": { "example": "example@company.com", "type": [ "string", "null" ], "description": "Email address of the Legal entity." }, "phoneNumber": { "example": "+421777123456", "type": [ "string", "null" ], "description": "Phone number of the Legal entity." }, "country": { "example": "SK", "type": "string", "description": "Country code ISO 3166-1 alpha-2 codes" }, "address": { "example": "Example Street 123", "type": "string", "description": "Legal entity address" }, "city": { "example": "Bratislava", "type": "string", "description": "Legal entity city" }, "stateOrProvince": { "example": "Bratislava", "type": [ "string", "null" ], "description": "Legal entity state or province" }, "zipCode": { "example": "84101", "type": "string", "description": "Legal entity zip code" }, "finalizeOnboardingUrl": { "example": "/initiate-onboarding/019ebad8-fa53-7419-8b74-481567a36fc1", "type": [ "string", "null" ], "description": "If the Legal Entity is not already onboarded with fatal errors or blocked, this URL needs to be used to complete the onboarding process on the Finan\u010dn\u00e1 Spr\u00e1va portal. The returned URL is relative, so please append the A-Cube base URL you used to call the endpoint to continue the onboarding." }, "createdAt": { "type": "string" }, "updatedAt": { "type": [ "string", "null" ] }, "config": { "$ref": "#/components/schemas/LegalEntityConfigOutput" } } }, "LegalEntity.LegalEntityOutput.jsonld": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "uuid": { "example": "019ebad8-fa53-7419-8b74-481567a36fc1", "type": "string", "description": "Internal identifier of the Legal entity." }, "taxId": { "example": "1234567890", "type": "string", "description": "Tax identifier (DI\u010c) of the Legal entity." }, "ico": { "example": "12345678", "type": [ "string", "null" ], "description": "I\u010cO of the Legal entity." }, "icDph": { "example": "SK1234567890", "type": [ "string", "null" ], "description": "I\u010c DPH of the Legal entity." }, "status": { "example": "active", "type": "string", "description": "The status of the Legal entity in the system.", "enum": [ "active", "pending", "waiting_user_interaction", "waiting_user_interaction_after_fail", "blocked" ] }, "name": { "example": "Example Company a.s.", "type": "string", "description": "Name used to register the Legal entity in the business registry of the jurisdiction where it is legally based." }, "email": { "example": "example@company.com", "type": [ "string", "null" ], "description": "Email address of the Legal entity." }, "phoneNumber": { "example": "+421777123456", "type": [ "string", "null" ], "description": "Phone number of the Legal entity." }, "country": { "example": "SK", "type": "string", "description": "Country code ISO 3166-1 alpha-2 codes" }, "address": { "example": "Example Street 123", "type": "string", "description": "Legal entity address" }, "city": { "example": "Bratislava", "type": "string", "description": "Legal entity city" }, "stateOrProvince": { "example": "Bratislava", "type": [ "string", "null" ], "description": "Legal entity state or province" }, "zipCode": { "example": "84101", "type": "string", "description": "Legal entity zip code" }, "finalizeOnboardingUrl": { "example": "/initiate-onboarding/019ebad8-fa53-7419-8b74-481567a36fc1", "type": [ "string", "null" ], "description": "If the Legal Entity is not already onboarded with fatal errors or blocked, this URL needs to be used to complete the onboarding process on the Finan\u010dn\u00e1 Spr\u00e1va portal. The returned URL is relative, so please append the A-Cube base URL you used to call the endpoint to continue the onboarding." }, "createdAt": { "type": "string" }, "updatedAt": { "type": [ "string", "null" ] }, "config": { "$ref": "#/components/schemas/LegalEntityConfigOutput.jsonld" } } } ] }, "LegalEntity.LegalEntityUpdateInput": { "type": "object", "properties": { "ico": { "example": "12345678", "type": [ "string", "null" ], "description": "I\u010cO of the Legal entity." }, "icDph": { "example": "SK1234567890", "type": [ "string", "null" ], "description": "I\u010c DPH of the Legal entity." }, "name": { "example": "Example Company a.s.", "type": "string", "description": "Name used to register the Legal entity in the business registry of the jurisdiction where it is legally based." }, "email": { "format": "email", "externalDocs": { "url": "https://schema.org/email" }, "example": "example@company.com", "type": [ "string", "null" ], "description": "Email address of the Legal entity." }, "phoneNumber": { "pattern": "^(\\+?[1-9]\\d{1,14})$", "example": "+421777123456", "type": [ "string", "null" ], "description": "Phone number of the Legal entity." }, "country": { "minLength": 2, "maxLength": 2, "example": "SK", "type": "string", "description": "Country code ISO 3166-1 alpha-2 codes" }, "address": { "example": "Example Street 123", "type": "string", "description": "Legal entity address" }, "city": { "example": "Bratislava", "type": "string", "description": "Legal entity city" }, "stateOrProvince": { "example": "Bratislava", "type": [ "string", "null" ], "description": "Legal entity state or province" }, "zipCode": { "example": "84101", "type": "string", "description": "Legal entity zip code" }, "config": { "$ref": "#/components/schemas/LegalEntityConfigInput" } }, "required": [ "name", "address", "city", "zipCode" ] }, "LegalEntityConfigInput": { "type": "object", "properties": { "supplierInvoiceEnabled": { "example": true, "type": "boolean", "description": "Setting enabled to true will enable the supplier invoice (incoming documents) feature for this legal entity" }, "customerInvoiceEnabled": { "example": true, "type": "boolean", "description": "Setting enabled to true will enable the customer invoice (outgoing documents) feature for this legal entity" } } }, "LegalEntityConfigOutput": { "type": "object", "properties": { "supplierInvoiceEnabled": { "example": true, "type": "boolean", "description": "Setting enabled to true will enable the supplier invoice (incoming documents) feature for this legal entity" }, "customerInvoiceEnabled": { "example": true, "type": "boolean", "description": "Setting enabled to true will enable the customer invoice (outgoing documents) feature for this legal entity" } } }, "LegalEntityConfigOutput.jsonld": { "type": "object", "properties": { "supplierInvoiceEnabled": { "example": true, "type": "boolean", "description": "Setting enabled to true will enable the supplier invoice (incoming documents) feature for this legal entity" }, "customerInvoiceEnabled": { "example": true, "type": "boolean", "description": "Setting enabled to true will enable the customer invoice (outgoing documents) feature for this legal entity" } } }, "LegalEntitySubAccount": { "type": "object", "properties": { "uuid": { "type": [ "string", "null" ], "format": "uuid" }, "legalEntity": { "type": "string", "format": "iri-reference", "example": "https://example.com/" }, "userId": { "type": "integer" }, "email": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": [ "string", "null" ], "format": "date-time" }, "ownedThroughPropertyName": { "readOnly": true }, "ownedThroughResourceClass": { "readOnly": true } } }, "LegalEntitySubAccount.LegalEntitySubAccountCreateInput": { "type": "object", "required": [ "email", "password" ], "properties": { "email": { "format": "email", "description": "Email address of the sub-account user", "externalDocs": { "url": "https://schema.org/email" }, "type": "string" }, "password": { "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", "null" ] } } }, "LegalEntitySubAccount.jsonld": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "uuid": { "type": [ "string", "null" ], "format": "uuid" }, "legalEntity": { "type": "string", "format": "iri-reference", "example": "https://example.com/" }, "userId": { "type": "integer" }, "email": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": [ "string", "null" ], "format": "date-time" }, "ownedThroughPropertyName": { "readOnly": true }, "ownedThroughResourceClass": { "readOnly": true } } } ] }, "MessageLevelStatus.MessageLevelStatusOutput": { "type": "object", "properties": { "uuid": { "example": "019ebad8-fa53-7419-8b74-481567a36fc1", "type": "string", "description": "Internal identifier of the Message Level Status (MLS)." }, "mlsCode": { "example": "AP", "type": [ "string", "null" ], "description": "Response code of the Message Level Status (MLS).", "enum": [ "AP", "AB", "RE" ] }, "mlsMode": { "example": "ALWAYS_SEND", "type": [ "string", "null" ], "description": "Response mode of the Message Level Status (MLS): whether it is sent for every document or only for failures.", "enum": [ "ALWAYS_SEND", "FAILURE_ONLY" ] }, "direction": { "example": "outgoing", "type": "string", "description": "Direction of the Message Level Status (MLS): whether it was sent (outgoing) or received (incoming) by the Legal entity.", "enum": [ "outgoing", "incoming" ] }, "status": { "example": "sent", "type": "string", "description": "The status of the Message Level Status (MLS) in the system.", "enum": [ "created", "processing", "sent", "received", "rejected", "failed" ] }, "downloaded": { "example": true, "type": "boolean", "description": "Whether the Message Level Status (MLS) document has already been downloaded." }, "downloadedAt": { "example": "2026-08-24T10:15:30+00:00", "type": [ "string", "null" ], "description": "Date and time the Message Level Status (MLS) document was downloaded, in ATOM format." }, "invoiceUuid": { "type": [ "string", "null" ], "description": "Internal identifier of the Invoice this Message Level Status (MLS) refers to, if any." }, "creditNoteUuid": { "example": "01a03984-4d8b-74de-a445-083c0defe92c", "type": [ "string", "null" ], "description": "Internal identifier of the Credit note this Message Level Status (MLS) refers to, if any." }, "taxDataDocumentUuid": { "type": [ "string", "null" ], "description": "Internal identifier of the Tax Data Document (TDD) this Message Level Status (MLS) refers to, if any." } } }, "MessageLevelStatus.MessageLevelStatusOutput.jsonld": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "uuid": { "example": "019ebad8-fa53-7419-8b74-481567a36fc1", "type": "string", "description": "Internal identifier of the Message Level Status (MLS)." }, "mlsCode": { "example": "AP", "type": [ "string", "null" ], "description": "Response code of the Message Level Status (MLS).", "enum": [ "AP", "AB", "RE" ] }, "mlsMode": { "example": "ALWAYS_SEND", "type": [ "string", "null" ], "description": "Response mode of the Message Level Status (MLS): whether it is sent for every document or only for failures.", "enum": [ "ALWAYS_SEND", "FAILURE_ONLY" ] }, "direction": { "example": "outgoing", "type": "string", "description": "Direction of the Message Level Status (MLS): whether it was sent (outgoing) or received (incoming) by the Legal entity.", "enum": [ "outgoing", "incoming" ] }, "status": { "example": "sent", "type": "string", "description": "The status of the Message Level Status (MLS) in the system.", "enum": [ "created", "processing", "sent", "received", "rejected", "failed" ] }, "downloaded": { "example": true, "type": "boolean", "description": "Whether the Message Level Status (MLS) document has already been downloaded." }, "downloadedAt": { "example": "2026-08-24T10:15:30+00:00", "type": [ "string", "null" ], "description": "Date and time the Message Level Status (MLS) document was downloaded, in ATOM format." }, "invoiceUuid": { "type": [ "string", "null" ], "description": "Internal identifier of the Invoice this Message Level Status (MLS) refers to, if any." }, "creditNoteUuid": { "example": "01a03984-4d8b-74de-a445-083c0defe92c", "type": [ "string", "null" ], "description": "Internal identifier of the Credit note this Message Level Status (MLS) refers to, if any." }, "taxDataDocumentUuid": { "type": [ "string", "null" ], "description": "Internal identifier of the Tax Data Document (TDD) this Message Level Status (MLS) refers to, if any." } } } ] }, "TaxDataDocument.TaxDataDocumentOutput": { "type": "object", "properties": { "uuid": { "example": "019ebad8-fa53-7419-8b74-481567a36fc1", "type": "string", "description": "Internal identifier of the Tax Data Document (TDD)." }, "scope": { "example": "DOMESTIC", "type": "string", "description": "Scope of the transaction reported by the Tax Data Document (TDD).", "enum": [ "DOMESTIC", "INTRA_COMMUNITY", "INTERNATIONAL" ] }, "reporterRole": { "example": "SENDER", "type": "string", "description": "Role of the Legal entity reporting the Tax Data Document (TDD): whether it is the sender or the receiver of the referenced Invoice or Credit note.", "enum": [ "SENDER", "RECEIVER" ] }, "status": { "example": "sent", "type": "string", "description": "The status of the Tax Data Document (TDD) in the system.", "enum": [ "created", "processing", "sent", "discarded", "failed", "non_domestic" ] }, "downloaded": { "example": true, "type": "boolean", "description": "Whether the Tax Data Document (TDD) document has already been downloaded." }, "downloadedAt": { "example": "2026-08-24T10:15:30+00:00", "type": [ "string", "null" ], "description": "Date and time the Tax Data Document (TDD) document was downloaded, in ATOM format." }, "invoiceUuid": { "example": "0a9ebad8-fa53-7419-8b74-481567a36aaa", "type": [ "string", "null" ], "description": "Internal identifier of the Invoice this Tax Data Document (TDD) refers to, if any." }, "creditNoteUuid": { "type": [ "string", "null" ], "description": "Internal identifier of the Credit note this Tax Data Document (TDD) refers to, if any." } } }, "TaxDataDocument.TaxDataDocumentOutput.jsonld": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "uuid": { "example": "019ebad8-fa53-7419-8b74-481567a36fc1", "type": "string", "description": "Internal identifier of the Tax Data Document (TDD)." }, "scope": { "example": "DOMESTIC", "type": "string", "description": "Scope of the transaction reported by the Tax Data Document (TDD).", "enum": [ "DOMESTIC", "INTRA_COMMUNITY", "INTERNATIONAL" ] }, "reporterRole": { "example": "SENDER", "type": "string", "description": "Role of the Legal entity reporting the Tax Data Document (TDD): whether it is the sender or the receiver of the referenced Invoice or Credit note.", "enum": [ "SENDER", "RECEIVER" ] }, "status": { "example": "sent", "type": "string", "description": "The status of the Tax Data Document (TDD) in the system.", "enum": [ "created", "processing", "sent", "discarded", "failed", "non_domestic" ] }, "downloaded": { "example": true, "type": "boolean", "description": "Whether the Tax Data Document (TDD) document has already been downloaded." }, "downloadedAt": { "example": "2026-08-24T10:15:30+00:00", "type": [ "string", "null" ], "description": "Date and time the Tax Data Document (TDD) document was downloaded, in ATOM format." }, "invoiceUuid": { "example": "0a9ebad8-fa53-7419-8b74-481567a36aaa", "type": [ "string", "null" ], "description": "Internal identifier of the Invoice this Tax Data Document (TDD) refers to, if any." }, "creditNoteUuid": { "type": [ "string", "null" ], "description": "Internal identifier of the Credit note this Tax Data Document (TDD) refers to, if any." } } } ] }, "Webhooks.EventDestinationCreateInput": { "type": "object", "properties": { "event": { "enum": [ "invoice.outbound", "invoice.inbound", "credit_note.outbound", "credit_note.inbound", "tax_data_document.outbound", "legal_entity.onboarding", "message_level_status.outbound", "message_level_status.inbound" ], "type": "string" }, "delivery": { "enum": [ "webhook", "email", "aws_event_bridge" ], "type": "string" }, "target": { "type": "string" }, "authType": { "enum": [ "none", "query", "header" ], "type": "string" }, "authKey": { "description": "The key to use for authentication. If not provided, defaults to \"Authorization\" for `header` auth type and \"token\" for `query` auth type.", "type": [ "string", "null" ] }, "authToken": { "type": [ "string", "null" ] } }, "required": [ "target", "authType" ] }, "Webhooks.EventDestinationOutput": { "type": "object", "properties": { "uuid": { "type": "string" }, "event": { "type": "string" }, "delivery": { "type": "string" }, "target": { "type": "string" }, "authType": { "type": "string" }, "authKey": { "type": [ "string", "null" ] }, "authToken": { "type": [ "string", "null" ] } } }, "Webhooks.EventDestinationOutput.jsonld": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "uuid": { "type": "string" }, "event": { "type": "string" }, "delivery": { "type": "string" }, "target": { "type": "string" }, "authType": { "type": "string" }, "authKey": { "type": [ "string", "null" ] }, "authToken": { "type": [ "string", "null" ] } } } ] }, "Webhooks.EventDestinationUpdateInput": { "type": "object", "properties": { "authType": { "enum": [ "none", "query", "header" ], "type": "string" }, "authKey": { "type": [ "string", "null" ] }, "authToken": { "type": [ "string", "null" ] } } } }, "responses": {}, "parameters": {}, "examples": {}, "requestBodies": {}, "headers": {}, "securitySchemes": { "bearerAuth": { "type": "http", "description": "Received from Platform Authentication.", "scheme": "bearer", "bearerFormat": "JWT" } } }, "security": [ { "bearerAuth": [] } ], "tags": [ { "name": "InitiateOnboarding", "description": "Resource 'InitiateOnboarding' operations." }, { "name": "CreditNote", "description": "Resource 'CreditNote' operations." }, { "name": "Webhooks", "description": "Resource 'Webhooks' operations." }, { "name": "Invoice", "description": "Resource 'Invoice' operations." }, { "name": "LegalEntity", "description": "Resource 'LegalEntity' operations." }, { "name": "LegalEntitySubAccount", "description": "Resource 'LegalEntitySubAccount' operations." }, { "name": "MessageLevelStatus", "description": "Resource 'MessageLevelStatus' operations." }, { "name": "TaxDataDocument", "description": "Resource 'TaxDataDocument' operations." } ], "webhooks": {} }