{ "openapi": "3.1.0", "info": { "title": "A-Cube Peppol API", "description": "", "version": "1.0.0", "x-logo": { "url": "https://www.acubeapi.com/logo.svg" } }, "servers": [ { "url": "https://peppol-sandbox.api.acubeapi.com", "description": "A-Cube API Peppol sandbox environment" }, { "url": "https://peppol.api.acubeapi.com", "description": "A-Cube API Peppol production environment", "x-production": "hide" } ], "paths": { "/be/credit-notes": { "get": { "operationId": "api_becredit-notes_get_collection", "tags": [ "CreditNote" ], "responses": { "200": { "description": "CreditNote collection", "content": { "application/ld+json": { "schema": { "type": "object", "properties": { "hydra:member": { "type": "array", "items": { "$ref": "#/components/schemas/CreditNote.CreditNoteOutput.jsonld" } }, "hydra:totalItems": { "type": "integer", "minimum": 0 }, "hydra:view": { "type": "object", "properties": { "@id": { "type": "string", "format": "iri-reference" }, "@type": { "type": "string" }, "hydra:first": { "type": "string", "format": "iri-reference" }, "hydra:last": { "type": "string", "format": "iri-reference" }, "hydra:previous": { "type": "string", "format": "iri-reference" }, "hydra:next": { "type": "string", "format": "iri-reference" } }, "example": { "@id": "string", "type": "string", "hydra:first": "string", "hydra:last": "string", "hydra:previous": "string", "hydra:next": "string" } }, "hydra:search": { "type": "object", "properties": { "@type": { "type": "string" }, "hydra:template": { "type": "string" }, "hydra:variableRepresentation": { "type": "string" }, "hydra:mapping": { "type": "array", "items": { "type": "object", "properties": { "@type": { "type": "string" }, "variable": { "type": "string" }, "property": { "type": [ "string", "null" ] }, "required": { "type": "boolean" } } } } } } }, "required": [ "hydra:member" ] } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CreditNote.CreditNoteOutput" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CreditNote.CreditNoteOutput" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CreditNote.CreditNoteOutput" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CreditNote.CreditNoteOutput" } } }, "application/pdf": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CreditNote.CreditNoteOutput" } } } } } }, "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, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 30, "minimum": 0, "maximum": 30 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "senderName", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "senderId", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "senderId[]", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": true, "allowReserved": false }, { "name": "recipientName", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "recipientId", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "recipientId[]", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": true, "allowReserved": false }, { "name": "documentNumber", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "documentNumber[]", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": true, "allowReserved": false }, { "name": "sortBy[createdAt]", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "default": "desc", "enum": [ "asc", "desc" ] }, "style": "form", "explode": false, "allowReserved": false }, { "name": "sortBy[documentDate]", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "default": "asc", "enum": [ "asc", "desc" ] }, "style": "form", "explode": false, "allowReserved": false }, { "name": "sortBy[senderName]", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "default": "asc", "enum": [ "asc", "desc" ] }, "style": "form", "explode": false, "allowReserved": false }, { "name": "sortBy[recipientName]", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "default": "asc", "enum": [ "asc", "desc" ] }, "style": "form", "explode": false, "allowReserved": false }, { "name": "createdAt[before]", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "createdAt[strictly_before]", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "createdAt[after]", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "createdAt[strictly_after]", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "documentDate[before]", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "documentDate[strictly_before]", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "documentDate[after]", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "documentDate[strictly_after]", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "downloaded", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "boolean" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "direction", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "description": "Filter document by direction, chose between \"outgoing\" or \"incoming\"", "enum": [ "outgoing", "incoming" ], "type": "string" }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false, "x-apiplatform-tag": [ "BE" ] } }, "/be/credit-notes/downloaded": { "post": { "operationId": "api_becredit-notesdownloaded_post", "tags": [ "CreditNote" ], "responses": { "204": { "description": "CreditNote resource created", "content": { "application/ld+json": { "schema": {} }, "application/json": { "schema": {} }, "text/html": { "schema": {} }, "application/xml": { "schema": {} }, "text/xml": { "schema": {} }, "application/pdf": { "schema": {} } }, "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-jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation-json" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation-json" } } }, "links": {} } }, "summary": "Mark the documents as downloaded", "description": "This is useful to keep track of the document that have been received by the user.", "parameters": [], "requestBody": { "description": "The new CreditNote resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditNote.DownloadedInput" } } }, "required": true }, "deprecated": false, "x-apiplatform-tag": [ "BE" ] } }, "/be/credit-notes/outgoing/ubl": { "post": { "operationId": "api_be_credit_notes_post_outgoing_ubl_collection", "tags": [ "CreditNote" ], "responses": { "202": { "description": "CreditNote resource created", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/CreditNote.CreditNoteOutput.jsonld" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreditNote.CreditNoteOutput" } }, "text/html": { "schema": { "$ref": "#/components/schemas/CreditNote.CreditNoteOutput" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CreditNote.CreditNoteOutput" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CreditNote.CreditNoteOutput" } }, "application/pdf": { "schema": { "$ref": "#/components/schemas/CreditNote.CreditNoteOutput" } } }, "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-jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation-json" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation-json" } } }, "links": {} } }, "summary": "Create a new credit note in UBL format", "description": "Send a credit note in either the original XML format or the JSON transposition.\nYou must send the XML or JSON as the request body along with the right `Content-Type` header (`application/xml` or `application/json`).\n\nOptionally you can send the `X-Validation-Rule: {validation-rule-code}` where `{validation-rule-code}` is one of the available validation rules you can use.\nYou can retrieve a list of the available validation rules using the API `GET /validation-rules`.\nBy default the validation rule is autodetected using the latest rule available for the given document.", "parameters": [], "deprecated": false, "x-apiplatform-tag": [ "BE" ] } }, "/be/credit-notes/{uuid}": { "get": { "operationId": "api_becredit-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" } }, "text/html": { "schema": { "$ref": "#/components/schemas/CreditNote.CreditNoteOutput" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CreditNote.CreditNoteOutput" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CreditNote.CreditNoteOutput" } }, "application/pdf": { "schema": { "$ref": "#/components/schemas/CreditNote.CreditNoteOutput" } } } }, "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, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false, "x-apiplatform-tag": [ "BE" ] } }, "/be/credit-notes/{uuid}/print": { "get": { "operationId": "api_becredit-notes_uuidprint_get", "tags": [ "CreditNote" ], "responses": { "302": { "description": "CreditNote resource", "content": { "text/html": { "schema": {} }, "application/pdf": { "schema": {} } } }, "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 the printed version of the document", "description": "You will receive a 302 redirect response with the Location header pointing to the downloadable file. Additionally you get the URL to the downloaded file in the JSON response body.", "parameters": [ { "name": "uuid", "in": "path", "description": "CreditNote identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false, "x-apiplatform-tag": [ "BE" ] } }, "/be/credit-notes/{uuid}/source": { "get": { "operationId": "api_becredit-notes_uuidsource_get", "tags": [ "CreditNote" ], "responses": { "204": { "description": "CreditNote resource", "content": { "application/xml": { "schema": {} }, "application/json": { "schema": {} } } }, "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 the original source document", "description": "You can retrieve the original source document in either XML or JSON format.", "parameters": [ { "name": "uuid", "in": "path", "description": "CreditNote identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false, "x-apiplatform-tag": [ "BE" ] } }, "/be/invoices": { "get": { "operationId": "api_beinvoices_get_collection", "tags": [ "Invoice" ], "responses": { "200": { "description": "Invoice collection", "content": { "application/ld+json": { "schema": { "type": "object", "properties": { "hydra:member": { "type": "array", "items": { "$ref": "#/components/schemas/Invoice.InvoiceOutput.jsonld" } }, "hydra:totalItems": { "type": "integer", "minimum": 0 }, "hydra:view": { "type": "object", "properties": { "@id": { "type": "string", "format": "iri-reference" }, "@type": { "type": "string" }, "hydra:first": { "type": "string", "format": "iri-reference" }, "hydra:last": { "type": "string", "format": "iri-reference" }, "hydra:previous": { "type": "string", "format": "iri-reference" }, "hydra:next": { "type": "string", "format": "iri-reference" } }, "example": { "@id": "string", "type": "string", "hydra:first": "string", "hydra:last": "string", "hydra:previous": "string", "hydra:next": "string" } }, "hydra:search": { "type": "object", "properties": { "@type": { "type": "string" }, "hydra:template": { "type": "string" }, "hydra:variableRepresentation": { "type": "string" }, "hydra:mapping": { "type": "array", "items": { "type": "object", "properties": { "@type": { "type": "string" }, "variable": { "type": "string" }, "property": { "type": [ "string", "null" ] }, "required": { "type": "boolean" } } } } } } }, "required": [ "hydra:member" ] } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Invoice.InvoiceOutput" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Invoice.InvoiceOutput" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Invoice.InvoiceOutput" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Invoice.InvoiceOutput" } } }, "application/pdf": { "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, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 30, "minimum": 0, "maximum": 30 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "senderName", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "senderId", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "senderId[]", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": true, "allowReserved": false }, { "name": "recipientName", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "recipientId", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "recipientId[]", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": true, "allowReserved": false }, { "name": "documentNumber", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "documentNumber[]", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": true, "allowReserved": false }, { "name": "sortBy[createdAt]", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "default": "desc", "enum": [ "asc", "desc" ] }, "style": "form", "explode": false, "allowReserved": false }, { "name": "sortBy[documentDate]", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "default": "asc", "enum": [ "asc", "desc" ] }, "style": "form", "explode": false, "allowReserved": false }, { "name": "sortBy[senderName]", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "default": "asc", "enum": [ "asc", "desc" ] }, "style": "form", "explode": false, "allowReserved": false }, { "name": "sortBy[recipientName]", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "default": "asc", "enum": [ "asc", "desc" ] }, "style": "form", "explode": false, "allowReserved": false }, { "name": "createdAt[before]", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "createdAt[strictly_before]", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "createdAt[after]", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "createdAt[strictly_after]", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "documentDate[before]", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "documentDate[strictly_before]", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "documentDate[after]", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "documentDate[strictly_after]", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "downloaded", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "boolean" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "direction", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "description": "Filter document by direction, chose between \"outgoing\" or \"incoming\"", "enum": [ "outgoing", "incoming" ], "type": "string" }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false, "x-apiplatform-tag": [ "BE" ] } }, "/be/invoices/downloaded": { "post": { "operationId": "api_beinvoicesdownloaded_post", "tags": [ "Invoice" ], "responses": { "204": { "description": "Invoice resource created", "content": { "application/ld+json": { "schema": {} }, "application/json": { "schema": {} }, "text/html": { "schema": {} }, "application/xml": { "schema": {} }, "text/xml": { "schema": {} }, "application/pdf": { "schema": {} } }, "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-jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation-json" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation-json" } } }, "links": {} } }, "summary": "Mark the documents as downloaded", "description": "This is useful to keep track of the document that have been received by the user.", "parameters": [], "requestBody": { "description": "The new Invoice resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invoice.DownloadedInput" } } }, "required": true }, "deprecated": false, "x-apiplatform-tag": [ "BE" ] } }, "/be/invoices/outgoing/ubl": { "post": { "operationId": "api_be_invoices_post_outgoing_ubl_collection", "tags": [ "Invoice" ], "responses": { "202": { "description": "Invoice resource created", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Invoice.InvoiceOutput.jsonld" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Invoice.InvoiceOutput" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Invoice.InvoiceOutput" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Invoice.InvoiceOutput" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Invoice.InvoiceOutput" } }, "application/pdf": { "schema": { "$ref": "#/components/schemas/Invoice.InvoiceOutput" } } }, "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-jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation-json" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation-json" } } }, "links": {} } }, "summary": "Create a new invoice in UBL format", "description": "Send a invoice in either the original XML format or the JSON transposition.\nYou must send the XML or JSON as the request body along with the right `Content-Type` header (`application/xml` or `application/json`).\n\nOptionally you can send the `X-Validation-Rule: {validation-rule-code}` where `{validation-rule-code}` is one of the available validation rules you can use.\nYou can retrieve a list of the available validation rules using the API `GET /validation-rules`.\nBy default the validation rule is autodetected using the latest rule available for the given document.", "parameters": [], "deprecated": false, "x-apiplatform-tag": [ "BE" ] } }, "/be/invoices/{uuid}": { "get": { "operationId": "api_beinvoices_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" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Invoice.InvoiceOutput" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Invoice.InvoiceOutput" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Invoice.InvoiceOutput" } }, "application/pdf": { "schema": { "$ref": "#/components/schemas/Invoice.InvoiceOutput" } } } }, "404": { "description": "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, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false, "x-apiplatform-tag": [ "BE" ] } }, "/be/invoices/{uuid}/print": { "get": { "operationId": "api_beinvoices_uuidprint_get", "tags": [ "Invoice" ], "responses": { "302": { "description": "Invoice resource", "content": { "text/html": { "schema": {} }, "application/pdf": { "schema": {} } } }, "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 the printed version of the document", "description": "You will receive a 302 redirect response with the Location header pointing to the downloadable file. Additionally you get the URL to the downloaded file in the JSON response body.", "parameters": [ { "name": "uuid", "in": "path", "description": "Invoice identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false, "x-apiplatform-tag": [ "BE" ] } }, "/be/invoices/{uuid}/source": { "get": { "operationId": "api_beinvoices_uuidsource_get", "tags": [ "Invoice" ], "responses": { "204": { "description": "Invoice resource", "content": { "application/xml": { "schema": {} }, "application/json": { "schema": {} } } }, "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 the original source document", "description": "You can retrieve the original source document in either XML or JSON format.", "parameters": [ { "name": "uuid", "in": "path", "description": "Invoice identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false, "x-apiplatform-tag": [ "BE" ] } }, "/be/legal-entities": { "get": { "operationId": "api_belegal-entities_get_collection", "tags": [ "LegalEntity" ], "responses": { "200": { "description": "LegalEntity collection", "content": { "application/ld+json": { "schema": { "type": "object", "properties": { "hydra:member": { "type": "array", "items": { "$ref": "#/components/schemas/LegalEntity.LegalEntityOutput.jsonld" } }, "hydra:totalItems": { "type": "integer", "minimum": 0 }, "hydra:view": { "type": "object", "properties": { "@id": { "type": "string", "format": "iri-reference" }, "@type": { "type": "string" }, "hydra:first": { "type": "string", "format": "iri-reference" }, "hydra:last": { "type": "string", "format": "iri-reference" }, "hydra:previous": { "type": "string", "format": "iri-reference" }, "hydra:next": { "type": "string", "format": "iri-reference" } }, "example": { "@id": "string", "type": "string", "hydra:first": "string", "hydra:last": "string", "hydra:previous": "string", "hydra:next": "string" } }, "hydra:search": { "type": "object", "properties": { "@type": { "type": "string" }, "hydra:template": { "type": "string" }, "hydra:variableRepresentation": { "type": "string" }, "hydra:mapping": { "type": "array", "items": { "type": "object", "properties": { "@type": { "type": "string" }, "variable": { "type": "string" }, "property": { "type": [ "string", "null" ] }, "required": { "type": "boolean" } } } } } } }, "required": [ "hydra:member" ] } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LegalEntity.LegalEntityOutput" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LegalEntity.LegalEntityOutput" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LegalEntity.LegalEntityOutput" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LegalEntity.LegalEntityOutput" } } }, "application/pdf": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LegalEntity.LegalEntityOutput" } } } } }, "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 LegalEntity resources.", "description": "Retrieves the collection of LegalEntity resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 30, "minimum": 0, "maximum": 30 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "sortBy[createdAt]", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "default": "desc", "enum": [ "asc", "desc" ] }, "style": "form", "explode": false, "allowReserved": false }, { "name": "sortBy[registeredName]", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "default": "asc", "enum": [ "asc", "desc" ] }, "style": "form", "explode": false, "allowReserved": false }, { "name": "sortBy[identifierScheme]", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "default": "asc", "enum": [ "asc", "desc" ] }, "style": "form", "explode": false, "allowReserved": false }, { "name": "sortBy[identifierValue]", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "default": "asc", "enum": [ "asc", "desc" ] }, "style": "form", "explode": false, "allowReserved": false }, { "name": "identifierValue", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "registeredName", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false, "x-apiplatform-tag": [ "BE" ] }, "post": { "operationId": "api_belegal-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" } }, "text/html": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntityOutput" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntityOutput" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntityOutput" } }, "application/pdf": { "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-jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation-json" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation-json" } } }, "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.LegalEntityInput.jsonld" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntityInput" } }, "text/html": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntityInput" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntityInput" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntityInput" } }, "application/pdf": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntityInput" } } }, "required": true }, "deprecated": false, "x-apiplatform-tag": [ "BE" ] } }, "/be/legal-entities/{uuid}": { "get": { "operationId": "api_belegal-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" } }, "text/html": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntityOutput" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntityOutput" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntityOutput" } }, "application/pdf": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntityOutput" } } } }, "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 LegalEntity resource.", "description": "Retrieves a LegalEntity resource.", "parameters": [ { "name": "uuid", "in": "path", "description": "LegalEntity identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false, "x-apiplatform-tag": [ "BE" ] }, "put": { "operationId": "api_belegal-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" } }, "text/html": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntityOutput" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntityOutput" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntityOutput" } }, "application/pdf": { "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-jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation-json" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation-json" } } }, "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, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The updated LegalEntity resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntityInput.jsonld" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntityInput" } }, "text/html": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntityInput" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntityInput" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntityInput" } }, "application/pdf": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntityInput" } } }, "required": true }, "deprecated": false, "x-apiplatform-tag": [ "BE" ] }, "delete": { "operationId": "api_belegal-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, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false, "x-apiplatform-tag": [ "BE" ] } }, "/be/legal-entities/{uuid}/smp": { "get": { "operationId": "api_belegal-entities_uuidsmp_get", "tags": [ "LegalEntity" ], "responses": { "200": { "description": "LegalEntity resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntitySMPOutput.jsonld" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntitySMPOutput" } }, "text/html": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntitySMPOutput" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntitySMPOutput" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntitySMPOutput" } }, "application/pdf": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntitySMPOutput" } } } }, "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": "Read SMP records", "description": "Read the SMP records for the LegalEntity resource", "parameters": [ { "name": "uuid", "in": "path", "description": "LegalEntity identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false, "x-apiplatform-tag": [ "BE" ] }, "put": { "operationId": "api_belegal-entities_uuidsmp_put", "tags": [ "LegalEntity" ], "responses": { "200": { "description": "LegalEntity resource updated", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntitySMPOutput.jsonld" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntitySMPOutput" } }, "text/html": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntitySMPOutput" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntitySMPOutput" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntitySMPOutput" } }, "application/pdf": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntitySMPOutput" } } }, "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-jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation-json" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation-json" } } }, "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": "Manage SMP records", "description": "Manage the SMP records for the LegalEntity resource", "parameters": [ { "name": "uuid", "in": "path", "description": "LegalEntity identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The updated LegalEntity resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntitySimpleSMPInput.jsonld" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntitySimpleSMPInput" } }, "text/html": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntitySimpleSMPInput" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntitySimpleSMPInput" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntitySimpleSMPInput" } }, "application/pdf": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntitySimpleSMPInput" } } }, "required": true }, "deprecated": false, "x-apiplatform-tag": [ "BE" ] } }, "/be/legal-entities/{legalEntityUuid}/sub-accounts": { "get": { "operationId": "api_belegal-entities_legalEntityUuidsub-accounts_get_collection", "tags": [ "LegalEntitySubAccount" ], "responses": { "200": { "description": "LegalEntitySubAccount collection", "content": { "application/ld+json": { "schema": { "type": "object", "properties": { "hydra:member": { "type": "array", "items": { "$ref": "#/components/schemas/LegalEntitySubAccount.LegalEntitySubAccountOutput.jsonld" } }, "hydra:totalItems": { "type": "integer", "minimum": 0 }, "hydra:view": { "type": "object", "properties": { "@id": { "type": "string", "format": "iri-reference" }, "@type": { "type": "string" }, "hydra:first": { "type": "string", "format": "iri-reference" }, "hydra:last": { "type": "string", "format": "iri-reference" }, "hydra:previous": { "type": "string", "format": "iri-reference" }, "hydra:next": { "type": "string", "format": "iri-reference" } }, "example": { "@id": "string", "type": "string", "hydra:first": "string", "hydra:last": "string", "hydra:previous": "string", "hydra:next": "string" } }, "hydra:search": { "type": "object", "properties": { "@type": { "type": "string" }, "hydra:template": { "type": "string" }, "hydra:variableRepresentation": { "type": "string" }, "hydra:mapping": { "type": "array", "items": { "type": "object", "properties": { "@type": { "type": "string" }, "variable": { "type": "string" }, "property": { "type": [ "string", "null" ] }, "required": { "type": "boolean" } } } } } } }, "required": [ "hydra:member" ] } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LegalEntitySubAccount.LegalEntitySubAccountOutput" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LegalEntitySubAccount.LegalEntitySubAccountOutput" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LegalEntitySubAccount.LegalEntitySubAccountOutput" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LegalEntitySubAccount.LegalEntitySubAccountOutput" } } }, "application/pdf": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LegalEntitySubAccount.LegalEntitySubAccountOutput" } } } } }, "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": "Retrieve all sub-accounts for a specific legal entity.", "description": "Retrieves a list of sub-accounts associated with a specific legal entity, identified by its UUID.", "parameters": [ { "name": "legalEntityUuid", "in": "path", "description": "The UUID of the legal entity to which the sub-accounts belong.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 30, "minimum": 0, "maximum": 30 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false, "x-apiplatform-tag": "BE" }, "post": { "operationId": "api_belegal-entities_legalEntityUuidsub-accounts_post", "tags": [ "LegalEntitySubAccount" ], "responses": { "201": { "description": "LegalEntitySubAccount resource created", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/LegalEntitySubAccount.LegalEntitySubAccountOutput.jsonld" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LegalEntitySubAccount.LegalEntitySubAccountOutput" } }, "text/html": { "schema": { "$ref": "#/components/schemas/LegalEntitySubAccount.LegalEntitySubAccountOutput" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/LegalEntitySubAccount.LegalEntitySubAccountOutput" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/LegalEntitySubAccount.LegalEntitySubAccountOutput" } }, "application/pdf": { "schema": { "$ref": "#/components/schemas/LegalEntitySubAccount.LegalEntitySubAccountOutput" } } }, "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-jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation-json" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation-json" } } }, "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 a new sub-account for a legal entity.", "description": "Creates a new sub-account for a specific legal entity, identified by its UUID. The sub-account will be granted access only to document related to the legal entity.", "parameters": [ { "name": "legalEntityUuid", "in": "path", "description": "The UUID of the legal entity to which the sub-account will be associated.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new LegalEntitySubAccount resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/LegalEntitySubAccount.LegalEntitySubAccountInput.jsonld" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LegalEntitySubAccount.LegalEntitySubAccountInput" } }, "text/html": { "schema": { "$ref": "#/components/schemas/LegalEntitySubAccount.LegalEntitySubAccountInput" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/LegalEntitySubAccount.LegalEntitySubAccountInput" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/LegalEntitySubAccount.LegalEntitySubAccountInput" } }, "application/pdf": { "schema": { "$ref": "#/components/schemas/LegalEntitySubAccount.LegalEntitySubAccountInput" } } }, "required": true }, "deprecated": false, "x-apiplatform-tag": "BE" } }, "/be/legal-entities/{legalEntityUuid}/sub-accounts/{email}": { "delete": { "operationId": "api_belegal-entities_legalEntityUuidsub-accounts_email_delete", "tags": [ "LegalEntitySubAccount" ], "responses": { "204": { "description": "LegalEntitySubAccount 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": "Delete a sub-account by email for a specific legal entity.", "description": "Deletes a sub-account associated with a specific legal entity, identified by the legal entity UUID and the sub-account email address. This operation will remove the sub-account and revoke its access to documents related to the legal entity.", "parameters": [ { "name": "legalEntityUuid", "in": "path", "description": "The UUID of the legal entity to which the sub-account belongs.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "email", "in": "path", "description": "The email address of the sub-account to be deleted.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false, "x-apiplatform-tag": "BE" } }, "/be/smpquery/{participantId}": { "get": { "operationId": "api_besmpquery_participantId_get", "tags": [ "PeppolParticipant" ], "responses": { "200": { "description": "PeppolParticipant resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/PeppolParticipant.jsonld" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PeppolParticipant" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PeppolParticipant" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/PeppolParticipant" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/PeppolParticipant" } }, "application/pdf": { "schema": { "$ref": "#/components/schemas/PeppolParticipant" } } } }, "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": "Queries the SMP for a participantId.", "description": "Returns a 200 if the participantId exists. Returns 404 if no match is found", "parameters": [ { "name": "participantId", "in": "path", "description": "PeppolParticipant identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false, "x-apiplatform-tag": [ "BE" ] } }, "/webhooks": { "get": { "operationId": "api_webhooks_get_collection", "tags": [ "Webhook" ], "responses": { "200": { "description": "Webhook collection", "content": { "application/ld+json": { "schema": { "type": "object", "properties": { "hydra:member": { "type": "array", "items": { "$ref": "#/components/schemas/Webhook.WebhookOutput.jsonld" } }, "hydra:totalItems": { "type": "integer", "minimum": 0 }, "hydra:view": { "type": "object", "properties": { "@id": { "type": "string", "format": "iri-reference" }, "@type": { "type": "string" }, "hydra:first": { "type": "string", "format": "iri-reference" }, "hydra:last": { "type": "string", "format": "iri-reference" }, "hydra:previous": { "type": "string", "format": "iri-reference" }, "hydra:next": { "type": "string", "format": "iri-reference" } }, "example": { "@id": "string", "type": "string", "hydra:first": "string", "hydra:last": "string", "hydra:previous": "string", "hydra:next": "string" } }, "hydra:search": { "type": "object", "properties": { "@type": { "type": "string" }, "hydra:template": { "type": "string" }, "hydra:variableRepresentation": { "type": "string" }, "hydra:mapping": { "type": "array", "items": { "type": "object", "properties": { "@type": { "type": "string" }, "variable": { "type": "string" }, "property": { "type": [ "string", "null" ] }, "required": { "type": "boolean" } } } } } } }, "required": [ "hydra:member" ] } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Webhook.WebhookOutput" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Webhook.WebhookOutput" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Webhook.WebhookOutput" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Webhook.WebhookOutput" } } }, "application/pdf": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Webhook.WebhookOutput" } } } } }, "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 Webhook resources.", "description": "Retrieves the collection of Webhook resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 30, "minimum": 0, "maximum": 30 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false, "x-apiplatform-tag": [ "BE", "IT", "ZZ" ] }, "post": { "operationId": "api_webhooks_post", "tags": [ "Webhook" ], "responses": { "201": { "description": "Webhook resource created", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Webhook.WebhookOutput.jsonld" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Webhook.WebhookOutput" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Webhook.WebhookOutput" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Webhook.WebhookOutput" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Webhook.WebhookOutput" } }, "application/pdf": { "schema": { "$ref": "#/components/schemas/Webhook.WebhookOutput" } } }, "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-jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation-json" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation-json" } } }, "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 Webhook resource.", "description": "Creates a Webhook resource.", "parameters": [], "requestBody": { "description": "The new Webhook resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Webhook.WebhookInput.jsonld" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Webhook.WebhookInput" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Webhook.WebhookInput" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Webhook.WebhookInput" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Webhook.WebhookInput" } }, "application/pdf": { "schema": { "$ref": "#/components/schemas/Webhook.WebhookInput" } } }, "required": true }, "deprecated": false, "x-apiplatform-tag": [ "BE", "IT", "ZZ" ] } }, "/webhooks/{uuid}": { "get": { "operationId": "api_webhooks_uuid_get", "tags": [ "Webhook" ], "responses": { "200": { "description": "Webhook resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Webhook.WebhookOutput.jsonld" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Webhook.WebhookOutput" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Webhook.WebhookOutput" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Webhook.WebhookOutput" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Webhook.WebhookOutput" } }, "application/pdf": { "schema": { "$ref": "#/components/schemas/Webhook.WebhookOutput" } } } }, "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 Webhook resource.", "description": "Retrieves a Webhook resource.", "parameters": [ { "name": "uuid", "in": "path", "description": "Webhook identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false, "x-apiplatform-tag": [ "BE", "IT", "ZZ" ] }, "delete": { "operationId": "api_webhooks_uuid_delete", "tags": [ "Webhook" ], "responses": { "204": { "description": "Webhook 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 Webhook resource.", "description": "Removes the Webhook resource.", "parameters": [ { "name": "uuid", "in": "path", "description": "Webhook identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false, "x-apiplatform-tag": [ "BE", "IT", "ZZ" ] } } }, "components": { "schemas": { "ConstraintViolation-json": { "type": "object", "description": "Unprocessable entity", "deprecated": false, "properties": { "status": { "default": 422, "example": 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" } } } }, "detail": { "readOnly": true, "type": "string" }, "type": { "readOnly": true, "type": "string" }, "title": { "readOnly": true, "type": [ "string", "null" ] }, "instance": { "readOnly": true, "type": [ "string", "null" ] } } }, "ConstraintViolation.jsonld-jsonld": { "type": "object", "description": "Unprocessable entity", "deprecated": false, "properties": { "@context": { "readOnly": true, "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "@vocab": { "type": "string" }, "hydra": { "type": "string", "enum": [ "http://www.w3.org/ns/hydra/core#" ] } }, "required": [ "@vocab", "hydra" ], "additionalProperties": true } ] }, "@id": { "readOnly": true, "type": "string" }, "@type": { "readOnly": true, "type": "string" }, "status": { "default": 422, "example": 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" } } } }, "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" ] } } }, "CreditNote.CreditNoteOutput": { "type": "object", "description": "", "deprecated": false, "properties": { "uuid": { "type": "string" }, "direction": { "type": "string", "enum": [ "outgoing", "incoming" ] }, "format": { "type": "string", "enum": [ "UBL 2.1 XML", "UBL 2.1 JSON" ] }, "number": { "type": "string" }, "date": { "type": "string" }, "sender": { "$ref": "#/components/schemas/Participant" }, "recipient": { "$ref": "#/components/schemas/Participant" }, "createdAt": { "type": "string" }, "downloaded": { "type": "boolean" }, "peppolMessage": { "anyOf": [ { "$ref": "#/components/schemas/PeppolMessageOutput" }, { "type": "null" } ] } } }, "CreditNote.CreditNoteOutput.jsonld": { "type": "object", "description": "", "deprecated": false, "properties": { "@context": { "readOnly": true, "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "@vocab": { "type": "string" }, "hydra": { "type": "string", "enum": [ "http://www.w3.org/ns/hydra/core#" ] } }, "required": [ "@vocab", "hydra" ], "additionalProperties": true } ] }, "@id": { "readOnly": true, "type": "string" }, "@type": { "readOnly": true, "type": "string" }, "uuid": { "type": "string" }, "direction": { "type": "string", "enum": [ "outgoing", "incoming" ] }, "format": { "type": "string", "enum": [ "UBL 2.1 XML", "UBL 2.1 JSON" ] }, "number": { "type": "string" }, "date": { "type": "string" }, "sender": { "$ref": "#/components/schemas/Participant.jsonld" }, "recipient": { "$ref": "#/components/schemas/Participant.jsonld" }, "createdAt": { "type": "string" }, "downloaded": { "type": "boolean" }, "peppolMessage": { "anyOf": [ { "$ref": "#/components/schemas/PeppolMessageOutput.jsonld" }, { "type": "null" } ] } } }, "CreditNote.DownloadedInput": { "type": "object", "description": "", "deprecated": false, "required": [ "downloaded", "uuids" ], "properties": { "downloaded": { "type": "boolean" }, "uuids": { "minItems": 1, "type": "array", "items": { "type": "string" } } } }, "Error": { "type": "object", "description": "A representation of common errors.", "deprecated": false, "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": "number", "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": { "type": "object", "description": "A representation of common errors.", "deprecated": false, "properties": { "@context": { "readOnly": true, "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "@vocab": { "type": "string" }, "hydra": { "type": "string", "enum": [ "http://www.w3.org/ns/hydra/core#" ] } }, "required": [ "@vocab", "hydra" ], "additionalProperties": true } ] }, "@id": { "readOnly": true, "type": "string" }, "@type": { "readOnly": true, "type": "string" }, "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": "number", "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" ] } } }, "Invoice.DownloadedInput": { "type": "object", "description": "", "deprecated": false, "required": [ "downloaded", "uuids" ], "properties": { "downloaded": { "type": "boolean" }, "uuids": { "minItems": 1, "type": "array", "items": { "type": "string" } } } }, "Invoice.InvoiceOutput": { "type": "object", "description": "", "deprecated": false, "properties": { "uuid": { "type": "string" }, "direction": { "type": "string", "enum": [ "outgoing", "incoming" ] }, "format": { "type": "string", "enum": [ "UBL 2.1 XML", "UBL 2.1 JSON" ] }, "number": { "type": "string" }, "date": { "type": "string" }, "sender": { "$ref": "#/components/schemas/Participant" }, "recipient": { "$ref": "#/components/schemas/Participant" }, "createdAt": { "type": "string" }, "downloaded": { "type": "boolean" }, "peppolMessage": { "anyOf": [ { "$ref": "#/components/schemas/PeppolMessageOutput" }, { "type": "null" } ] } } }, "Invoice.InvoiceOutput.jsonld": { "type": "object", "description": "", "deprecated": false, "properties": { "@context": { "readOnly": true, "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "@vocab": { "type": "string" }, "hydra": { "type": "string", "enum": [ "http://www.w3.org/ns/hydra/core#" ] } }, "required": [ "@vocab", "hydra" ], "additionalProperties": true } ] }, "@id": { "readOnly": true, "type": "string" }, "@type": { "readOnly": true, "type": "string" }, "uuid": { "type": "string" }, "direction": { "type": "string", "enum": [ "outgoing", "incoming" ] }, "format": { "type": "string", "enum": [ "UBL 2.1 XML", "UBL 2.1 JSON" ] }, "number": { "type": "string" }, "date": { "type": "string" }, "sender": { "$ref": "#/components/schemas/Participant.jsonld" }, "recipient": { "$ref": "#/components/schemas/Participant.jsonld" }, "createdAt": { "type": "string" }, "downloaded": { "type": "boolean" }, "peppolMessage": { "anyOf": [ { "$ref": "#/components/schemas/PeppolMessageOutput.jsonld" }, { "type": "null" } ] } } }, "LegalEntity.LegalEntityInput": { "type": "object", "description": "", "deprecated": false, "required": [ "registeredName", "country", "address", "city", "zipCode", "identifierValue" ], "properties": { "registeredName": { "type": "string", "description": "Name used to register the End User in the business registry of the jurisdiction where it is legally based." }, "country": { "minLength": 2, "maxLength": 2, "default": "BE", "example": "BE", "type": "string", "description": "Country code ISO 3166-1 alpha-2 codes" }, "address": { "type": [ "string", "null" ], "description": "Legal entity address" }, "city": { "type": [ "string", "null" ], "description": "Legal entity city" }, "stateOrProvince": { "type": [ "string", "null" ], "description": "Legal entity state or province" }, "zipCode": { "minLength": 4, "maxLength": 4, "type": [ "string", "null" ], "description": "Legal entity zip code" }, "identifierScheme": { "enum": [ "iso6523-actorid-upis" ], "default": "iso6523-actorid-upis", "example": "iso6523-actorid-upis", "type": "string", "description": "The participant identifier scheme" }, "identifierValue": { "pattern": "^(.*(^(0208:[01]\\d{9}|9925:BE\\d{10})$).*)$", "type": "string", "description": "The participant identifier built in the form of 0208:{CBE number} or 9925:{VAT number}" }, "receivedDocumentNotificationEmails": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "The list of email addresses where a notification is sent for each received document" } } }, "LegalEntity.LegalEntityInput.jsonld": { "type": "object", "description": "", "deprecated": false, "required": [ "registeredName", "country", "address", "city", "zipCode", "identifierValue" ], "properties": { "registeredName": { "type": "string", "description": "Name used to register the End User in the business registry of the jurisdiction where it is legally based." }, "country": { "minLength": 2, "maxLength": 2, "default": "BE", "example": "BE", "type": "string", "description": "Country code ISO 3166-1 alpha-2 codes" }, "address": { "type": [ "string", "null" ], "description": "Legal entity address" }, "city": { "type": [ "string", "null" ], "description": "Legal entity city" }, "stateOrProvince": { "type": [ "string", "null" ], "description": "Legal entity state or province" }, "zipCode": { "minLength": 4, "maxLength": 4, "type": [ "string", "null" ], "description": "Legal entity zip code" }, "identifierScheme": { "enum": [ "iso6523-actorid-upis" ], "default": "iso6523-actorid-upis", "example": "iso6523-actorid-upis", "type": "string", "description": "The participant identifier scheme" }, "identifierValue": { "pattern": "^(.*(^(0208:[01]\\d{9}|9925:BE\\d{10})$).*)$", "type": "string", "description": "The participant identifier built in the form of 0208:{CBE number} or 9925:{VAT number}" }, "receivedDocumentNotificationEmails": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "The list of email addresses where a notification is sent for each received document" } } }, "LegalEntity.LegalEntityOutput": { "type": "object", "description": "", "deprecated": false, "properties": { "uuid": { "type": "string" }, "registeredName": { "type": "string", "description": "Name used to register the End User in the business registry of the jurisdiction where it is legally based." }, "country": { "type": [ "string", "null" ], "description": "Country code ISO 3166-1 alpha-2 codes" }, "address": { "type": [ "string", "null" ], "description": "Legal entity address" }, "city": { "type": [ "string", "null" ], "description": "Legal entity city" }, "stateOrProvince": { "type": [ "string", "null" ], "description": "Legal entity state or province" }, "zipCode": { "type": [ "string", "null" ], "description": "Legal entity zip code" }, "identifierScheme": { "default": "iso6523-actorid-upis", "example": "iso6523-actorid-upis", "type": "string", "description": "The participant identifier scheme" }, "identifierValue": { "type": "string", "description": "The participant identifier built as per the OpenPeppol normative version of the code list." }, "receivedDocumentNotificationEmails": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "The list of email addresses where a notification is sent for each received document" }, "smpEnabled": { "type": "boolean", "description": "True when this legal entity has been correctly registered into the SMP service." }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } } }, "LegalEntity.LegalEntityOutput.jsonld": { "type": "object", "description": "", "deprecated": false, "properties": { "@context": { "readOnly": true, "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "@vocab": { "type": "string" }, "hydra": { "type": "string", "enum": [ "http://www.w3.org/ns/hydra/core#" ] } }, "required": [ "@vocab", "hydra" ], "additionalProperties": true } ] }, "@id": { "readOnly": true, "type": "string" }, "@type": { "readOnly": true, "type": "string" }, "uuid": { "type": "string" }, "registeredName": { "type": "string", "description": "Name used to register the End User in the business registry of the jurisdiction where it is legally based." }, "country": { "type": [ "string", "null" ], "description": "Country code ISO 3166-1 alpha-2 codes" }, "address": { "type": [ "string", "null" ], "description": "Legal entity address" }, "city": { "type": [ "string", "null" ], "description": "Legal entity city" }, "stateOrProvince": { "type": [ "string", "null" ], "description": "Legal entity state or province" }, "zipCode": { "type": [ "string", "null" ], "description": "Legal entity zip code" }, "identifierScheme": { "default": "iso6523-actorid-upis", "example": "iso6523-actorid-upis", "type": "string", "description": "The participant identifier scheme" }, "identifierValue": { "type": "string", "description": "The participant identifier built as per the OpenPeppol normative version of the code list." }, "receivedDocumentNotificationEmails": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "The list of email addresses where a notification is sent for each received document" }, "smpEnabled": { "type": "boolean", "description": "True when this legal entity has been correctly registered into the SMP service." }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } } }, "LegalEntity.LegalEntitySMPOutput": { "type": "object", "description": "", "deprecated": false, "properties": { "enabled": { "type": "boolean" }, "capabilities": { "type": "array", "items": { "$ref": "#/components/schemas/LegalEntitySMPCapabilityOutput" }, "description": "The list of documents and processes this legal entity can manage, stored into the SMP." } } }, "LegalEntity.LegalEntitySMPOutput.jsonld": { "type": "object", "description": "", "deprecated": false, "properties": { "@context": { "readOnly": true, "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "@vocab": { "type": "string" }, "hydra": { "type": "string", "enum": [ "http://www.w3.org/ns/hydra/core#" ] } }, "required": [ "@vocab", "hydra" ], "additionalProperties": true } ] }, "@id": { "readOnly": true, "type": "string" }, "@type": { "readOnly": true, "type": "string" }, "enabled": { "type": "boolean" }, "capabilities": { "type": "array", "items": { "$ref": "#/components/schemas/LegalEntitySMPCapabilityOutput.jsonld" }, "description": "The list of documents and processes this legal entity can manage, stored into the SMP." } } }, "LegalEntity.LegalEntitySimpleSMPInput": { "type": "object", "description": "", "deprecated": false, "properties": { "enabled": { "type": "boolean", "description": "Setting enabled to true will write the record into the SMP, with false the record will be deleted from the SMP." }, "capabilities": { "type": "array", "items": { "type": "string", "enum": [ "invoice", "credit-note" ] }, "default": [ "invoice", "credit-note" ], "example": [ "invoice", "credit-note" ], "description": "The list of documents types this legal entity can manage, stored into the SMP." } } }, "LegalEntity.LegalEntitySimpleSMPInput.jsonld": { "type": "object", "description": "", "deprecated": false, "properties": { "enabled": { "type": "boolean", "description": "Setting enabled to true will write the record into the SMP, with false the record will be deleted from the SMP." }, "capabilities": { "type": "array", "items": { "type": "string", "enum": [ "invoice", "credit-note" ] }, "default": [ "invoice", "credit-note" ], "example": [ "invoice", "credit-note" ], "description": "The list of documents types this legal entity can manage, stored into the SMP." } } }, "LegalEntitySMPCapabilityOutput": { "type": "object", "description": "", "deprecated": false, "properties": { "documentTypeScheme": { "type": "string", "description": "The document type scheme, see the [list of supported document types](/docs/api/peppol/api-document-types-get-collection.api.mdx)" }, "documentType": { "type": "string", "description": "The document type identifier, see the [list of supported document types](/docs/api/peppol/api-document-types-get-collection.api.mdx)" }, "processScheme": { "type": "string", "description": "The process scheme, see the [list of supported processes](/docs/api/peppol/api-processes-get-collection.api.mdx)" }, "process": { "type": "string", "description": "The process identifier, see the [list of supported processes](/docs/api/peppol/api-processes-get-collection.api.mdx)" } } }, "LegalEntitySMPCapabilityOutput.jsonld": { "type": "object", "description": "", "deprecated": false, "properties": { "@context": { "readOnly": true, "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "@vocab": { "type": "string" }, "hydra": { "type": "string", "enum": [ "http://www.w3.org/ns/hydra/core#" ] } }, "required": [ "@vocab", "hydra" ], "additionalProperties": true } ] }, "@id": { "readOnly": true, "type": "string" }, "@type": { "readOnly": true, "type": "string" }, "documentTypeScheme": { "type": "string", "description": "The document type scheme, see the [list of supported document types](/docs/api/peppol/api-document-types-get-collection.api.mdx)" }, "documentType": { "type": "string", "description": "The document type identifier, see the [list of supported document types](/docs/api/peppol/api-document-types-get-collection.api.mdx)" }, "processScheme": { "type": "string", "description": "The process scheme, see the [list of supported processes](/docs/api/peppol/api-processes-get-collection.api.mdx)" }, "process": { "type": "string", "description": "The process identifier, see the [list of supported processes](/docs/api/peppol/api-processes-get-collection.api.mdx)" } } }, "LegalEntitySubAccount.LegalEntitySubAccountInput": { "type": "object", "description": "", "deprecated": false, "properties": { "email": { "format": "email", "description": "The username of the sub-account. It must be unique within the whole A-Cube platform.", "externalDocs": { "url": "https://schema.org/email" }, "type": "string" }, "password": { "description": "The password for the sub-account. It will be set only if the sub-account is created contextually within the request. If not provided, the user must set it later via the reset password flow.", "type": [ "string", "null" ] } } }, "LegalEntitySubAccount.LegalEntitySubAccountInput.jsonld": { "type": "object", "description": "", "deprecated": false, "properties": { "email": { "format": "email", "description": "The username of the sub-account. It must be unique within the whole A-Cube platform.", "externalDocs": { "url": "https://schema.org/email" }, "type": "string" }, "password": { "description": "The password for the sub-account. It will be set only if the sub-account is created contextually within the request. If not provided, the user must set it later via the reset password flow.", "type": [ "string", "null" ] } } }, "LegalEntitySubAccount.LegalEntitySubAccountOutput": { "type": "object", "description": "", "deprecated": false, "properties": { "uuid": { "type": "string" }, "email": { "type": "string" }, "createdAt": { "type": "string" } } }, "LegalEntitySubAccount.LegalEntitySubAccountOutput.jsonld": { "type": "object", "description": "", "deprecated": false, "properties": { "@context": { "readOnly": true, "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "@vocab": { "type": "string" }, "hydra": { "type": "string", "enum": [ "http://www.w3.org/ns/hydra/core#" ] } }, "required": [ "@vocab", "hydra" ], "additionalProperties": true } ] }, "@id": { "readOnly": true, "type": "string" }, "@type": { "readOnly": true, "type": "string" }, "uuid": { "type": "string" }, "email": { "type": "string" }, "createdAt": { "type": "string" } } }, "Participant": { "type": "object", "description": "", "deprecated": false, "properties": { "name": { "type": [ "string", "null" ] }, "identifier": { "type": [ "string", "null" ] } } }, "Participant.jsonld": { "type": "object", "description": "", "deprecated": false, "properties": { "@context": { "readOnly": true, "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "@vocab": { "type": "string" }, "hydra": { "type": "string", "enum": [ "http://www.w3.org/ns/hydra/core#" ] } }, "required": [ "@vocab", "hydra" ], "additionalProperties": true } ] }, "@id": { "readOnly": true, "type": "string" }, "@type": { "readOnly": true, "type": "string" }, "name": { "type": [ "string", "null" ] }, "identifier": { "type": [ "string", "null" ] } } }, "PeppolMessageOutput": { "type": "object", "description": "", "deprecated": false, "properties": { "uuid": { "type": "string" }, "createdAt": { "type": "string" }, "requestSentAt": { "type": [ "string", "null" ] }, "responseReceivedAt": { "type": [ "string", "null" ] }, "success": { "type": [ "boolean", "null" ] }, "errorCode": { "type": [ "string", "null" ] }, "errorMessage": { "type": [ "string", "null" ] } } }, "PeppolMessageOutput.jsonld": { "type": "object", "description": "", "deprecated": false, "properties": { "@context": { "readOnly": true, "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "@vocab": { "type": "string" }, "hydra": { "type": "string", "enum": [ "http://www.w3.org/ns/hydra/core#" ] } }, "required": [ "@vocab", "hydra" ], "additionalProperties": true } ] }, "@id": { "readOnly": true, "type": "string" }, "@type": { "readOnly": true, "type": "string" }, "uuid": { "type": "string" }, "createdAt": { "type": "string" }, "requestSentAt": { "type": [ "string", "null" ] }, "responseReceivedAt": { "type": [ "string", "null" ] }, "success": { "type": [ "boolean", "null" ] }, "errorCode": { "type": [ "string", "null" ] }, "errorMessage": { "type": [ "string", "null" ] } } }, "PeppolParticipant": { "type": "object", "description": "", "deprecated": false, "properties": { "participantID": { "type": "string" }, "urls": { "type": "array", "items": { "$ref": "#/components/schemas/PeppolUrl" } } } }, "PeppolParticipant.jsonld": { "type": "object", "description": "", "deprecated": false, "properties": { "@context": { "readOnly": true, "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "@vocab": { "type": "string" }, "hydra": { "type": "string", "enum": [ "http://www.w3.org/ns/hydra/core#" ] } }, "required": [ "@vocab", "hydra" ], "additionalProperties": true } ] }, "@id": { "readOnly": true, "type": "string" }, "@type": { "readOnly": true, "type": "string" }, "participantID": { "type": "string" }, "urls": { "type": "array", "items": { "$ref": "#/components/schemas/PeppolUrl.jsonld" } } } }, "PeppolUrl": { "type": "object", "description": "", "deprecated": false, "properties": { "href": { "type": "string" }, "documentTypeID": { "type": "string" }, "niceName": { "type": [ "string", "null" ] }, "state": { "type": [ "string", "null" ] }, "isDeprecated": { "type": [ "boolean", "null" ] } } }, "PeppolUrl.jsonld": { "type": "object", "description": "", "deprecated": false, "properties": { "@context": { "readOnly": true, "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "@vocab": { "type": "string" }, "hydra": { "type": "string", "enum": [ "http://www.w3.org/ns/hydra/core#" ] } }, "required": [ "@vocab", "hydra" ], "additionalProperties": true } ] }, "@id": { "readOnly": true, "type": "string" }, "@type": { "readOnly": true, "type": "string" }, "href": { "type": "string" }, "documentTypeID": { "type": "string" }, "niceName": { "type": [ "string", "null" ] }, "state": { "type": [ "string", "null" ] }, "isDeprecated": { "type": [ "boolean", "null" ] } } }, "Webhook.WebhookInput": { "type": "object", "description": "", "deprecated": false, "required": [ "event", "url" ], "properties": { "event": { "enum": [ "outgoing-document", "incoming-document" ], "default": "", "example": "", "type": "string" }, "url": { "format": "uri", "externalDocs": { "url": "https://schema.org/url" }, "default": "", "example": "", "type": "string" } } }, "Webhook.WebhookInput.jsonld": { "type": "object", "description": "", "deprecated": false, "required": [ "event", "url" ], "properties": { "event": { "enum": [ "outgoing-document", "incoming-document" ], "default": "", "example": "", "type": "string" }, "url": { "format": "uri", "externalDocs": { "url": "https://schema.org/url" }, "default": "", "example": "", "type": "string" } } }, "Webhook.WebhookOutput": { "type": "object", "description": "", "deprecated": false, "properties": { "uuid": { "type": "string" }, "event": { "type": "string" }, "url": { "type": "string" }, "createdAt": { "type": "string" } } }, "Webhook.WebhookOutput.jsonld": { "type": "object", "description": "", "deprecated": false, "properties": { "@context": { "readOnly": true, "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "@vocab": { "type": "string" }, "hydra": { "type": "string", "enum": [ "http://www.w3.org/ns/hydra/core#" ] } }, "required": [ "@vocab", "hydra" ], "additionalProperties": true } ] }, "@id": { "readOnly": true, "type": "string" }, "@type": { "readOnly": true, "type": "string" }, "uuid": { "type": "string" }, "event": { "type": "string" }, "url": { "type": "string" }, "createdAt": { "type": "string" } } } }, "responses": {}, "parameters": {}, "examples": {}, "requestBodies": {}, "headers": {}, "securitySchemes": { "bearerAuth": { "type": "http", "description": "Received from Platform Authentication.", "scheme": "bearer", "bearerFormat": "JWT" } } }, "security": [ { "bearerAuth": [] } ], "tags": [ { "name": "PeppolParticipant" }, { "name": "CreditNote" }, { "name": "Invoice" }, { "name": "LegalEntity" }, { "name": "LegalEntitySubAccount" }, { "name": "Webhook" } ], "webhooks": {} }