{ "openapi": "3.1.0", "info": { "title": "Gov-DE API Platform", "description": "API Platform for Gov-DE project", "version": "1.0.0" }, "servers": [ { "url": "/", "description": "" } ], "paths": { "/api/event-destinations": { "get": { "operationId": "api_event-destinations_get_collection", "tags": [ "EventDestination" ], "responses": { "200": { "description": "EventDestination collection", "content": { "application/ld+json": { "schema": { "type": "object", "description": "EventDestination.EventDestinationReadResource.jsonld collection.", "allOf": [ { "$ref": "#/components/schemas/HydraCollectionBaseSchema" }, { "type": "object", "required": [ "member" ], "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/EventDestination.EventDestinationReadResource.jsonld" } } } } ] } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EventDestination.EventDestinationReadResource" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EventDestination.EventDestinationReadResource.html" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EventDestination.EventDestinationReadResource.xml" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EventDestination.EventDestinationReadResource.xml" } } }, "application/octet-stream": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EventDestination.EventDestinationReadResource.raw" } } } } }, "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 all configured event destinations", "description": "Returns the event destination collection for the authenticated owner.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "schema": { "type": "integer", "default": 30, "minimum": 0, "maximum": 100 }, "style": "form", "explode": false } ] }, "post": { "operationId": "api_event-destinations_post", "tags": [ "EventDestination" ], "responses": { "201": { "description": "EventDestination resource created", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/EventDestination.EventDestinationReadResource.jsonld" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EventDestination.EventDestinationReadResource" } }, "text/html": { "schema": { "$ref": "#/components/schemas/EventDestination.EventDestinationReadResource.html" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/EventDestination.EventDestinationReadResource.xml" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/EventDestination.EventDestinationReadResource.xml" } }, "application/octet-stream": { "schema": { "$ref": "#/components/schemas/EventDestination.EventDestinationReadResource.raw" } } }, "links": {} }, "400": { "description": "Invalid input", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} }, "422": { "description": "An error occurred", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } } }, "links": {} }, "403": { "description": "Forbidden", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} } }, "summary": "Creates an event destination", "description": "Registers a destination endpoint for a single subscribed event type.", "parameters": [], "requestBody": { "description": "The new EventDestination resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/EventDestination.EventDestinationCreateInput" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EventDestination.EventDestinationCreateInput" } }, "text/html": { "schema": { "$ref": "#/components/schemas/EventDestination.EventDestinationCreateInput" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/EventDestination.EventDestinationCreateInput" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/EventDestination.EventDestinationCreateInput" } }, "application/octet-stream": { "schema": { "$ref": "#/components/schemas/EventDestination.EventDestinationCreateInput" } } }, "required": true } } }, "/api/event-destinations/{uuid}": { "get": { "operationId": "api_event-destinations_uuid_get", "tags": [ "EventDestination" ], "responses": { "200": { "description": "EventDestination resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/EventDestination.EventDestinationReadResource.jsonld" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EventDestination.EventDestinationReadResource" } }, "text/html": { "schema": { "$ref": "#/components/schemas/EventDestination.EventDestinationReadResource.html" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/EventDestination.EventDestinationReadResource.xml" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/EventDestination.EventDestinationReadResource.xml" } }, "application/octet-stream": { "schema": { "$ref": "#/components/schemas/EventDestination.EventDestinationReadResource.raw" } } } }, "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 specific event destination", "description": "Returns one event destination configuration for the authenticated owner.", "parameters": [ { "name": "uuid", "in": "path", "description": "EventDestination identifier", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ] }, "delete": { "operationId": "api_event-destinations_uuid_delete", "tags": [ "EventDestination" ], "responses": { "204": { "description": "EventDestination 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": "Deletes an event destination", "description": "Removes an event destination from the authenticated owner.", "parameters": [ { "name": "uuid", "in": "path", "description": "EventDestination identifier", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ] } }, "/api/invoices": { "get": { "operationId": "api_invoices_get_collection", "tags": [ "Invoice" ], "responses": { "200": { "description": "Invoice collection", "content": { "application/ld+json": { "schema": { "type": "object", "description": "Invoice.InvoiceReadResource.jsonld collection.", "allOf": [ { "$ref": "#/components/schemas/HydraCollectionBaseSchema" }, { "type": "object", "required": [ "member" ], "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/Invoice.InvoiceReadResource.jsonld" } } } } ] } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Invoice.InvoiceReadResource" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Invoice.InvoiceReadResource.html" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Invoice.InvoiceReadResource.xml" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Invoice.InvoiceReadResource.xml" } } }, "application/octet-stream": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Invoice.InvoiceReadResource.raw" } } } } }, "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 invoices", "description": "Returns a paginated list of invoices. Filter by direction or status via query params.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "schema": { "type": "integer", "default": 30, "minimum": 0, "maximum": 100 }, "style": "form", "explode": false }, { "name": "owningLegalEntity.uuid", "in": "query", "description": "", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false }, { "name": "owningLegalEntity.uuid[]", "in": "query", "description": "", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": true }, { "name": "owningLegalEntity.name", "in": "query", "description": "", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false }, { "name": "owningLegalEntity.email", "in": "query", "description": "", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false }, { "name": "invoiceNumber", "in": "query", "description": "", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false }, { "name": "status", "in": "query", "description": "", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false }, { "name": "status[]", "in": "query", "description": "", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": true }, { "name": "direction", "in": "query", "description": "", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false }, { "name": "direction[]", "in": "query", "description": "", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": true }, { "name": "sender.identifier", "in": "query", "description": "", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false }, { "name": "sender.identifier[]", "in": "query", "description": "", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": true }, { "name": "sender.name", "in": "query", "description": "", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false }, { "name": "recipient.identifier", "in": "query", "description": "", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false }, { "name": "recipient.identifier[]", "in": "query", "description": "", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": true }, { "name": "recipient.name", "in": "query", "description": "", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false }, { "name": "externalReferenceId", "in": "query", "description": "", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false }, { "name": "invoiceDate[before]", "in": "query", "description": "", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false }, { "name": "invoiceDate[strictly_before]", "in": "query", "description": "", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false }, { "name": "invoiceDate[after]", "in": "query", "description": "", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false }, { "name": "invoiceDate[strictly_after]", "in": "query", "description": "", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false }, { "name": "dueDate[before]", "in": "query", "description": "", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false }, { "name": "dueDate[strictly_before]", "in": "query", "description": "", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false }, { "name": "dueDate[after]", "in": "query", "description": "", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false }, { "name": "dueDate[strictly_after]", "in": "query", "description": "", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false }, { "name": "sortBy[invoiceDate]", "in": "query", "description": "", "required": false, "deprecated": false, "schema": { "type": "string", "default": "asc", "enum": [ "asc", "desc" ] }, "style": "form", "explode": false }, { "name": "sortBy[sender.name]", "in": "query", "description": "", "required": false, "deprecated": false, "schema": { "type": "string", "default": "asc", "enum": [ "asc", "desc" ] }, "style": "form", "explode": false }, { "name": "sortBy[recipient.name]", "in": "query", "description": "", "required": false, "deprecated": false, "schema": { "type": "string", "default": "asc", "enum": [ "asc", "desc" ] }, "style": "form", "explode": false }, { "name": "amounts.totalAmount[between]", "in": "query", "description": "", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false }, { "name": "amounts.totalAmount[gt]", "in": "query", "description": "", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false }, { "name": "amounts.totalAmount[gte]", "in": "query", "description": "", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false }, { "name": "amounts.totalAmount[lt]", "in": "query", "description": "", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false }, { "name": "amounts.totalAmount[lte]", "in": "query", "description": "", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false }, { "name": "amounts.totalAmountNet[between]", "in": "query", "description": "", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false }, { "name": "amounts.totalAmountNet[gt]", "in": "query", "description": "", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false }, { "name": "amounts.totalAmountNet[gte]", "in": "query", "description": "", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false }, { "name": "amounts.totalAmountNet[lt]", "in": "query", "description": "", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false }, { "name": "amounts.totalAmountNet[lte]", "in": "query", "description": "", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false }, { "name": "downloaded", "in": "query", "description": "Filter by downloaded state. true => downloadedByRecipientAt IS NOT NULL, false => downloadedByRecipientAt IS NULL.", "required": false, "deprecated": false, "schema": { "type": "boolean" }, "style": "form", "explode": false } ] } }, "/api/invoices/downloaded": { "post": { "operationId": "api_invoicesdownloaded_post", "tags": [ "Invoice" ], "responses": { "204": { "description": "Invoice resource created", "links": {} }, "400": { "description": "Invalid input", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} }, "422": { "description": "An error occurred", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } } }, "links": {} }, "403": { "description": "Forbidden", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} } }, "summary": "Mark invoices as downloaded", "description": "Marks or unmarks multiple invoices as downloaded for the authenticated owner.", "parameters": [], "requestBody": { "description": "The new Invoice resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invoice.DownloadedInput" } } }, "required": true } } }, "/api/invoices/{uuid}": { "get": { "operationId": "api_invoices_uuid_get", "tags": [ "Invoice" ], "responses": { "200": { "description": "Invoice resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Invoice.InvoiceReadResource.jsonld" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Invoice.InvoiceReadResource" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Invoice.InvoiceReadResource.html" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Invoice.InvoiceReadResource.xml" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Invoice.InvoiceReadResource.xml" } }, "application/octet-stream": { "schema": { "$ref": "#/components/schemas/Invoice.InvoiceReadResource.raw" } } } }, "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 an invoice", "description": "Returns the full invoice resource for the authenticated owner.", "parameters": [ { "name": "uuid", "in": "path", "description": "Invoice identifier", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ] } }, "/api/invoices/{uuid}/print": { "get": { "operationId": "api_invoices_uuidprint_get", "tags": [ "Invoice" ], "responses": { "200": { "description": "Invoice resource", "content": { "text/html": { "schema": { "$ref": "#/components/schemas/Invoice.print_html" } }, "application/pdf": { "schema": { "$ref": "#/components/schemas/Invoice.pdf" } } } }, "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": "Get the printed version of the document", "description": "Returns a printable invoice representation in HTML or PDF.", "parameters": [ { "name": "uuid", "in": "path", "description": "Invoice identifier", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ] } }, "/api/invoices/{uuid}/source": { "get": { "operationId": "api_invoices_uuidsource_get", "tags": [ "Invoice" ], "responses": { "200": { "description": "Invoice resource", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/Invoice.xml" } } } }, "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": "Get the original source document", "description": "You can retrieve the original source document in XML format.", "parameters": [ { "name": "uuid", "in": "path", "description": "Invoice identifier", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ] } }, "/api/legal-entities": { "get": { "operationId": "api_legal-entities_get_collection", "tags": [ "LegalEntity" ], "responses": { "200": { "description": "LegalEntity collection", "content": { "application/ld+json": { "schema": { "type": "object", "description": "LegalEntity.LegalEntityReadResource.jsonld collection.", "allOf": [ { "$ref": "#/components/schemas/HydraCollectionBaseSchema" }, { "type": "object", "required": [ "member" ], "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/LegalEntity.LegalEntityReadResource.jsonld" } } } } ] } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LegalEntity.LegalEntityReadResource" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LegalEntity.LegalEntityReadResource.html" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LegalEntity.LegalEntityReadResource.xml" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LegalEntity.LegalEntityReadResource.xml" } } }, "application/octet-stream": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LegalEntity.LegalEntityReadResource.raw" } } } } }, "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 a list of legal entities managed by the Partner", "description": "", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "schema": { "type": "integer", "default": 30, "minimum": 0, "maximum": 100 }, "style": "form", "explode": false } ] }, "post": { "operationId": "api_legal-entities_post", "tags": [ "LegalEntity" ], "responses": { "201": { "description": "LegalEntity resource created", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntityReadResource.jsonld" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntityReadResource" } }, "text/html": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntityReadResource.html" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntityReadResource.xml" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntityReadResource.xml" } }, "application/octet-stream": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntityReadResource.raw" } } }, "links": {} }, "400": { "description": "Invalid input", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} }, "422": { "description": "An error occurred", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } } }, "links": {} }, "403": { "description": "Forbidden", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} } }, "summary": "Creates a new legal entity, registered in the system", "description": "", "parameters": [], "requestBody": { "description": "The new LegalEntity resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntityCreateResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntityCreateResource" } }, "text/html": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntityCreateResource" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntityCreateResource" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntityCreateResource" } }, "application/octet-stream": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntityCreateResource" } } }, "required": true } } }, "/api/legal-entities/{uuid}": { "get": { "operationId": "api_legal-entities_uuid_get", "tags": [ "LegalEntity" ], "responses": { "200": { "description": "LegalEntity resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntityReadResource.jsonld" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntityReadResource" } }, "text/html": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntityReadResource.html" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntityReadResource.xml" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntityReadResource.xml" } }, "application/octet-stream": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntityReadResource.raw" } } } }, "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 specific legal entity", "description": "", "parameters": [ { "name": "uuid", "in": "path", "description": "LegalEntity identifier", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ] }, "put": { "operationId": "api_legal-entities_uuid_put", "tags": [ "LegalEntity" ], "responses": { "200": { "description": "LegalEntity resource updated", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntityReadResource.jsonld" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntityReadResource" } }, "text/html": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntityReadResource.html" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntityReadResource.xml" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntityReadResource.xml" } }, "application/octet-stream": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntityReadResource.raw" } } }, "links": {} }, "400": { "description": "Invalid input", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} }, "422": { "description": "An error occurred", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } } }, "links": {} }, "403": { "description": "Forbidden", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} }, "404": { "description": "Not found", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} } }, "summary": "Replaces data for an existing legal entity", "description": "", "parameters": [ { "name": "uuid", "in": "path", "description": "LegalEntity identifier", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ], "requestBody": { "description": "The updated LegalEntity resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntityUpdateResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntityUpdateResource" } }, "text/html": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntityUpdateResource" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntityUpdateResource" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntityUpdateResource" } }, "application/octet-stream": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntityUpdateResource" } } }, "required": true } }, "delete": { "operationId": "api_legal-entities_uuid_delete", "tags": [ "LegalEntity" ], "responses": { "204": { "description": "LegalEntity resource deleted" }, "403": { "description": "Forbidden", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} }, "404": { "description": "Not found", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} } }, "summary": "Removes the legal entity. Only if there are no associated invoices.", "description": "", "parameters": [ { "name": "uuid", "in": "path", "description": "LegalEntity identifier", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ] } }, "/api/invoices/outgoing/xrechnung": { "post": { "operationId": "api_invoicesoutgoingxrechnung_post", "tags": [ "OutgoingXRechnungCreateResource" ], "responses": { "201": { "description": "XRechnung invoice created successfully", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/OutgoingXRechnungCreateResource.InvoiceReadResource.jsonld" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OutgoingXRechnungCreateResource.InvoiceReadResource" } }, "text/html": { "schema": { "$ref": "#/components/schemas/OutgoingXRechnungCreateResource.InvoiceReadResource.html" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OutgoingXRechnungCreateResource.InvoiceReadResource.xml" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/OutgoingXRechnungCreateResource.InvoiceReadResource.xml" } }, "application/octet-stream": { "schema": { "$ref": "#/components/schemas/OutgoingXRechnungCreateResource.InvoiceReadResource.raw" } } }, "links": {} }, "400": { "description": "Invalid request format or missing fields", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} }, "422": { "description": "XRechnung validation failed or business rule violation", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } } }, "links": {} }, "404": { "description": "Legal entity not found" }, "403": { "description": "Forbidden", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} } }, "summary": "Create an outgoing XRechnung invoice", "description": "Accepts an XRechnung XML document directly as request body", "parameters": [] } }, "/api/invoices/outgoing/zugferd": { "post": { "operationId": "api_invoicesoutgoingzugferd_post", "tags": [ "OutgoingZugferdCreateResource" ], "responses": { "201": { "description": "ZUGFeRD invoice created successfully", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/OutgoingZugferdCreateResource.InvoiceReadResource.jsonld" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OutgoingZugferdCreateResource.InvoiceReadResource" } }, "text/html": { "schema": { "$ref": "#/components/schemas/OutgoingZugferdCreateResource.InvoiceReadResource.html" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OutgoingZugferdCreateResource.InvoiceReadResource.xml" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/OutgoingZugferdCreateResource.InvoiceReadResource.xml" } }, "application/octet-stream": { "schema": { "$ref": "#/components/schemas/OutgoingZugferdCreateResource.InvoiceReadResource.raw" } } }, "links": {} }, "400": { "description": "Invalid request format or missing fields", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} }, "422": { "description": "ZUGFeRD validation failed or business rule violation", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } } }, "links": {} }, "404": { "description": "Legal entity not found" }, "403": { "description": "Forbidden", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} } }, "summary": "Create an outgoing ZUGFeRD invoice", "description": "Accepts a ZUGFeRD XML document directly as request body", "parameters": [] } } }, "components": { "schemas": { "ConstraintViolation": { "type": "object", "description": "Unprocessable entity", "properties": { "status": { "default": 422, "type": "integer" }, "violations": { "type": "array", "items": { "type": "object", "properties": { "propertyPath": { "type": "string", "description": "The property path of the violation" }, "message": { "type": "string", "description": "The message associated with the violation" }, "code": { "type": "string", "description": "The code of the violation" }, "hint": { "type": "string", "description": "An extra hint to understand the violation" }, "payload": { "type": "object", "additionalProperties": true, "description": "The serialized payload of the violation" } }, "required": [ "propertyPath", "message" ] } }, "detail": { "readOnly": true, "type": "string" }, "type": { "readOnly": true, "type": "string" }, "title": { "readOnly": true, "type": [ "string", "null" ] }, "instance": { "readOnly": true, "type": [ "string", "null" ] } } }, "ConstraintViolation.jsonld": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "status": { "default": 422, "type": "integer" }, "violations": { "type": "array", "items": { "type": "object", "properties": { "propertyPath": { "type": "string", "description": "The property path of the violation" }, "message": { "type": "string", "description": "The message associated with the violation" }, "code": { "type": "string", "description": "The code of the violation" }, "hint": { "type": "string", "description": "An extra hint to understand the violation" }, "payload": { "type": "object", "additionalProperties": true, "description": "The serialized payload of the violation" } }, "required": [ "propertyPath", "message" ] } }, "detail": { "readOnly": true, "type": "string" }, "description": { "readOnly": true, "type": "string" }, "type": { "readOnly": true, "type": "string" }, "title": { "readOnly": true, "type": [ "string", "null" ] }, "instance": { "readOnly": true, "type": [ "string", "null" ] } } } ], "description": "Unprocessable entity" }, "Error": { "type": "object", "description": "A representation of common errors.", "properties": { "title": { "readOnly": true, "description": "A short, human-readable summary of the problem.", "type": [ "string", "null" ] }, "detail": { "readOnly": true, "description": "A human-readable explanation specific to this occurrence of the problem.", "type": [ "string", "null" ] }, "status": { "type": [ "number", "null" ], "examples": [ 404 ], "default": 400 }, "instance": { "readOnly": true, "description": "A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.", "type": [ "string", "null" ] }, "type": { "readOnly": true, "description": "A URI reference that identifies the problem type", "type": "string" } } }, "Error.jsonld": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "title": { "readOnly": true, "description": "A short, human-readable summary of the problem.", "type": [ "string", "null" ] }, "detail": { "readOnly": true, "description": "A human-readable explanation specific to this occurrence of the problem.", "type": [ "string", "null" ] }, "status": { "type": [ "number", "null" ], "examples": [ 404 ], "default": 400 }, "instance": { "readOnly": true, "description": "A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.", "type": [ "string", "null" ] }, "type": { "readOnly": true, "description": "A URI reference that identifies the problem type", "type": "string" }, "description": { "readOnly": true, "type": [ "string", "null" ] } } } ], "description": "A representation of common errors." }, "EventDestination": { "type": "object", "properties": { "uuid": { "type": [ "string", "null" ], "format": "uuid" }, "ownerId": { "type": "integer" }, "target": { "type": "string" }, "event": { "type": "string", "enum": [ "invoice.sent", "invoice.received", "invoice.rejected", "invoice.failed", "legal_entity.onboarding_completed", "legal_entity.onboarding_failed" ] }, "delivery": { "type": "string", "enum": [ "webhook", "email", "aws_event_bridge" ] }, "authType": { "type": "string", "enum": [ "none", "query", "header" ] }, "authToken": { "type": [ "string", "null" ] }, "authKey": { "default": "token", "type": [ "string", "null" ] }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, "EventDestination.EventDestinationCreateInput": { "type": "object", "required": [ "event", "delivery", "target", "authType" ], "properties": { "event": { "enum": [ "invoice.sent", "invoice.received", "invoice.rejected", "invoice.failed", "legal_entity.onboarding_completed", "legal_entity.onboarding_failed" ], "type": "string" }, "delivery": { "enum": [ "webhook" ], "type": "string" }, "target": { "format": "uri", "maxLength": 2048, "externalDocs": { "url": "https://schema.org/url" }, "type": "string" }, "authType": { "enum": [ "none", "query", "header" ], "type": "string" }, "authToken": { "maxLength": 2048, "type": [ "string", "null" ] }, "authKey": { "maxLength": 255, "type": [ "string", "null" ] } } }, "EventDestination.EventDestinationReadResource": { "type": "object", "properties": { "uuid": { "readOnly": true, "type": "string" }, "event": { "type": "string" }, "delivery": { "type": "string" }, "target": { "type": "string" }, "authType": { "type": "string" }, "authKey": { "type": "string" } } }, "EventDestination.EventDestinationReadResource.html": { "type": "object", "properties": { "uuid": { "readOnly": true, "type": "string" }, "event": { "type": "string" }, "delivery": { "type": "string" }, "target": { "type": "string" }, "authType": { "type": "string" }, "authKey": { "type": "string" } } }, "EventDestination.EventDestinationReadResource.jsonld": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "uuid": { "readOnly": true, "type": "string" }, "event": { "type": "string" }, "delivery": { "type": "string" }, "target": { "type": "string" }, "authType": { "type": "string" }, "authKey": { "type": "string" } } } ] }, "EventDestination.EventDestinationReadResource.raw": { "type": "object", "properties": { "uuid": { "readOnly": true, "type": "string" }, "event": { "type": "string" }, "delivery": { "type": "string" }, "target": { "type": "string" }, "authType": { "type": "string" }, "authKey": { "type": "string" } } }, "EventDestination.EventDestinationReadResource.xml": { "type": "object", "properties": { "uuid": { "readOnly": true, "type": "string" }, "event": { "type": "string" }, "delivery": { "type": "string" }, "target": { "type": "string" }, "authType": { "type": "string" }, "authKey": { "type": "string" } } }, "EventDestination.html": { "type": "object", "properties": { "uuid": { "type": [ "string", "null" ], "format": "uuid" }, "ownerId": { "type": "integer" }, "target": { "type": "string" }, "event": { "type": "string", "enum": [ "invoice.sent", "invoice.received", "invoice.rejected", "invoice.failed", "legal_entity.onboarding_completed", "legal_entity.onboarding_failed" ] }, "delivery": { "type": "string", "enum": [ "webhook", "email", "aws_event_bridge" ] }, "authType": { "type": "string", "enum": [ "none", "query", "header" ] }, "authToken": { "type": [ "string", "null" ] }, "authKey": { "default": "token", "type": [ "string", "null" ] }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, "EventDestination.jsonld": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "uuid": { "type": [ "string", "null" ], "format": "uuid" }, "ownerId": { "type": "integer" }, "target": { "type": "string" }, "event": { "type": "string", "enum": [ "invoice.sent", "invoice.received", "invoice.rejected", "invoice.failed", "legal_entity.onboarding_completed", "legal_entity.onboarding_failed" ] }, "delivery": { "type": "string", "enum": [ "webhook", "email", "aws_event_bridge" ] }, "authType": { "type": "string", "enum": [ "none", "query", "header" ] }, "authToken": { "type": [ "string", "null" ] }, "authKey": { "default": "token", "type": [ "string", "null" ] }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } ] }, "EventDestination.raw": { "type": "object", "properties": { "uuid": { "type": [ "string", "null" ], "format": "uuid" }, "ownerId": { "type": "integer" }, "target": { "type": "string" }, "event": { "type": "string", "enum": [ "invoice.sent", "invoice.received", "invoice.rejected", "invoice.failed", "legal_entity.onboarding_completed", "legal_entity.onboarding_failed" ] }, "delivery": { "type": "string", "enum": [ "webhook", "email", "aws_event_bridge" ] }, "authType": { "type": "string", "enum": [ "none", "query", "header" ] }, "authToken": { "type": [ "string", "null" ] }, "authKey": { "default": "token", "type": [ "string", "null" ] }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, "EventDestination.xml": { "type": "object", "properties": { "uuid": { "type": [ "string", "null" ], "format": "uuid" }, "ownerId": { "type": "integer" }, "target": { "type": "string" }, "event": { "type": "string", "enum": [ "invoice.sent", "invoice.received", "invoice.rejected", "invoice.failed", "legal_entity.onboarding_completed", "legal_entity.onboarding_failed" ] }, "delivery": { "type": "string", "enum": [ "webhook", "email", "aws_event_bridge" ] }, "authType": { "type": "string", "enum": [ "none", "query", "header" ] }, "authToken": { "type": [ "string", "null" ] }, "authKey": { "default": "token", "type": [ "string", "null" ] }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, "GermanVatId": { "type": "object", "properties": { "identifier": { "readOnly": true, "type": "string" } } }, "GermanVatId.html": { "type": "object", "properties": { "identifier": { "readOnly": true, "type": "string" } } }, "GermanVatId.jsonld": { "type": "object", "properties": { "identifier": { "readOnly": true, "type": "string" } } }, "GermanVatId.raw": { "type": "object", "properties": { "identifier": { "readOnly": true, "type": "string" } } }, "GermanVatId.xml": { "type": "object", "properties": { "identifier": { "readOnly": true, "type": "string" } } }, "HydraCollectionBaseSchema": { "allOf": [ { "$ref": "#/components/schemas/HydraCollectionBaseSchemaNoPagination" }, { "type": "object", "properties": { "view": { "type": "object", "properties": { "@id": { "type": "string", "format": "iri-reference" }, "@type": { "type": "string" }, "first": { "type": "string", "format": "iri-reference" }, "last": { "type": "string", "format": "iri-reference" }, "previous": { "type": "string", "format": "iri-reference" }, "next": { "type": "string", "format": "iri-reference" } }, "example": { "@id": "string", "type": "string", "first": "string", "last": "string", "previous": "string", "next": "string" } } } } ] }, "HydraCollectionBaseSchemaNoPagination": { "type": "object", "properties": { "totalItems": { "type": "integer", "minimum": 0 }, "search": { "type": "object", "properties": { "@type": { "type": "string" }, "template": { "type": "string" }, "variableRepresentation": { "type": "string" }, "mapping": { "type": "array", "items": { "type": "object", "properties": { "@type": { "type": "string" }, "variable": { "type": "string" }, "property": { "type": [ "string", "null" ] }, "required": { "type": "boolean" } } } } } } } }, "HydraItemBaseSchema": { "type": "object", "properties": { "@context": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "@vocab": { "type": "string" }, "hydra": { "type": "string", "enum": [ "http://www.w3.org/ns/hydra/core#" ] } }, "required": [ "@vocab", "hydra" ], "additionalProperties": true } ] }, "@id": { "type": "string" }, "@type": { "type": "string" } }, "required": [ "@id", "@type" ] }, "Invoice.DownloadedInput": { "type": "object", "required": [ "downloaded", "uuids" ], "properties": { "downloaded": { "type": "boolean" }, "uuids": { "minItems": 1, "type": "array", "items": { "type": "string" } } } }, "Invoice.InvoiceReadResource": { "type": "object", "properties": { "uuid": { "type": [ "string", "null" ] }, "legalEntityUuid": { "type": [ "string", "null" ] }, "direction": { "type": "string", "enum": [ "incoming", "outgoing" ] }, "status": { "type": "string", "enum": [ "valid", "sending_started", "sending_queued", "sending_error", "sent", "sent_error", "received" ] }, "deliveryChannel": { "type": "string", "enum": [ "email", "peppol" ] }, "sender": { "$ref": "#/components/schemas/InvoiceActor" }, "recipient": { "$ref": "#/components/schemas/InvoiceActor" }, "invoiceNumber": { "type": "string" }, "amounts": { "$ref": "#/components/schemas/InvoiceAmounts" }, "fileFormat": { "type": "string", "enum": [ "X_RECHNUNG", "ZUGFERD" ] }, "fileFormatVersion": { "type": "string" }, "storedFile": { "$ref": "#/components/schemas/StoredFileReference" }, "invoiceDate": { "type": "string", "format": "date-time" }, "dueDate": { "type": [ "string", "null" ], "format": "date-time" }, "sentToRecipientAt": { "type": [ "string", "null" ], "format": "date-time" }, "downloadedByRecipientAt": { "type": [ "string", "null" ], "format": "date-time" }, "lastError": { "type": [ "string", "null" ] }, "externalReferenceId": { "type": [ "string", "null" ] }, "invoiceAttachments": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceAttachmentReadResource" } } } }, "Invoice.InvoiceReadResource.html": { "type": "object", "properties": { "uuid": { "type": [ "string", "null" ] }, "legalEntityUuid": { "type": [ "string", "null" ] }, "direction": { "type": "string", "enum": [ "incoming", "outgoing" ] }, "status": { "type": "string", "enum": [ "valid", "sending_started", "sending_queued", "sending_error", "sent", "sent_error", "received" ] }, "deliveryChannel": { "type": "string", "enum": [ "email", "peppol" ] }, "sender": { "$ref": "#/components/schemas/InvoiceActor.html" }, "recipient": { "$ref": "#/components/schemas/InvoiceActor.html" }, "invoiceNumber": { "type": "string" }, "amounts": { "$ref": "#/components/schemas/InvoiceAmounts.html" }, "fileFormat": { "type": "string", "enum": [ "X_RECHNUNG", "ZUGFERD" ] }, "fileFormatVersion": { "type": "string" }, "storedFile": { "$ref": "#/components/schemas/StoredFileReference.html" }, "invoiceDate": { "type": "string", "format": "date-time" }, "dueDate": { "type": [ "string", "null" ], "format": "date-time" }, "sentToRecipientAt": { "type": [ "string", "null" ], "format": "date-time" }, "downloadedByRecipientAt": { "type": [ "string", "null" ], "format": "date-time" }, "lastError": { "type": [ "string", "null" ] }, "externalReferenceId": { "type": [ "string", "null" ] }, "invoiceAttachments": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceAttachmentReadResource.html" } } } }, "Invoice.InvoiceReadResource.jsonld": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "uuid": { "type": [ "string", "null" ] }, "legalEntityUuid": { "type": [ "string", "null" ] }, "direction": { "type": "string", "enum": [ "incoming", "outgoing" ] }, "status": { "type": "string", "enum": [ "valid", "sending_started", "sending_queued", "sending_error", "sent", "sent_error", "received" ] }, "deliveryChannel": { "type": "string", "enum": [ "email", "peppol" ] }, "sender": { "$ref": "#/components/schemas/InvoiceActor.jsonld" }, "recipient": { "$ref": "#/components/schemas/InvoiceActor.jsonld" }, "invoiceNumber": { "type": "string" }, "amounts": { "$ref": "#/components/schemas/InvoiceAmounts.jsonld" }, "fileFormat": { "type": "string", "enum": [ "X_RECHNUNG", "ZUGFERD" ] }, "fileFormatVersion": { "type": "string" }, "storedFile": { "$ref": "#/components/schemas/StoredFileReference.jsonld" }, "invoiceDate": { "type": "string", "format": "date-time" }, "dueDate": { "type": [ "string", "null" ], "format": "date-time" }, "sentToRecipientAt": { "type": [ "string", "null" ], "format": "date-time" }, "downloadedByRecipientAt": { "type": [ "string", "null" ], "format": "date-time" }, "lastError": { "type": [ "string", "null" ] }, "externalReferenceId": { "type": [ "string", "null" ] }, "invoiceAttachments": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceAttachmentReadResource.jsonld" } } } } ] }, "Invoice.InvoiceReadResource.raw": { "type": "object", "properties": { "uuid": { "type": [ "string", "null" ] }, "legalEntityUuid": { "type": [ "string", "null" ] }, "direction": { "type": "string", "enum": [ "incoming", "outgoing" ] }, "status": { "type": "string", "enum": [ "valid", "sending_started", "sending_queued", "sending_error", "sent", "sent_error", "received" ] }, "deliveryChannel": { "type": "string", "enum": [ "email", "peppol" ] }, "sender": { "$ref": "#/components/schemas/InvoiceActor.raw" }, "recipient": { "$ref": "#/components/schemas/InvoiceActor.raw" }, "invoiceNumber": { "type": "string" }, "amounts": { "$ref": "#/components/schemas/InvoiceAmounts.raw" }, "fileFormat": { "type": "string", "enum": [ "X_RECHNUNG", "ZUGFERD" ] }, "fileFormatVersion": { "type": "string" }, "storedFile": { "$ref": "#/components/schemas/StoredFileReference.raw" }, "invoiceDate": { "type": "string", "format": "date-time" }, "dueDate": { "type": [ "string", "null" ], "format": "date-time" }, "sentToRecipientAt": { "type": [ "string", "null" ], "format": "date-time" }, "downloadedByRecipientAt": { "type": [ "string", "null" ], "format": "date-time" }, "lastError": { "type": [ "string", "null" ] }, "externalReferenceId": { "type": [ "string", "null" ] }, "invoiceAttachments": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceAttachmentReadResource.raw" } } } }, "Invoice.InvoiceReadResource.xml": { "type": "object", "properties": { "uuid": { "type": [ "string", "null" ] }, "legalEntityUuid": { "type": [ "string", "null" ] }, "direction": { "type": "string", "enum": [ "incoming", "outgoing" ] }, "status": { "type": "string", "enum": [ "valid", "sending_started", "sending_queued", "sending_error", "sent", "sent_error", "received" ] }, "deliveryChannel": { "type": "string", "enum": [ "email", "peppol" ] }, "sender": { "$ref": "#/components/schemas/InvoiceActor.xml" }, "recipient": { "$ref": "#/components/schemas/InvoiceActor.xml" }, "invoiceNumber": { "type": "string" }, "amounts": { "$ref": "#/components/schemas/InvoiceAmounts.xml" }, "fileFormat": { "type": "string", "enum": [ "X_RECHNUNG", "ZUGFERD" ] }, "fileFormatVersion": { "type": "string" }, "storedFile": { "$ref": "#/components/schemas/StoredFileReference.xml" }, "invoiceDate": { "type": "string", "format": "date-time" }, "dueDate": { "type": [ "string", "null" ], "format": "date-time" }, "sentToRecipientAt": { "type": [ "string", "null" ], "format": "date-time" }, "downloadedByRecipientAt": { "type": [ "string", "null" ], "format": "date-time" }, "lastError": { "type": [ "string", "null" ] }, "externalReferenceId": { "type": [ "string", "null" ] }, "invoiceAttachments": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceAttachmentReadResource.xml" } } } }, "Invoice.pdf": { "type": "object", "properties": { "uuid": { "type": [ "string", "null" ], "format": "uuid" }, "owningLegalEntity": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "ownerId": { "type": "integer" }, "direction": { "type": "string", "enum": [ "incoming", "outgoing" ] }, "status": { "type": "string", "enum": [ "valid", "sending_started", "sending_queued", "sending_error", "sent", "sent_error", "received" ] }, "deliveryChannel": { "type": "string", "enum": [ "email", "peppol" ] }, "sender": { "$ref": "#/components/schemas/InvoiceActor.pdf" }, "recipient": { "$ref": "#/components/schemas/InvoiceActor.pdf" }, "invoiceNumber": { "type": "string" }, "amounts": { "$ref": "#/components/schemas/InvoiceAmounts.pdf" }, "fileFormat": { "type": "string", "enum": [ "X_RECHNUNG", "ZUGFERD" ] }, "fileFormatVersion": { "type": "string" }, "storedFile": { "$ref": "#/components/schemas/StoredFileReference.pdf" }, "invoiceDate": { "type": "string", "format": "date-time" }, "dueDate": { "type": [ "string", "null" ], "format": "date-time" }, "sentToRecipientAt": { "type": [ "string", "null" ], "format": "date-time" }, "downloadedByRecipientAt": { "type": [ "string", "null" ], "format": "date-time" }, "lastError": { "type": [ "string", "null" ] }, "externalReferenceId": { "type": [ "string", "null" ] }, "invoiceAttachments": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceAttachment.pdf" } }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, "Invoice.print_html": { "type": "object", "properties": { "uuid": { "type": [ "string", "null" ], "format": "uuid" }, "owningLegalEntity": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "ownerId": { "type": "integer" }, "direction": { "type": "string", "enum": [ "incoming", "outgoing" ] }, "status": { "type": "string", "enum": [ "valid", "sending_started", "sending_queued", "sending_error", "sent", "sent_error", "received" ] }, "deliveryChannel": { "type": "string", "enum": [ "email", "peppol" ] }, "sender": { "$ref": "#/components/schemas/InvoiceActor.print_html" }, "recipient": { "$ref": "#/components/schemas/InvoiceActor.print_html" }, "invoiceNumber": { "type": "string" }, "amounts": { "$ref": "#/components/schemas/InvoiceAmounts.print_html" }, "fileFormat": { "type": "string", "enum": [ "X_RECHNUNG", "ZUGFERD" ] }, "fileFormatVersion": { "type": "string" }, "storedFile": { "$ref": "#/components/schemas/StoredFileReference.print_html" }, "invoiceDate": { "type": "string", "format": "date-time" }, "dueDate": { "type": [ "string", "null" ], "format": "date-time" }, "sentToRecipientAt": { "type": [ "string", "null" ], "format": "date-time" }, "downloadedByRecipientAt": { "type": [ "string", "null" ], "format": "date-time" }, "lastError": { "type": [ "string", "null" ] }, "externalReferenceId": { "type": [ "string", "null" ] }, "invoiceAttachments": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceAttachment.print_html" } }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, "Invoice.xml": { "type": "object", "properties": { "uuid": { "type": [ "string", "null" ], "format": "uuid" }, "owningLegalEntity": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "ownerId": { "type": "integer" }, "direction": { "type": "string", "enum": [ "incoming", "outgoing" ] }, "status": { "type": "string", "enum": [ "valid", "sending_started", "sending_queued", "sending_error", "sent", "sent_error", "received" ] }, "deliveryChannel": { "type": "string", "enum": [ "email", "peppol" ] }, "sender": { "$ref": "#/components/schemas/InvoiceActor.xml" }, "recipient": { "$ref": "#/components/schemas/InvoiceActor.xml" }, "invoiceNumber": { "type": "string" }, "amounts": { "$ref": "#/components/schemas/InvoiceAmounts.xml" }, "fileFormat": { "type": "string", "enum": [ "X_RECHNUNG", "ZUGFERD" ] }, "fileFormatVersion": { "type": "string" }, "storedFile": { "$ref": "#/components/schemas/StoredFileReference.xml" }, "invoiceDate": { "type": "string", "format": "date-time" }, "dueDate": { "type": [ "string", "null" ], "format": "date-time" }, "sentToRecipientAt": { "type": [ "string", "null" ], "format": "date-time" }, "downloadedByRecipientAt": { "type": [ "string", "null" ], "format": "date-time" }, "lastError": { "type": [ "string", "null" ] }, "externalReferenceId": { "type": [ "string", "null" ] }, "invoiceAttachments": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceAttachment.xml" } }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, "InvoiceActor": { "type": "object", "properties": { "name": { "type": "string" }, "identifier": { "type": "string" }, "identifierType": { "type": "string", "enum": [ "email", "peppol_participant_id", "vat_id" ] } } }, "InvoiceActor.html": { "type": "object", "properties": { "name": { "type": "string" }, "identifier": { "type": "string" }, "identifierType": { "type": "string", "enum": [ "email", "peppol_participant_id", "vat_id" ] } } }, "InvoiceActor.jsonld": { "type": "object", "properties": { "name": { "type": "string" }, "identifier": { "type": "string" }, "identifierType": { "type": "string", "enum": [ "email", "peppol_participant_id", "vat_id" ] } } }, "InvoiceActor.pdf": { "type": "object", "properties": { "name": { "type": "string" }, "identifier": { "type": "string" }, "identifierType": { "type": "string", "enum": [ "email", "peppol_participant_id", "vat_id" ] } } }, "InvoiceActor.print_html": { "type": "object", "properties": { "name": { "type": "string" }, "identifier": { "type": "string" }, "identifierType": { "type": "string", "enum": [ "email", "peppol_participant_id", "vat_id" ] } } }, "InvoiceActor.raw": { "type": "object", "properties": { "name": { "type": "string" }, "identifier": { "type": "string" }, "identifierType": { "type": "string", "enum": [ "email", "peppol_participant_id", "vat_id" ] } } }, "InvoiceActor.xml": { "type": "object", "properties": { "name": { "type": "string" }, "identifier": { "type": "string" }, "identifierType": { "type": "string", "enum": [ "email", "peppol_participant_id", "vat_id" ] } } }, "InvoiceAmounts": { "type": "object", "properties": { "totalAmount": { "type": "string" }, "totalAmountNet": { "type": "string" }, "currencyCode": { "type": "string", "enum": [ "EUR" ] } } }, "InvoiceAmounts.html": { "type": "object", "properties": { "totalAmount": { "type": "string" }, "totalAmountNet": { "type": "string" }, "currencyCode": { "type": "string", "enum": [ "EUR" ] } } }, "InvoiceAmounts.jsonld": { "type": "object", "properties": { "totalAmount": { "type": "string" }, "totalAmountNet": { "type": "string" }, "currencyCode": { "type": "string", "enum": [ "EUR" ] } } }, "InvoiceAmounts.pdf": { "type": "object", "properties": { "totalAmount": { "type": "string" }, "totalAmountNet": { "type": "string" }, "currencyCode": { "type": "string", "enum": [ "EUR" ] } } }, "InvoiceAmounts.print_html": { "type": "object", "properties": { "totalAmount": { "type": "string" }, "totalAmountNet": { "type": "string" }, "currencyCode": { "type": "string", "enum": [ "EUR" ] } } }, "InvoiceAmounts.raw": { "type": "object", "properties": { "totalAmount": { "type": "string" }, "totalAmountNet": { "type": "string" }, "currencyCode": { "type": "string", "enum": [ "EUR" ] } } }, "InvoiceAmounts.xml": { "type": "object", "properties": { "totalAmount": { "type": "string" }, "totalAmountNet": { "type": "string" }, "currencyCode": { "type": "string", "enum": [ "EUR" ] } } }, "InvoiceAttachment.pdf": { "type": "object", "properties": { "uuid": { "readOnly": true, "type": "string", "format": "uuid" }, "invoice": { "type": "string", "format": "iri-reference", "example": "https://example.com/" }, "ownerId": { "readOnly": true, "anyOf": [ { "type": "integer" }, { "type": "string" } ] }, "storedFile": { "$ref": "#/components/schemas/StoredFileReference.pdf" } } }, "InvoiceAttachment.print_html": { "type": "object", "properties": { "uuid": { "readOnly": true, "type": "string", "format": "uuid" }, "invoice": { "type": "string", "format": "iri-reference", "example": "https://example.com/" }, "ownerId": { "readOnly": true, "anyOf": [ { "type": "integer" }, { "type": "string" } ] }, "storedFile": { "$ref": "#/components/schemas/StoredFileReference.print_html" } } }, "InvoiceAttachment.xml": { "type": "object", "properties": { "uuid": { "readOnly": true, "type": "string", "format": "uuid" }, "invoice": { "type": "string", "format": "iri-reference", "example": "https://example.com/" }, "ownerId": { "readOnly": true, "anyOf": [ { "type": "integer" }, { "type": "string" } ] }, "storedFile": { "$ref": "#/components/schemas/StoredFileReference.xml" } } }, "InvoiceAttachmentReadResource": { "type": "object", "properties": { "uuid": { "type": [ "string", "null" ] }, "storedFile": { "$ref": "#/components/schemas/StoredFileReference" } } }, "InvoiceAttachmentReadResource.html": { "type": "object", "properties": { "uuid": { "type": [ "string", "null" ] }, "storedFile": { "$ref": "#/components/schemas/StoredFileReference.html" } } }, "InvoiceAttachmentReadResource.jsonld": { "type": "object", "properties": { "uuid": { "type": [ "string", "null" ] }, "storedFile": { "$ref": "#/components/schemas/StoredFileReference.jsonld" } } }, "InvoiceAttachmentReadResource.raw": { "type": "object", "properties": { "uuid": { "type": [ "string", "null" ] }, "storedFile": { "$ref": "#/components/schemas/StoredFileReference.raw" } } }, "InvoiceAttachmentReadResource.xml": { "type": "object", "properties": { "uuid": { "type": [ "string", "null" ] }, "storedFile": { "$ref": "#/components/schemas/StoredFileReference.xml" } } }, "LegalEntity": { "type": "object", "properties": { "uuid": { "type": [ "string", "null" ] }, "ownerId": { "type": "integer" }, "status": { "type": "string", "enum": [ "pending", "active", "blocked" ] }, "name": { "type": "string" }, "email": { "type": "string" }, "vatId": { "$ref": "#/components/schemas/GermanVatId" }, "peppolInvoiceReceivingEnabled": { "default": false, "type": "boolean" }, "addressStreet": { "type": "string" }, "addressStreetNumber": { "type": "string" }, "zipCode": { "type": "string" }, "province": { "type": [ "string", "null" ] }, "city": { "type": "string" }, "countryIso2": { "default": "DE", "type": "string", "enum": [ "DE" ] }, "allowedDocumentFormats": { "type": [ "array", "null" ], "items": { "type": "string" } }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, "LegalEntity.LegalEntityCreateResource": { "type": "object", "properties": { "uuid": { "readOnly": true, "type": [ "string", "null" ] }, "name": { "type": "string" }, "email": { "format": "email", "externalDocs": { "url": "https://schema.org/email" }, "type": "string" }, "vatId": { "pattern": "^(DE\\d{9})$", "type": "string" }, "peppolInvoiceReceivingEnabled": { "type": "boolean" }, "addressStreet": { "type": "string" }, "addressStreetNumber": { "type": "string" }, "zipCode": { "type": "string" }, "province": { "type": [ "string", "null" ] }, "city": { "type": "string" }, "countryIso2": { "enum": [ "DE" ], "default": "DE", "type": "string" }, "allowedDocumentTypes": { "type": "array", "items": { "type": "string", "enum": [ "X_RECHNUNG", "ZUGFERD" ] }, "default": [ "X_RECHNUNG", "ZUGFERD" ] } }, "required": [ "name", "email", "vatId", "peppolInvoiceReceivingEnabled", "addressStreet", "addressStreetNumber", "zipCode", "city" ] }, "LegalEntity.LegalEntityReadResource": { "type": "object", "properties": { "uuid": { "readOnly": true, "type": [ "string", "null" ] }, "status": { "type": "string" }, "name": { "type": "string" }, "email": { "format": "email", "externalDocs": { "url": "https://schema.org/email" }, "type": "string" }, "vatId": { "pattern": "^(DE\\d{9})$", "type": "string" }, "peppolInvoiceReceivingEnabled": { "type": "boolean" }, "addressStreet": { "type": "string" }, "addressStreetNumber": { "type": "string" }, "zipCode": { "type": "string" }, "province": { "type": [ "string", "null" ] }, "city": { "type": "string" }, "countryIso2": { "enum": [ "DE" ], "default": "DE", "type": "string" }, "allowedDocumentTypes": { "type": "array", "items": { "type": "string", "enum": [ "X_RECHNUNG", "ZUGFERD" ] } }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "name", "email", "vatId", "peppolInvoiceReceivingEnabled", "addressStreet", "addressStreetNumber", "zipCode", "city" ] }, "LegalEntity.LegalEntityReadResource.html": { "type": "object", "properties": { "uuid": { "readOnly": true, "type": [ "string", "null" ] }, "status": { "type": "string" }, "name": { "type": "string" }, "email": { "format": "email", "externalDocs": { "url": "https://schema.org/email" }, "type": "string" }, "vatId": { "pattern": "^(DE\\d{9})$", "type": "string" }, "peppolInvoiceReceivingEnabled": { "type": "boolean" }, "addressStreet": { "type": "string" }, "addressStreetNumber": { "type": "string" }, "zipCode": { "type": "string" }, "province": { "type": [ "string", "null" ] }, "city": { "type": "string" }, "countryIso2": { "enum": [ "DE" ], "default": "DE", "type": "string" }, "allowedDocumentTypes": { "type": "array", "items": { "type": "string", "enum": [ "X_RECHNUNG", "ZUGFERD" ] } }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "name", "email", "vatId", "peppolInvoiceReceivingEnabled", "addressStreet", "addressStreetNumber", "zipCode", "city" ] }, "LegalEntity.LegalEntityReadResource.jsonld": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "uuid": { "readOnly": true, "type": [ "string", "null" ] }, "status": { "type": "string" }, "name": { "type": "string" }, "email": { "format": "email", "externalDocs": { "url": "https://schema.org/email" }, "type": "string" }, "vatId": { "pattern": "^(DE\\d{9})$", "type": "string" }, "peppolInvoiceReceivingEnabled": { "type": "boolean" }, "addressStreet": { "type": "string" }, "addressStreetNumber": { "type": "string" }, "zipCode": { "type": "string" }, "province": { "type": [ "string", "null" ] }, "city": { "type": "string" }, "countryIso2": { "enum": [ "DE" ], "default": "DE", "type": "string" }, "allowedDocumentTypes": { "type": "array", "items": { "type": "string", "enum": [ "X_RECHNUNG", "ZUGFERD" ] } }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "name", "email", "vatId", "peppolInvoiceReceivingEnabled", "addressStreet", "addressStreetNumber", "zipCode", "city" ] } ] }, "LegalEntity.LegalEntityReadResource.raw": { "type": "object", "properties": { "uuid": { "readOnly": true, "type": [ "string", "null" ] }, "status": { "type": "string" }, "name": { "type": "string" }, "email": { "format": "email", "externalDocs": { "url": "https://schema.org/email" }, "type": "string" }, "vatId": { "pattern": "^(DE\\d{9})$", "type": "string" }, "peppolInvoiceReceivingEnabled": { "type": "boolean" }, "addressStreet": { "type": "string" }, "addressStreetNumber": { "type": "string" }, "zipCode": { "type": "string" }, "province": { "type": [ "string", "null" ] }, "city": { "type": "string" }, "countryIso2": { "enum": [ "DE" ], "default": "DE", "type": "string" }, "allowedDocumentTypes": { "type": "array", "items": { "type": "string", "enum": [ "X_RECHNUNG", "ZUGFERD" ] } }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "name", "email", "vatId", "peppolInvoiceReceivingEnabled", "addressStreet", "addressStreetNumber", "zipCode", "city" ] }, "LegalEntity.LegalEntityReadResource.xml": { "type": "object", "properties": { "uuid": { "readOnly": true, "type": [ "string", "null" ] }, "status": { "type": "string" }, "name": { "type": "string" }, "email": { "format": "email", "externalDocs": { "url": "https://schema.org/email" }, "type": "string" }, "vatId": { "pattern": "^(DE\\d{9})$", "type": "string" }, "peppolInvoiceReceivingEnabled": { "type": "boolean" }, "addressStreet": { "type": "string" }, "addressStreetNumber": { "type": "string" }, "zipCode": { "type": "string" }, "province": { "type": [ "string", "null" ] }, "city": { "type": "string" }, "countryIso2": { "enum": [ "DE" ], "default": "DE", "type": "string" }, "allowedDocumentTypes": { "type": "array", "items": { "type": "string", "enum": [ "X_RECHNUNG", "ZUGFERD" ] } }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "name", "email", "vatId", "peppolInvoiceReceivingEnabled", "addressStreet", "addressStreetNumber", "zipCode", "city" ] }, "LegalEntity.LegalEntityUpdateResource": { "type": "object", "properties": { "uuid": { "readOnly": true, "type": [ "string", "null" ] }, "name": { "type": "string" }, "email": { "format": "email", "externalDocs": { "url": "https://schema.org/email" }, "type": "string" }, "peppolInvoiceReceivingEnabled": { "type": "boolean" }, "addressStreet": { "type": "string" }, "addressStreetNumber": { "type": "string" }, "zipCode": { "type": "string" }, "province": { "type": [ "string", "null" ] }, "city": { "type": "string" }, "countryIso2": { "enum": [ "DE" ], "default": "DE", "type": "string" }, "allowedDocumentTypes": { "type": "array", "items": { "type": "string", "enum": [ "X_RECHNUNG", "ZUGFERD" ] }, "default": [ "X_RECHNUNG", "ZUGFERD" ] } }, "required": [ "name", "email", "peppolInvoiceReceivingEnabled", "addressStreet", "addressStreetNumber", "zipCode", "city" ] }, "LegalEntity.html": { "type": "object", "properties": { "uuid": { "type": [ "string", "null" ] }, "ownerId": { "type": "integer" }, "status": { "type": "string", "enum": [ "pending", "active", "blocked" ] }, "name": { "type": "string" }, "email": { "type": "string" }, "vatId": { "$ref": "#/components/schemas/GermanVatId.html" }, "peppolInvoiceReceivingEnabled": { "default": false, "type": "boolean" }, "addressStreet": { "type": "string" }, "addressStreetNumber": { "type": "string" }, "zipCode": { "type": "string" }, "province": { "type": [ "string", "null" ] }, "city": { "type": "string" }, "countryIso2": { "default": "DE", "type": "string", "enum": [ "DE" ] }, "allowedDocumentFormats": { "type": [ "array", "null" ], "items": { "type": "string" } }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, "LegalEntity.jsonld": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "uuid": { "type": [ "string", "null" ] }, "ownerId": { "type": "integer" }, "status": { "type": "string", "enum": [ "pending", "active", "blocked" ] }, "name": { "type": "string" }, "email": { "type": "string" }, "vatId": { "$ref": "#/components/schemas/GermanVatId.jsonld" }, "peppolInvoiceReceivingEnabled": { "default": false, "type": "boolean" }, "addressStreet": { "type": "string" }, "addressStreetNumber": { "type": "string" }, "zipCode": { "type": "string" }, "province": { "type": [ "string", "null" ] }, "city": { "type": "string" }, "countryIso2": { "default": "DE", "type": "string", "enum": [ "DE" ] }, "allowedDocumentFormats": { "type": [ "array", "null" ], "items": { "type": "string" } }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } ] }, "LegalEntity.raw": { "type": "object", "properties": { "uuid": { "type": [ "string", "null" ] }, "ownerId": { "type": "integer" }, "status": { "type": "string", "enum": [ "pending", "active", "blocked" ] }, "name": { "type": "string" }, "email": { "type": "string" }, "vatId": { "$ref": "#/components/schemas/GermanVatId.raw" }, "peppolInvoiceReceivingEnabled": { "default": false, "type": "boolean" }, "addressStreet": { "type": "string" }, "addressStreetNumber": { "type": "string" }, "zipCode": { "type": "string" }, "province": { "type": [ "string", "null" ] }, "city": { "type": "string" }, "countryIso2": { "default": "DE", "type": "string", "enum": [ "DE" ] }, "allowedDocumentFormats": { "type": [ "array", "null" ], "items": { "type": "string" } }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, "LegalEntity.xml": { "type": "object", "properties": { "uuid": { "type": [ "string", "null" ] }, "ownerId": { "type": "integer" }, "status": { "type": "string", "enum": [ "pending", "active", "blocked" ] }, "name": { "type": "string" }, "email": { "type": "string" }, "vatId": { "$ref": "#/components/schemas/GermanVatId.xml" }, "peppolInvoiceReceivingEnabled": { "default": false, "type": "boolean" }, "addressStreet": { "type": "string" }, "addressStreetNumber": { "type": "string" }, "zipCode": { "type": "string" }, "province": { "type": [ "string", "null" ] }, "city": { "type": "string" }, "countryIso2": { "default": "DE", "type": "string", "enum": [ "DE" ] }, "allowedDocumentFormats": { "type": [ "array", "null" ], "items": { "type": "string" } }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, "OutgoingXRechnungCreateResource.InvoiceReadResource": { "type": "object", "properties": { "uuid": { "type": [ "string", "null" ] }, "legalEntityUuid": { "type": [ "string", "null" ] }, "direction": { "type": "string", "enum": [ "incoming", "outgoing" ] }, "status": { "type": "string", "enum": [ "valid", "sending_started", "sending_queued", "sending_error", "sent", "sent_error", "received" ] }, "deliveryChannel": { "type": "string", "enum": [ "email", "peppol" ] }, "sender": { "$ref": "#/components/schemas/InvoiceActor" }, "recipient": { "$ref": "#/components/schemas/InvoiceActor" }, "invoiceNumber": { "type": "string" }, "amounts": { "$ref": "#/components/schemas/InvoiceAmounts" }, "fileFormat": { "type": "string", "enum": [ "X_RECHNUNG", "ZUGFERD" ] }, "fileFormatVersion": { "type": "string" }, "storedFile": { "$ref": "#/components/schemas/StoredFileReference" }, "invoiceDate": { "type": "string", "format": "date-time" }, "dueDate": { "type": [ "string", "null" ], "format": "date-time" }, "sentToRecipientAt": { "type": [ "string", "null" ], "format": "date-time" }, "downloadedByRecipientAt": { "type": [ "string", "null" ], "format": "date-time" }, "lastError": { "type": [ "string", "null" ] }, "externalReferenceId": { "type": [ "string", "null" ] }, "invoiceAttachments": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceAttachmentReadResource" } } } }, "OutgoingXRechnungCreateResource.InvoiceReadResource.html": { "type": "object", "properties": { "uuid": { "type": [ "string", "null" ] }, "legalEntityUuid": { "type": [ "string", "null" ] }, "direction": { "type": "string", "enum": [ "incoming", "outgoing" ] }, "status": { "type": "string", "enum": [ "valid", "sending_started", "sending_queued", "sending_error", "sent", "sent_error", "received" ] }, "deliveryChannel": { "type": "string", "enum": [ "email", "peppol" ] }, "sender": { "$ref": "#/components/schemas/InvoiceActor.html" }, "recipient": { "$ref": "#/components/schemas/InvoiceActor.html" }, "invoiceNumber": { "type": "string" }, "amounts": { "$ref": "#/components/schemas/InvoiceAmounts.html" }, "fileFormat": { "type": "string", "enum": [ "X_RECHNUNG", "ZUGFERD" ] }, "fileFormatVersion": { "type": "string" }, "storedFile": { "$ref": "#/components/schemas/StoredFileReference.html" }, "invoiceDate": { "type": "string", "format": "date-time" }, "dueDate": { "type": [ "string", "null" ], "format": "date-time" }, "sentToRecipientAt": { "type": [ "string", "null" ], "format": "date-time" }, "downloadedByRecipientAt": { "type": [ "string", "null" ], "format": "date-time" }, "lastError": { "type": [ "string", "null" ] }, "externalReferenceId": { "type": [ "string", "null" ] }, "invoiceAttachments": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceAttachmentReadResource.html" } } } }, "OutgoingXRechnungCreateResource.InvoiceReadResource.jsonld": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "uuid": { "type": [ "string", "null" ] }, "legalEntityUuid": { "type": [ "string", "null" ] }, "direction": { "type": "string", "enum": [ "incoming", "outgoing" ] }, "status": { "type": "string", "enum": [ "valid", "sending_started", "sending_queued", "sending_error", "sent", "sent_error", "received" ] }, "deliveryChannel": { "type": "string", "enum": [ "email", "peppol" ] }, "sender": { "$ref": "#/components/schemas/InvoiceActor.jsonld" }, "recipient": { "$ref": "#/components/schemas/InvoiceActor.jsonld" }, "invoiceNumber": { "type": "string" }, "amounts": { "$ref": "#/components/schemas/InvoiceAmounts.jsonld" }, "fileFormat": { "type": "string", "enum": [ "X_RECHNUNG", "ZUGFERD" ] }, "fileFormatVersion": { "type": "string" }, "storedFile": { "$ref": "#/components/schemas/StoredFileReference.jsonld" }, "invoiceDate": { "type": "string", "format": "date-time" }, "dueDate": { "type": [ "string", "null" ], "format": "date-time" }, "sentToRecipientAt": { "type": [ "string", "null" ], "format": "date-time" }, "downloadedByRecipientAt": { "type": [ "string", "null" ], "format": "date-time" }, "lastError": { "type": [ "string", "null" ] }, "externalReferenceId": { "type": [ "string", "null" ] }, "invoiceAttachments": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceAttachmentReadResource.jsonld" } } } } ] }, "OutgoingXRechnungCreateResource.InvoiceReadResource.raw": { "type": "object", "properties": { "uuid": { "type": [ "string", "null" ] }, "legalEntityUuid": { "type": [ "string", "null" ] }, "direction": { "type": "string", "enum": [ "incoming", "outgoing" ] }, "status": { "type": "string", "enum": [ "valid", "sending_started", "sending_queued", "sending_error", "sent", "sent_error", "received" ] }, "deliveryChannel": { "type": "string", "enum": [ "email", "peppol" ] }, "sender": { "$ref": "#/components/schemas/InvoiceActor.raw" }, "recipient": { "$ref": "#/components/schemas/InvoiceActor.raw" }, "invoiceNumber": { "type": "string" }, "amounts": { "$ref": "#/components/schemas/InvoiceAmounts.raw" }, "fileFormat": { "type": "string", "enum": [ "X_RECHNUNG", "ZUGFERD" ] }, "fileFormatVersion": { "type": "string" }, "storedFile": { "$ref": "#/components/schemas/StoredFileReference.raw" }, "invoiceDate": { "type": "string", "format": "date-time" }, "dueDate": { "type": [ "string", "null" ], "format": "date-time" }, "sentToRecipientAt": { "type": [ "string", "null" ], "format": "date-time" }, "downloadedByRecipientAt": { "type": [ "string", "null" ], "format": "date-time" }, "lastError": { "type": [ "string", "null" ] }, "externalReferenceId": { "type": [ "string", "null" ] }, "invoiceAttachments": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceAttachmentReadResource.raw" } } } }, "OutgoingXRechnungCreateResource.InvoiceReadResource.xml": { "type": "object", "properties": { "uuid": { "type": [ "string", "null" ] }, "legalEntityUuid": { "type": [ "string", "null" ] }, "direction": { "type": "string", "enum": [ "incoming", "outgoing" ] }, "status": { "type": "string", "enum": [ "valid", "sending_started", "sending_queued", "sending_error", "sent", "sent_error", "received" ] }, "deliveryChannel": { "type": "string", "enum": [ "email", "peppol" ] }, "sender": { "$ref": "#/components/schemas/InvoiceActor.xml" }, "recipient": { "$ref": "#/components/schemas/InvoiceActor.xml" }, "invoiceNumber": { "type": "string" }, "amounts": { "$ref": "#/components/schemas/InvoiceAmounts.xml" }, "fileFormat": { "type": "string", "enum": [ "X_RECHNUNG", "ZUGFERD" ] }, "fileFormatVersion": { "type": "string" }, "storedFile": { "$ref": "#/components/schemas/StoredFileReference.xml" }, "invoiceDate": { "type": "string", "format": "date-time" }, "dueDate": { "type": [ "string", "null" ], "format": "date-time" }, "sentToRecipientAt": { "type": [ "string", "null" ], "format": "date-time" }, "downloadedByRecipientAt": { "type": [ "string", "null" ], "format": "date-time" }, "lastError": { "type": [ "string", "null" ] }, "externalReferenceId": { "type": [ "string", "null" ] }, "invoiceAttachments": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceAttachmentReadResource.xml" } } } }, "OutgoingZugferdCreateResource.InvoiceReadResource": { "type": "object", "properties": { "uuid": { "type": [ "string", "null" ] }, "legalEntityUuid": { "type": [ "string", "null" ] }, "direction": { "type": "string", "enum": [ "incoming", "outgoing" ] }, "status": { "type": "string", "enum": [ "valid", "sending_started", "sending_queued", "sending_error", "sent", "sent_error", "received" ] }, "deliveryChannel": { "type": "string", "enum": [ "email", "peppol" ] }, "sender": { "$ref": "#/components/schemas/InvoiceActor" }, "recipient": { "$ref": "#/components/schemas/InvoiceActor" }, "invoiceNumber": { "type": "string" }, "amounts": { "$ref": "#/components/schemas/InvoiceAmounts" }, "fileFormat": { "type": "string", "enum": [ "X_RECHNUNG", "ZUGFERD" ] }, "fileFormatVersion": { "type": "string" }, "storedFile": { "$ref": "#/components/schemas/StoredFileReference" }, "invoiceDate": { "type": "string", "format": "date-time" }, "dueDate": { "type": [ "string", "null" ], "format": "date-time" }, "sentToRecipientAt": { "type": [ "string", "null" ], "format": "date-time" }, "downloadedByRecipientAt": { "type": [ "string", "null" ], "format": "date-time" }, "lastError": { "type": [ "string", "null" ] }, "externalReferenceId": { "type": [ "string", "null" ] }, "invoiceAttachments": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceAttachmentReadResource" } } } }, "OutgoingZugferdCreateResource.InvoiceReadResource.html": { "type": "object", "properties": { "uuid": { "type": [ "string", "null" ] }, "legalEntityUuid": { "type": [ "string", "null" ] }, "direction": { "type": "string", "enum": [ "incoming", "outgoing" ] }, "status": { "type": "string", "enum": [ "valid", "sending_started", "sending_queued", "sending_error", "sent", "sent_error", "received" ] }, "deliveryChannel": { "type": "string", "enum": [ "email", "peppol" ] }, "sender": { "$ref": "#/components/schemas/InvoiceActor.html" }, "recipient": { "$ref": "#/components/schemas/InvoiceActor.html" }, "invoiceNumber": { "type": "string" }, "amounts": { "$ref": "#/components/schemas/InvoiceAmounts.html" }, "fileFormat": { "type": "string", "enum": [ "X_RECHNUNG", "ZUGFERD" ] }, "fileFormatVersion": { "type": "string" }, "storedFile": { "$ref": "#/components/schemas/StoredFileReference.html" }, "invoiceDate": { "type": "string", "format": "date-time" }, "dueDate": { "type": [ "string", "null" ], "format": "date-time" }, "sentToRecipientAt": { "type": [ "string", "null" ], "format": "date-time" }, "downloadedByRecipientAt": { "type": [ "string", "null" ], "format": "date-time" }, "lastError": { "type": [ "string", "null" ] }, "externalReferenceId": { "type": [ "string", "null" ] }, "invoiceAttachments": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceAttachmentReadResource.html" } } } }, "OutgoingZugferdCreateResource.InvoiceReadResource.jsonld": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "uuid": { "type": [ "string", "null" ] }, "legalEntityUuid": { "type": [ "string", "null" ] }, "direction": { "type": "string", "enum": [ "incoming", "outgoing" ] }, "status": { "type": "string", "enum": [ "valid", "sending_started", "sending_queued", "sending_error", "sent", "sent_error", "received" ] }, "deliveryChannel": { "type": "string", "enum": [ "email", "peppol" ] }, "sender": { "$ref": "#/components/schemas/InvoiceActor.jsonld" }, "recipient": { "$ref": "#/components/schemas/InvoiceActor.jsonld" }, "invoiceNumber": { "type": "string" }, "amounts": { "$ref": "#/components/schemas/InvoiceAmounts.jsonld" }, "fileFormat": { "type": "string", "enum": [ "X_RECHNUNG", "ZUGFERD" ] }, "fileFormatVersion": { "type": "string" }, "storedFile": { "$ref": "#/components/schemas/StoredFileReference.jsonld" }, "invoiceDate": { "type": "string", "format": "date-time" }, "dueDate": { "type": [ "string", "null" ], "format": "date-time" }, "sentToRecipientAt": { "type": [ "string", "null" ], "format": "date-time" }, "downloadedByRecipientAt": { "type": [ "string", "null" ], "format": "date-time" }, "lastError": { "type": [ "string", "null" ] }, "externalReferenceId": { "type": [ "string", "null" ] }, "invoiceAttachments": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceAttachmentReadResource.jsonld" } } } } ] }, "OutgoingZugferdCreateResource.InvoiceReadResource.raw": { "type": "object", "properties": { "uuid": { "type": [ "string", "null" ] }, "legalEntityUuid": { "type": [ "string", "null" ] }, "direction": { "type": "string", "enum": [ "incoming", "outgoing" ] }, "status": { "type": "string", "enum": [ "valid", "sending_started", "sending_queued", "sending_error", "sent", "sent_error", "received" ] }, "deliveryChannel": { "type": "string", "enum": [ "email", "peppol" ] }, "sender": { "$ref": "#/components/schemas/InvoiceActor.raw" }, "recipient": { "$ref": "#/components/schemas/InvoiceActor.raw" }, "invoiceNumber": { "type": "string" }, "amounts": { "$ref": "#/components/schemas/InvoiceAmounts.raw" }, "fileFormat": { "type": "string", "enum": [ "X_RECHNUNG", "ZUGFERD" ] }, "fileFormatVersion": { "type": "string" }, "storedFile": { "$ref": "#/components/schemas/StoredFileReference.raw" }, "invoiceDate": { "type": "string", "format": "date-time" }, "dueDate": { "type": [ "string", "null" ], "format": "date-time" }, "sentToRecipientAt": { "type": [ "string", "null" ], "format": "date-time" }, "downloadedByRecipientAt": { "type": [ "string", "null" ], "format": "date-time" }, "lastError": { "type": [ "string", "null" ] }, "externalReferenceId": { "type": [ "string", "null" ] }, "invoiceAttachments": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceAttachmentReadResource.raw" } } } }, "OutgoingZugferdCreateResource.InvoiceReadResource.xml": { "type": "object", "properties": { "uuid": { "type": [ "string", "null" ] }, "legalEntityUuid": { "type": [ "string", "null" ] }, "direction": { "type": "string", "enum": [ "incoming", "outgoing" ] }, "status": { "type": "string", "enum": [ "valid", "sending_started", "sending_queued", "sending_error", "sent", "sent_error", "received" ] }, "deliveryChannel": { "type": "string", "enum": [ "email", "peppol" ] }, "sender": { "$ref": "#/components/schemas/InvoiceActor.xml" }, "recipient": { "$ref": "#/components/schemas/InvoiceActor.xml" }, "invoiceNumber": { "type": "string" }, "amounts": { "$ref": "#/components/schemas/InvoiceAmounts.xml" }, "fileFormat": { "type": "string", "enum": [ "X_RECHNUNG", "ZUGFERD" ] }, "fileFormatVersion": { "type": "string" }, "storedFile": { "$ref": "#/components/schemas/StoredFileReference.xml" }, "invoiceDate": { "type": "string", "format": "date-time" }, "dueDate": { "type": [ "string", "null" ], "format": "date-time" }, "sentToRecipientAt": { "type": [ "string", "null" ], "format": "date-time" }, "downloadedByRecipientAt": { "type": [ "string", "null" ], "format": "date-time" }, "lastError": { "type": [ "string", "null" ] }, "externalReferenceId": { "type": [ "string", "null" ] }, "invoiceAttachments": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceAttachmentReadResource.xml" } } } }, "StoredFileReference": { "type": "object", "properties": { "storageReference": { "type": "string" }, "sizeBytes": { "type": "integer" }, "checksum": { "type": "string" }, "mimeType": { "type": [ "string", "null" ] } } }, "StoredFileReference.html": { "type": "object", "properties": { "storageReference": { "type": "string" }, "sizeBytes": { "type": "integer" }, "checksum": { "type": "string" }, "mimeType": { "type": [ "string", "null" ] } } }, "StoredFileReference.jsonld": { "type": "object", "properties": { "storageReference": { "type": "string" }, "sizeBytes": { "type": "integer" }, "checksum": { "type": "string" }, "mimeType": { "type": [ "string", "null" ] } } }, "StoredFileReference.pdf": { "type": "object", "properties": { "storageReference": { "type": "string" }, "sizeBytes": { "type": "integer" }, "checksum": { "type": "string" }, "mimeType": { "type": [ "string", "null" ] } } }, "StoredFileReference.print_html": { "type": "object", "properties": { "storageReference": { "type": "string" }, "sizeBytes": { "type": "integer" }, "checksum": { "type": "string" }, "mimeType": { "type": [ "string", "null" ] } } }, "StoredFileReference.raw": { "type": "object", "properties": { "storageReference": { "type": "string" }, "sizeBytes": { "type": "integer" }, "checksum": { "type": "string" }, "mimeType": { "type": [ "string", "null" ] } } }, "StoredFileReference.xml": { "type": "object", "properties": { "storageReference": { "type": "string" }, "sizeBytes": { "type": "integer" }, "checksum": { "type": "string" }, "mimeType": { "type": [ "string", "null" ] } } } }, "responses": {}, "parameters": {}, "examples": {}, "requestBodies": {}, "headers": {}, "securitySchemes": { "Bearer": { "type": "apiKey", "description": "Value for the Authorization header parameter.", "name": "Authorization", "in": "header" } } }, "security": [ { "Bearer": [] } ], "tags": [ { "name": "OutgoingXRechnungCreateResource", "description": "Resource 'OutgoingXRechnungCreateResource' operations." }, { "name": "OutgoingZugferdCreateResource", "description": "Resource 'OutgoingZugferdCreateResource' operations." }, { "name": "EventDestination", "description": "Resource 'EventDestination' operations." }, { "name": "Invoice", "description": "Resource 'Invoice' operations." }, { "name": "LegalEntity", "description": "Resource 'LegalEntity' operations." } ], "webhooks": {} }