{ "openapi": "3.1.0", "info": { "title": "A-Cube FR 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": "List your event destinations", "description": "Returns the paginated list of your event destinations, each routing one event type to one target", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": true }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "schema": { "type": "integer", "default": 30, "minimum": 0, "maximum": 30 }, "style": "form", "explode": true } ] }, "post": { "operationId": "api_event-destinations_post", "tags": [ "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": "Create an event destination", "description": "Creates a new event destination with dedicated configuration", "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": "Get an event destination", "description": "Returns the corresponding event destination by uuid", "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": "Update an event destination", "description": "Update the configuration of the event destination matching uuid", "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": "Delete an event destination", "description": "Deletes the event destination matching uuid. This is a hard delete, the record will be removed and cannot be recovered.", "parameters": [ { "name": "uuid", "in": "path", "description": "EventDestination identifier", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ] } }, "/invoices": { "get": { "operationId": "api_invoices_get_collection", "tags": [ "Invoices" ], "responses": { "200": { "description": "Invoice collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Invoice.InvoiceOutput" } } } } } }, "summary": "List your invoices", "description": "Returns the flat list of your invoices, sorted by most recent first. All filters are combinable with AND.", "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": 100 }, "style": "form", "explode": true }, { "name": "direction", "in": "query", "description": "Filter by direction (`INBOUND` or `OUTBOUND`).", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "direction[]", "in": "query", "description": "Filter by direction (`INBOUND` or `OUTBOUND`).", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "deepObject", "explode": true }, { "name": "status", "in": "query", "description": "Filter by status exact match (e.g. `SUBMITTED`, `REFUSED`, `PAYMENT_RECEIVED`).", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "status[]", "in": "query", "description": "Filter by status exact match (e.g. `SUBMITTED`, `REFUSED`, `PAYMENT_RECEIVED`).", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "deepObject", "explode": true }, { "name": "legalEntityUuid", "in": "query", "description": "Filter by your legal entity uuid (the one this invoice belongs to on your side).", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "legalEntityUuid[]", "in": "query", "description": "Filter by your legal entity uuid (the one this invoice belongs to on your side).", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "deepObject", "explode": true }, { "name": "invoiceNumber", "in": "query", "description": "Filter by invoice number, case-insensitive substring match (French invoice numbers are often non-numeric and noisy).", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "invoiceNumber[]", "in": "query", "description": "Filter by invoice number, case-insensitive substring match (French invoice numbers are often non-numeric and noisy).", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "deepObject", "explode": true }, { "name": "counterpartyName", "in": "query", "description": "Filter by counterparty name, case-insensitive substring match.", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "counterpartyName[]", "in": "query", "description": "Filter by counterparty name, case-insensitive substring match.", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "deepObject", "explode": true }, { "name": "counterpartySiren", "in": "query", "description": "Filter by counterparty 9-digit SIREN exact match.", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "counterpartySiren[]", "in": "query", "description": "Filter by counterparty 9-digit SIREN exact match.", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "deepObject", "explode": true }, { "name": "invoiceDate", "in": "query", "description": "Filter by invoice date (exact match, format YYYY-MM-DD). Range filtering (`[after]` / `[before]`) will arrive in a follow-up.", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "invoiceDate[]", "in": "query", "description": "Filter by invoice date (exact match, format YYYY-MM-DD). Range filtering (`[after]` / `[before]`) will arrive in a follow-up.", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "deepObject", "explode": true } ] }, "post": { "operationId": "api_invoices_post", "tags": [ "Invoices" ], "responses": { "201": { "description": "Invoice resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invoice.InvoiceOutput" } } }, "links": {} }, "400": { "description": "Invalid input", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} }, "422": { "description": "An error occurred", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } } }, "links": {} } }, "summary": "Emit an invoice (UBL, Factur-X, CII)", "description": "Uploads an invoice file to A-Cube.Returns 422 if the seller is not enrolled. The lifecycle status update flow is asynchronous: the response carries the initial `SUBMITTED` status; subsequent transitions arrive via your A-Cube webhook subscription.", "parameters": [], "requestBody": { "description": "The new Invoice resource", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/Invoice" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Invoice" } } }, "required": true } } }, "/invoices/{uuid}": { "get": { "operationId": "api_invoices_uuid_get", "tags": [ "Invoices" ], "responses": { "200": { "description": "Invoice resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invoice.InvoiceOutput" } } } }, "404": { "description": "Not found", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} } }, "summary": "Get one of your invoices by uuid", "description": "Returns the invoice matching `uuid`. Responds 404 if the uuid is unknown or belongs to another tenant.", "parameters": [ { "name": "uuid", "in": "path", "description": "Invoice identifier", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ] } }, "/invoices/{uuid}/current-status": { "get": { "operationId": "api_invoices_uuidcurrent-status_get", "tags": [ "Invoices" ], "responses": { "200": { "description": "Invoice resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invoice" } } } }, "404": { "description": "Not found", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} } }, "summary": "Get the current lifecycle status for an invoice", "description": "Returns the current lifecycle status of an invoice.", "parameters": [ { "name": "uuid", "in": "path", "description": "Invoice identifier", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ] } }, "/invoices/{uuid}/lifecycle": { "get": { "operationId": "api_invoices_uuidlifecycle_get", "tags": [ "Invoices" ], "responses": { "200": { "description": "Invoice resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invoice" } } } }, "404": { "description": "Not found", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} } }, "summary": "Get the chronological lifecycle event history for an invoice", "description": "Returns the full sequence of lifecycle events recorded upstream for the invoice. Owner-scoped.", "parameters": [ { "name": "uuid", "in": "path", "description": "Invoice identifier", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ] }, "put": { "operationId": "api_invoices_uuidlifecycle_put", "tags": [ "Invoices" ], "responses": { "202": { "description": "Invoice resource updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invoice" } } }, "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": "Send a lifecycle event for an invoice", "description": "Submits a status transition for the invoice (e.g. REFUSED, APPROVED, PAYMENT_RECEIVED). The upstream provider processes the event asynchronously and emits follow-up status callbacks. Returns 202 on success. Returns 422 if `invoiceStatus` is not a known InvoiceStatus value. Owner-scoped.", "parameters": [ { "name": "uuid", "in": "path", "description": "Invoice identifier", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ], "requestBody": { "description": "The updated Invoice resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invoice.UpdateInvoiceStatusInput" } } }, "required": true } } }, "/legal-entities": { "get": { "operationId": "api_legal-entities_get_collection", "tags": [ "LegalEntity" ], "responses": { "200": { "description": "LegalEntity collection", "content": { "application/ld+json": { "schema": { "type": "object", "description": "LegalEntity.LegalEntityOutput.jsonld collection.", "allOf": [ { "$ref": "#/components/schemas/HydraCollectionBaseSchema" }, { "type": "object", "required": [ "hydra:member" ], "properties": { "hydra:member": { "type": "array", "items": { "$ref": "#/components/schemas/LegalEntity.LegalEntityOutput.jsonld" } } } } ] } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LegalEntity.LegalEntityOutput" } } } } } }, "summary": "List your legal entities", "description": "Returns the flat list of your legal entities, sorted by most recent first", "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": "status", "in": "query", "description": "Filter by status exact match (e.g. `PENDING`, `COMPLETED`).", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "status[]", "in": "query", "description": "Filter by status exact match (e.g. `PENDING`, `COMPLETED`).", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "deepObject", "explode": true }, { "name": "siren", "in": "query", "description": "Filter by 9-digit SIREN exact match.", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "siren[]", "in": "query", "description": "Filter by 9-digit SIREN exact match.", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "deepObject", "explode": true }, { "name": "siret", "in": "query", "description": "Filter by 14-digit SIRET exact match.", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "siret[]", "in": "query", "description": "Filter by 14-digit SIRET exact match.", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "deepObject", "explode": true }, { "name": "displayName", "in": "query", "description": "Filter by company name as a case-insensitive substring (e.g. `?displayName=agonar` matches \"FRAGONARD OPERA\").", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "displayName[]", "in": "query", "description": "Filter by company name as a case-insensitive substring (e.g. `?displayName=agonar` matches \"FRAGONARD OPERA\").", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "deepObject", "explode": true } ] }, "post": { "operationId": "api_legal-entities_post", "tags": [ "LegalEntity" ], "responses": { "201": { "description": "LegalEntity resource created", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntityOutput.jsonld" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntityOutput" } } }, "links": {} }, "400": { "description": "Invalid input", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} }, "422": { "description": "An error occurred", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } } }, "links": {} } }, "summary": "Create a legal entity from its SIREN", "description": "Validates the SIREN against the French directory, then creates a corresponding record on the platform.", "parameters": [], "requestBody": { "description": "The new LegalEntity resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntityInput" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntityInput" } } }, "required": true } } }, "/legal-entities/{uuid}": { "get": { "operationId": "api_legal-entities_uuid_get", "tags": [ "LegalEntity" ], "responses": { "200": { "description": "LegalEntity resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntityOutput.jsonld" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntityOutput" } } } }, "404": { "description": "Not found", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} } }, "summary": "Get one of your legal entities by uuid", "description": "Returns the legal entity matching `uuid`. Responds 404 if the uuid is unknown.", "parameters": [ { "name": "uuid", "in": "path", "description": "LegalEntity identifier", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ] }, "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": "Delete a legal entity by uuid", "description": "Deletes the legal entity matching `uuid`. Removal is permanent and the legal entity will be delisted from the French directory.", "parameters": [ { "name": "uuid", "in": "path", "description": "LegalEntity identifier", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ] } }, "/legal-entities/{uuid}/onboard": { "get": { "operationId": "api_legal-entities_uuidonboard_get", "tags": [ "LegalEntity" ], "responses": { "200": { "description": "LegalEntity resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntityOnboardingRequestOutput.jsonld" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntityOnboardingRequestOutput" } } } }, "404": { "description": "Not found", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} } }, "summary": "Get the active onboarding URL for a legal entity", "description": "Returns the active (unexpired) onboarding URL for the legal entity identified by `uuid`.", "parameters": [ { "name": "uuid", "in": "path", "description": "LegalEntity identifier", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ] }, "post": { "operationId": "api_legal-entities_uuidonboard_post", "tags": [ "LegalEntity" ], "responses": { "201": { "description": "LegalEntity resource created", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntityOnboardingRequestOutput.jsonld" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LegalEntity.LegalEntityOnboardingRequestOutput" } } }, "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": "Onboard a legal entity", "description": "Start the onboarding process for the legal entity identified by `uuid`.", "parameters": [ { "name": "uuid", "in": "path", "description": "LegalEntity identifier", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ] } } }, "components": { "schemas": { "ConstraintViolation": { "type": "object", "description": "Unprocessable entity", "properties": { "status": { "default": 422, "type": "integer" }, "violations": { "type": "array", "items": { "type": "object", "properties": { "propertyPath": { "type": "string", "description": "The property path of the violation" }, "message": { "type": "string", "description": "The message associated with the violation" }, "code": { "type": "string", "description": "The code of the violation" }, "hint": { "type": "string", "description": "An extra hint to understand the violation" }, "payload": { "type": "object", "additionalProperties": true, "description": "The serialized payload of the violation" } }, "required": [ "propertyPath", "message" ] } }, "detail": { "readOnly": true, "type": "string" }, "type": { "readOnly": true, "type": "string" }, "title": { "readOnly": true, "type": [ "string", "null" ] }, "instance": { "readOnly": true, "type": [ "string", "null" ] } } }, "ConstraintViolation.jsonld": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "status": { "default": 422, "type": "integer" }, "violations": { "type": "array", "items": { "type": "object", "properties": { "propertyPath": { "type": "string", "description": "The property path of the violation" }, "message": { "type": "string", "description": "The message associated with the violation" }, "code": { "type": "string", "description": "The code of the violation" }, "hint": { "type": "string", "description": "An extra hint to understand the violation" }, "payload": { "type": "object", "additionalProperties": true, "description": "The serialized payload of the violation" } }, "required": [ "propertyPath", "message" ] } }, "detail": { "readOnly": true, "type": "string" }, "description": { "readOnly": true, "type": "string" }, "type": { "readOnly": true, "type": "string" }, "title": { "readOnly": true, "type": [ "string", "null" ] }, "instance": { "readOnly": true, "type": [ "string", "null" ] } } } ], "description": "Unprocessable entity" }, "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", "description": "One webhook routes a single event type to one HTTPS target.\n\nRouting is free: the same event type may be sent to several webhooks (delete\nand re-create to change the routing). Only status and label can be updated in\nplace.", "required": [ "event", "target", "delivery", "status" ], "properties": { "event": { "enum": [ "invoice.status", "invoice.inbound", "invoice.outbound", "legal_entity.onboarding" ], "type": "string" }, "target": { "format": "uri", "maxLength": 2048, "externalDocs": { "url": "https://schema.org/url" }, "type": "string" }, "delivery": { "enum": [ "webhook" ], "default": "webhook", "type": "string" }, "status": { "enum": [ "active", "inactive" ], "default": "active", "type": "string" }, "authType": { "enum": [ "none", "query", "header" ], "default": "none", "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" ] } } }, "EventDestination.EventDestinationOutput": { "type": "object", "description": "One webhook routes a single event type to one HTTPS target.\n\nRouting is free: the same event type may be sent to several webhooks (delete\nand re-create to change the routing). Only status and label can be updated in\nplace.", "properties": { "uuid": { "type": "string" }, "event": { "type": "string" }, "delivery": { "type": "string" }, "target": { "type": "string" }, "status": { "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" }, "status": { "type": "string" }, "authType": { "type": "string" }, "authKey": { "type": [ "string", "null" ] }, "authToken": { "type": [ "string", "null" ] } } } ], "description": "One webhook routes a single event type to one HTTPS target.\n\nRouting is free: the same event type may be sent to several webhooks (delete\nand re-create to change the routing). Only status and label can be updated in\nplace." }, "EventDestination.EventDestinationUpdateInput": { "type": "object", "description": "One webhook routes a single event type to one HTTPS target.\n\nRouting is free: the same event type may be sent to several webhooks (delete\nand re-create to change the routing). Only status and label can be updated in\nplace.", "required": [ "status", "authType" ], "properties": { "status": { "enum": [ "active", "inactive" ], "default": "active", "type": "string" }, "authType": { "enum": [ "none", "query", "header" ], "type": "string" }, "authKey": { "type": [ "string", "null" ] }, "authToken": { "type": [ "string", "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", "format": "iri-reference" }, "hydra:last": { "type": "string", "format": "iri-reference" }, "hydra:previous": { "type": "string", "format": "iri-reference" }, "hydra:next": { "type": "string", "format": "iri-reference" } }, "example": { "@id": "string", "@type": "string", "hydra:first": "string", "hydra:last": "string", "hydra:previous": "string", "hydra:next": "string" } } } } ] }, "HydraCollectionBaseSchemaNoPagination": { "type": "object", "properties": { "hydra:totalItems": { "type": "integer", "minimum": 0 }, "hydra:search": { "type": "object", "properties": { "@type": { "type": "string" }, "hydra:template": { "type": "string" }, "hydra:variableRepresentation": { "type": "string" }, "hydra:mapping": { "type": "array", "items": { "type": "object", "properties": { "@type": { "type": "string" }, "variable": { "type": "string" }, "property": { "type": [ "string", "null" ] }, "required": { "type": "boolean" } } } } } } } }, "HydraItemBaseSchema": { "type": "object", "properties": { "@context": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "@vocab": { "type": "string" }, "hydra": { "type": "string", "enum": [ "http://www.w3.org/ns/hydra/core#" ] } }, "required": [ "@vocab", "hydra" ], "additionalProperties": true } ] }, "@id": { "type": "string" }, "@type": { "type": "string" } }, "required": [ "@id", "@type" ] }, "Invoice": { "type": "object", "properties": { "uuid": { "type": [ "string", "null" ], "format": "uuid" }, "ownerId": { "type": "integer" }, "legalEntity": { "type": "string", "format": "iri-reference", "example": "https://example.com/" }, "providerInvoiceId": { "type": "string" }, "direction": { "type": "string", "enum": [ "INBOUND", "OUTBOUND" ] }, "status": { "type": "string", "enum": [ "SUBMITTED", "RECEIVED", "REJECTED", "SUSPENDED", "COMPLETED", "DISPUTED", "APPROVED", "REFUSED", "PAID" ] }, "invoiceTypeCode": { "type": [ "string", "null" ] }, "invoiceNumber": { "type": "string" }, "invoiceDate": { "type": "string", "format": "date-time" }, "dueDate": { "type": [ "string", "null" ], "format": "date-time" }, "currency": { "type": "string" }, "totalAmount": { "type": "string", "format": "string" }, "netAmount": { "type": [ "string", "null" ], "format": "string" }, "taxAmount": { "type": [ "string", "null" ], "format": "string" }, "payableAmount": { "type": [ "string", "null" ], "format": "string" }, "counterparty": { "$ref": "#/components/schemas/InvoiceParty" }, "payloadPath": { "type": [ "string", "null" ] }, "senderAcceptStatus": { "type": [ "boolean", "null" ] }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, "Invoice.InvoiceOutput": { "type": "object", "properties": { "uuid": { "type": "string" }, "legalEntityUuid": { "type": "string" }, "direction": { "type": "string" }, "status": { "type": "string" }, "invoiceTypeCode": { "type": [ "string", "null" ] }, "invoiceNumber": { "type": "string" }, "invoiceDate": { "type": "string" }, "dueDate": { "type": [ "string", "null" ] }, "currency": { "type": "string" }, "totalAmount": { "type": "string" }, "netAmount": { "type": [ "string", "null" ] }, "taxAmount": { "type": [ "string", "null" ] }, "payableAmount": { "type": [ "string", "null" ] }, "counterparty": { "type": "object", "additionalProperties": { "type": [ "string", "null" ] } }, "createdAt": { "type": "string" }, "updatedAt": { "type": [ "string", "null" ] } } }, "Invoice.UpdateInvoiceStatusInput": { "type": "object", "required": [ "invoiceStatus" ], "properties": { "invoiceStatus": { "enum": [ 200, "SUBMITTED", 201, "SENT_BY_THE_PLATFORM", 202, "RECEIVED_BY_THE_PLATFORM", 203, "MADE_AVAILABLE", 204, "IN_HAND", 205, "APPROVED", 206, "PARTIALLY_APPROVED", 207, "IN_DISPUTE", 208, "SUSPENDED", 209, "COMPLETED", 210, "REFUSED", 211, "PAYMENT_SENT", 212, "PAYMENT_RECEIVED", 213, "REJECTED" ], "anyOf": [ { "type": "integer" }, { "type": "string" } ] } } }, "InvoiceParty": { "type": "object", "properties": { "name": { "type": "string" }, "siren": { "type": [ "string", "null" ] }, "siret": { "type": [ "string", "null" ] }, "identifierScheme": { "type": [ "string", "null" ] }, "identifierValue": { "type": [ "string", "null" ] } } }, "LegalEntity.LegalEntityInput": { "type": "object", "required": [ "siren" ], "properties": { "siren": { "pattern": "^(\\d{9})$", "type": "string" } } }, "LegalEntity.LegalEntityOnboardingRequestOutput": { "type": "object", "properties": { "onboardingUrl": { "type": "string" } } }, "LegalEntity.LegalEntityOnboardingRequestOutput.jsonld": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "onboardingUrl": { "type": "string" } } } ] }, "LegalEntity.LegalEntityOutput": { "type": "object", "properties": { "uuid": { "type": "string" }, "parentLegalEntityUuid": { "type": [ "string", "null" ] }, "mailleType": { "type": "string" }, "status": { "type": "string" }, "vatRegimeCode": { "type": [ "string", "null" ] }, "displayName": { "type": "string" }, "countryCode": { "type": "string" }, "siren": { "type": [ "string", "null" ] }, "siret": { "type": [ "string", "null" ] }, "idRoutage": { "type": [ "string", "null" ] }, "suffix": { "type": [ "string", "null" ] }, "identifierScheme": { "type": [ "string", "null" ] }, "identifierValue": { "type": [ "string", "null" ] }, "contactEmail": { "type": [ "string", "null" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": [ "string", "null" ] } } }, "LegalEntity.LegalEntityOutput.jsonld": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "uuid": { "type": "string" }, "parentLegalEntityUuid": { "type": [ "string", "null" ] }, "mailleType": { "type": "string" }, "status": { "type": "string" }, "vatRegimeCode": { "type": [ "string", "null" ] }, "displayName": { "type": "string" }, "countryCode": { "type": "string" }, "siren": { "type": [ "string", "null" ] }, "siret": { "type": [ "string", "null" ] }, "idRoutage": { "type": [ "string", "null" ] }, "suffix": { "type": [ "string", "null" ] }, "identifierScheme": { "type": [ "string", "null" ] }, "identifierValue": { "type": [ "string", "null" ] }, "contactEmail": { "type": [ "string", "null" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": [ "string", "null" ] } } } ] } }, "responses": {}, "parameters": {}, "examples": {}, "requestBodies": {}, "headers": {}, "securitySchemes": {} }, "security": [], "tags": [ { "name": "EventDestination", "description": "One webhook routes a single event type to one HTTPS target.\n\nRouting is free: the same event type may be sent to several webhooks (delete\nand re-create to change the routing). Only status and label can be updated in\nplace." }, { "name": "Invoices", "description": "Resource 'Invoices' operations." }, { "name": "LegalEntity", "description": "Resource 'LegalEntity' operations." } ], "webhooks": {} }