{ "openapi": "3.1.0", "info": { "title": "A-Cube ES Api", "description": "", "version": "1.0.0" }, "servers": [ { "url": "/", "description": "" } ], "paths": { "/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.EventDestinationOutput.jsonld collection.", "allOf": [ { "$ref": "#/components/schemas/HydraCollectionBaseSchema" }, { "type": "object", "required": [ "hydra:member" ], "properties": { "hydra:member": { "type": "array", "items": { "$ref": "#/components/schemas/EventDestination.EventDestinationOutput.jsonld" } } } } ] } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EventDestination.EventDestinationOutput" } } } } } }, "summary": "Retrieves the collection of EventDestination resources.", "description": "Retrieves the collection of EventDestination resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": true }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "schema": { "type": "integer", "default": 30, "minimum": 0, "maximum": 30 }, "style": "form", "explode": true } ] }, "post": { "operationId": "api_event-destinations_post", "tags": [ "EventDestination" ], "responses": { "201": { "description": "EventDestination resource created", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/EventDestination.EventDestinationOutput.jsonld" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EventDestination.EventDestinationOutput" } } }, "links": {} }, "400": { "description": "Invalid input", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} }, "422": { "description": "An error occurred", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } } }, "links": {} } }, "summary": "Creates a EventDestination resource.", "description": "Creates a EventDestination resource.", "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" } } }, "required": true } } }, "/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.EventDestinationOutput.jsonld" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EventDestination.EventDestinationOutput" } } } }, "404": { "description": "Not found", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} } }, "summary": "Retrieves a EventDestination resource.", "description": "Retrieves a EventDestination resource.", "parameters": [ { "name": "uuid", "in": "path", "description": "EventDestination identifier", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ] }, "put": { "operationId": "api_event-destinations_uuid_put", "tags": [ "EventDestination" ], "responses": { "200": { "description": "EventDestination resource updated", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/EventDestination.EventDestinationOutput.jsonld" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EventDestination.EventDestinationOutput" } } }, "links": {} }, "400": { "description": "Invalid input", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} }, "422": { "description": "An error occurred", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } } }, "links": {} }, "404": { "description": "Not found", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} } }, "summary": "Replaces the EventDestination resource.", "description": "Replaces the EventDestination resource.", "parameters": [ { "name": "uuid", "in": "path", "description": "EventDestination identifier", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ], "requestBody": { "description": "The updated EventDestination resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/EventDestination.EventDestinationUpdateInput" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EventDestination.EventDestinationUpdateInput" } } }, "required": true } }, "delete": { "operationId": "api_event-destinations_uuid_delete", "tags": [ "EventDestination" ], "responses": { "204": { "description": "EventDestination resource deleted" }, "404": { "description": "Not found", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} } }, "summary": "Removes the EventDestination resource.", "description": "Removes the EventDestination resource.", "parameters": [ { "name": "uuid", "in": "path", "description": "EventDestination identifier", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ] } }, "/invoices": { "get": { "operationId": "api_invoices_get_collection", "tags": [ "Invoice" ], "responses": { "200": { "description": "Invoice collection", "content": { "application/ld+json": { "schema": { "type": "object", "description": "Entity.Invoice.InvoiceOutput.jsonld collection.", "allOf": [ { "$ref": "#/components/schemas/HydraCollectionBaseSchema" }, { "type": "object", "required": [ "hydra:member" ], "properties": { "hydra:member": { "type": "array", "items": { "$ref": "#/components/schemas/Entity.Invoice.InvoiceOutput.jsonld" } } } } ] } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Entity.Invoice.InvoiceOutput" } } } } } }, "summary": "Retrieves the collection of Invoice resources.", "description": "Retrieves the collection of Invoice resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": true }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "schema": { "type": "integer", "default": 30, "minimum": 0, "maximum": 30 }, "style": "form", "explode": true }, { "name": "createdAt[gt]", "in": "query", "description": "Invoice createdAt", "required": false, "deprecated": false, "schema": { "type": "object", "properties": { "gt": { "type": "string" }, "gte": { "type": "string" }, "lt": { "type": "string" }, "lte": { "type": "string" }, "ne": { "type": "string" } } }, "style": "form", "explode": true }, { "name": "createdAt[gte]", "in": "query", "description": "Invoice createdAt", "required": false, "deprecated": false, "schema": { "type": "object", "properties": { "gt": { "type": "string" }, "gte": { "type": "string" }, "lt": { "type": "string" }, "lte": { "type": "string" }, "ne": { "type": "string" } } }, "style": "form", "explode": true }, { "name": "createdAt[lt]", "in": "query", "description": "Invoice createdAt", "required": false, "deprecated": false, "schema": { "type": "object", "properties": { "gt": { "type": "string" }, "gte": { "type": "string" }, "lt": { "type": "string" }, "lte": { "type": "string" }, "ne": { "type": "string" } } }, "style": "form", "explode": true }, { "name": "createdAt[lte]", "in": "query", "description": "Invoice createdAt", "required": false, "deprecated": false, "schema": { "type": "object", "properties": { "gt": { "type": "string" }, "gte": { "type": "string" }, "lt": { "type": "string" }, "lte": { "type": "string" }, "ne": { "type": "string" } } }, "style": "form", "explode": true }, { "name": "createdAt[ne]", "in": "query", "description": "Invoice createdAt", "required": false, "deprecated": false, "schema": { "type": "object", "properties": { "gt": { "type": "string" }, "gte": { "type": "string" }, "lt": { "type": "string" }, "lte": { "type": "string" }, "ne": { "type": "string" } } }, "style": "form", "explode": true }, { "name": "invoiceDate[gt]", "in": "query", "description": "Invoice invoiceDate", "required": false, "deprecated": false, "schema": { "type": "object", "properties": { "gt": { "type": "string" }, "gte": { "type": "string" }, "lt": { "type": "string" }, "lte": { "type": "string" }, "ne": { "type": "string" } } }, "style": "form", "explode": true }, { "name": "invoiceDate[gte]", "in": "query", "description": "Invoice invoiceDate", "required": false, "deprecated": false, "schema": { "type": "object", "properties": { "gt": { "type": "string" }, "gte": { "type": "string" }, "lt": { "type": "string" }, "lte": { "type": "string" }, "ne": { "type": "string" } } }, "style": "form", "explode": true }, { "name": "invoiceDate[lt]", "in": "query", "description": "Invoice invoiceDate", "required": false, "deprecated": false, "schema": { "type": "object", "properties": { "gt": { "type": "string" }, "gte": { "type": "string" }, "lt": { "type": "string" }, "lte": { "type": "string" }, "ne": { "type": "string" } } }, "style": "form", "explode": true }, { "name": "invoiceDate[lte]", "in": "query", "description": "Invoice invoiceDate", "required": false, "deprecated": false, "schema": { "type": "object", "properties": { "gt": { "type": "string" }, "gte": { "type": "string" }, "lt": { "type": "string" }, "lte": { "type": "string" }, "ne": { "type": "string" } } }, "style": "form", "explode": true }, { "name": "invoiceDate[ne]", "in": "query", "description": "Invoice invoiceDate", "required": false, "deprecated": false, "schema": { "type": "object", "properties": { "gt": { "type": "string" }, "gte": { "type": "string" }, "lt": { "type": "string" }, "lte": { "type": "string" }, "ne": { "type": "string" } } }, "style": "form", "explode": true }, { "name": "invoiceNumber", "in": "query", "description": "Invoice invoiceNumber", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "status", "in": "query", "description": "Invoice status", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "status[]", "in": "query", "description": "Invoice status", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "deepObject", "explode": true }, { "name": "direction", "in": "query", "description": "Invoice direction", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "direction[]", "in": "query", "description": "Invoice direction", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "deepObject", "explode": true }, { "name": "downloaded", "in": "query", "description": "Invoice downloaded", "required": false, "deprecated": false, "schema": { "type": "boolean" }, "style": "form", "explode": true }, { "name": "senderName", "in": "query", "description": "Invoice senderName", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "senderName[]", "in": "query", "description": "Invoice senderName", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "deepObject", "explode": true }, { "name": "senderFiscalId", "in": "query", "description": "Invoice senderFiscalId", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "senderFiscalId[]", "in": "query", "description": "Invoice senderFiscalId", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "deepObject", "explode": true }, { "name": "recipientName", "in": "query", "description": "Invoice recipientName", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "recipientName[]", "in": "query", "description": "Invoice recipientName", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "deepObject", "explode": true }, { "name": "recipientFiscalId", "in": "query", "description": "Invoice recipientFiscalId", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "recipientFiscalId[]", "in": "query", "description": "Invoice recipientFiscalId", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "deepObject", "explode": true }, { "name": "order[invoiceDate]", "in": "query", "description": "Invoice order[invoiceDate]", "required": false, "deprecated": false, "schema": { "type": "string", "enum": [ "asc", "desc", "ASC", "DESC" ] }, "style": "form", "explode": true }, { "name": "order[invoiceNumber]", "in": "query", "description": "Invoice order[invoiceNumber]", "required": false, "deprecated": false, "schema": { "type": "string", "enum": [ "asc", "desc", "ASC", "DESC" ] }, "style": "form", "explode": true }, { "name": "order[uuid]", "in": "query", "description": "Invoice order[uuid]", "required": false, "deprecated": false, "schema": { "type": "string", "enum": [ "asc", "desc", "ASC", "DESC" ] }, "style": "form", "explode": true } ] }, "post": { "operationId": "api_invoices_post", "tags": [ "Invoice" ], "responses": { "202": { "description": "Invoice resource created", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Entity.Invoice.InvoiceOutput.jsonld" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Entity.Invoice.InvoiceOutput" } } }, "links": {} }, "400": { "description": "Invalid input", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} }, "422": { "description": "An error occurred", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation.jsonld" } }, "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 Invoice resource.", "description": "Creates a Invoice resource.", "parameters": [], "requestBody": { "description": "The new Invoice resource", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/Entity.Invoice.InvoiceCreateInput" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Entity.Invoice.InvoiceCreateInput" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Entity.Invoice.InvoiceCreateInput" } } }, "required": true } } }, "/invoices/{uuid}": { "get": { "operationId": "api_invoices_uuid_get", "tags": [ "Invoice" ], "responses": { "200": { "description": "Invoice resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Entity.Invoice.InvoiceOutput.jsonld" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Entity.Invoice.InvoiceOutput" } } } }, "404": { "description": "Not found", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} } }, "summary": "Retrieves a Invoice resource.", "description": "Retrieves a Invoice resource.", "parameters": [ { "name": "uuid", "in": "path", "description": "Invoice identifier", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ] } }, "/invoices/{uuid}/qr": { "get": { "operationId": "api_invoices_uuidqr_get", "tags": [ "Invoice" ], "responses": { "200": { "description": "The VERI*FACTU QR - VerifactuQrData as JSON, or a PNG image, depending on the Accept header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity.Invoice.VerifactuQrData" } }, "image/png": { "schema": { "type": "string", "format": "binary" } } } }, "404": { "description": "The invoice does not exist or does not belong to the caller" } }, "summary": "Retrieves a Invoice resource.", "description": "Retrieves a Invoice resource.", "parameters": [ { "name": "uuid", "in": "path", "description": "Invoice identifier", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ] } }, "/invoices/draft": { "get": { "operationId": "api_invoicesdraft_get_collection", "tags": [ "InvoiceDraft" ], "responses": { "200": { "description": "InvoiceDraft collection", "content": { "application/ld+json": { "schema": { "type": "object", "description": "InvoiceDraft.InvoiceOutput.jsonld collection.", "allOf": [ { "$ref": "#/components/schemas/HydraCollectionBaseSchema" }, { "type": "object", "required": [ "hydra:member" ], "properties": { "hydra:member": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceDraft.InvoiceOutput.jsonld" } } } } ] } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceDraft.InvoiceOutput" } } } } }, "403": { "description": "Forbidden", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} } }, "summary": "Retrieves the collection of InvoiceDraft resources.", "description": "Retrieves the collection of InvoiceDraft resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": true }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "schema": { "type": "integer", "default": 30, "minimum": 0, "maximum": 30 }, "style": "form", "explode": true } ] }, "post": { "operationId": "api_invoicesdraft_post", "tags": [ "InvoiceDraft" ], "responses": { "201": { "description": "InvoiceDraft resource created", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/InvoiceDraft.InvoiceOutput.jsonld" } }, "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceDraft.InvoiceOutput" } } }, "links": {} }, "400": { "description": "Invalid input", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} }, "422": { "description": "An error occurred", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation.jsonld" } }, "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 InvoiceDraft resource.", "description": "Creates a InvoiceDraft resource.", "parameters": [], "requestBody": { "description": "The new InvoiceDraft resource", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/InvoiceDraft.InvoiceDraftCreateInput" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/InvoiceDraft.InvoiceDraftCreateInput" } }, "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceDraft.InvoiceDraftCreateInput" } } }, "required": true } } }, "/invoices/draft/{uuid}": { "get": { "operationId": "api_invoicesdraft_uuid_get", "tags": [ "InvoiceDraft" ], "responses": { "200": { "description": "InvoiceDraft resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/InvoiceDraft.InvoiceOutput.jsonld" } }, "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceDraft.InvoiceOutput" } } } }, "403": { "description": "Forbidden", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} }, "404": { "description": "Not found", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} } }, "summary": "Retrieves a InvoiceDraft resource.", "description": "Retrieves a InvoiceDraft resource.", "parameters": [ { "name": "uuid", "in": "path", "description": "InvoiceDraft identifier", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ] }, "put": { "operationId": "api_invoicesdraft_uuid_put", "tags": [ "InvoiceDraft" ], "responses": { "200": { "description": "InvoiceDraft resource updated", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/InvoiceDraft.InvoiceOutput.jsonld" } }, "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceDraft.InvoiceOutput" } } }, "links": {} }, "400": { "description": "Invalid input", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} }, "422": { "description": "An error occurred", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } } }, "links": {} }, "403": { "description": "Forbidden", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} }, "404": { "description": "Not found", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} } }, "summary": "Replaces the InvoiceDraft resource.", "description": "Replaces the InvoiceDraft resource.", "parameters": [ { "name": "uuid", "in": "path", "description": "InvoiceDraft identifier", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ], "requestBody": { "description": "The updated InvoiceDraft resource", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/InvoiceDraft.InvoiceDraftCreateInput" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/InvoiceDraft.InvoiceDraftCreateInput" } }, "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceDraft.InvoiceDraftCreateInput" } } }, "required": true } }, "delete": { "operationId": "api_invoicesdraft_uuid_delete", "tags": [ "InvoiceDraft" ], "responses": { "204": { "description": "InvoiceDraft 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 InvoiceDraft resource.", "description": "Removes the InvoiceDraft resource.", "parameters": [ { "name": "uuid", "in": "path", "description": "InvoiceDraft identifier", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ] } }, "/invoices/draft/{uuid}/send": { "post": { "operationId": "api_invoicesdraft_uuidsend_post", "tags": [ "InvoiceDraft" ], "responses": { "202": { "description": "InvoiceDraft resource created", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/InvoiceDraft.InvoiceOutput.jsonld" } }, "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceDraft.InvoiceOutput" } } }, "links": {} }, "400": { "description": "Invalid input", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} }, "422": { "description": "An error occurred", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation.jsonld" } }, "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 InvoiceDraft resource.", "description": "Creates a InvoiceDraft resource.", "parameters": [ { "name": "uuid", "in": "path", "description": "InvoiceDraft identifier", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ] } }, "/legal-entities": { "get": { "operationId": "api_legal-entities_get_collection", "tags": [ "LegalEntity" ], "responses": { "200": { "description": "LegalEntity collection", "content": { "application/ld+json": { "schema": { "type": "object", "description": "Entity.LegalEntity.LegalEntityOutput.jsonld collection.", "allOf": [ { "$ref": "#/components/schemas/HydraCollectionBaseSchema" }, { "type": "object", "required": [ "hydra:member" ], "properties": { "hydra:member": { "type": "array", "items": { "$ref": "#/components/schemas/Entity.LegalEntity.LegalEntityOutput.jsonld" } } } } ] } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Entity.LegalEntity.LegalEntityOutput" } } } } } }, "summary": "Retrieves the collection of LegalEntity resources.", "description": "Retrieves the collection of LegalEntity resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": true }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "schema": { "type": "integer", "default": 30, "minimum": 0, "maximum": 30 }, "style": "form", "explode": true } ] }, "post": { "operationId": "api_legal-entities_post", "tags": [ "LegalEntity" ], "responses": { "201": { "description": "LegalEntity resource created", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Entity.LegalEntity.LegalEntityOutput.jsonld" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Entity.LegalEntity.LegalEntityOutput" } } }, "links": {} }, "400": { "description": "Invalid input", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} }, "422": { "description": "An error occurred", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } } }, "links": {} } }, "summary": "Creates a LegalEntity resource.", "description": "Creates a LegalEntity resource.", "parameters": [], "requestBody": { "description": "The new LegalEntity resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Entity.LegalEntity.LegalEntityCreateInput" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Entity.LegalEntity.LegalEntityCreateInput" } } }, "required": true } } }, "/legal-entities/{uuid}": { "get": { "operationId": "api_legal-entities_uuid_get", "tags": [ "LegalEntity" ], "responses": { "200": { "description": "LegalEntity resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Entity.LegalEntity.LegalEntityOutput.jsonld" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Entity.LegalEntity.LegalEntityOutput" } } } }, "404": { "description": "Not found", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} } }, "summary": "Retrieves a LegalEntity resource.", "description": "Retrieves a LegalEntity resource.", "parameters": [ { "name": "uuid", "in": "path", "description": "LegalEntity identifier", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ] }, "put": { "operationId": "api_legal-entities_uuid_put", "tags": [ "LegalEntity" ], "responses": { "200": { "description": "LegalEntity resource updated", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Entity.LegalEntity.LegalEntityOutput.jsonld" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Entity.LegalEntity.LegalEntityOutput" } } }, "links": {} }, "400": { "description": "Invalid input", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} }, "422": { "description": "An error occurred", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } } }, "links": {} }, "404": { "description": "Not found", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} } }, "summary": "Replaces the LegalEntity resource.", "description": "Replaces the LegalEntity resource.", "parameters": [ { "name": "uuid", "in": "path", "description": "LegalEntity identifier", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ], "requestBody": { "description": "The updated LegalEntity resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Entity.LegalEntity.LegalEntityUpdateInput" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Entity.LegalEntity.LegalEntityUpdateInput" } } }, "required": true } }, "delete": { "operationId": "api_legal-entities_uuid_delete", "tags": [ "LegalEntity" ], "responses": { "204": { "description": "LegalEntity resource deleted" }, "404": { "description": "Not found", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} } }, "summary": "Removes the LegalEntity resource.", "description": "Removes the LegalEntity resource.", "parameters": [ { "name": "uuid", "in": "path", "description": "LegalEntity identifier", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ] } }, "/legal-entities/{legalEntityUuid}/sub-accounts": { "get": { "operationId": "api_legal-entities_legalEntityUuidsub-accounts_get_collection", "tags": [ "LegalEntitySubAccount" ], "responses": { "200": { "description": "LegalEntitySubAccount collection", "content": { "application/ld+json": { "schema": { "type": "object", "description": "LegalEntitySubAccount.jsonld collection.", "allOf": [ { "$ref": "#/components/schemas/HydraCollectionBaseSchema" }, { "type": "object", "required": [ "hydra:member" ], "properties": { "hydra:member": { "type": "array", "items": { "$ref": "#/components/schemas/LegalEntitySubAccount.jsonld" } } } } ] } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LegalEntitySubAccount" } } } } } }, "summary": "Retrieves the collection of LegalEntitySubAccount resources.", "description": "Retrieves the collection of LegalEntitySubAccount resources.", "parameters": [ { "name": "legalEntityUuid", "in": "path", "description": "LegalEntity identifier", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false }, { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": true }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "schema": { "type": "integer", "default": 30, "minimum": 0, "maximum": 30 }, "style": "form", "explode": true } ] }, "post": { "operationId": "api_legal-entities_legalEntityUuidsub-accounts_post", "tags": [ "LegalEntitySubAccount" ], "responses": { "201": { "description": "LegalEntitySubAccount resource created", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/LegalEntitySubAccount.jsonld" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LegalEntitySubAccount" } } }, "links": {} }, "400": { "description": "Invalid input", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} }, "422": { "description": "An error occurred", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } } }, "links": {} } }, "summary": "Creates a LegalEntitySubAccount resource.", "description": "Creates a LegalEntitySubAccount resource.", "parameters": [ { "name": "legalEntityUuid", "in": "path", "description": "LegalEntity identifier", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ], "requestBody": { "description": "The new LegalEntitySubAccount resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/LegalEntitySubAccount.LegalEntitySubAccountCreateInput" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LegalEntitySubAccount.LegalEntitySubAccountCreateInput" } } }, "required": true } } }, "/legal-entities/{legalEntityUuid}/sub-accounts/{uuid}": { "get": { "operationId": "api_legal-entities_legalEntityUuidsub-accounts_uuid_get", "tags": [ "LegalEntitySubAccount" ], "responses": { "200": { "description": "LegalEntitySubAccount resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/LegalEntitySubAccount.jsonld" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LegalEntitySubAccount" } } } }, "404": { "description": "Not found", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} } }, "summary": "Retrieves a LegalEntitySubAccount resource.", "description": "Retrieves a LegalEntitySubAccount resource.", "parameters": [ { "name": "legalEntityUuid", "in": "path", "description": "LegalEntity identifier", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false }, { "name": "uuid", "in": "path", "description": "LegalEntitySubAccount identifier", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ] }, "delete": { "operationId": "api_legal-entities_legalEntityUuidsub-accounts_uuid_delete", "tags": [ "LegalEntitySubAccount" ], "responses": { "204": { "description": "LegalEntitySubAccount resource deleted" }, "404": { "description": "Not found", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} } }, "summary": "Removes the LegalEntitySubAccount resource.", "description": "Removes the LegalEntitySubAccount resource.", "parameters": [ { "name": "legalEntityUuid", "in": "path", "description": "LegalEntity identifier", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false }, { "name": "uuid", "in": "path", "description": "LegalEntitySubAccount identifier", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ] } } }, "components": { "schemas": { "Account": { "type": "object", "properties": { "IBAN": { "minLength": 5, "maxLength": 34, "type": [ "string", "null" ] }, "AccountNumber": { "minLength": 5, "maxLength": 34, "type": [ "string", "null" ] }, "BankCode": { "maxLength": 60, "type": [ "string", "null" ] }, "BranchCode": { "maxLength": 60, "type": [ "string", "null" ] }, "BranchInSpainAddress": { "anyOf": [ { "$ref": "#/components/schemas/Address" }, { "type": "null" } ] }, "OverseasBranchAddress": { "anyOf": [ { "$ref": "#/components/schemas/OverseasAddress" }, { "type": "null" } ] }, "BIC": { "minLength": 11, "maxLength": 11, "type": [ "string", "null" ] } } }, "AdditionalData": { "type": "object", "properties": { "RelatedInvoice": { "type": [ "string", "null" ] }, "RelatedDocuments": { "anyOf": [ { "$ref": "#/components/schemas/AttachedDocuments" }, { "type": "null" } ] }, "InvoiceAdditionalInformation": { "type": [ "string", "null" ] }, "Extensions": { "anyOf": [ { "$ref": "#/components/schemas/Extensions" }, { "type": "null" } ] } } }, "Address": { "type": "object", "required": [ "Address", "PostCode", "Town", "Province", "CountryCode" ], "properties": { "Address": { "maxLength": 80, "type": "string" }, "PostCode": { "minLength": 5, "maxLength": 5, "type": "string" }, "Town": { "maxLength": 50, "type": "string" }, "Province": { "maxLength": 20, "type": "string" }, "CountryCode": { "enum": [ "AFG", "ALB", "DZA", "ASM", "AND", "AGO", "AIA", "ATG", "ARG", "ARM", "ABW", "AUS", "AUT", "AZE", "BHS", "BHR", "BGD", "BRB", "BLR", "BEL", "BLZ", "BEN", "BMU", "BTN", "BOL", "BIH", "BWA", "BRA", "BRN", "BGR", "BFA", "BDI", "KHM", "CMR", "CAN", "CPV", "CYM", "CAF", "TCD", "CHL", "CHN", "COD", "COL", "COM", "COG", "COK", "CRI", "CIV", "HRV", "CUB", "CYP", "CZE", "DNK", "DJI", "DMA", "DOM", "ECU", "EGY", "SLV", "GNQ", "ERI", "EST", "ETH", "FLK", "FRO", "FJI", "FIN", "FRA", "GUF", "PYF", "GAB", "GMB", "GEO", "GGY", "DEU", "GHA", "GIB", "GRC", "GRL", "GRD", "GLP", "GUM", "GTM", "GIN", "GNB", "GUY", "HTI", "HND", "HKG", "HUN", "ISL", "IND", "IDN", "IMN", "IRN", "IRQ", "IRL", "ISR", "ITA", "JAM", "JEY", "JPN", "JOR", "KAZ", "KEN", "KIR", "PRK", "KOR", "KWT", "KGZ", "LAO", "LVA", "LBN", "LSO", "LBR", "LBY", "LIE", "LTU", "LUX", "MAC", "MKD", "MDG", "MWI", "MYS", "MDV", "MLI", "MLT", "MHL", "MTQ", "MRT", "MUS", "MYT", "MEX", "FSM", "MDA", "MCO", "MNE", "MNG", "MSR", "MAR", "MOZ", "MMR", "NAM", "NRU", "NPL", "NLD", "ANT", "NCL", "NZL", "NIC", "NER", "NGA", "NIU", "NFK", "MNP", "NOR", "OMN", "PAK", "PLW", "PAN", "PNG", "PRY", "PSE", "PER", "PHL", "PCN", "POL", "PRT", "PRI", "QAT", "REU", "ROU", "RUS", "RWA", "KNA", "LCA", "VCT", "WSM", "SMR", "STP", "SAU", "SEN", "SRB", "SYC", "SLE", "SGP", "SVK", "SVN", "SLB", "SOM", "ZAF", "ESP", "LKA", "SHN", "SPM", "SDN", "SUR", "SJM", "SWZ", "SWE", "CHE", "SYR", "TWN", "TJK", "TZA", "THA", "TGO", "TKL", "TON", "TTO", "TUN", "TUR", "TKM", "TLS", "TCA", "TUV", "UGA", "UKR", "ARE", "GBR", "USA", "URY", "UZB", "VUT", "VAT", "VEN", "VNM", "VGB", "VIR", "WLF", "ESH", "YEM", "ZAR", "ZMB", "ZWE" ], "type": "string" } } }, "AdministrativeCentre": { "type": "object", "properties": { "CentreCode": { "maxLength": 10, "type": [ "string", "null" ] }, "RoleTypeCode": { "type": [ "string", "null" ], "enum": [ "01", "02", "03", "04", "05", "06", "07", "08", "09", null ] }, "Name": { "maxLength": 40, "type": [ "string", "null" ] }, "FirstSurname": { "maxLength": 40, "type": [ "string", "null" ] }, "SecondSurname": { "maxLength": 40, "type": [ "string", "null" ] }, "AddressInSpain": { "anyOf": [ { "$ref": "#/components/schemas/Address" }, { "type": "null" } ] }, "OverseasAddress": { "anyOf": [ { "$ref": "#/components/schemas/OverseasAddress" }, { "type": "null" } ] }, "ContactDetails": { "anyOf": [ { "$ref": "#/components/schemas/ContactDetails" }, { "type": "null" } ] }, "PhysicalGLN": { "maxLength": 14, "type": [ "string", "null" ] }, "LogicalOperationalPoint": { "maxLength": 14, "type": [ "string", "null" ] }, "CentreDescription": { "maxLength": 2500, "type": [ "string", "null" ] } } }, "AdministrativeCentres": { "type": "object", "properties": { "AdministrativeCentre": { "type": "array", "items": { "$ref": "#/components/schemas/AdministrativeCentre" } } } }, "Amount": { "type": "object", "properties": { "TotalAmount": { "type": [ "string", "null" ] }, "EquivalentInEuros": { "type": [ "string", "null" ] } } }, "AmountsWithheld": { "type": "object", "properties": { "WithholdingReason": { "type": [ "string", "null" ] }, "WithholdingRate": { "type": [ "string", "null" ] }, "WithholdingAmount": { "type": [ "string", "null" ] } } }, "Assignee": { "type": "object", "properties": { "TaxIdentification": { "anyOf": [ { "$ref": "#/components/schemas/TaxIdentification" }, { "type": "null" } ] }, "LegalEntity": { "anyOf": [ { "$ref": "#/components/schemas/LegalEntity" }, { "type": "null" } ] }, "Individual": { "anyOf": [ { "$ref": "#/components/schemas/Individual" }, { "type": "null" } ] } } }, "AttachedDocuments": { "type": "object", "properties": { "Attachment": { "type": "array", "items": { "$ref": "#/components/schemas/Attachment" } } } }, "Attachment": { "type": "object", "properties": { "AttachmentCompressionAlgorithm": { "type": [ "string", "null" ] }, "AttachmentFormat": { "type": [ "string", "null" ] }, "AttachmentEncoding": { "type": [ "string", "null" ] }, "AttachmentDescription": { "type": [ "string", "null" ] }, "AttachmentData": { "type": [ "string", "null" ] } } }, "Batch": { "type": "object", "properties": { "BatchIdentifier": { "type": [ "string", "null" ] }, "InvoicesCount": { "type": [ "integer", "null" ] }, "TotalInvoicesAmount": { "anyOf": [ { "$ref": "#/components/schemas/Amount" }, { "type": "null" } ] }, "TotalOutstandingAmount": { "anyOf": [ { "$ref": "#/components/schemas/Amount" }, { "type": "null" } ] }, "TotalExecutableAmount": { "anyOf": [ { "$ref": "#/components/schemas/Amount" }, { "type": "null" } ] }, "InvoiceCurrencyCode": { "type": [ "string", "null" ] } } }, "Business": { "type": "object", "required": [ "TaxIdentification" ], "properties": { "TaxIdentification": { "anyOf": [ { "$ref": "#/components/schemas/FacturaeDraft.TaxIdentification" }, { "type": "null" } ] }, "PartyIdentification": { "maxLength": 10, "type": [ "string", "null" ] }, "AdministrativeCentres": { "anyOf": [ { "$ref": "#/components/schemas/AdministrativeCentres" }, { "type": "null" } ] }, "LegalEntity": { "anyOf": [ { "$ref": "#/components/schemas/FacturaeDraft.LegalEntity" }, { "type": "null" } ] }, "Individual": { "anyOf": [ { "$ref": "#/components/schemas/FacturaeDraft.Individual" }, { "type": "null" } ] } } }, "CanonicalizationMethod": { "type": "object", "required": [ "@Algorithm" ], "properties": { "@Algorithm": { "type": "string" } } }, "Charge": { "type": "object", "properties": { "ChargeReason": { "type": [ "string", "null" ] }, "ChargeRate": { "type": [ "string", "null" ] }, "ChargeAmount": { "type": [ "string", "null" ] } } }, "Charges": { "type": "object", "properties": { "Charge": { "type": "array", "items": { "$ref": "#/components/schemas/Charge" } } } }, "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" }, "ContactDetails": { "type": "object", "properties": { "Telephone": { "maxLength": 15, "type": [ "string", "null" ] }, "TeleFax": { "maxLength": 15, "type": [ "string", "null" ] }, "WebAddress": { "maxLength": 60, "type": [ "string", "null" ] }, "ElectronicMail": { "maxLength": 60, "type": [ "string", "null" ] }, "ContactPersons": { "maxLength": 40, "type": [ "string", "null" ] }, "CnoCnae": { "minLength": 5, "maxLength": 5, "type": [ "string", "null" ] }, "INETownCode": { "maxLength": 9, "type": [ "string", "null" ] }, "AdditionalContactDetails": { "maxLength": 60, "type": [ "string", "null" ] } } }, "Corrective": { "type": "object", "properties": { "InvoiceNumber": { "type": [ "string", "null" ] }, "InvoiceSeriesCode": { "type": [ "string", "null" ] }, "ReasonCode": { "type": [ "string", "null" ] }, "ReasonDescription": { "type": [ "string", "null" ] }, "TaxPeriod": { "anyOf": [ { "$ref": "#/components/schemas/PeriodDates" }, { "type": "null" } ] }, "CorrectionMethod": { "type": [ "string", "null" ] }, "CorrectionMethodDescription": { "type": [ "string", "null" ] }, "AdditionalReasonDescription": { "type": [ "string", "null" ] }, "InvoiceIssueDate": { "type": [ "string", "null" ], "format": "date-time" } } }, "DeliveryNote": { "type": "object", "properties": { "DeliveryNoteNumber": { "type": [ "string", "null" ] }, "DeliveryNoteDate": { "type": [ "string", "null" ], "format": "date-time" } } }, "DeliveryNotesReferences": { "type": "object", "properties": { "DeliveryNote": { "type": "array", "items": { "$ref": "#/components/schemas/DeliveryNote" } } } }, "DigestMethod": { "type": "object", "required": [ "@Algorithm" ], "properties": { "@Algorithm": { "type": "string" } } }, "Discount": { "type": "object", "properties": { "DiscountReason": { "type": [ "string", "null" ] }, "DiscountRate": { "type": [ "string", "null" ] }, "DiscountAmount": { "type": [ "string", "null" ] } } }, "DiscountsAndRebates": { "type": "object", "properties": { "Discount": { "type": "array", "items": { "$ref": "#/components/schemas/Discount" } } } }, "Entity.Invoice.InvoiceCreateInput": { "type": "object", "description": "Creates and sends an outgoing invoice. Accepts a Facturae 3.2.2 document either as XML (application/xml) or as an equivalent JSON object (application/json) whose keys mirror the Facturae element names; JSON input is converted to Facturae XML before processing.", "required": [ "FileHeader", "Parties", "Invoices" ], "properties": { "FileHeader": { "$ref": "#/components/schemas/Facturae.FileHeader" }, "Parties": { "$ref": "#/components/schemas/Facturae.Parties" }, "Invoices": { "$ref": "#/components/schemas/Facturae.Invoices" }, "Extensions": { "anyOf": [ { "$ref": "#/components/schemas/Extensions" }, { "type": "null" } ] }, "ds:Signature": { "anyOf": [ { "$ref": "#/components/schemas/Signature" }, { "type": "null" } ] } } }, "Entity.Invoice.InvoiceOutput": { "type": "object", "properties": { "uuid": { "type": "string" }, "invoiceNumber": { "type": [ "string", "null" ] }, "invoiceDate": { "type": [ "string", "null" ] }, "dueDate": { "type": [ "string", "null" ] }, "currency": { "type": [ "string", "null" ] }, "totalAmount": { "type": [ "string", "null" ] }, "netAmount": { "type": [ "string", "null" ] }, "direction": { "type": "string" }, "sender": { "$ref": "#/components/schemas/InvoicePartyOutput" }, "recipient": { "$ref": "#/components/schemas/InvoicePartyOutput" }, "status": { "type": "string" }, "errorReason": { "type": [ "string", "null" ] }, "downloaded": { "type": "boolean" }, "downloadedAt": { "type": [ "string", "null" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": [ "string", "null" ] } } }, "Entity.Invoice.InvoiceOutput.jsonld": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "uuid": { "type": "string" }, "invoiceNumber": { "type": [ "string", "null" ] }, "invoiceDate": { "type": [ "string", "null" ] }, "dueDate": { "type": [ "string", "null" ] }, "currency": { "type": [ "string", "null" ] }, "totalAmount": { "type": [ "string", "null" ] }, "netAmount": { "type": [ "string", "null" ] }, "direction": { "type": "string" }, "sender": { "$ref": "#/components/schemas/InvoicePartyOutput.jsonld" }, "recipient": { "$ref": "#/components/schemas/InvoicePartyOutput.jsonld" }, "status": { "type": "string" }, "errorReason": { "type": [ "string", "null" ] }, "downloaded": { "type": "boolean" }, "downloadedAt": { "type": [ "string", "null" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": [ "string", "null" ] } } } ] }, "Entity.Invoice.VerifactuQrData": { "type": "object", "description": "Returns the VERI*FACTU \"QR tributario\" of an issued invoice: the AEAT ValidarQR payload (and the fields it is built from) as JSON, or the rendered QR as a PNG image - selected by the Accept header (application/json or image/png).", "properties": { "url": { "type": "string" }, "nif": { "type": "string" }, "seriesNumber": { "type": "string" }, "issueDate": { "type": "string" }, "totalAmount": { "type": "string" } } }, "Entity.Invoice.VerifactuQrData.png": { "type": "object", "description": "Returns the VERI*FACTU \"QR tributario\" of an issued invoice: the AEAT ValidarQR payload (and the fields it is built from) as JSON, or the rendered QR as a PNG image - selected by the Accept header (application/json or image/png).", "properties": { "url": { "type": "string" }, "nif": { "type": "string" }, "seriesNumber": { "type": "string" }, "issueDate": { "type": "string" }, "totalAmount": { "type": "string" } } }, "Entity.LegalEntity.LegalEntityCreateInput": { "type": "object", "required": [ "taxId", "name", "address", "city", "zipCode" ], "properties": { "taxId": { "minLength": 9, "maxLength": 9, "example": "A58818501", "type": "string", "description": "Spanish tax identifier (NIF, NIE or CIF) of the legal entity, 9 characters." }, "name": { "maxLength": 120, "type": "string" }, "email": { "format": "email", "externalDocs": { "url": "https://schema.org/email" }, "type": [ "string", "null" ] }, "phoneNumber": { "pattern": "^(\\+?[1-9]\\d{1,14})$", "type": [ "string", "null" ] }, "country": { "minLength": 2, "maxLength": 2, "type": "string" }, "address": { "type": "string" }, "city": { "type": "string" }, "stateOrProvince": { "type": [ "string", "null" ] }, "zipCode": { "type": "string" }, "config": { "$ref": "#/components/schemas/LegalEntityConfigInput" } } }, "Entity.LegalEntity.LegalEntityOutput": { "type": "object", "properties": { "uuid": { "type": "string" }, "taxId": { "type": "string", "description": "Tax identifier of the Legal entity, used to uniquely identify the Legal entity in the jurisdiction where it is legally based." }, "name": { "type": "string", "description": "Name used to register the Legal entity in the business registry of the jurisdiction where it is legally based." }, "email": { "type": [ "string", "null" ], "description": "Email address of the Legal entity." }, "phoneNumber": { "type": [ "string", "null" ], "description": "Phone number of the Legal entity." }, "country": { "type": "string", "description": "Country code ISO 3166-1 alpha-2 codes" }, "address": { "type": "string", "description": "Legal entity address" }, "city": { "type": "string", "description": "Legal entity city" }, "stateOrProvince": { "type": [ "string", "null" ], "description": "Legal entity state or province" }, "zipCode": { "type": "string", "description": "Legal entity zip code" }, "status": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": [ "string", "null" ] }, "config": { "$ref": "#/components/schemas/LegalEntityConfigOutput" } } }, "Entity.LegalEntity.LegalEntityOutput.jsonld": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "uuid": { "type": "string" }, "taxId": { "type": "string", "description": "Tax identifier of the Legal entity, used to uniquely identify the Legal entity in the jurisdiction where it is legally based." }, "name": { "type": "string", "description": "Name used to register the Legal entity in the business registry of the jurisdiction where it is legally based." }, "email": { "type": [ "string", "null" ], "description": "Email address of the Legal entity." }, "phoneNumber": { "type": [ "string", "null" ], "description": "Phone number of the Legal entity." }, "country": { "type": "string", "description": "Country code ISO 3166-1 alpha-2 codes" }, "address": { "type": "string", "description": "Legal entity address" }, "city": { "type": "string", "description": "Legal entity city" }, "stateOrProvince": { "type": [ "string", "null" ], "description": "Legal entity state or province" }, "zipCode": { "type": "string", "description": "Legal entity zip code" }, "status": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": [ "string", "null" ] }, "config": { "$ref": "#/components/schemas/LegalEntityConfigOutput.jsonld" } } } ] }, "Entity.LegalEntity.LegalEntityUpdateInput": { "type": "object", "required": [ "name", "address", "city", "zipCode" ], "properties": { "name": { "maxLength": 120, "type": "string" }, "email": { "format": "email", "externalDocs": { "url": "https://schema.org/email" }, "type": [ "string", "null" ] }, "phoneNumber": { "pattern": "^(\\+?[1-9]\\d{1,14})$", "type": [ "string", "null" ] }, "country": { "minLength": 2, "maxLength": 2, "type": "string" }, "address": { "type": "string" }, "city": { "type": "string" }, "stateOrProvince": { "type": [ "string", "null" ] }, "zipCode": { "type": "string" }, "config": { "$ref": "#/components/schemas/LegalEntityConfigInput" } } }, "Error": { "type": "object", "description": "A representation of common errors.", "properties": { "title": { "readOnly": true, "description": "A short, human-readable summary of the problem.", "type": [ "string", "null" ] }, "detail": { "readOnly": true, "description": "A human-readable explanation specific to this occurrence of the problem.", "type": [ "string", "null" ] }, "status": { "type": [ "integer", "null" ], "examples": [ 404 ], "default": 400 }, "instance": { "readOnly": true, "description": "A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.", "type": [ "string", "null" ] }, "type": { "readOnly": true, "description": "A URI reference that identifies the problem type", "type": "string" } } }, "Error.jsonld": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "title": { "readOnly": true, "description": "A short, human-readable summary of the problem.", "type": [ "string", "null" ] }, "detail": { "readOnly": true, "description": "A human-readable explanation specific to this occurrence of the problem.", "type": [ "string", "null" ] }, "status": { "type": [ "integer", "null" ], "examples": [ 404 ], "default": 400 }, "instance": { "readOnly": true, "description": "A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.", "type": [ "string", "null" ] }, "type": { "readOnly": true, "description": "A URI reference that identifies the problem type", "type": "string" }, "description": { "readOnly": true, "type": [ "string", "null" ] } } } ], "description": "A representation of common errors." }, "EventDestination.EventDestinationCreateInput": { "type": "object", "properties": { "event": { "enum": [ "invoice.sent", "invoice.received", "invoice.rejected", "invoice.failed", "legal_entity.onboarding_completed", "legal_entity.onboarding_failed" ], "type": "string" }, "delivery": { "enum": [ "webhook", "email", "aws_event_bridge" ], "type": "string" }, "target": { "type": "string" }, "authType": { "enum": [ "none", "query", "header" ], "type": "string" }, "authKey": { "description": "The key to use for authentication. If not provided, defaults to \"Authorization\" for `header` auth type and \"token\" for `query` auth type.", "type": [ "string", "null" ] }, "authToken": { "type": [ "string", "null" ] } }, "required": [ "target", "authType" ] }, "EventDestination.EventDestinationOutput": { "type": "object", "properties": { "uuid": { "type": "string" }, "event": { "type": "string" }, "delivery": { "type": "string" }, "target": { "type": "string" }, "authType": { "type": "string" }, "authKey": { "type": [ "string", "null" ] }, "authToken": { "type": [ "string", "null" ] } } }, "EventDestination.EventDestinationOutput.jsonld": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "uuid": { "type": "string" }, "event": { "type": "string" }, "delivery": { "type": "string" }, "target": { "type": "string" }, "authType": { "type": "string" }, "authKey": { "type": [ "string", "null" ] }, "authToken": { "type": [ "string", "null" ] } } } ] }, "EventDestination.EventDestinationUpdateInput": { "type": "object", "properties": { "authType": { "enum": [ "none", "query", "header" ], "type": "string" }, "authKey": { "type": [ "string", "null" ] }, "authToken": { "type": [ "string", "null" ] } } }, "ExchangeRateDetails": { "type": "object", "properties": { "ExchangeRate": { "type": [ "string", "null" ] }, "ExchangeRateDate": { "type": [ "string", "null" ], "format": "date-time" } } }, "Extensions": { "type": "object" }, "FactoringAssignmentData": { "type": "object", "properties": { "Assignee": { "anyOf": [ { "$ref": "#/components/schemas/Assignee" }, { "type": "null" } ] }, "PaymentDetails": { "anyOf": [ { "$ref": "#/components/schemas/Installments" }, { "type": "null" } ] }, "FactoringAssignmentClauses": { "type": [ "string", "null" ] }, "FactoringAssignmentDocument": { "type": "array", "items": { "$ref": "#/components/schemas/FactoringAssignmentDocument" } } } }, "FactoringAssignmentDocument": { "type": "object", "properties": { "DocumentCharacter": { "type": [ "string", "null" ] }, "RepresentationIdentity": { "type": [ "string", "null" ] }, "DocumentType": { "type": [ "string", "null" ] }, "Repository": { "anyOf": [ { "$ref": "#/components/schemas/Repository" }, { "type": "null" } ] } } }, "Facturae.AdditionalData": { "type": "object", "properties": { "RelatedInvoice": { "maxLength": 40, "type": [ "string", "null" ] }, "RelatedDocuments": { "anyOf": [ { "$ref": "#/components/schemas/Facturae.AttachedDocuments" }, { "type": "null" } ] }, "InvoiceAdditionalInformation": { "maxLength": 2500, "type": [ "string", "null" ] }, "Extensions": { "anyOf": [ { "$ref": "#/components/schemas/Extensions" }, { "type": "null" } ] } } }, "Facturae.Amount": { "type": "object", "required": [ "TotalAmount" ], "properties": { "TotalAmount": { "type": "string" }, "EquivalentInEuros": { "type": [ "string", "null" ] } } }, "Facturae.AmountsWithheld": { "type": "object", "required": [ "WithholdingReason", "WithholdingAmount" ], "properties": { "WithholdingReason": { "maxLength": 2500, "type": "string" }, "WithholdingRate": { "type": [ "string", "null" ] }, "WithholdingAmount": { "type": "string" } } }, "Facturae.Assignee": { "type": "object", "required": [ "TaxIdentification" ], "properties": { "TaxIdentification": { "$ref": "#/components/schemas/TaxIdentification" }, "LegalEntity": { "anyOf": [ { "$ref": "#/components/schemas/LegalEntity" }, { "type": "null" } ] }, "Individual": { "anyOf": [ { "$ref": "#/components/schemas/Individual" }, { "type": "null" } ] } } }, "Facturae.AttachedDocuments": { "type": "object", "properties": { "Attachment": { "type": "array", "items": { "$ref": "#/components/schemas/Facturae.Attachment" } } } }, "Facturae.Attachment": { "type": "object", "properties": { "AttachmentCompressionAlgorithm": { "type": [ "string", "null" ], "enum": [ "ZIP", "GZIP", "NONE", null ] }, "AttachmentFormat": { "type": "string", "enum": [ "xml", "doc", "gif", "rtf", "pdf", "xls", "jpg", "bmp", "tiff", "html" ] }, "AttachmentEncoding": { "type": [ "string", "null" ], "enum": [ "BASE64", "BER", "DER", "NONE", null ] }, "AttachmentDescription": { "maxLength": 2500, "type": [ "string", "null" ] }, "AttachmentData": { "type": "string" } }, "required": [ "AttachmentFormat", "AttachmentData" ] }, "Facturae.Batch": { "type": "object", "required": [ "BatchIdentifier", "InvoicesCount", "TotalInvoicesAmount", "TotalOutstandingAmount", "TotalExecutableAmount", "InvoiceCurrencyCode" ], "properties": { "BatchIdentifier": { "maxLength": 70, "type": "string" }, "InvoicesCount": { "type": "integer" }, "TotalInvoicesAmount": { "$ref": "#/components/schemas/Facturae.Amount" }, "TotalOutstandingAmount": { "$ref": "#/components/schemas/Facturae.Amount" }, "TotalExecutableAmount": { "$ref": "#/components/schemas/Facturae.Amount" }, "InvoiceCurrencyCode": { "enum": [ "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAD", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BRR", "BSD", "BWP", "BYR", "BZD", "CAD", "CDF", "CDP", "CHF", "CLP", "CNY", "COP", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DRP", "DZD", "EEK", "EGP", "ESP", "ETB", "EUR", "FJD", "FKP", "GBP", "GEK", "GHC", "GIP", "GMD", "GNF", "GTQ", "GWP", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGF", "MNC", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZM", "NGN", "NIC", "NIO", "NIS", "NOK", "NPR", "NZD", "OMR", "PAB", "PEI", "PEN", "PES", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RMB", "RON", "RUB", "RWF", "SAR", "SBD", "SCR", "SDP", "SEK", "SGD", "SHP", "SKK", "SLL", "SOL", "SOS", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMM", "TND", "TOP", "TPE", "TRY", "TTD", "TWD", "TZS", "UAH", "UGS", "USD", "UYP", "UYU", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "YER", "ZAR", "ZMK", "ZWD" ], "type": "string" } } }, "Facturae.Business": { "type": "object", "required": [ "TaxIdentification" ], "properties": { "TaxIdentification": { "$ref": "#/components/schemas/TaxIdentification" }, "PartyIdentification": { "maxLength": 10, "type": [ "string", "null" ] }, "AdministrativeCentres": { "anyOf": [ { "$ref": "#/components/schemas/AdministrativeCentres" }, { "type": "null" } ] }, "LegalEntity": { "anyOf": [ { "$ref": "#/components/schemas/LegalEntity" }, { "type": "null" } ] }, "Individual": { "anyOf": [ { "$ref": "#/components/schemas/Individual" }, { "type": "null" } ] } } }, "Facturae.Charge": { "type": "object", "required": [ "ChargeReason", "ChargeAmount" ], "properties": { "ChargeReason": { "maxLength": 2500, "type": "string" }, "ChargeRate": { "type": [ "string", "null" ] }, "ChargeAmount": { "type": "string" } } }, "Facturae.Charges": { "type": "object", "properties": { "Charge": { "type": "array", "items": { "$ref": "#/components/schemas/Facturae.Charge" } } } }, "Facturae.Corrective": { "type": "object", "properties": { "InvoiceNumber": { "maxLength": 20, "type": [ "string", "null" ] }, "InvoiceSeriesCode": { "maxLength": 20, "type": [ "string", "null" ] }, "ReasonCode": { "type": "string", "enum": [ "01", "02", "03", "04", "05", "06", "07", "08", "09", "10", "11", "12", "13", "14", "15", "16", "80", "81", "82", "83", "84", "85" ] }, "ReasonDescription": { "enum": [ "Número de la factura", "Serie de la factura", "Fecha expedición", "Nombre y apellidos/Razón Social-Emisor", "Nombre y apellidos/Razón Social-Receptor", "Identificación fiscal Emisor/obligado", "Identificación fiscal Receptor", "Domicilio Emisor/Obligado", "Domicilio Receptor", "Detalle Operación", "Porcentaje impositivo a aplicar", "Cuota tributaria a aplicar", "Fecha/Periodo a aplicar", "Clase de factura", "Literales legales", "Base imponible", "Cálculo de cuotas repercutidas", "Cálculo de cuotas retenidas", "Base imponible modificada por devolución de envases / embalajes", "Base imponible modificada por descuentos y bonificaciones", "Base imponible modificada por resolución firme, judicial o administrativa", "Base imponible modificada cuotas repercutidas no satisfechas. Auto de declaración de concurso" ], "type": "string" }, "TaxPeriod": { "$ref": "#/components/schemas/Facturae.PeriodDates" }, "CorrectionMethod": { "type": "string", "enum": [ "01", "02", "03", "04" ] }, "CorrectionMethodDescription": { "enum": [ "Rectificación íntegra", "Rectificación por diferencias", "Rectificación por descuento por volumen de operaciones durante un periodo", "Autorizadas por la Agencia Tributaria" ], "type": "string" }, "AdditionalReasonDescription": { "maxLength": 2500, "type": [ "string", "null" ] }, "InvoiceIssueDate": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "ReasonCode", "ReasonDescription", "TaxPeriod", "CorrectionMethod", "CorrectionMethodDescription" ] }, "Facturae.DeliveryNote": { "type": "object", "required": [ "DeliveryNoteNumber" ], "properties": { "DeliveryNoteNumber": { "maxLength": 30, "type": "string" }, "DeliveryNoteDate": { "type": [ "string", "null" ], "format": "date-time" } } }, "Facturae.DeliveryNotesReferences": { "type": "object", "properties": { "DeliveryNote": { "type": "array", "items": { "$ref": "#/components/schemas/Facturae.DeliveryNote" } } } }, "Facturae.Discount": { "type": "object", "required": [ "DiscountReason", "DiscountAmount" ], "properties": { "DiscountReason": { "maxLength": 2500, "type": "string" }, "DiscountRate": { "type": [ "string", "null" ] }, "DiscountAmount": { "type": "string" } } }, "Facturae.DiscountsAndRebates": { "type": "object", "properties": { "Discount": { "type": "array", "items": { "$ref": "#/components/schemas/Facturae.Discount" } } } }, "Facturae.ExchangeRateDetails": { "type": "object", "required": [ "ExchangeRate", "ExchangeRateDate" ], "properties": { "ExchangeRate": { "type": "string" }, "ExchangeRateDate": { "type": "string", "format": "date-time" } } }, "Facturae.FactoringAssignmentData": { "type": "object", "required": [ "Assignee", "PaymentDetails", "FactoringAssignmentClauses" ], "properties": { "Assignee": { "$ref": "#/components/schemas/Facturae.Assignee" }, "PaymentDetails": { "$ref": "#/components/schemas/Facturae.Installments" }, "FactoringAssignmentClauses": { "maxLength": 2500, "type": "string" }, "FactoringAssignmentDocument": { "type": "array", "items": { "$ref": "#/components/schemas/Facturae.FactoringAssignmentDocument" } } } }, "Facturae.FactoringAssignmentDocument": { "type": "object", "required": [ "DocumentCharacter", "DocumentType" ], "properties": { "DocumentCharacter": { "maxLength": 50, "type": "string" }, "RepresentationIdentity": { "maxLength": 80, "type": [ "string", "null" ] }, "DocumentType": { "maxLength": 50, "type": "string" }, "Repository": { "anyOf": [ { "$ref": "#/components/schemas/Facturae.Repository" }, { "type": "null" } ] } } }, "Facturae.FileHeader": { "type": "object", "required": [ "SchemaVersion", "Modality", "InvoiceIssuerType", "Batch" ], "properties": { "SchemaVersion": { "enum": [ "3.2.2" ], "type": "string" }, "Modality": { "type": "string", "enum": [ "I", "L" ] }, "InvoiceIssuerType": { "type": "string", "enum": [ "EM", "RE", "TE" ] }, "ThirdParty": { "anyOf": [ { "$ref": "#/components/schemas/Facturae.ThirdParty" }, { "type": "null" } ] }, "Batch": { "$ref": "#/components/schemas/Facturae.Batch" }, "FactoringAssignmentData": { "anyOf": [ { "$ref": "#/components/schemas/Facturae.FactoringAssignmentData" }, { "type": "null" } ] } } }, "Facturae.Installment": { "type": "object", "required": [ "InstallmentDueDate", "InstallmentAmount", "PaymentMeans" ], "properties": { "InstallmentDueDate": { "type": "string", "format": "date-time" }, "InstallmentAmount": { "type": "string" }, "PaymentMeans": { "type": "string", "enum": [ "01", "02", "03", "04", "05", "06", "07", "08", "09", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19" ] }, "AccountToBeCredited": { "anyOf": [ { "$ref": "#/components/schemas/Account" }, { "type": "null" } ] }, "PaymentReconciliationReference": { "maxLength": 60, "type": [ "string", "null" ] }, "AccountToBeDebited": { "anyOf": [ { "$ref": "#/components/schemas/Account" }, { "type": "null" } ] }, "CollectionAdditionalInformation": { "maxLength": 2500, "type": [ "string", "null" ] }, "RegulatoryReportingData": { "minLength": 6, "maxLength": 6, "type": [ "string", "null" ] }, "DebitReconciliationReference": { "maxLength": 60, "type": [ "string", "null" ] } } }, "Facturae.Installments": { "type": "object", "properties": { "Installment": { "type": "array", "items": { "$ref": "#/components/schemas/Facturae.Installment" } } } }, "Facturae.Invoice": { "type": "object", "required": [ "InvoiceHeader", "InvoiceIssueData", "TaxesOutputs", "InvoiceTotals", "Items" ], "properties": { "InvoiceHeader": { "$ref": "#/components/schemas/Facturae.InvoiceHeader" }, "InvoiceIssueData": { "$ref": "#/components/schemas/Facturae.InvoiceIssueData" }, "TaxesOutputs": { "$ref": "#/components/schemas/Facturae.TaxesOutputs" }, "TaxesWithheld": { "anyOf": [ { "$ref": "#/components/schemas/Facturae.Taxes" }, { "type": "null" } ] }, "InvoiceTotals": { "$ref": "#/components/schemas/Facturae.InvoiceTotals" }, "Items": { "$ref": "#/components/schemas/Facturae.Items" }, "PaymentDetails": { "anyOf": [ { "$ref": "#/components/schemas/Facturae.Installments" }, { "type": "null" } ] }, "LegalLiterals": { "anyOf": [ { "$ref": "#/components/schemas/LegalLiterals" }, { "type": "null" } ] }, "AdditionalData": { "anyOf": [ { "$ref": "#/components/schemas/Facturae.AdditionalData" }, { "type": "null" } ] } } }, "Facturae.InvoiceHeader": { "type": "object", "required": [ "InvoiceNumber", "InvoiceDocumentType", "InvoiceClass" ], "properties": { "InvoiceNumber": { "maxLength": 20, "type": "string" }, "InvoiceSeriesCode": { "maxLength": 20, "type": [ "string", "null" ] }, "InvoiceDocumentType": { "type": "string", "enum": [ "FC", "FA", "AF" ] }, "InvoiceClass": { "type": "string", "enum": [ "OO", "OR", "OC", "CO", "CR", "CC" ] }, "Corrective": { "anyOf": [ { "$ref": "#/components/schemas/Facturae.Corrective" }, { "type": "null" } ] } } }, "Facturae.InvoiceIssueData": { "type": "object", "required": [ "IssueDate", "InvoiceCurrencyCode", "TaxCurrencyCode", "LanguageName" ], "properties": { "IssueDate": { "type": "string", "format": "date-time" }, "OperationDate": { "type": [ "string", "null" ], "format": "date-time" }, "PlaceOfIssue": { "anyOf": [ { "$ref": "#/components/schemas/Facturae.PlaceOfIssue" }, { "type": "null" } ] }, "InvoicingPeriod": { "anyOf": [ { "$ref": "#/components/schemas/Facturae.PeriodDates" }, { "type": "null" } ] }, "InvoiceCurrencyCode": { "enum": [ "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAD", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BRR", "BSD", "BWP", "BYR", "BZD", "CAD", "CDF", "CDP", "CHF", "CLP", "CNY", "COP", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DRP", "DZD", "EEK", "EGP", "ESP", "ETB", "EUR", "FJD", "FKP", "GBP", "GEK", "GHC", "GIP", "GMD", "GNF", "GTQ", "GWP", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGF", "MNC", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZM", "NGN", "NIC", "NIO", "NIS", "NOK", "NPR", "NZD", "OMR", "PAB", "PEI", "PEN", "PES", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RMB", "RON", "RUB", "RWF", "SAR", "SBD", "SCR", "SDP", "SEK", "SGD", "SHP", "SKK", "SLL", "SOL", "SOS", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMM", "TND", "TOP", "TPE", "TRY", "TTD", "TWD", "TZS", "UAH", "UGS", "USD", "UYP", "UYU", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "YER", "ZAR", "ZMK", "ZWD" ], "type": "string" }, "ExchangeRateDetails": { "anyOf": [ { "$ref": "#/components/schemas/Facturae.ExchangeRateDetails" }, { "type": "null" } ] }, "TaxCurrencyCode": { "enum": [ "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAD", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BRR", "BSD", "BWP", "BYR", "BZD", "CAD", "CDF", "CDP", "CHF", "CLP", "CNY", "COP", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DRP", "DZD", "EEK", "EGP", "ESP", "ETB", "EUR", "FJD", "FKP", "GBP", "GEK", "GHC", "GIP", "GMD", "GNF", "GTQ", "GWP", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGF", "MNC", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZM", "NGN", "NIC", "NIO", "NIS", "NOK", "NPR", "NZD", "OMR", "PAB", "PEI", "PEN", "PES", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RMB", "RON", "RUB", "RWF", "SAR", "SBD", "SCR", "SDP", "SEK", "SGD", "SHP", "SKK", "SLL", "SOL", "SOS", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMM", "TND", "TOP", "TPE", "TRY", "TTD", "TWD", "TZS", "UAH", "UGS", "USD", "UYP", "UYU", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "YER", "ZAR", "ZMK", "ZWD" ], "type": "string" }, "LanguageName": { "enum": [ "ar", "be", "bg", "ca", "cs", "da", "de", "el", "en", "es", "et", "eu", "fi", "fr", "ga", "gl", "hr", "hu", "is", "it", "lv", "lt", "mk", "mt", "nl", "no", "pl", "pt", "ro", "ru", "sk", "sl", "sq", "sr", "sv", "tr", "uk" ], "type": "string" }, "InvoiceDescription": { "maxLength": 2500, "type": [ "string", "null" ] }, "ReceiverTransactionReference": { "maxLength": 20, "type": [ "string", "null" ] }, "FileReference": { "maxLength": 20, "type": [ "string", "null" ] }, "ReceiverContractReference": { "maxLength": 20, "type": [ "string", "null" ] } } }, "Facturae.InvoiceLine": { "type": "object", "properties": { "IssuerContractReference": { "maxLength": 20, "type": [ "string", "null" ] }, "IssuerContractDate": { "type": [ "string", "null" ], "format": "date-time" }, "IssuerTransactionReference": { "maxLength": 20, "type": [ "string", "null" ] }, "IssuerTransactionDate": { "type": [ "string", "null" ], "format": "date-time" }, "ReceiverContractReference": { "maxLength": 20, "type": [ "string", "null" ] }, "ReceiverContractDate": { "type": [ "string", "null" ], "format": "date-time" }, "ReceiverTransactionReference": { "maxLength": 20, "type": [ "string", "null" ] }, "ReceiverTransactionDate": { "type": [ "string", "null" ], "format": "date-time" }, "FileReference": { "maxLength": 20, "type": [ "string", "null" ] }, "FileDate": { "type": [ "string", "null" ], "format": "date-time" }, "SequenceNumber": { "type": [ "string", "null" ] }, "DeliveryNotesReferences": { "anyOf": [ { "$ref": "#/components/schemas/Facturae.DeliveryNotesReferences" }, { "type": "null" } ] }, "ItemDescription": { "maxLength": 2500, "type": "string" }, "Quantity": { "type": "string" }, "UnitOfMeasure": { "type": [ "string", "null" ], "enum": [ "01", "02", "03", "04", "05", "06", "07", "08", "09", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23", "24", "25", "26", "27", "28", "29", "30", "31", "32", "33", "34", "35", "36", null ] }, "UnitPriceWithoutTax": { "type": "string" }, "TotalCost": { "type": "string" }, "DiscountsAndRebates": { "anyOf": [ { "$ref": "#/components/schemas/Facturae.DiscountsAndRebates" }, { "type": "null" } ] }, "Charges": { "anyOf": [ { "$ref": "#/components/schemas/Facturae.Charges" }, { "type": "null" } ] }, "GrossAmount": { "type": "string" }, "TaxesWithheld": { "anyOf": [ { "$ref": "#/components/schemas/Facturae.Taxes" }, { "type": "null" } ] }, "TaxesOutputs": { "$ref": "#/components/schemas/Facturae.TaxesOutputs" }, "LineItemPeriod": { "anyOf": [ { "$ref": "#/components/schemas/Facturae.PeriodDates" }, { "type": "null" } ] }, "TransactionDate": { "type": [ "string", "null" ], "format": "date-time" }, "AdditionalLineItemInformation": { "maxLength": 2500, "type": [ "string", "null" ] }, "SpecialTaxableEvent": { "anyOf": [ { "$ref": "#/components/schemas/Facturae.SpecialTaxableEvent" }, { "type": "null" } ] }, "ArticleCode": { "maxLength": 20, "type": [ "string", "null" ] }, "Extensions": { "anyOf": [ { "$ref": "#/components/schemas/Extensions" }, { "type": "null" } ] } }, "required": [ "ItemDescription", "Quantity", "UnitPriceWithoutTax", "TotalCost", "GrossAmount", "TaxesOutputs" ] }, "Facturae.InvoiceTotals": { "type": "object", "required": [ "TotalGrossAmount", "TotalGrossAmountBeforeTaxes", "TotalTaxOutputs", "TotalTaxesWithheld", "InvoiceTotal", "TotalOutstandingAmount", "TotalExecutableAmount" ], "properties": { "TotalGrossAmount": { "type": "string" }, "GeneralDiscounts": { "anyOf": [ { "$ref": "#/components/schemas/Facturae.DiscountsAndRebates" }, { "type": "null" } ] }, "GeneralSurcharges": { "anyOf": [ { "$ref": "#/components/schemas/Facturae.Charges" }, { "type": "null" } ] }, "TotalGeneralDiscounts": { "type": [ "string", "null" ] }, "TotalGeneralSurcharges": { "type": [ "string", "null" ] }, "TotalGrossAmountBeforeTaxes": { "type": "string" }, "TotalTaxOutputs": { "type": "string" }, "TotalTaxesWithheld": { "type": "string" }, "InvoiceTotal": { "type": "string" }, "Subsidies": { "anyOf": [ { "$ref": "#/components/schemas/Facturae.Subsidies" }, { "type": "null" } ] }, "PaymentsOnAccount": { "anyOf": [ { "$ref": "#/components/schemas/Facturae.PaymentsOnAccount" }, { "type": "null" } ] }, "ReimbursableExpenses": { "anyOf": [ { "$ref": "#/components/schemas/Facturae.ReimbursableExpensesList" }, { "type": "null" } ] }, "TotalFinancialExpenses": { "type": [ "string", "null" ] }, "TotalOutstandingAmount": { "type": "string" }, "TotalPaymentsOnAccount": { "type": [ "string", "null" ] }, "AmountsWithheld": { "anyOf": [ { "$ref": "#/components/schemas/Facturae.AmountsWithheld" }, { "type": "null" } ] }, "TotalExecutableAmount": { "type": "string" }, "TotalReimbursableExpenses": { "type": [ "string", "null" ] }, "PaymentInKind": { "anyOf": [ { "$ref": "#/components/schemas/Facturae.PaymentInKind" }, { "type": "null" } ] } } }, "Facturae.Invoices": { "type": "object", "properties": { "Invoice": { "type": "array", "items": { "$ref": "#/components/schemas/Facturae.Invoice" } } } }, "Facturae.Items": { "type": "object", "properties": { "InvoiceLine": { "type": "array", "items": { "$ref": "#/components/schemas/Facturae.InvoiceLine" } } } }, "Facturae.Parties": { "type": "object", "required": [ "SellerParty", "BuyerParty" ], "properties": { "SellerParty": { "$ref": "#/components/schemas/Facturae.Business" }, "BuyerParty": { "$ref": "#/components/schemas/Facturae.Business" } } }, "Facturae.PaymentInKind": { "type": "object", "required": [ "PaymentInKindReason", "PaymentInKindAmount" ], "properties": { "PaymentInKindReason": { "maxLength": 2500, "type": "string" }, "PaymentInKindAmount": { "type": "string" } } }, "Facturae.PaymentOnAccount": { "type": "object", "required": [ "PaymentOnAccountDate", "PaymentOnAccountAmount" ], "properties": { "PaymentOnAccountDate": { "type": "string", "format": "date-time" }, "PaymentOnAccountAmount": { "type": "string" } } }, "Facturae.PaymentsOnAccount": { "type": "object", "properties": { "PaymentOnAccount": { "type": "array", "items": { "$ref": "#/components/schemas/Facturae.PaymentOnAccount" } } } }, "Facturae.PeriodDates": { "type": "object", "required": [ "StartDate", "EndDate" ], "properties": { "StartDate": { "type": "string", "format": "date-time" }, "EndDate": { "type": "string", "format": "date-time" } } }, "Facturae.PlaceOfIssue": { "type": "object", "required": [ "PostCode" ], "properties": { "PostCode": { "minLength": 5, "maxLength": 5, "type": "string" }, "PlaceOfIssueDescription": { "maxLength": 20, "type": [ "string", "null" ] } } }, "Facturae.ReimbursableExpense": { "type": "object", "properties": { "ReimbursableExpensesSellerParty": { "anyOf": [ { "$ref": "#/components/schemas/TaxIdentification" }, { "type": "null" } ] }, "ReimbursableExpensesBuyerParty": { "anyOf": [ { "$ref": "#/components/schemas/TaxIdentification" }, { "type": "null" } ] }, "IssueDate": { "type": [ "string", "null" ], "format": "date-time" }, "InvoiceNumber": { "maxLength": 20, "type": [ "string", "null" ] }, "InvoiceSeriesCode": { "maxLength": 20, "type": [ "string", "null" ] }, "ReimbursableExpensesAmount": { "type": "string" } }, "required": [ "ReimbursableExpensesAmount" ] }, "Facturae.ReimbursableExpensesList": { "type": "object", "properties": { "ReimbursableExpenses": { "type": "array", "items": { "$ref": "#/components/schemas/Facturae.ReimbursableExpense" } } } }, "Facturae.Repository": { "type": "object", "required": [ "RepositoryName", "Reference" ], "properties": { "RepositoryName": { "maxLength": 20, "type": "string" }, "URL": { "maxLength": 250, "type": [ "string", "null" ] }, "Reference": { "maxLength": 250, "type": "string" } } }, "Facturae.SpecialTaxableEvent": { "type": "object", "required": [ "SpecialTaxableEventCode", "SpecialTaxableEventReason" ], "properties": { "SpecialTaxableEventCode": { "type": "string", "enum": [ "01", "02" ] }, "SpecialTaxableEventReason": { "maxLength": 2500, "type": "string" } } }, "Facturae.Subsidies": { "type": "object", "properties": { "Subsidy": { "type": "array", "items": { "$ref": "#/components/schemas/Facturae.Subsidy" } } } }, "Facturae.Subsidy": { "type": "object", "required": [ "SubsidyDescription", "SubsidyAmount" ], "properties": { "SubsidyDescription": { "maxLength": 2500, "type": "string" }, "SubsidyRate": { "type": [ "string", "null" ] }, "SubsidyAmount": { "type": "string" } } }, "Facturae.Tax": { "type": "object", "required": [ "TaxTypeCode", "TaxRate", "TaxableBase" ], "properties": { "TaxTypeCode": { "type": "string", "enum": [ "01", "02", "03", "04", "05", "06", "07", "08", "09", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23", "24", "25", "26", "27", "28", "29" ] }, "TaxRate": { "type": "string" }, "TaxableBase": { "$ref": "#/components/schemas/Facturae.Amount" }, "TaxAmount": { "anyOf": [ { "$ref": "#/components/schemas/Facturae.Amount" }, { "type": "null" } ] } } }, "Facturae.TaxOutput": { "type": "object", "required": [ "TaxTypeCode", "TaxRate", "TaxableBase" ], "properties": { "TaxTypeCode": { "type": "string", "enum": [ "01", "02", "03", "04", "05", "06", "07", "08", "09", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23", "24", "25", "26", "27", "28", "29" ] }, "TaxRate": { "type": "string" }, "TaxableBase": { "$ref": "#/components/schemas/Facturae.Amount" }, "TaxAmount": { "anyOf": [ { "$ref": "#/components/schemas/Facturae.Amount" }, { "type": "null" } ] }, "SpecialTaxableBase": { "anyOf": [ { "$ref": "#/components/schemas/Facturae.Amount" }, { "type": "null" } ] }, "SpecialTaxAmount": { "anyOf": [ { "$ref": "#/components/schemas/Facturae.Amount" }, { "type": "null" } ] }, "EquivalenceSurcharge": { "type": [ "string", "null" ] }, "EquivalenceSurchargeAmount": { "anyOf": [ { "$ref": "#/components/schemas/Facturae.Amount" }, { "type": "null" } ] } } }, "Facturae.Taxes": { "type": "object", "properties": { "Tax": { "type": "array", "items": { "$ref": "#/components/schemas/Facturae.Tax" } } } }, "Facturae.TaxesOutputs": { "type": "object", "properties": { "Tax": { "type": "array", "items": { "$ref": "#/components/schemas/Facturae.TaxOutput" } } } }, "Facturae.ThirdParty": { "type": "object", "required": [ "TaxIdentification" ], "properties": { "TaxIdentification": { "$ref": "#/components/schemas/TaxIdentification" }, "LegalEntity": { "anyOf": [ { "$ref": "#/components/schemas/LegalEntity" }, { "type": "null" } ] }, "Individual": { "anyOf": [ { "$ref": "#/components/schemas/Individual" }, { "type": "null" } ] } } }, "FacturaeDraft.Individual": { "type": "object", "required": [ "Name", "FirstSurname" ], "properties": { "Name": { "maxLength": 40, "type": [ "string", "null" ] }, "FirstSurname": { "maxLength": 40, "type": [ "string", "null" ] }, "SecondSurname": { "maxLength": 40, "type": [ "string", "null" ] }, "AddressInSpain": { "anyOf": [ { "$ref": "#/components/schemas/Address" }, { "type": "null" } ] }, "OverseasAddress": { "anyOf": [ { "$ref": "#/components/schemas/OverseasAddress" }, { "type": "null" } ] }, "ContactDetails": { "anyOf": [ { "$ref": "#/components/schemas/ContactDetails" }, { "type": "null" } ] } } }, "FacturaeDraft.LegalEntity": { "type": "object", "required": [ "CorporateName" ], "properties": { "CorporateName": { "maxLength": 80, "type": [ "string", "null" ] }, "TradeName": { "maxLength": 40, "type": [ "string", "null" ] }, "RegistrationData": { "anyOf": [ { "$ref": "#/components/schemas/RegistrationData" }, { "type": "null" } ] }, "AddressInSpain": { "anyOf": [ { "$ref": "#/components/schemas/Address" }, { "type": "null" } ] }, "OverseasAddress": { "anyOf": [ { "$ref": "#/components/schemas/OverseasAddress" }, { "type": "null" } ] }, "ContactDetails": { "anyOf": [ { "$ref": "#/components/schemas/ContactDetails" }, { "type": "null" } ] } } }, "FacturaeDraft.TaxIdentification": { "type": "object", "required": [ "PersonTypeCode", "ResidenceTypeCode", "TaxIdentificationNumber" ], "properties": { "PersonTypeCode": { "type": [ "string", "null" ], "enum": [ "F", "J", null ] }, "ResidenceTypeCode": { "type": [ "string", "null" ], "enum": [ "E", "R", "U", null ] }, "TaxIdentificationNumber": { "minLength": 3, "maxLength": 30, "type": [ "string", "null" ] } } }, "FileHeader": { "type": "object", "properties": { "SchemaVersion": { "type": [ "string", "null" ] }, "Modality": { "type": [ "string", "null" ] }, "InvoiceIssuerType": { "type": [ "string", "null" ] }, "ThirdParty": { "anyOf": [ { "$ref": "#/components/schemas/ThirdParty" }, { "type": "null" } ] }, "Batch": { "anyOf": [ { "$ref": "#/components/schemas/Batch" }, { "type": "null" } ] }, "FactoringAssignmentData": { "anyOf": [ { "$ref": "#/components/schemas/FactoringAssignmentData" }, { "type": "null" } ] } } }, "HydraCollectionBaseSchema": { "allOf": [ { "$ref": "#/components/schemas/HydraCollectionBaseSchemaNoPagination" }, { "type": "object", "properties": { "hydra:view": { "type": "object", "properties": { "@id": { "type": "string", "format": "iri-reference" }, "@type": { "type": "string" }, "hydra:first": { "type": [ "string", "null" ], "format": "iri-reference" }, "hydra:last": { "type": [ "string", "null" ], "format": "iri-reference" }, "hydra:previous": { "type": [ "string", "null" ], "format": "iri-reference" }, "hydra:next": { "type": [ "string", "null" ], "format": "iri-reference" } }, "example": { "@id": "string", "@type": "string", "hydra:first": "string", "hydra:last": "string", "hydra:previous": "string", "hydra:next": "string" } } } } ] }, "HydraCollectionBaseSchemaNoPagination": { "type": "object", "properties": { "hydra:totalItems": { "type": "integer", "minimum": 0 }, "hydra:search": { "type": "object", "properties": { "@type": { "type": "string" }, "hydra:template": { "type": "string" }, "hydra:variableRepresentation": { "type": "string" }, "hydra:mapping": { "type": "array", "items": { "type": "object", "properties": { "@type": { "type": "string" }, "variable": { "type": "string" }, "property": { "type": [ "string", "null" ] }, "required": { "type": "boolean" } } } } } } } }, "HydraItemBaseSchema": { "type": "object", "properties": { "@context": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "@vocab": { "type": "string" }, "hydra": { "type": "string", "enum": [ "http://www.w3.org/ns/hydra/core#" ] } }, "required": [ "@vocab", "hydra" ], "additionalProperties": true } ] }, "@id": { "type": "string" }, "@type": { "type": "string" } }, "required": [ "@id", "@type" ] }, "Individual": { "type": "object", "required": [ "Name", "FirstSurname" ], "properties": { "Name": { "maxLength": 40, "type": "string" }, "FirstSurname": { "maxLength": 40, "type": "string" }, "SecondSurname": { "maxLength": 40, "type": [ "string", "null" ] }, "AddressInSpain": { "anyOf": [ { "$ref": "#/components/schemas/Address" }, { "type": "null" } ] }, "OverseasAddress": { "anyOf": [ { "$ref": "#/components/schemas/OverseasAddress" }, { "type": "null" } ] }, "ContactDetails": { "anyOf": [ { "$ref": "#/components/schemas/ContactDetails" }, { "type": "null" } ] } } }, "Installment": { "type": "object", "properties": { "InstallmentDueDate": { "type": [ "string", "null" ], "format": "date-time" }, "InstallmentAmount": { "type": [ "string", "null" ] }, "PaymentMeans": { "type": [ "string", "null" ] }, "AccountToBeCredited": { "anyOf": [ { "$ref": "#/components/schemas/Account" }, { "type": "null" } ] }, "PaymentReconciliationReference": { "type": [ "string", "null" ] }, "AccountToBeDebited": { "anyOf": [ { "$ref": "#/components/schemas/Account" }, { "type": "null" } ] }, "CollectionAdditionalInformation": { "type": [ "string", "null" ] }, "RegulatoryReportingData": { "type": [ "string", "null" ] }, "DebitReconciliationReference": { "type": [ "string", "null" ] } } }, "Installments": { "type": "object", "properties": { "Installment": { "type": "array", "items": { "$ref": "#/components/schemas/Installment" } } } }, "Invoice": { "type": "object", "properties": { "InvoiceHeader": { "anyOf": [ { "$ref": "#/components/schemas/InvoiceHeader" }, { "type": "null" } ] }, "InvoiceIssueData": { "anyOf": [ { "$ref": "#/components/schemas/InvoiceIssueData" }, { "type": "null" } ] }, "TaxesOutputs": { "anyOf": [ { "$ref": "#/components/schemas/TaxesOutputs" }, { "type": "null" } ] }, "TaxesWithheld": { "anyOf": [ { "$ref": "#/components/schemas/Taxes" }, { "type": "null" } ] }, "InvoiceTotals": { "anyOf": [ { "$ref": "#/components/schemas/InvoiceTotals" }, { "type": "null" } ] }, "Items": { "anyOf": [ { "$ref": "#/components/schemas/Items" }, { "type": "null" } ] }, "PaymentDetails": { "anyOf": [ { "$ref": "#/components/schemas/Installments" }, { "type": "null" } ] }, "LegalLiterals": { "anyOf": [ { "$ref": "#/components/schemas/LegalLiterals" }, { "type": "null" } ] }, "AdditionalData": { "anyOf": [ { "$ref": "#/components/schemas/AdditionalData" }, { "type": "null" } ] } } }, "InvoiceDraft.InvoiceDraftCreateInput": { "type": "object", "description": "Creates a new invoice in draft mode: every field is optional except sender/receiver identity, so it can be reviewed before being sent. Accepts a Facturae 3.2.2 document either as XML (application/xml) or as an equivalent JSON object (application/json) whose keys mirror the Facturae element names; JSON input is converted to Facturae XML before processing. Always creates a new draft; to update an existing one, use PUT /invoices/draft/{uuid} instead.", "properties": { "FileHeader": { "anyOf": [ { "$ref": "#/components/schemas/FileHeader" }, { "type": "null" } ] }, "Parties": { "anyOf": [ { "$ref": "#/components/schemas/Parties" }, { "type": "null" } ] }, "Invoices": { "anyOf": [ { "$ref": "#/components/schemas/Invoices" }, { "type": "null" } ] }, "Extensions": { "anyOf": [ { "$ref": "#/components/schemas/Extensions" }, { "type": "null" } ] } }, "required": [ "Parties" ] }, "InvoiceDraft.InvoiceOutput": { "type": "object", "description": "Get the collection of draft invoices belonging to the caller.", "properties": { "uuid": { "type": "string" }, "invoiceNumber": { "type": [ "string", "null" ] }, "invoiceDate": { "type": [ "string", "null" ] }, "dueDate": { "type": [ "string", "null" ] }, "currency": { "type": [ "string", "null" ] }, "totalAmount": { "type": [ "string", "null" ] }, "netAmount": { "type": [ "string", "null" ] }, "direction": { "type": "string" }, "sender": { "$ref": "#/components/schemas/InvoicePartyOutput" }, "recipient": { "$ref": "#/components/schemas/InvoicePartyOutput" }, "status": { "type": "string" }, "errorReason": { "type": [ "string", "null" ] }, "downloaded": { "type": "boolean" }, "downloadedAt": { "type": [ "string", "null" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": [ "string", "null" ] } } }, "InvoiceDraft.InvoiceOutput.jsonld": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "uuid": { "type": "string" }, "invoiceNumber": { "type": [ "string", "null" ] }, "invoiceDate": { "type": [ "string", "null" ] }, "dueDate": { "type": [ "string", "null" ] }, "currency": { "type": [ "string", "null" ] }, "totalAmount": { "type": [ "string", "null" ] }, "netAmount": { "type": [ "string", "null" ] }, "direction": { "type": "string" }, "sender": { "$ref": "#/components/schemas/InvoicePartyOutput.jsonld" }, "recipient": { "$ref": "#/components/schemas/InvoicePartyOutput.jsonld" }, "status": { "type": "string" }, "errorReason": { "type": [ "string", "null" ] }, "downloaded": { "type": "boolean" }, "downloadedAt": { "type": [ "string", "null" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": [ "string", "null" ] } } } ], "description": "Get the collection of draft invoices belonging to the caller." }, "InvoiceHeader": { "type": "object", "properties": { "InvoiceNumber": { "type": [ "string", "null" ] }, "InvoiceSeriesCode": { "type": [ "string", "null" ] }, "InvoiceDocumentType": { "type": [ "string", "null" ] }, "InvoiceClass": { "type": [ "string", "null" ] }, "Corrective": { "anyOf": [ { "$ref": "#/components/schemas/Corrective" }, { "type": "null" } ] } } }, "InvoiceIssueData": { "type": "object", "properties": { "IssueDate": { "type": [ "string", "null" ], "format": "date-time" }, "OperationDate": { "type": [ "string", "null" ], "format": "date-time" }, "PlaceOfIssue": { "anyOf": [ { "$ref": "#/components/schemas/PlaceOfIssue" }, { "type": "null" } ] }, "InvoicingPeriod": { "anyOf": [ { "$ref": "#/components/schemas/PeriodDates" }, { "type": "null" } ] }, "InvoiceCurrencyCode": { "type": [ "string", "null" ] }, "ExchangeRateDetails": { "anyOf": [ { "$ref": "#/components/schemas/ExchangeRateDetails" }, { "type": "null" } ] }, "TaxCurrencyCode": { "type": [ "string", "null" ] }, "LanguageName": { "type": [ "string", "null" ] }, "InvoiceDescription": { "type": [ "string", "null" ] }, "ReceiverTransactionReference": { "type": [ "string", "null" ] }, "FileReference": { "type": [ "string", "null" ] }, "ReceiverContractReference": { "type": [ "string", "null" ] } } }, "InvoiceLine": { "type": "object", "properties": { "IssuerContractReference": { "type": [ "string", "null" ] }, "IssuerContractDate": { "type": [ "string", "null" ], "format": "date-time" }, "IssuerTransactionReference": { "type": [ "string", "null" ] }, "IssuerTransactionDate": { "type": [ "string", "null" ], "format": "date-time" }, "ReceiverContractReference": { "type": [ "string", "null" ] }, "ReceiverContractDate": { "type": [ "string", "null" ], "format": "date-time" }, "ReceiverTransactionReference": { "type": [ "string", "null" ] }, "ReceiverTransactionDate": { "type": [ "string", "null" ], "format": "date-time" }, "FileReference": { "type": [ "string", "null" ] }, "FileDate": { "type": [ "string", "null" ], "format": "date-time" }, "SequenceNumber": { "type": [ "string", "null" ] }, "DeliveryNotesReferences": { "anyOf": [ { "$ref": "#/components/schemas/DeliveryNotesReferences" }, { "type": "null" } ] }, "ItemDescription": { "type": [ "string", "null" ] }, "Quantity": { "type": [ "string", "null" ] }, "UnitOfMeasure": { "type": [ "string", "null" ] }, "UnitPriceWithoutTax": { "type": [ "string", "null" ] }, "TotalCost": { "type": [ "string", "null" ] }, "DiscountsAndRebates": { "anyOf": [ { "$ref": "#/components/schemas/DiscountsAndRebates" }, { "type": "null" } ] }, "Charges": { "anyOf": [ { "$ref": "#/components/schemas/Charges" }, { "type": "null" } ] }, "GrossAmount": { "type": [ "string", "null" ] }, "TaxesWithheld": { "anyOf": [ { "$ref": "#/components/schemas/Taxes" }, { "type": "null" } ] }, "TaxesOutputs": { "anyOf": [ { "$ref": "#/components/schemas/TaxesOutputs" }, { "type": "null" } ] }, "LineItemPeriod": { "anyOf": [ { "$ref": "#/components/schemas/PeriodDates" }, { "type": "null" } ] }, "TransactionDate": { "type": [ "string", "null" ], "format": "date-time" }, "AdditionalLineItemInformation": { "type": [ "string", "null" ] }, "SpecialTaxableEvent": { "anyOf": [ { "$ref": "#/components/schemas/SpecialTaxableEvent" }, { "type": "null" } ] }, "ArticleCode": { "type": [ "string", "null" ] }, "Extensions": { "anyOf": [ { "$ref": "#/components/schemas/Extensions" }, { "type": "null" } ] } } }, "InvoicePartyOutput": { "type": "object", "properties": { "name": { "type": "string" }, "fiscalId": { "type": "string" } } }, "InvoicePartyOutput.jsonld": { "type": "object", "properties": { "name": { "type": "string" }, "fiscalId": { "type": "string" } } }, "InvoiceTotals": { "type": "object", "properties": { "TotalGrossAmount": { "type": [ "string", "null" ] }, "GeneralDiscounts": { "anyOf": [ { "$ref": "#/components/schemas/DiscountsAndRebates" }, { "type": "null" } ] }, "GeneralSurcharges": { "anyOf": [ { "$ref": "#/components/schemas/Charges" }, { "type": "null" } ] }, "TotalGeneralDiscounts": { "type": [ "string", "null" ] }, "TotalGeneralSurcharges": { "type": [ "string", "null" ] }, "TotalGrossAmountBeforeTaxes": { "type": [ "string", "null" ] }, "TotalTaxOutputs": { "type": [ "string", "null" ] }, "TotalTaxesWithheld": { "type": [ "string", "null" ] }, "InvoiceTotal": { "type": [ "string", "null" ] }, "Subsidies": { "anyOf": [ { "$ref": "#/components/schemas/Subsidies" }, { "type": "null" } ] }, "PaymentsOnAccount": { "anyOf": [ { "$ref": "#/components/schemas/PaymentsOnAccount" }, { "type": "null" } ] }, "ReimbursableExpenses": { "anyOf": [ { "$ref": "#/components/schemas/ReimbursableExpensesList" }, { "type": "null" } ] }, "TotalFinancialExpenses": { "type": [ "string", "null" ] }, "TotalOutstandingAmount": { "type": [ "string", "null" ] }, "TotalPaymentsOnAccount": { "type": [ "string", "null" ] }, "AmountsWithheld": { "anyOf": [ { "$ref": "#/components/schemas/AmountsWithheld" }, { "type": "null" } ] }, "TotalExecutableAmount": { "type": [ "string", "null" ] }, "TotalReimbursableExpenses": { "type": [ "string", "null" ] }, "PaymentInKind": { "anyOf": [ { "$ref": "#/components/schemas/PaymentInKind" }, { "type": "null" } ] } } }, "Invoices": { "type": "object", "properties": { "Invoice": { "type": "array", "items": { "$ref": "#/components/schemas/Invoice" } } } }, "Items": { "type": "object", "properties": { "InvoiceLine": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceLine" } } } }, "KeyInfo": { "type": "object", "properties": { "@Id": { "type": [ "string", "null" ] }, "ds:X509Data": { "type": "array", "items": { "$ref": "#/components/schemas/X509Data" } } } }, "LegalEntity": { "type": "object", "required": [ "CorporateName" ], "properties": { "CorporateName": { "maxLength": 80, "type": "string" }, "TradeName": { "maxLength": 40, "type": [ "string", "null" ] }, "RegistrationData": { "anyOf": [ { "$ref": "#/components/schemas/RegistrationData" }, { "type": "null" } ] }, "AddressInSpain": { "anyOf": [ { "$ref": "#/components/schemas/Address" }, { "type": "null" } ] }, "OverseasAddress": { "anyOf": [ { "$ref": "#/components/schemas/OverseasAddress" }, { "type": "null" } ] }, "ContactDetails": { "anyOf": [ { "$ref": "#/components/schemas/ContactDetails" }, { "type": "null" } ] } } }, "LegalEntityConfigInput": { "type": "object", "properties": { "supplierInvoiceEnabled": { "type": "boolean" }, "customerInvoiceEnabled": { "type": "boolean" } } }, "LegalEntityConfigOutput": { "type": "object", "properties": { "supplierInvoiceEnabled": { "type": "boolean", "description": "Setting enabled to true will enable the supplier invoice feature for this legal entity" }, "customerInvoiceEnabled": { "type": "boolean", "description": "Setting enabled to true will enable the customer invoice feature for this legal entity" } } }, "LegalEntityConfigOutput.jsonld": { "type": "object", "properties": { "supplierInvoiceEnabled": { "type": "boolean", "description": "Setting enabled to true will enable the supplier invoice feature for this legal entity" }, "customerInvoiceEnabled": { "type": "boolean", "description": "Setting enabled to true will enable the customer invoice feature for this legal entity" } } }, "LegalEntitySubAccount": { "type": "object", "properties": { "uuid": { "type": [ "string", "null" ], "format": "uuid" }, "legalEntity": { "type": "string", "format": "iri-reference", "example": "https://example.com/" }, "userId": { "type": "integer" }, "email": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": [ "string", "null" ], "format": "date-time" }, "ownedThroughPropertyName": { "readOnly": true }, "ownedThroughResourceClass": { "readOnly": true } } }, "LegalEntitySubAccount.LegalEntitySubAccountCreateInput": { "type": "object", "required": [ "email", "password" ], "properties": { "email": { "format": "email", "description": "Email address of the sub-account user", "externalDocs": { "url": "https://schema.org/email" }, "type": "string" }, "password": { "description": "Password for the sub-account user. If the sub-account is already present on the system, the password this value will be ignored", "type": [ "string", "null" ] } } }, "LegalEntitySubAccount.jsonld": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "uuid": { "type": [ "string", "null" ], "format": "uuid" }, "legalEntity": { "type": "string", "format": "iri-reference", "example": "https://example.com/" }, "userId": { "type": "integer" }, "email": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": [ "string", "null" ], "format": "date-time" }, "ownedThroughPropertyName": { "readOnly": true }, "ownedThroughResourceClass": { "readOnly": true } } } ] }, "LegalLiterals": { "type": "object", "properties": { "LegalReference": { "type": "array", "items": { "type": "string" } } } }, "OverseasAddress": { "type": "object", "required": [ "Address", "PostCodeAndTown", "Province", "CountryCode" ], "properties": { "Address": { "maxLength": 80, "type": "string" }, "PostCodeAndTown": { "maxLength": 50, "type": "string" }, "Province": { "maxLength": 20, "type": "string" }, "CountryCode": { "enum": [ "AFG", "ALB", "DZA", "ASM", "AND", "AGO", "AIA", "ATG", "ARG", "ARM", "ABW", "AUS", "AUT", "AZE", "BHS", "BHR", "BGD", "BRB", "BLR", "BEL", "BLZ", "BEN", "BMU", "BTN", "BOL", "BIH", "BWA", "BRA", "BRN", "BGR", "BFA", "BDI", "KHM", "CMR", "CAN", "CPV", "CYM", "CAF", "TCD", "CHL", "CHN", "COD", "COL", "COM", "COG", "COK", "CRI", "CIV", "HRV", "CUB", "CYP", "CZE", "DNK", "DJI", "DMA", "DOM", "ECU", "EGY", "SLV", "GNQ", "ERI", "EST", "ETH", "FLK", "FRO", "FJI", "FIN", "FRA", "GUF", "PYF", "GAB", "GMB", "GEO", "GGY", "DEU", "GHA", "GIB", "GRC", "GRL", "GRD", "GLP", "GUM", "GTM", "GIN", "GNB", "GUY", "HTI", "HND", "HKG", "HUN", "ISL", "IND", "IDN", "IMN", "IRN", "IRQ", "IRL", "ISR", "ITA", "JAM", "JEY", "JPN", "JOR", "KAZ", "KEN", "KIR", "PRK", "KOR", "KWT", "KGZ", "LAO", "LVA", "LBN", "LSO", "LBR", "LBY", "LIE", "LTU", "LUX", "MAC", "MKD", "MDG", "MWI", "MYS", "MDV", "MLI", "MLT", "MHL", "MTQ", "MRT", "MUS", "MYT", "MEX", "FSM", "MDA", "MCO", "MNE", "MNG", "MSR", "MAR", "MOZ", "MMR", "NAM", "NRU", "NPL", "NLD", "ANT", "NCL", "NZL", "NIC", "NER", "NGA", "NIU", "NFK", "MNP", "NOR", "OMN", "PAK", "PLW", "PAN", "PNG", "PRY", "PSE", "PER", "PHL", "PCN", "POL", "PRT", "PRI", "QAT", "REU", "ROU", "RUS", "RWA", "KNA", "LCA", "VCT", "WSM", "SMR", "STP", "SAU", "SEN", "SRB", "SYC", "SLE", "SGP", "SVK", "SVN", "SLB", "SOM", "ZAF", "ESP", "LKA", "SHN", "SPM", "SDN", "SUR", "SJM", "SWZ", "SWE", "CHE", "SYR", "TWN", "TJK", "TZA", "THA", "TGO", "TKL", "TON", "TTO", "TUN", "TUR", "TKM", "TLS", "TCA", "TUV", "UGA", "UKR", "ARE", "GBR", "USA", "URY", "UZB", "VUT", "VAT", "VEN", "VNM", "VGB", "VIR", "WLF", "ESH", "YEM", "ZAR", "ZMB", "ZWE" ], "type": "string" } } }, "Parties": { "type": "object", "required": [ "SellerParty", "BuyerParty" ], "properties": { "SellerParty": { "anyOf": [ { "$ref": "#/components/schemas/Business" }, { "type": "null" } ] }, "BuyerParty": { "anyOf": [ { "$ref": "#/components/schemas/Business" }, { "type": "null" } ] } } }, "PaymentInKind": { "type": "object", "properties": { "PaymentInKindReason": { "type": [ "string", "null" ] }, "PaymentInKindAmount": { "type": [ "string", "null" ] } } }, "PaymentOnAccount": { "type": "object", "properties": { "PaymentOnAccountDate": { "type": [ "string", "null" ], "format": "date-time" }, "PaymentOnAccountAmount": { "type": [ "string", "null" ] } } }, "PaymentsOnAccount": { "type": "object", "properties": { "PaymentOnAccount": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentOnAccount" } } } }, "PeriodDates": { "type": "object", "properties": { "StartDate": { "type": [ "string", "null" ], "format": "date-time" }, "EndDate": { "type": [ "string", "null" ], "format": "date-time" } } }, "PlaceOfIssue": { "type": "object", "properties": { "PostCode": { "type": [ "string", "null" ] }, "PlaceOfIssueDescription": { "type": [ "string", "null" ] } } }, "Reference": { "type": "object", "properties": { "@Id": { "type": [ "string", "null" ] }, "@URI": { "type": [ "string", "null" ] }, "@Type": { "type": [ "string", "null" ] }, "ds:Transforms": { "anyOf": [ { "$ref": "#/components/schemas/Transforms" }, { "type": "null" } ] }, "ds:DigestMethod": { "$ref": "#/components/schemas/DigestMethod" }, "ds:DigestValue": { "type": "string" } }, "required": [ "ds:DigestMethod", "ds:DigestValue" ] }, "RegistrationData": { "type": "object", "properties": { "Book": { "maxLength": 20, "type": [ "string", "null" ] }, "RegisterOfCompaniesLocation": { "maxLength": 20, "type": [ "string", "null" ] }, "Sheet": { "maxLength": 20, "type": [ "string", "null" ] }, "Folio": { "maxLength": 20, "type": [ "string", "null" ] }, "Section": { "maxLength": 20, "type": [ "string", "null" ] }, "Volume": { "maxLength": 20, "type": [ "string", "null" ] }, "AdditionalRegistrationData": { "maxLength": 20, "type": [ "string", "null" ] } } }, "ReimbursableExpense": { "type": "object", "properties": { "ReimbursableExpensesSellerParty": { "anyOf": [ { "$ref": "#/components/schemas/TaxIdentification" }, { "type": "null" } ] }, "ReimbursableExpensesBuyerParty": { "anyOf": [ { "$ref": "#/components/schemas/TaxIdentification" }, { "type": "null" } ] }, "IssueDate": { "type": [ "string", "null" ], "format": "date-time" }, "InvoiceNumber": { "type": [ "string", "null" ] }, "InvoiceSeriesCode": { "type": [ "string", "null" ] }, "ReimbursableExpensesAmount": { "type": [ "string", "null" ] } } }, "ReimbursableExpensesList": { "type": "object", "properties": { "ReimbursableExpenses": { "type": "array", "items": { "$ref": "#/components/schemas/ReimbursableExpense" } } } }, "Repository": { "type": "object", "properties": { "RepositoryName": { "type": [ "string", "null" ] }, "URL": { "type": [ "string", "null" ] }, "Reference": { "type": [ "string", "null" ] } } }, "Signature": { "type": "object", "properties": { "@Id": { "type": [ "string", "null" ] }, "ds:SignedInfo": { "$ref": "#/components/schemas/SignedInfo" }, "ds:SignatureValue": { "$ref": "#/components/schemas/SignatureValue" }, "ds:KeyInfo": { "anyOf": [ { "$ref": "#/components/schemas/KeyInfo" }, { "type": "null" } ] } }, "required": [ "ds:SignedInfo", "ds:SignatureValue" ] }, "SignatureMethod": { "type": "object", "required": [ "@Algorithm" ], "properties": { "@Algorithm": { "type": "string" } } }, "SignatureValue": { "type": "object", "properties": { "@Id": { "type": [ "string", "null" ] }, "#": { "type": "string" } } }, "SignedInfo": { "type": "object", "properties": { "@Id": { "type": [ "string", "null" ] }, "ds:CanonicalizationMethod": { "$ref": "#/components/schemas/CanonicalizationMethod" }, "ds:SignatureMethod": { "$ref": "#/components/schemas/SignatureMethod" }, "ds:Reference": { "type": "array", "items": { "$ref": "#/components/schemas/Reference" } } }, "required": [ "ds:CanonicalizationMethod", "ds:SignatureMethod" ] }, "SpecialTaxableEvent": { "type": "object", "properties": { "SpecialTaxableEventCode": { "type": [ "string", "null" ] }, "SpecialTaxableEventReason": { "type": [ "string", "null" ] } } }, "Subsidies": { "type": "object", "properties": { "Subsidy": { "type": "array", "items": { "$ref": "#/components/schemas/Subsidy" } } } }, "Subsidy": { "type": "object", "properties": { "SubsidyDescription": { "type": [ "string", "null" ] }, "SubsidyRate": { "type": [ "string", "null" ] }, "SubsidyAmount": { "type": [ "string", "null" ] } } }, "Tax": { "type": "object", "properties": { "TaxTypeCode": { "type": [ "string", "null" ] }, "TaxRate": { "type": [ "string", "null" ] }, "TaxableBase": { "anyOf": [ { "$ref": "#/components/schemas/Amount" }, { "type": "null" } ] }, "TaxAmount": { "anyOf": [ { "$ref": "#/components/schemas/Amount" }, { "type": "null" } ] } } }, "TaxIdentification": { "type": "object", "required": [ "PersonTypeCode", "ResidenceTypeCode", "TaxIdentificationNumber" ], "properties": { "PersonTypeCode": { "type": "string", "enum": [ "F", "J" ] }, "ResidenceTypeCode": { "type": "string", "enum": [ "E", "R", "U" ] }, "TaxIdentificationNumber": { "minLength": 3, "maxLength": 30, "type": "string" } } }, "TaxOutput": { "type": "object", "properties": { "TaxTypeCode": { "type": [ "string", "null" ] }, "TaxRate": { "type": [ "string", "null" ] }, "TaxableBase": { "anyOf": [ { "$ref": "#/components/schemas/Amount" }, { "type": "null" } ] }, "TaxAmount": { "anyOf": [ { "$ref": "#/components/schemas/Amount" }, { "type": "null" } ] }, "SpecialTaxableBase": { "anyOf": [ { "$ref": "#/components/schemas/Amount" }, { "type": "null" } ] }, "SpecialTaxAmount": { "anyOf": [ { "$ref": "#/components/schemas/Amount" }, { "type": "null" } ] }, "EquivalenceSurcharge": { "type": [ "string", "null" ] }, "EquivalenceSurchargeAmount": { "anyOf": [ { "$ref": "#/components/schemas/Amount" }, { "type": "null" } ] } } }, "Taxes": { "type": "object", "properties": { "Tax": { "type": "array", "items": { "$ref": "#/components/schemas/Tax" } } } }, "TaxesOutputs": { "type": "object", "properties": { "Tax": { "type": "array", "items": { "$ref": "#/components/schemas/TaxOutput" } } } }, "ThirdParty": { "type": "object", "properties": { "TaxIdentification": { "anyOf": [ { "$ref": "#/components/schemas/TaxIdentification" }, { "type": "null" } ] }, "LegalEntity": { "anyOf": [ { "$ref": "#/components/schemas/LegalEntity" }, { "type": "null" } ] }, "Individual": { "anyOf": [ { "$ref": "#/components/schemas/Individual" }, { "type": "null" } ] } } }, "Transform": { "type": "object", "required": [ "@Algorithm" ], "properties": { "@Algorithm": { "type": "string" } } }, "Transforms": { "type": "object", "properties": { "ds:Transform": { "type": "array", "items": { "$ref": "#/components/schemas/Transform" } } } }, "X509Data": { "type": "object", "properties": { "ds:X509IssuerSerial": { "type": "array", "items": { "$ref": "#/components/schemas/X509IssuerSerial" } }, "ds:X509SubjectName": { "type": "array", "items": { "type": "string" } }, "ds:X509Certificate": { "type": "array", "items": { "type": "string" } } } }, "X509IssuerSerial": { "type": "object", "required": [ "ds:X509IssuerName", "ds:X509SerialNumber" ], "properties": { "ds:X509IssuerName": { "type": "string" }, "ds:X509SerialNumber": { "type": "string" } } } }, "responses": {}, "parameters": {}, "examples": {}, "requestBodies": {}, "headers": {}, "securitySchemes": {} }, "security": [], "tags": [ { "name": "InvoiceDraft", "description": "The draft-invoice API surface: a `DRAFT`-status {@see Invoice} that can be reviewed,\namended and finally sent. It's a dedicated resource so these operations don't bloat the\nInvoice entity; state (read, persist, delete) is backed by the Invoice entity through\n`stateOptions`, and every operation runs a custom provider/processor." }, { "name": "EventDestination", "description": "Resource 'EventDestination' operations." }, { "name": "Invoice", "description": "Resource 'Invoice' operations." }, { "name": "LegalEntity", "description": "Resource 'LegalEntity' operations." }, { "name": "LegalEntitySubAccount", "description": "Resource 'LegalEntitySubAccount' operations." } ], "webhooks": {} }