{
"openapi": "3.1.0",
"info": {
"title": "A-Cube FR API",
"description": "",
"version": "1.0.0",
"x-logo": {
"url": "https://assets.acubeapi.com/logo_rect_white.png"
}
},
"servers": [
{
"url": "https://fr-sandbox.api.acubeapi.com",
"description": "Sandbox"
},
{
"url": "https://fr.api.acubeapi.com",
"description": "Production"
}
],
"paths": {
"/credit-notes": {
"get": {
"operationId": "api_credit-notes_get_collection",
"tags": [
"Credit Notes"
],
"responses": {
"200": {
"description": "CreditNote collection",
"content": {
"application/ld+json": {
"schema": {
"type": "object",
"description": "CreditNote.InvoiceOutput.jsonld collection.",
"allOf": [
{
"$ref": "#/components/schemas/HydraCollectionBaseSchema"
},
{
"type": "object",
"required": [
"hydra:member"
],
"properties": {
"hydra:member": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreditNote.InvoiceOutput.jsonld"
}
}
}
}
]
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreditNote.InvoiceOutput"
}
}
}
}
}
},
"summary": "List your credit notes.",
"description": "Returns the flat list of your credit notes, 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": "direction",
"in": "query",
"description": "Filter by direction (case-insensitive)",
"required": false,
"deprecated": false,
"schema": {
"enum": [
"INBOUND",
"OUTBOUND"
]
},
"style": "form",
"explode": true
},
{
"name": "direction[]",
"in": "query",
"description": "Filter by direction (case-insensitive)",
"required": false,
"deprecated": false,
"schema": {
"type": "array",
"items": {
"enum": [
"INBOUND",
"OUTBOUND"
]
}
},
"style": "deepObject",
"explode": true
},
{
"name": "status",
"in": "query",
"description": "Filter by status exact match (case-insensitive)",
"required": false,
"deprecated": false,
"schema": {
"enum": [
"ACQUIRED",
"SUBMITTED",
"RECEIVED",
"REJECTED",
"SUSPENDED",
"COMPLETED",
"DISPUTED",
"APPROVED",
"REFUSED",
"PAID"
]
},
"style": "form",
"explode": true
},
{
"name": "status[]",
"in": "query",
"description": "Filter by status exact match (case-insensitive)",
"required": false,
"deprecated": false,
"schema": {
"type": "array",
"items": {
"enum": [
"ACQUIRED",
"SUBMITTED",
"RECEIVED",
"REJECTED",
"SUSPENDED",
"COMPLETED",
"DISPUTED",
"APPROVED",
"REFUSED",
"PAID"
]
}
},
"style": "deepObject",
"explode": true
},
{
"name": "senderName",
"in": "query",
"description": "Filter by party name, case-insensitive substring match.",
"required": false,
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": true
},
{
"name": "senderName[]",
"in": "query",
"description": "Filter by party name, case-insensitive substring match.",
"required": false,
"deprecated": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"style": "deepObject",
"explode": true
},
{
"name": "senderSiren",
"in": "query",
"description": "Filter by party 9-digit SIREN exact match.",
"required": false,
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": true
},
{
"name": "senderSiren[]",
"in": "query",
"description": "Filter by party 9-digit SIREN exact match.",
"required": false,
"deprecated": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"style": "deepObject",
"explode": true
},
{
"name": "invoiceNumber",
"in": "query",
"description": "Filter by credit note number, case-insensitive substring match",
"required": false,
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": true
},
{
"name": "invoiceNumber[]",
"in": "query",
"description": "Filter by credit note number, case-insensitive substring match",
"required": false,
"deprecated": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"style": "deepObject",
"explode": true
},
{
"name": "recipientName",
"in": "query",
"description": "Filter by recipient name, case-insensitive substring match.",
"required": false,
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": true
},
{
"name": "recipientName[]",
"in": "query",
"description": "Filter by recipient name, case-insensitive substring match.",
"required": false,
"deprecated": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"style": "deepObject",
"explode": true
},
{
"name": "recipientSiren",
"in": "query",
"description": "Filter by recipient 9-digit SIREN exact match.",
"required": false,
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": true
},
{
"name": "recipientSiren[]",
"in": "query",
"description": "Filter by recipient 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 credit note date (exact match, format YYYY-MM-DD).",
"required": false,
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": true
},
{
"name": "invoiceDate[]",
"in": "query",
"description": "Filter by credit note date (exact match, format YYYY-MM-DD).",
"required": false,
"deprecated": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"style": "deepObject",
"explode": true
},
{
"name": "partyName",
"in": "query",
"description": "**Deprecated** — use `senderName` (supplier) or `recipientName` (customer). Matches the owner's own side: sender on OUTBOUND, recipient on INBOUND.",
"required": false,
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": true
},
{
"name": "partySiren",
"in": "query",
"description": "**Deprecated** — use `senderSiren` (supplier) or `recipientSiren` (customer). Matches the owner's own side: sender on OUTBOUND, recipient on INBOUND.",
"required": false,
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": true
},
{
"name": "counterpartyName",
"in": "query",
"description": "**Deprecated** — use `recipientName` (supplier) or `senderName` (customer). Matches the other side: recipient on OUTBOUND, sender on INBOUND.",
"required": false,
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": true
},
{
"name": "counterpartySiren",
"in": "query",
"description": "**Deprecated** — use `recipientSiren` (supplier) or `senderSiren` (customer). Matches the other side: recipient on OUTBOUND, sender on INBOUND.",
"required": false,
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": true
}
]
},
"post": {
"operationId": "api_credit-notes_post",
"tags": [
"Credit Notes"
],
"responses": {
"201": {
"description": "CreditNote resource created",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/CreditNote.InvoiceOutput.jsonld"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreditNote.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": "Send a credit note (UBL or CII)",
"description": "Uploads a credit note file to A-Cube. Accepts UBL 2.1 or UN/CEFACT CII XML documents; the syntax is detected automatically from the payload. Support for Factur-X will be added in the near future. Send the `X-Referenced-Invoice-Uuid` header to link the credit note to one of your invoices.",
"parameters": [
{
"name": "X-Referenced-Invoice-Uuid",
"in": "header",
"description": "Uuid of one of your invoices that this credit note refers to. Optional; when present it must resolve to an invoice you own, otherwise the request is rejected with 400.",
"required": false,
"deprecated": false,
"schema": {
"type": "string",
"format": "uuid"
},
"style": "simple",
"explode": false
}
],
"requestBody": {
"description": "XML payload of the credit note to send. Must be a valid UBL 2.1 or CII (Cross Industry Invoice) document.",
"content": {},
"required": true
}
}
},
"/credit-notes/{uuid}": {
"get": {
"operationId": "api_credit-notes_uuid_get",
"tags": [
"Credit Notes"
],
"responses": {
"200": {
"description": "CreditNote resource",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/CreditNote.InvoiceOutput.jsonld"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreditNote.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 credit notes by uuid",
"description": "Returns the credit notes matching `uuid`. Responds 404 if the uuid is unknown or belongs to another tenant.",
"parameters": [
{
"name": "uuid",
"in": "path",
"description": "CreditNote identifier",
"required": true,
"deprecated": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false
}
]
}
},
"/credit-notes/{uuid}/current-status": {
"get": {
"operationId": "api_credit-notes_uuidcurrent-status_get",
"tags": [
"Credit Notes"
],
"responses": {
"200": {
"description": "CreditNote resource",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/CreditNote.InvoiceStatusOutput.jsonld"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreditNote.InvoiceStatusOutput"
}
}
}
},
"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 a credit note",
"description": "Returns the current lifecycle status of a credit note.",
"parameters": [
{
"name": "uuid",
"in": "path",
"description": "CreditNote identifier",
"required": true,
"deprecated": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false
}
]
}
},
"/credit-notes/{uuid}/lifecycle": {
"get": {
"operationId": "api_credit-notes_uuidlifecycle_get_collection",
"tags": [
"Credit Notes"
],
"responses": {
"200": {
"description": "CreditNote collection",
"content": {
"application/ld+json": {
"schema": {
"type": "object",
"description": "CreditNote.InvoiceStatusOutput.jsonld collection.",
"allOf": [
{
"$ref": "#/components/schemas/HydraCollectionBaseSchemaNoPagination"
},
{
"type": "object",
"required": [
"hydra:member"
],
"properties": {
"hydra:member": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreditNote.InvoiceStatusOutput.jsonld"
}
}
}
}
]
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreditNote.InvoiceStatusOutput"
}
}
}
}
}
},
"summary": "Get the chronological lifecycle event history for a credit note",
"description": "Returns the full sequence of lifecycle events recorded upstream for the credit note. Owner-scoped.",
"parameters": [
{
"name": "uuid",
"in": "path",
"description": "CreditNote identifier",
"required": true,
"deprecated": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false
}
]
},
"put": {
"operationId": "api_credit-notes_uuidlifecycle_put",
"tags": [
"Credit Notes"
],
"responses": {
"200": {
"description": "CreditNote resource updated",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/CreditNote.InvoiceStatusOutput.jsonld"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreditNote.InvoiceStatusOutput"
}
}
},
"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 a credit note",
"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": "CreditNote identifier",
"required": true,
"deprecated": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false
}
],
"requestBody": {
"description": "The updated CreditNote resource",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/CreditNote.UpdateInvoiceStatusInput"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreditNote.UpdateInvoiceStatusInput"
}
}
},
"required": true
}
}
},
"/credit-notes/{uuid}/print": {
"get": {
"operationId": "api_credit-notes_uuidprint_get",
"tags": [
"Credit Notes"
],
"responses": {
"200": {
"description": "A PDF rendering of the invoice.",
"content": {
"application/pdf": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"204": {
"description": "CreditNote resource"
},
"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": "Download a human-readable PDF rendering of the credit note",
"description": "Streams a PDF rendering of the credit note.",
"parameters": [
{
"name": "uuid",
"in": "path",
"description": "CreditNote identifier",
"required": true,
"deprecated": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false
}
]
}
},
"/credit-notes/{uuid}/source": {
"get": {
"operationId": "api_credit-notes_uuidsource_get",
"tags": [
"Credit Notes"
],
"responses": {
"200": {
"description": "The original invoice payload, in whatever format it was submitted/received in.",
"content": {
"application/xml": {
"schema": {
"type": "string",
"format": "binary"
},
"example": "\n\n \n"
}
}
},
"204": {
"description": "CreditNote resource"
},
"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": "Download the original credit note payload",
"description": "Streams the original credit note payload (UBL XML / Factur-X PDF / CII XML) for the invoice identified by `uuid`.",
"parameters": [
{
"name": "uuid",
"in": "path",
"description": "CreditNote identifier",
"required": true,
"deprecated": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false
}
]
}
},
"/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
}
]
}
},
"/french-directory": {
"get": {
"operationId": "api_french-directory_get_collection",
"tags": [
"FrenchDirectoryEntry"
],
"responses": {
"200": {
"description": "FrenchDirectoryEntry collection",
"content": {
"application/ld+json": {
"schema": {
"type": "object",
"description": "FrenchDirectoryEntry.FrenchDirectoryEntryOutput.jsonld collection.",
"allOf": [
{
"$ref": "#/components/schemas/HydraCollectionBaseSchema"
},
{
"type": "object",
"required": [
"hydra:member"
],
"properties": {
"hydra:member": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FrenchDirectoryEntry.FrenchDirectoryEntryOutput.jsonld"
}
}
}
}
]
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FrenchDirectoryEntry.FrenchDirectoryEntryOutput"
}
}
}
}
}
},
"summary": "Retrieves the collection of FrenchDirectoryEntry resources.",
"description": "Retrieves the collection of FrenchDirectoryEntry 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": "siren",
"in": "query",
"description": "The SIREN number of the company (exact match, 9 digits). Mutually exclusive with `siret`.",
"required": false,
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": true
},
{
"name": "siret",
"in": "query",
"description": "The SIRET number of the company (exact match, 14 digits). Mutually exclusive with `siren`.",
"required": false,
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": true
},
{
"name": "name",
"in": "query",
"description": "The name of the company (partial match, `**`).",
"required": false,
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": true
}
]
}
},
"/invoices": {
"get": {
"operationId": "api_invoices_get_collection",
"tags": [
"Invoices"
],
"responses": {
"200": {
"description": "Invoice collection",
"content": {
"application/ld+json": {
"schema": {
"type": "object",
"description": "Invoice.InvoiceOutput.jsonld collection.",
"allOf": [
{
"$ref": "#/components/schemas/HydraCollectionBaseSchema"
},
{
"type": "object",
"required": [
"hydra:member"
],
"properties": {
"hydra:member": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Invoice.InvoiceOutput.jsonld"
}
}
}
}
]
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Invoice.InvoiceOutput"
}
}
}
}
}
},
"summary": "List your invoices",
"description": "Returns the flat list of your invoices, 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": "direction",
"in": "query",
"description": "Filter by direction (case-insensitive)",
"required": false,
"deprecated": false,
"schema": {
"enum": [
"INBOUND",
"OUTBOUND"
]
},
"style": "form",
"explode": true
},
{
"name": "direction[]",
"in": "query",
"description": "Filter by direction (case-insensitive)",
"required": false,
"deprecated": false,
"schema": {
"type": "array",
"items": {
"enum": [
"INBOUND",
"OUTBOUND"
]
}
},
"style": "deepObject",
"explode": true
},
{
"name": "status",
"in": "query",
"description": "Filter by status exact match (case-insensitive)",
"required": false,
"deprecated": false,
"schema": {
"enum": [
"ACQUIRED",
"SUBMITTED",
"RECEIVED",
"REJECTED",
"SUSPENDED",
"COMPLETED",
"DISPUTED",
"APPROVED",
"REFUSED",
"PAID"
]
},
"style": "form",
"explode": true
},
{
"name": "status[]",
"in": "query",
"description": "Filter by status exact match (case-insensitive)",
"required": false,
"deprecated": false,
"schema": {
"type": "array",
"items": {
"enum": [
"ACQUIRED",
"SUBMITTED",
"RECEIVED",
"REJECTED",
"SUSPENDED",
"COMPLETED",
"DISPUTED",
"APPROVED",
"REFUSED",
"PAID"
]
}
},
"style": "deepObject",
"explode": true
},
{
"name": "senderName",
"in": "query",
"description": "Filter by party name, case-insensitive substring match.",
"required": false,
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": true
},
{
"name": "senderName[]",
"in": "query",
"description": "Filter by party name, case-insensitive substring match.",
"required": false,
"deprecated": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"style": "deepObject",
"explode": true
},
{
"name": "partyName",
"in": "query",
"description": "**Deprecated** — use `senderName` (supplier) or `recipientName` (customer). Matches the owner's own side: sender on OUTBOUND, recipient on INBOUND.",
"required": false,
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": true
},
{
"name": "senderSiren",
"in": "query",
"description": "Filter by party 9-digit SIREN exact match.",
"required": false,
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": true
},
{
"name": "senderSiren[]",
"in": "query",
"description": "Filter by party 9-digit SIREN exact match.",
"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",
"required": false,
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": true
},
{
"name": "invoiceNumber[]",
"in": "query",
"description": "Filter by invoice number, case-insensitive substring match",
"required": false,
"deprecated": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"style": "deepObject",
"explode": true
},
{
"name": "recipientName",
"in": "query",
"description": "Filter by counterparty name, case-insensitive substring match.",
"required": false,
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": true
},
{
"name": "recipientName[]",
"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": "recipientSiren",
"in": "query",
"description": "Filter by counterparty 9-digit SIREN exact match.",
"required": false,
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": true
},
{
"name": "recipientSiren[]",
"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).",
"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).",
"required": false,
"deprecated": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"style": "deepObject",
"explode": true
},
{
"name": "partySiren",
"in": "query",
"description": "**Deprecated** — use `senderSiren` (supplier) or `recipientSiren` (customer). Matches the owner's own side: sender on OUTBOUND, recipient on INBOUND.",
"required": false,
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": true
},
{
"name": "counterpartyName",
"in": "query",
"description": "**Deprecated** — use `recipientName` (supplier) or `senderName` (customer). Matches the other side: recipient on OUTBOUND, sender on INBOUND.",
"required": false,
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": true
},
{
"name": "counterpartySiren",
"in": "query",
"description": "**Deprecated** — use `recipientSiren` (supplier) or `senderSiren` (customer). Matches the other side: recipient on OUTBOUND, sender on INBOUND.",
"required": false,
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": true
}
]
},
"post": {
"operationId": "api_invoices_post",
"tags": [
"Invoices"
],
"responses": {
"201": {
"description": "Invoice resource created",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/Invoice.InvoiceOutput.jsonld"
}
},
"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": "Send an invoice (UBL or CII)",
"description": "Uploads an invoice file to A-Cube. Accepts UBL 2.1 or UN/CEFACT CII XML documents; the syntax is detected automatically from the payload. Support for Factur-X will be added in the near future",
"parameters": [],
"requestBody": {
"description": "XML payload of the invoice to send. Must be a valid UBL 2.1 or CII (Cross Industry Invoice) document.",
"content": {},
"required": true
}
}
},
"/invoices/{uuid}": {
"get": {
"operationId": "api_invoices_uuid_get",
"tags": [
"Invoices"
],
"responses": {
"200": {
"description": "Invoice resource",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/Invoice.InvoiceOutput.jsonld"
}
},
"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/ld+json": {
"schema": {
"$ref": "#/components/schemas/Invoice.InvoiceStatusOutput.jsonld"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Invoice.InvoiceStatusOutput"
}
}
}
},
"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_collection",
"tags": [
"Invoices"
],
"responses": {
"200": {
"description": "Invoice collection",
"content": {
"application/ld+json": {
"schema": {
"type": "object",
"description": "Invoice.InvoiceStatusOutput.jsonld collection.",
"allOf": [
{
"$ref": "#/components/schemas/HydraCollectionBaseSchemaNoPagination"
},
{
"type": "object",
"required": [
"hydra:member"
],
"properties": {
"hydra:member": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Invoice.InvoiceStatusOutput.jsonld"
}
}
}
}
]
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Invoice.InvoiceStatusOutput"
}
}
}
}
}
},
"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": {
"200": {
"description": "Invoice resource updated",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/Invoice.InvoiceStatusOutput.jsonld"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Invoice.InvoiceStatusOutput"
}
}
},
"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/ld+json": {
"schema": {
"$ref": "#/components/schemas/Invoice.UpdateInvoiceStatusInput"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Invoice.UpdateInvoiceStatusInput"
}
}
},
"required": true
}
}
},
"/invoices/{uuid}/print": {
"get": {
"operationId": "api_invoices_uuidprint_get",
"tags": [
"Invoices"
],
"responses": {
"200": {
"description": "A PDF rendering of the invoice.",
"content": {
"application/pdf": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"204": {
"description": "Invoice resource"
},
"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": "Download a human-readable PDF rendering of the invoice",
"description": "Streams a PDF rendering of the invoice.",
"parameters": [
{
"name": "uuid",
"in": "path",
"description": "Invoice identifier",
"required": true,
"deprecated": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false
}
]
}
},
"/invoices/{uuid}/source": {
"get": {
"operationId": "api_invoices_uuidsource_get",
"tags": [
"Invoices"
],
"responses": {
"200": {
"description": "The original invoice payload, in whatever format it was submitted/received in.",
"content": {
"application/xml": {
"schema": {
"type": "string",
"format": "binary"
},
"example": "\n\n \n"
}
}
},
"204": {
"description": "Invoice resource"
},
"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": "Download the original invoice payload",
"description": "Streams the original invoice payload (UBL XML / Factur-X PDF / CII XML) for the invoice identified by `uuid`.",
"parameters": [
{
"name": "uuid",
"in": "path",
"description": "Invoice identifier",
"required": true,
"deprecated": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false
}
]
}
},
"/legal-entities": {
"get": {
"operationId": "api_legal-entities_get_collection",
"tags": [
"LegalEntity"
],
"responses": {
"200": {
"description": "LegalEntity collection",
"content": {
"application/ld+json": {
"schema": {
"type": "object",
"description": "LegalEntity.LegalEntityOutput.jsonld collection.",
"allOf": [
{
"$ref": "#/components/schemas/HydraCollectionBaseSchema"
},
{
"type": "object",
"required": [
"hydra:member"
],
"properties": {
"hydra:member": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LegalEntity.LegalEntityOutput.jsonld"
}
}
}
}
]
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LegalEntity.LegalEntityOutput"
}
}
}
}
},
"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": "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,",
"required": false,
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": true
},
{
"name": "status[]",
"in": "query",
"description": "Filter by status exact match,",
"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": "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": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/Error.jsonld"
}
},
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"links": {}
}
},
"summary": "Create a 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"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/Error.jsonld"
}
},
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"links": {}
},
"404": {
"description": "Not found",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/Error.jsonld"
}
},
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"links": {}
}
},
"summary": "Get 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"
},
"403": {
"description": "Forbidden",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/Error.jsonld"
}
},
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"links": {}
},
"404": {
"description": "Not found",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/Error.jsonld"
}
},
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"links": {}
}
},
"summary": "Delete a 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"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/Error.jsonld"
}
},
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"links": {}
},
"404": {
"description": "Not found",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/Error.jsonld"
}
},
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"links": {}
}
},
"summary": "Get the 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": {}
},
"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": "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
}
]
}
},
"/legal-entities/{uuid}/register": {
"put": {
"operationId": "api_legal-entities_uuidregister_put",
"tags": [
"LegalEntity"
],
"responses": {
"200": {
"description": "LegalEntity resource updated",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/LegalEntity.LegalEntityOutput.jsonld"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/LegalEntity.LegalEntityOutput"
}
}
},
"links": {}
},
"400": {
"description": "Invalid input",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/Error.jsonld"
}
},
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"links": {}
},
"422": {
"description": "An error occurred",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/ConstraintViolation.jsonld"
}
},
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ConstraintViolation"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConstraintViolation"
}
}
},
"links": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/Error.jsonld"
}
},
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"links": {}
},
"404": {
"description": "Not found",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/Error.jsonld"
}
},
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"links": {}
}
},
"summary": "Register a legal entity on the network",
"description": "Registers the legal entity identified by `uuid` on the network without going through the onboarding procedure. The `0225:siren` address is registered on the first call and left untouched afterwards. `suffixes` declares the complete set of `0225:siren_suffix` addresses: entries not registered yet are added, and addresses missing from the body are removed. An omitted body therefore removes every suffix address.",
"parameters": [
{
"name": "uuid",
"in": "path",
"description": "LegalEntity identifier",
"required": true,
"deprecated": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false
}
],
"requestBody": {
"description": "The updated LegalEntity resource",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/LegalEntity.NetworkRegisterInput"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/LegalEntity.NetworkRegisterInput"
}
}
},
"required": true
}
}
},
"/legal-entities/{uuid}/vat-regime": {
"put": {
"operationId": "api_legal-entities_uuidvat-regime_put",
"tags": [
"LegalEntity"
],
"responses": {
"200": {
"description": "LegalEntity resource updated",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/LegalEntity.LegalEntityOutput.jsonld"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/LegalEntity.LegalEntityOutput"
}
}
},
"links": {}
},
"400": {
"description": "Invalid input",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/Error.jsonld"
}
},
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"links": {}
},
"422": {
"description": "An error occurred",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/ConstraintViolation.jsonld"
}
},
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ConstraintViolation"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConstraintViolation"
}
}
},
"links": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/Error.jsonld"
}
},
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"links": {}
},
"404": {
"description": "Not found",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/Error.jsonld"
}
},
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"links": {}
}
},
"summary": "Set the VAT regime of a legal entity",
"description": "Sets the French VAT regime for the legal entity identified by `uuid`. Required for e-reporting: reports are rejected while the regime is unset.\n\n- `MONTHLY`: real normal regime, monthly VAT returns\n- `QUARTERLY`: real normal regime, quarterly VAT returns\n- `SIMPLIFIED`: simplified regime, annual VAT returns\n- `EXEMPT`: VAT exemption (franchise en base de TVA)\n",
"parameters": [
{
"name": "uuid",
"in": "path",
"description": "LegalEntity identifier",
"required": true,
"deprecated": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false
}
],
"requestBody": {
"description": "The updated LegalEntity resource",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/LegalEntity.VatRegimeInput"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/LegalEntity.VatRegimeInput"
}
}
},
"required": true
}
}
},
"/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.LegalEntitySubAccountOutput.jsonld collection.",
"allOf": [
{
"$ref": "#/components/schemas/HydraCollectionBaseSchema"
},
{
"type": "object",
"required": [
"hydra:member"
],
"properties": {
"hydra:member": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LegalEntitySubAccount.LegalEntitySubAccountOutput.jsonld"
}
}
}
}
]
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LegalEntitySubAccount.LegalEntitySubAccountOutput"
}
}
}
}
}
},
"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.LegalEntitySubAccountOutput.jsonld"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/LegalEntitySubAccount.LegalEntitySubAccountOutput"
}
}
},
"links": {}
},
"400": {
"description": "Invalid input",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/Error.jsonld"
}
},
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"links": {}
},
"422": {
"description": "An error occurred",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/ConstraintViolation.jsonld"
}
},
"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.LegalEntitySubAccountOutput.jsonld"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/LegalEntitySubAccount.LegalEntitySubAccountOutput"
}
}
}
},
"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
}
]
}
},
"/legal-entities/{legalEntityUuid}/offices": {
"get": {
"operationId": "api_legal-entities_legalEntityUuidoffices_get_collection",
"tags": [
"Office"
],
"responses": {
"200": {
"description": "Office collection",
"content": {
"application/ld+json": {
"schema": {
"type": "object",
"description": "Office.OfficeOutput.jsonld collection.",
"allOf": [
{
"$ref": "#/components/schemas/HydraCollectionBaseSchema"
},
{
"type": "object",
"required": [
"hydra:member"
],
"properties": {
"hydra:member": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Office.OfficeOutput.jsonld"
}
}
}
}
]
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Office.OfficeOutput"
}
}
}
}
},
"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": "List the offices of a legal entity",
"description": "Returns the offices of the legal entity identified by `legalEntityUuid`, sorted by most recent first.",
"parameters": [
{
"name": "legalEntityUuid",
"in": "path",
"description": "The Legal Entity 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
},
{
"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 office name as a case-insensitive substring (e.g. `?displayName=aris` matches \"Paris HQ\").",
"required": false,
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": true
},
{
"name": "displayName[]",
"in": "query",
"description": "Filter by office name as a case-insensitive substring (e.g. `?displayName=aris` matches \"Paris HQ\").",
"required": false,
"deprecated": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"style": "deepObject",
"explode": true
}
]
},
"post": {
"operationId": "api_legal-entities_legalEntityUuidoffices_post",
"tags": [
"Office"
],
"responses": {
"201": {
"description": "Office resource created",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/Office.OfficeOutput.jsonld"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Office.OfficeOutput"
}
}
},
"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": "Create an office from its SIRET",
"description": "Validates the SIRET against the French directory, checks it belongs to the legal entity identified by `legalEntityUuid`, then creates a corresponding record on the platform.",
"parameters": [
{
"name": "legalEntityUuid",
"in": "path",
"description": "LegalEntity identifier",
"required": true,
"deprecated": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false
}
],
"requestBody": {
"description": "The new Office resource",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/Office.OfficeCreateInput"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Office.OfficeCreateInput"
}
}
},
"required": true
}
}
},
"/legal-entities/{legalEntityUuid}/offices/{uuid}": {
"get": {
"operationId": "api_legal-entities_legalEntityUuidoffices_uuid_get",
"tags": [
"Office"
],
"responses": {
"200": {
"description": "Office resource",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/Office.OfficeOutput.jsonld"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Office.OfficeOutput"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/Error.jsonld"
}
},
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"links": {}
},
"404": {
"description": "Not found",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/Error.jsonld"
}
},
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"links": {}
}
},
"summary": "Get one office of a legal entity by uuid",
"description": "Returns the office matching `uuid`. Responds 404 if the uuid is unknown.",
"parameters": [
{
"name": "legalEntityUuid",
"in": "path",
"description": "LegalEntity identifier",
"required": true,
"deprecated": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false
},
{
"name": "uuid",
"in": "path",
"description": "Office identifier",
"required": true,
"deprecated": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false
}
]
},
"delete": {
"operationId": "api_legal-entities_legalEntityUuidoffices_uuid_delete",
"tags": [
"Office"
],
"responses": {
"204": {
"description": "Office resource deleted"
},
"403": {
"description": "Forbidden",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/Error.jsonld"
}
},
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"links": {}
},
"404": {
"description": "Not found",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/Error.jsonld"
}
},
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"links": {}
}
},
"summary": "Delete an office by uuid",
"description": "Deletes the office matching `uuid`. Removal is permanent and the office will be delisted from the French directory.",
"parameters": [
{
"name": "legalEntityUuid",
"in": "path",
"description": "LegalEntity identifier",
"required": true,
"deprecated": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false
},
{
"name": "uuid",
"in": "path",
"description": "Office identifier",
"required": true,
"deprecated": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false
}
]
}
},
"/legal-entities/{legalEntityUuid}/offices/{uuid}/register": {
"put": {
"operationId": "api_legal-entities_legalEntityUuidoffices_uuidregister_put",
"tags": [
"Office"
],
"responses": {
"200": {
"description": "Office resource updated",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/Office.OfficeOutput.jsonld"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Office.OfficeOutput"
}
}
},
"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": "Register an office on the network",
"description": "Registers the office identified by `uuid` on the network. The `0225:siren_siret` address is registered on the first call and left untouched afterwards. `suffixes` declares the complete set of `0225:siren_siret_suffix` routing code addresses: entries not registered yet are added, and addresses missing from the body are removed. An omitted body therefore removes every routing code address.",
"parameters": [
{
"name": "legalEntityUuid",
"in": "path",
"description": "LegalEntity identifier",
"required": true,
"deprecated": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false
},
{
"name": "uuid",
"in": "path",
"description": "Office identifier",
"required": true,
"deprecated": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false
}
],
"requestBody": {
"description": "The updated Office resource",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/Office.NetworkRegisterInput"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Office.NetworkRegisterInput"
}
}
},
"required": true
}
}
},
"/legal-entities/{legalEntityUuid}/b2b-payments": {
"get": {
"operationId": "api_legal-entities_legalEntityUuidb2b-payments_get_collection",
"tags": [
"Reporting"
],
"responses": {
"200": {
"description": "B2bPaymentReport collection",
"content": {
"application/ld+json": {
"schema": {
"type": "object",
"description": "B2bPaymentReport.B2bPaymentReportOutput.jsonld collection.",
"allOf": [
{
"$ref": "#/components/schemas/HydraCollectionBaseSchema"
},
{
"type": "object",
"required": [
"hydra:member"
],
"properties": {
"hydra:member": {
"type": "array",
"items": {
"$ref": "#/components/schemas/B2bPaymentReport.B2bPaymentReportOutput.jsonld"
}
}
}
}
]
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/B2bPaymentReport.B2bPaymentReportOutput"
}
}
}
}
},
"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": "List the B2B payment reports of a legal entity",
"description": "Returns the B2B invoice payment reports submitted for the legal entity identified by `legalEntityUuid`, sorted by most recent first.",
"parameters": [
{
"name": "legalEntityUuid",
"in": "path",
"description": "The Legal Entity 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
},
{
"name": "invoiceId",
"in": "query",
"description": "Filter by invoice identifier (exact match).",
"required": false,
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": true
},
{
"name": "invoiceId[]",
"in": "query",
"description": "Filter by invoice identifier (exact match).",
"required": false,
"deprecated": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"style": "deepObject",
"explode": true
},
{
"name": "paymentDate",
"in": "query",
"description": "Filter by payment date (exact match, format YYYY-MM-DD).",
"required": false,
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": true
},
{
"name": "paymentDate[]",
"in": "query",
"description": "Filter by payment date (exact match, format YYYY-MM-DD).",
"required": false,
"deprecated": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"style": "deepObject",
"explode": true
}
]
},
"post": {
"operationId": "api_legal-entities_legalEntityUuidb2b-payments_post",
"tags": [
"Reporting"
],
"responses": {
"202": {
"description": "B2bPaymentReport resource created",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/B2bPaymentReport.B2bPaymentReportOutput.jsonld"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/B2bPaymentReport.B2bPaymentReportOutput"
}
}
},
"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": "Report a B2B invoice payment for a legal entity",
"description": "Submit the payment of a B2B invoice to the tax reporting service\nfor the legal entity identified by `uuid`.\n\nUse this to declare collected VAT once a B2B invoice with\npayment-based VAT is paid.\n\nThe legal entity must be in **ONBOARDED** status.",
"parameters": [
{
"name": "legalEntityUuid",
"in": "path",
"description": "The Legal Entity identifier",
"required": true,
"deprecated": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false
}
],
"requestBody": {
"description": "The new B2bPaymentReport resource",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/B2bPaymentReport.B2bPaymentReportInput"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/B2bPaymentReport.B2bPaymentReportInput"
}
}
},
"required": true
}
}
},
"/legal-entities/{legalEntityUuid}/b2b-payments/{uuid}": {
"get": {
"operationId": "api_legal-entities_legalEntityUuidb2b-payments_uuid_get",
"tags": [
"Reporting"
],
"responses": {
"200": {
"description": "B2bPaymentReport resource",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/B2bPaymentReport.B2bPaymentReportOutput.jsonld"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/B2bPaymentReport.B2bPaymentReportOutput"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/Error.jsonld"
}
},
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"links": {}
},
"404": {
"description": "Not found",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/Error.jsonld"
}
},
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"links": {}
}
},
"summary": "Get one B2B payment report by uuid",
"description": "Returns the B2B payment report matching `uuid`.",
"parameters": [
{
"name": "legalEntityUuid",
"in": "path",
"description": "LegalEntity identifier",
"required": true,
"deprecated": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false
},
{
"name": "uuid",
"in": "path",
"description": "B2bPaymentReport identifier",
"required": true,
"deprecated": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false
}
]
},
"put": {
"operationId": "api_legal-entities_legalEntityUuidb2b-payments_uuid_put",
"tags": [
"Reporting"
],
"responses": {
"202": {
"description": "B2bPaymentReport resource updated",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/B2bPaymentReport.B2bPaymentReportOutput.jsonld"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/B2bPaymentReport.B2bPaymentReportOutput"
}
}
},
"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": "Update a B2B payment report",
"description": "Replaces the B2B payment report matching `uuid` with the submitted payload,\nwhich has the same shape as the creation payload.",
"parameters": [
{
"name": "legalEntityUuid",
"in": "path",
"description": "LegalEntity identifier",
"required": true,
"deprecated": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false
},
{
"name": "uuid",
"in": "path",
"description": "B2bPaymentReport identifier",
"required": true,
"deprecated": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false
}
],
"requestBody": {
"description": "The updated B2bPaymentReport resource",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/B2bPaymentReport.B2bPaymentReportInput"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/B2bPaymentReport.B2bPaymentReportInput"
}
}
},
"required": true
}
},
"delete": {
"operationId": "api_legal-entities_legalEntityUuidb2b-payments_uuid_delete",
"tags": [
"Reporting"
],
"responses": {
"204": {
"description": "B2bPaymentReport 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": "Cancel a B2B payment report",
"description": "Cancels the B2B payment report matching `uuid`. The report is not removed:\nit stays readable with `cancelledAt` set to the cancellation date.",
"parameters": [
{
"name": "legalEntityUuid",
"in": "path",
"description": "LegalEntity identifier",
"required": true,
"deprecated": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false
},
{
"name": "uuid",
"in": "path",
"description": "B2bPaymentReport identifier",
"required": true,
"deprecated": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false
}
]
}
},
"/legal-entities/{legalEntityUuid}/b2b-transactions": {
"get": {
"operationId": "api_legal-entities_legalEntityUuidb2b-transactions_get_collection",
"tags": [
"Reporting"
],
"responses": {
"200": {
"description": "B2bTransactionReport collection",
"content": {
"application/ld+json": {
"schema": {
"type": "object",
"description": "B2bTransactionReport.B2bTransactionReportOutput.jsonld collection.",
"allOf": [
{
"$ref": "#/components/schemas/HydraCollectionBaseSchema"
},
{
"type": "object",
"required": [
"hydra:member"
],
"properties": {
"hydra:member": {
"type": "array",
"items": {
"$ref": "#/components/schemas/B2bTransactionReport.B2bTransactionReportOutput.jsonld"
}
}
}
}
]
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/B2bTransactionReport.B2bTransactionReportOutput"
}
}
}
}
},
"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": "List the B2B invoice reports of a legal entity",
"description": "Returns the B2B invoice reports submitted for the legal entity identified by `legalEntityUuid`, sorted by most recent first.",
"parameters": [
{
"name": "legalEntityUuid",
"in": "path",
"description": "The Legal Entity 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
},
{
"name": "invoiceId",
"in": "query",
"description": "Filter by invoice identifier (exact match).",
"required": false,
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": true
},
{
"name": "invoiceId[]",
"in": "query",
"description": "Filter by invoice identifier (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).",
"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).",
"required": false,
"deprecated": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"style": "deepObject",
"explode": true
}
]
},
"post": {
"operationId": "api_legal-entities_legalEntityUuidb2b-transactions_post",
"tags": [
"Reporting"
],
"responses": {
"202": {
"description": "B2bTransactionReport resource created",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/B2bTransactionReport.B2bTransactionReportOutput.jsonld"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/B2bTransactionReport.B2bTransactionReportOutput"
}
}
},
"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": "Report a B2B invoice for a legal entity",
"description": "Submit a structured B2B invoice to the tax reporting service\nfor the legal entity identified by `uuid`.\n\nThe legal entity must be in **ONBOARDED** status.\n\n**Process types (`processType`):**\n- `B1`/`S1`/`M1`: goods / services / mixed invoice\n- `B2`/`S2`/`M2`: goods / services / mixed invoice, already paid\n- `B4`/`S4`/`M4`: final invoice after a down payment\n- `S5`/`S6`: subcontractor / co-contractor services invoice\n- `B7`/`S7`: goods / services invoice, e-reporting of VAT collected",
"parameters": [
{
"name": "legalEntityUuid",
"in": "path",
"description": "The Legal Entity identifier",
"required": true,
"deprecated": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false
}
],
"requestBody": {
"description": "The new B2bTransactionReport resource",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/B2bTransactionReport.B2bTransactionReportInput"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/B2bTransactionReport.B2bTransactionReportInput"
}
}
},
"required": true
}
}
},
"/legal-entities/{legalEntityUuid}/b2b-transactions/{uuid}": {
"get": {
"operationId": "api_legal-entities_legalEntityUuidb2b-transactions_uuid_get",
"tags": [
"Reporting"
],
"responses": {
"200": {
"description": "B2bTransactionReport resource",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/B2bTransactionReport.B2bTransactionReportOutput.jsonld"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/B2bTransactionReport.B2bTransactionReportOutput"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/Error.jsonld"
}
},
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"links": {}
},
"404": {
"description": "Not found",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/Error.jsonld"
}
},
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"links": {}
}
},
"summary": "Get one B2B invoice report by uuid",
"description": "Returns the B2B invoice report matching `uuid`.",
"parameters": [
{
"name": "legalEntityUuid",
"in": "path",
"description": "LegalEntity identifier",
"required": true,
"deprecated": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false
},
{
"name": "uuid",
"in": "path",
"description": "B2bTransactionReport identifier",
"required": true,
"deprecated": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false
}
]
},
"put": {
"operationId": "api_legal-entities_legalEntityUuidb2b-transactions_uuid_put",
"tags": [
"Reporting"
],
"responses": {
"202": {
"description": "B2bTransactionReport resource updated",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/B2bTransactionReport.B2bTransactionReportOutput.jsonld"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/B2bTransactionReport.B2bTransactionReportOutput"
}
}
},
"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": "Update a B2B transaction report",
"description": "Replaces the B2B transaction report matching `uuid` with the submitted payload,\nwhich has the same shape as the creation payload.",
"parameters": [
{
"name": "legalEntityUuid",
"in": "path",
"description": "LegalEntity identifier",
"required": true,
"deprecated": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false
},
{
"name": "uuid",
"in": "path",
"description": "B2bTransactionReport identifier",
"required": true,
"deprecated": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false
}
],
"requestBody": {
"description": "The updated B2bTransactionReport resource",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/B2bTransactionReport.B2bTransactionReportInput"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/B2bTransactionReport.B2bTransactionReportInput"
}
}
},
"required": true
}
},
"delete": {
"operationId": "api_legal-entities_legalEntityUuidb2b-transactions_uuid_delete",
"tags": [
"Reporting"
],
"responses": {
"204": {
"description": "B2bTransactionReport 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": "Cancel a B2B transaction report",
"description": "Cancels the B2B transaction report matching `uuid`. The report is not removed:\nit stays readable with `cancelledAt` set to the cancellation date.\nis already cancelled.",
"parameters": [
{
"name": "legalEntityUuid",
"in": "path",
"description": "LegalEntity identifier",
"required": true,
"deprecated": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false
},
{
"name": "uuid",
"in": "path",
"description": "B2bTransactionReport identifier",
"required": true,
"deprecated": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false
}
]
}
},
"/legal-entities/{legalEntityUuid}/b2c-payments": {
"get": {
"operationId": "api_legal-entities_legalEntityUuidb2c-payments_get_collection",
"tags": [
"Reporting"
],
"responses": {
"200": {
"description": "B2cPaymentReport collection",
"content": {
"application/ld+json": {
"schema": {
"type": "object",
"description": "B2cPaymentReport.B2cPaymentReportOutput.jsonld collection.",
"allOf": [
{
"$ref": "#/components/schemas/HydraCollectionBaseSchema"
},
{
"type": "object",
"required": [
"hydra:member"
],
"properties": {
"hydra:member": {
"type": "array",
"items": {
"$ref": "#/components/schemas/B2cPaymentReport.B2cPaymentReportOutput.jsonld"
}
}
}
}
]
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/B2cPaymentReport.B2cPaymentReportOutput"
}
}
}
}
},
"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": "List the B2C payment reports of a legal entity",
"description": "Returns the B2C payment reports submitted for the legal entity identified by `legalEntityUuid`, sorted by most recent first.",
"parameters": [
{
"name": "legalEntityUuid",
"in": "path",
"description": "The Legal Entity 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
},
{
"name": "paymentDate",
"in": "query",
"description": "Filter by payment date (exact match, format YYYY-MM-DD).",
"required": false,
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": true
},
{
"name": "paymentDate[]",
"in": "query",
"description": "Filter by payment date (exact match, format YYYY-MM-DD).",
"required": false,
"deprecated": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"style": "deepObject",
"explode": true
}
]
},
"post": {
"operationId": "api_legal-entities_legalEntityUuidb2c-payments_post",
"tags": [
"Reporting"
],
"responses": {
"202": {
"description": "B2cPaymentReport resource created",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/B2cPaymentReport.B2cPaymentReportOutput.jsonld"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/B2cPaymentReport.B2cPaymentReportOutput"
}
}
},
"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": "Report B2C payments for a legal entity",
"description": "Submit a batch of B2C payments to the tax reporting service\nfor the legal entity identified by `uuid`.\n\nThe legal entity must be in **ONBOARDED** status.",
"parameters": [
{
"name": "legalEntityUuid",
"in": "path",
"description": "The Legal Entity identifier",
"required": true,
"deprecated": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false
}
],
"requestBody": {
"description": "The new B2cPaymentReport resource",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/B2cPaymentReport.B2cPaymentReportInput"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/B2cPaymentReport.B2cPaymentReportInput"
}
}
},
"required": true
}
}
},
"/legal-entities/{legalEntityUuid}/b2c-payments/{uuid}": {
"get": {
"operationId": "api_legal-entities_legalEntityUuidb2c-payments_uuid_get",
"tags": [
"Reporting"
],
"responses": {
"200": {
"description": "B2cPaymentReport resource",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/B2cPaymentReport.B2cPaymentReportOutput.jsonld"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/B2cPaymentReport.B2cPaymentReportOutput"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/Error.jsonld"
}
},
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"links": {}
},
"404": {
"description": "Not found",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/Error.jsonld"
}
},
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"links": {}
}
},
"summary": "Get one B2C payment report by uuid",
"description": "Returns the B2C payment report matching `uuid`.",
"parameters": [
{
"name": "legalEntityUuid",
"in": "path",
"description": "LegalEntity identifier",
"required": true,
"deprecated": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false
},
{
"name": "uuid",
"in": "path",
"description": "B2cPaymentReport identifier",
"required": true,
"deprecated": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false
}
]
},
"put": {
"operationId": "api_legal-entities_legalEntityUuidb2c-payments_uuid_put",
"tags": [
"Reporting"
],
"responses": {
"202": {
"description": "B2cPaymentReport resource updated",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/B2cPaymentReport.B2cPaymentReportOutput.jsonld"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/B2cPaymentReport.B2cPaymentReportOutput"
}
}
},
"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": "Update a B2C payment report",
"description": "Replaces the B2C payment report matching `uuid` with the submitted payload,\nwhich has the same shape as the creation payload.",
"parameters": [
{
"name": "legalEntityUuid",
"in": "path",
"description": "LegalEntity identifier",
"required": true,
"deprecated": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false
},
{
"name": "uuid",
"in": "path",
"description": "B2cPaymentReport identifier",
"required": true,
"deprecated": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false
}
],
"requestBody": {
"description": "The updated B2cPaymentReport resource",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/B2cPaymentReport.B2cPaymentReportInput"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/B2cPaymentReport.B2cPaymentReportInput"
}
}
},
"required": true
}
},
"delete": {
"operationId": "api_legal-entities_legalEntityUuidb2c-payments_uuid_delete",
"tags": [
"Reporting"
],
"responses": {
"204": {
"description": "B2cPaymentReport 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": "Cancel a B2C payment report",
"description": "Cancels the B2C payment report matching `uuid`. The report is not removed:\nit stays readable with `cancelledAt` set to the cancellation date.",
"parameters": [
{
"name": "legalEntityUuid",
"in": "path",
"description": "LegalEntity identifier",
"required": true,
"deprecated": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false
},
{
"name": "uuid",
"in": "path",
"description": "B2cPaymentReport identifier",
"required": true,
"deprecated": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false
}
]
}
},
"/legal-entities/{legalEntityUuid}/b2c-transactions": {
"get": {
"operationId": "api_legal-entities_legalEntityUuidb2c-transactions_get_collection",
"tags": [
"Reporting"
],
"responses": {
"200": {
"description": "B2cTransactionReport collection",
"content": {
"application/ld+json": {
"schema": {
"type": "object",
"description": "B2cTransactionReport.B2cTransactionReportOutput.jsonld collection.",
"allOf": [
{
"$ref": "#/components/schemas/HydraCollectionBaseSchema"
},
{
"type": "object",
"required": [
"hydra:member"
],
"properties": {
"hydra:member": {
"type": "array",
"items": {
"$ref": "#/components/schemas/B2cTransactionReport.B2cTransactionReportOutput.jsonld"
}
}
}
}
]
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/B2cTransactionReport.B2cTransactionReportOutput"
}
}
}
}
},
"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": "List the B2C transaction reports of a legal entity",
"description": "Returns the B2C transaction reports submitted for the legal entity identified by `legalEntityUuid`, sorted by most recent first.",
"parameters": [
{
"name": "legalEntityUuid",
"in": "path",
"description": "The Legal Entity 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
},
{
"name": "transactionDate",
"in": "query",
"description": "Filter by transaction date (exact match, format YYYY-MM-DD).",
"required": false,
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": true
},
{
"name": "transactionDate[]",
"in": "query",
"description": "Filter by transaction date (exact match, format YYYY-MM-DD).",
"required": false,
"deprecated": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"style": "deepObject",
"explode": true
}
]
},
"post": {
"operationId": "api_legal-entities_legalEntityUuidb2c-transactions_post",
"tags": [
"Reporting"
],
"responses": {
"202": {
"description": "B2cTransactionReport resource created",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/B2cTransactionReport.B2cTransactionReportOutput.jsonld"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/B2cTransactionReport.B2cTransactionReportOutput"
}
}
},
"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": "Report B2C transactions for a legal entity",
"description": "Submit a batch of B2C transaction data to the tax reporting service\nfor the legal entity identified by `uuid`.\n\nThe legal entity must be in **ONBOARDED** status.\n\n**Category codes:**\n- `TLB1`: Supply of goods subject to VAT\n- `TPS1`: Services subject to VAT (`taxPaymentOption` is **mandatory**)\n- `TNT1`: Transactions not subject to VAT in France\n- `TMA1`: Transactions under the VAT margin scheme",
"parameters": [
{
"name": "legalEntityUuid",
"in": "path",
"description": "The Legal Entity identifier",
"required": true,
"deprecated": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false
}
],
"requestBody": {
"description": "The new B2cTransactionReport resource",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/B2cTransactionReport.B2cTransactionReportInput"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/B2cTransactionReport.B2cTransactionReportInput"
}
}
},
"required": true
}
}
},
"/legal-entities/{legalEntityUuid}/b2c-transactions/{uuid}": {
"get": {
"operationId": "api_legal-entities_legalEntityUuidb2c-transactions_uuid_get",
"tags": [
"Reporting"
],
"responses": {
"200": {
"description": "B2cTransactionReport resource",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/B2cTransactionReport.B2cTransactionReportOutput.jsonld"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/B2cTransactionReport.B2cTransactionReportOutput"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/Error.jsonld"
}
},
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"links": {}
},
"404": {
"description": "Not found",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/Error.jsonld"
}
},
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"links": {}
}
},
"summary": "Get one B2C transaction report by uuid",
"description": "Returns the B2C transaction report matching `uuid`.",
"parameters": [
{
"name": "legalEntityUuid",
"in": "path",
"description": "LegalEntity identifier",
"required": true,
"deprecated": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false
},
{
"name": "uuid",
"in": "path",
"description": "B2cTransactionReport identifier",
"required": true,
"deprecated": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false
}
]
},
"put": {
"operationId": "api_legal-entities_legalEntityUuidb2c-transactions_uuid_put",
"tags": [
"Reporting"
],
"responses": {
"202": {
"description": "B2cTransactionReport resource updated",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/B2cTransactionReport.B2cTransactionReportOutput.jsonld"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/B2cTransactionReport.B2cTransactionReportOutput"
}
}
},
"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": "Update a B2C transaction report",
"description": "Replaces the B2C transaction report matching `uuid` with the submitted payload,\nwhich has the same shape as the creation payload.",
"parameters": [
{
"name": "legalEntityUuid",
"in": "path",
"description": "LegalEntity identifier",
"required": true,
"deprecated": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false
},
{
"name": "uuid",
"in": "path",
"description": "B2cTransactionReport identifier",
"required": true,
"deprecated": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false
}
],
"requestBody": {
"description": "The updated B2cTransactionReport resource",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/B2cTransactionReport.B2cTransactionReportInput"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/B2cTransactionReport.B2cTransactionReportInput"
}
}
},
"required": true
}
},
"delete": {
"operationId": "api_legal-entities_legalEntityUuidb2c-transactions_uuid_delete",
"tags": [
"Reporting"
],
"responses": {
"204": {
"description": "B2cTransactionReport 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": "Cancel a B2C transaction report",
"description": "Cancels the B2C transaction report matching `uuid`. The report is not removed:\nit stays readable with `cancelledAt` set to the cancellation date.",
"parameters": [
{
"name": "legalEntityUuid",
"in": "path",
"description": "LegalEntity identifier",
"required": true,
"deprecated": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false
},
{
"name": "uuid",
"in": "path",
"description": "B2cTransactionReport identifier",
"required": true,
"deprecated": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false
}
]
}
},
"/user-configs": {
"get": {
"operationId": "api_user-configs_get_collection",
"tags": [
"UserConfig"
],
"responses": {
"200": {
"description": "UserConfig collection",
"content": {
"application/ld+json": {
"schema": {
"type": "object",
"description": "UserConfig.UserConfigOutput.jsonld collection.",
"allOf": [
{
"$ref": "#/components/schemas/HydraCollectionBaseSchema"
},
{
"type": "object",
"required": [
"hydra:member"
],
"properties": {
"hydra:member": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserConfig.UserConfigOutput.jsonld"
}
}
}
}
]
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserConfig.UserConfigOutput"
}
}
}
}
}
},
"summary": "List user configurations",
"description": "Returns the stored configuration of every user of your account.",
"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": "email",
"in": "query",
"description": "Filter by user email exact match.",
"required": false,
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": true
},
{
"name": "email[]",
"in": "query",
"description": "Filter by user email exact match.",
"required": false,
"deprecated": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"style": "deepObject",
"explode": true
}
]
},
"post": {
"operationId": "api_user-configs_post",
"tags": [
"UserConfig"
],
"responses": {
"201": {
"description": "UserConfig resource created",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/UserConfig.UserConfigOutput.jsonld"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserConfig.UserConfigOutput"
}
}
},
"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 user configuration",
"description": "Creates the configuration of the user matching the given email, registering that email as a sub-account of your account when it is not one yet.",
"parameters": [],
"requestBody": {
"description": "The new UserConfig resource",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/UserConfig.UserConfigCreateInput"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserConfig.UserConfigCreateInput"
}
}
},
"required": true
}
}
},
"/user-configs/{uuid}": {
"get": {
"operationId": "api_user-configs_uuid_get",
"tags": [
"UserConfig"
],
"responses": {
"200": {
"description": "UserConfig resource",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/UserConfig.UserConfigOutput.jsonld"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserConfig.UserConfigOutput"
}
}
}
},
"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 a user configuration",
"description": "Returns the corresponding user configuration by uuid.",
"parameters": [
{
"name": "uuid",
"in": "path",
"description": "UserConfig identifier",
"required": true,
"deprecated": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false
}
]
},
"put": {
"operationId": "api_user-configs_uuid_put",
"tags": [
"UserConfig"
],
"responses": {
"200": {
"description": "UserConfig resource updated",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/UserConfig.UserConfigOutput.jsonld"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserConfig.UserConfigOutput"
}
}
},
"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 a user configuration",
"description": "Updates the configuration matching uuid. The user it belongs to is immutable: create a separate configuration to target another email.",
"parameters": [
{
"name": "uuid",
"in": "path",
"description": "UserConfig identifier",
"required": true,
"deprecated": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false
}
],
"requestBody": {
"description": "The updated UserConfig resource",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/UserConfig.UserConfigUpdateInput"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserConfig.UserConfigUpdateInput"
}
}
},
"required": true
}
}
}
},
"components": {
"schemas": {
"B2bAllowanceInput": {
"type": "object",
"required": [
"actualAmount",
"taxCategoryCode"
],
"properties": {
"actualAmount": {
"type": "string"
},
"taxCategoryCode": {
"enum": [
"S",
"Z",
"E",
"AE",
"K",
"G",
"O",
"L",
"M"
],
"description": "VAT category code (UNCL5305)",
"externalDocs": {
"url": "https://service.unece.org/trade/untdid/d99a/uncl/uncl5305.htm"
},
"example": "S",
"type": "string"
},
"basisAmount": {
"type": [
"string",
"null"
]
},
"calculationPercent": {
"type": [
"string",
"null"
]
},
"taxPercent": {
"type": [
"string",
"null"
]
},
"reason": {
"type": [
"string",
"null"
]
},
"reasonCode": {
"enum": [
"41",
"42",
"60",
"62",
"63",
"64",
"65",
"66",
"67",
"68",
"70",
"71",
"88",
"95",
"100",
"102",
"103",
"104",
"105"
],
"description": "UNCL5189 allowance reason code",
"externalDocs": {
"url": "https://service.unece.org/trade/untdid/d99a/uncl/uncl5189.htm"
},
"type": [
"string",
"null"
]
}
}
},
"B2bAttachmentInput": {
"type": "object",
"required": [
"reference",
"description"
],
"properties": {
"reference": {
"description": "Attachment reference",
"type": "string"
},
"description": {
"description": "Attachment description",
"type": "string"
},
"externalUrl": {
"description": "External URL to the document",
"type": [
"string",
"null"
]
},
"data": {
"description": "Base64-encoded document content",
"type": [
"string",
"null"
]
},
"mimeType": {
"type": [
"string",
"null"
]
},
"filename": {
"type": [
"string",
"null"
]
}
}
},
"B2bChargeInput": {
"type": "object",
"required": [
"actualAmount",
"taxCategoryCode"
],
"properties": {
"actualAmount": {
"type": "string"
},
"taxCategoryCode": {
"enum": [
"S",
"Z",
"E",
"AE",
"K",
"G",
"O",
"L",
"M"
],
"description": "VAT category code (UNCL5305)",
"externalDocs": {
"url": "https://service.unece.org/trade/untdid/d99a/uncl/uncl5305.htm"
},
"example": "S",
"type": "string"
},
"basisAmount": {
"type": [
"string",
"null"
]
},
"calculationPercent": {
"type": [
"string",
"null"
]
},
"taxPercent": {
"type": [
"string",
"null"
]
},
"reason": {
"type": [
"string",
"null"
]
},
"reasonCode": {
"enum": [
"AA",
"AAA",
"AAC",
"AAD",
"AAE",
"AAF",
"AAH",
"AAI",
"AAS",
"AAT",
"AAV",
"AAY",
"AAZ",
"ABA",
"ABB",
"ABC",
"ABD",
"ABF",
"ABK",
"ABL",
"ABN",
"ABR",
"ABS",
"ABT",
"ABU",
"ACF",
"ACG",
"ACH",
"ACI",
"ACJ",
"ACK",
"ACL",
"ACM",
"ACS",
"ADC",
"ADE",
"ADJ",
"ADK",
"ADL",
"ADM",
"ADN",
"ADO",
"ADP",
"ADQ",
"ADR",
"ADT",
"ADW",
"ADY",
"ADZ",
"AEA",
"AEB",
"AEC",
"AED",
"AEF",
"AEH",
"AEI",
"AEJ",
"AEK",
"AEL",
"AEM",
"AEN",
"AEO",
"AEP",
"AES",
"AET",
"AEU",
"AEV",
"AEW",
"AEX",
"AEY",
"AEZ",
"AJ",
"AU",
"CA",
"CAB",
"CAD",
"CAE",
"CAF",
"CAI",
"CAJ",
"CAK",
"CAL",
"CAM",
"CAN",
"CAO",
"CAP",
"CAQ",
"CAR",
"CAS",
"CAT",
"CAU",
"CAV",
"CAW",
"CAX",
"CAY",
"CAZ",
"CD",
"CG",
"CS",
"CT",
"DAB",
"DAC",
"DAD",
"DAF",
"DAG",
"DAH",
"DAI",
"DAJ",
"DAK",
"DAL",
"DAM",
"DAN",
"DAO",
"DAP",
"DAQ",
"DL",
"EG",
"EP",
"ER",
"FAA",
"FAB",
"FAC",
"FC",
"FH",
"FI",
"GAA",
"HAA",
"HD",
"HH",
"IAA",
"IAB",
"ID",
"IF",
"IR",
"IS",
"KO",
"L1",
"LA",
"LAA",
"LAB",
"LF",
"MAE",
"MI",
"ML",
"NAA",
"OA",
"PA",
"PAA",
"PC",
"PL",
"RAB",
"RAC",
"RAD",
"RAF",
"RE",
"RF",
"RH",
"RV",
"SA",
"SAA",
"SAD",
"SAE",
"SAI",
"SG",
"SH",
"SM",
"SU",
"TAB",
"TAC",
"TT",
"TV",
"V1",
"V2",
"WH",
"XAA",
"YY",
"ZZZ"
],
"description": "UNCL7161 charge reason code",
"externalDocs": {
"url": "https://service.unece.org/trade/untdid/d99a/uncl/uncl7161.htm"
},
"type": [
"string",
"null"
]
}
}
},
"B2bNoteInput": {
"type": "object",
"required": [
"content"
],
"properties": {
"content": {
"description": "Note content",
"type": "string"
},
"typeCode": {
"enum": [
"AAA",
"AAB",
"AAC",
"AAD",
"AAE",
"AAF",
"AAG",
"AAI",
"AAJ",
"AAK",
"AAL",
"AAM",
"AAN",
"AAO",
"AAP",
"AAQ",
"AAR",
"AAS",
"AAT",
"AAU",
"AAV",
"AAW",
"AAX",
"AAY",
"AAZ",
"ABA",
"ABB",
"ABC",
"ABD",
"ABE",
"ABF",
"ABG",
"ABH",
"ABI",
"ABJ",
"ABK",
"ABL",
"ABM",
"ABN",
"ABO",
"ABP",
"ABQ",
"ABR",
"ABS",
"ABT",
"ABU",
"ABV",
"ABW",
"ABX",
"ABZ",
"ACA",
"ACB",
"ACC",
"ACD",
"ACE",
"ACF",
"ACG",
"ACH",
"ACI",
"ACJ",
"ACK",
"ACL",
"ACM",
"ACN",
"ACO",
"ACP",
"ACQ",
"ACR",
"ACS",
"ACT",
"ACU",
"ACV",
"ACW",
"ACX",
"ACY",
"ACZ",
"ADA",
"ADB",
"ADC",
"ADD",
"ADE",
"ADF",
"ADG",
"ADH",
"ADI",
"ADJ",
"ADK",
"ADL",
"ADM",
"ADN",
"ADO",
"ADP",
"ADQ",
"ADR",
"ADS",
"ADT",
"ADU",
"ADV",
"ADW",
"ADX",
"ADY",
"ADZ",
"AEA",
"AEB",
"AEC",
"AED",
"AEE",
"AEF",
"AEG",
"AEH",
"AEI",
"AEJ",
"AEK",
"AEL",
"AEM",
"AEN",
"AEO",
"AEP",
"AEQ",
"AER",
"AES",
"AET",
"AEU",
"AEV",
"AEW",
"AEX",
"AEY",
"AEZ",
"AFA",
"AFB",
"AFC",
"AFD",
"AFE",
"AFF",
"AFG",
"AFH",
"AFI",
"AFJ",
"AFK",
"AFL",
"AFM",
"AFN",
"AFO",
"AFP",
"AFQ",
"AFR",
"AFS",
"AFT",
"AFU",
"AFV",
"AFW",
"AFX",
"AFY",
"AFZ",
"AGA",
"AGB",
"AGC",
"AGD",
"AGE",
"AGF",
"AGG",
"AGH",
"AGI",
"AGJ",
"AGK",
"AGL",
"AGM",
"AGN",
"AGO",
"AGP",
"AGQ",
"AGR",
"AGS",
"AGT",
"AGU",
"AGV",
"AGW",
"AGX",
"AGY",
"AGZ",
"AHA",
"AHB",
"AHC",
"AHD",
"AHE",
"AHF",
"AHG",
"AHH",
"AHI",
"AHJ",
"AHK",
"AHL",
"AHM",
"AHN",
"AHO",
"AHP",
"AHQ",
"AHR",
"AHS",
"AHT",
"AHU",
"AHV",
"AHW",
"AHX",
"AHY",
"AHZ",
"AIA",
"AIB",
"AIC",
"AID",
"AIE",
"AIF",
"AIG",
"AIH",
"AII",
"AIJ",
"AIK",
"AIL",
"AIM",
"AIN",
"AIO",
"AIP",
"AIQ",
"AIR",
"AIS",
"AIT",
"AIU",
"AIV",
"AIW",
"AIX",
"AIY",
"AIZ",
"AJA",
"AJB",
"ALC",
"ALD",
"ALE",
"ALF",
"ALG",
"ALH",
"ALI",
"ALJ",
"ALK",
"ALL",
"ALM",
"ALN",
"ALO",
"ALP",
"ALQ",
"ARR",
"ARS",
"AUT",
"AUU",
"AUV",
"AUW",
"AUX",
"AUY",
"AUZ",
"AVA",
"AVB",
"AVC",
"AVD",
"AVE",
"AVF",
"BAG",
"BAH",
"BAI",
"BAJ",
"BAK",
"BAL",
"BAM",
"BAN",
"BAO",
"BAP",
"BAQ",
"BAR",
"BAS",
"BLC",
"BLD",
"BLE",
"BLF",
"BLG",
"BLH",
"BLI",
"BLJ",
"BLK",
"BLL",
"BLM",
"BLN",
"BLO",
"BLP",
"BLQ",
"BLR",
"BLS",
"BLT",
"BLU",
"BLV",
"BLW",
"BLX",
"BLY",
"BLZ",
"BMA",
"BMB",
"BMC",
"BMD",
"BME",
"CCI",
"CEX",
"CHG",
"CIP",
"CLP",
"CLR",
"COI",
"CUR",
"CUS",
"DAR",
"DCL",
"DEL",
"DIN",
"DOC",
"DUT",
"EUR",
"FBC",
"GBL",
"GEN",
"GS7",
"HAN",
"HAZ",
"ICN",
"IIN",
"IMI",
"IND",
"INS",
"INV",
"IRP",
"ITR",
"ITS",
"LAN",
"LIN",
"LOI",
"MCO",
"MDH",
"MKS",
"ORI",
"OSI",
"PAC",
"PAI",
"PAY",
"PKG",
"PKT",
"PMD",
"PMT",
"PRD",
"PRF",
"PRI",
"PUR",
"QIN",
"QQD",
"QUT",
"RAH",
"REG",
"RET",
"REV",
"RQR",
"SAF",
"SIC",
"SIN",
"SLR",
"SPA",
"SPG",
"SPH",
"SPP",
"SPT",
"SRN",
"SSR",
"SUR",
"TCA",
"TDT",
"TRA",
"TRR",
"TXD",
"WHI",
"ZZZ"
],
"description": "UNCL4451 text subject code qualifier",
"externalDocs": {
"url": "https://service.unece.org/trade/untdid/d99a/uncl/uncl4451.htm"
},
"type": [
"string",
"null"
]
},
"typeDescription": {
"type": [
"string",
"null"
]
}
}
},
"B2bPartyInput": {
"type": "object",
"required": [
"name",
"vatNumber",
"country"
],
"properties": {
"name": {
"description": "Legal name of the party",
"example": "Acme SAS",
"type": "string"
},
"vatNumber": {
"description": "Intra-Community VAT number",
"example": "FR12345678901",
"type": "string"
},
"country": {
"description": "ISO 3166-1 alpha-2 country code",
"example": "FR",
"type": "string"
},
"siren": {
"type": [
"string",
"null"
]
},
"siret": {
"type": [
"string",
"null"
]
},
"identifierScheme": {
"description": "EAS scheme code identifying the identifier type",
"example": "0009",
"type": [
"string",
"null"
]
},
"identifierValue": {
"description": "Identifier value (e.g. electronic address)",
"type": [
"string",
"null"
]
},
"identifierType": {
"type": [
"string",
"null"
],
"enum": [
"electronic_identifier",
"party_identifier",
"legal_identifier",
null
]
}
}
},
"B2bPaymentItemInput": {
"type": "object",
"required": [
"collectedAmount",
"taxRate"
],
"properties": {
"collectedAmount": {
"pattern": "^(\\d+(\\.\\d{1,2})?)$",
"description": "Total collected amount, including tax. Up to 2 decimal places.",
"example": "100.00",
"type": "string"
},
"taxRate": {
"pattern": "^(\\d{1,3}(\\.\\d{1,2})?)$",
"description": "Tax rate applied to the payment. Up to 2 decimal places.",
"example": "20.00",
"type": "string"
}
}
},
"B2bPaymentMeansInput": {
"type": "object",
"required": [
"typeCode",
"paymentReference"
],
"properties": {
"typeCode": {
"enum": [
"1",
"2",
"3",
"4",
"5",
"6",
"7",
"8",
"9",
"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",
"37",
"38",
"39",
"40",
"41",
"42",
"43",
"44",
"45",
"46",
"47",
"48",
"49",
"50",
"51",
"52",
"53",
"54",
"55",
"56",
"57",
"58",
"59",
"60",
"61",
"62",
"63",
"64",
"65",
"66",
"67",
"68",
"69",
"70",
"74",
"75",
"76",
"77",
"78",
"91",
"92",
"93",
"94",
"95",
"96",
"97",
"ZZZ"
],
"description": "UNCL4461 payment means type code",
"externalDocs": {
"url": "https://service.unece.org/trade/untdid/d99a/uncl/uncl4461.htm"
},
"example": "30",
"type": "string"
},
"paymentReference": {
"description": "Payment reference",
"type": "string"
},
"label": {
"type": [
"string",
"null"
]
},
"iban": {
"type": [
"string",
"null"
]
},
"accountName": {
"type": [
"string",
"null"
]
},
"bic": {
"type": [
"string",
"null"
]
},
"cardId": {
"type": [
"string",
"null"
]
},
"cardHolderName": {
"type": [
"string",
"null"
]
}
}
},
"B2bPaymentReport.B2bPaymentReportInput": {
"type": "object",
"required": [
"invoiceId",
"invoiceDate",
"paymentDate"
],
"properties": {
"invoiceId": {
"description": "Identifier of the invoice the payment settles",
"example": "INV-001",
"type": "string"
},
"invoiceDate": {
"description": "Date of the invoice (YYYY-MM-DD)",
"externalDocs": {
"url": "https://schema.org/Date"
},
"example": "2026-07-15",
"type": "string"
},
"paymentDate": {
"description": "Date of the payment (YYYY-MM-DD)",
"externalDocs": {
"url": "https://schema.org/Date"
},
"example": "2026-07-31",
"type": "string"
},
"paymentDetails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/B2bPaymentItemInput"
}
}
}
},
"B2bPaymentReport.B2bPaymentReportOutput": {
"type": "object",
"properties": {
"uuid": {
"type": "string"
},
"siren": {
"type": "string"
},
"invoiceId": {
"type": "string"
},
"invoiceDate": {
"type": "string"
},
"paymentDate": {
"type": "string"
},
"totalAmount": {
"type": "string"
},
"cancelledAt": {
"type": [
"string",
"null"
]
}
}
},
"B2bPaymentReport.B2bPaymentReportOutput.jsonld": {
"allOf": [
{
"$ref": "#/components/schemas/HydraItemBaseSchema"
},
{
"type": "object",
"properties": {
"uuid": {
"type": "string"
},
"siren": {
"type": "string"
},
"invoiceId": {
"type": "string"
},
"invoiceDate": {
"type": "string"
},
"paymentDate": {
"type": "string"
},
"totalAmount": {
"type": "string"
},
"cancelledAt": {
"type": [
"string",
"null"
]
}
}
}
]
},
"B2bReferenceDataInput": {
"type": "object",
"properties": {
"buyerReferenceId": {
"type": [
"string",
"null"
]
},
"projectReferenceId": {
"type": [
"string",
"null"
]
},
"contractReferenceId": {
"type": [
"string",
"null"
]
},
"buyerOrderReferenceId": {
"type": [
"string",
"null"
]
},
"sellerOrderReferenceId": {
"type": [
"string",
"null"
]
},
"receiptDocumentReferenceId": {
"type": [
"string",
"null"
]
},
"despatchDocumentReferenceId": {
"type": [
"string",
"null"
]
},
"originatorDocumentReferenceId": {
"type": [
"string",
"null"
]
},
"accountingCostId": {
"type": [
"string",
"null"
]
},
"directDebitMandateId": {
"type": [
"string",
"null"
]
},
"creditorReferenceId": {
"type": [
"string",
"null"
]
},
"contractReferenceTypeId": {
"type": [
"string",
"null"
]
}
}
},
"B2bReferencedDocumentInput": {
"type": "object",
"required": [
"invoiceNumber",
"invoiceDate"
],
"properties": {
"invoiceNumber": {
"description": "Referenced invoice number",
"type": "string"
},
"invoiceDate": {
"description": "Referenced invoice date (YYYY-MM-DD)",
"externalDocs": {
"url": "https://schema.org/Date"
},
"example": "2026-01-15",
"type": "string"
},
"type": {
"enum": [
"APP",
"ADE",
"AGC",
"AFN",
"AV",
"ANA",
"AWQ",
"AOD",
"ASU",
"AP",
"AKO",
"AQQ",
"ACD",
"ACF",
"AWT",
"AMP",
"AWD",
"AJE",
"AGD",
"AGE",
"ALU",
"AJS",
"AGA",
"AC",
"AWB",
"AF",
"SEA",
"ABY",
"ADD",
"CFF",
"ABC",
"APT",
"AEH",
"AFQ",
"AGF",
"AUK",
"AGK",
"AKP",
"ABU",
"AEB",
"AFL",
"ASC",
"ACG",
"APV",
"AHB",
"AE",
"ANJ",
"ALF",
"AU",
"ATL",
"AAH",
"AII",
"ATG",
"AAI",
"AIK",
"ACX",
"AQZ",
"LS",
"BT",
"BTP",
"AQN",
"BA",
"BE",
"AFS",
"AFO",
"BD",
"BM",
"AFX",
"BO",
"BW",
"ART",
"AFC",
"BR",
"AVK",
"ASD",
"ADI",
"AMW",
"BC",
"DB",
"AWW",
"ADA",
"ANF",
"ASW",
"AOJ",
"COF",
"AMN",
"ACA",
"XC",
"AFB",
"AAY",
"CN",
"AMH",
"ANO",
"AKS",
"ADG",
"AWH",
"ASY",
"APD",
"CEC",
"APJ",
"AQE",
"AQG",
"AQF",
"AID",
"AHO",
"AIU",
"CNO",
"CKN",
"CK",
"AJF",
"AAX",
"ATU",
"ANX",
"ACQ",
"ANP",
"ACN",
"ATN",
"AUD",
"APQ",
"AED",
"AIH",
"ARC",
"ADK",
"AGP",
"AWX",
"XA",
"ANB",
"AIA",
"CP",
"CS",
"AWN",
"AUV",
"CFO",
"AIZ",
"CG",
"ANT",
"AXP",
"BN",
"CU",
"FF",
"AVL",
"REN",
"AUF",
"AUP",
"AOX",
"AMF",
"AKA",
"CV",
"AKB",
"ADO",
"ER",
"APR",
"AAD",
"CT",
"AGB",
"APS",
"APO",
"ATO",
"CZ",
"AOU",
"CAY",
"AWE",
"ATP",
"ARD",
"CM",
"CD",
"AGH",
"AHL",
"OH",
"CH",
"ACJ",
"AEF",
"CR",
"ALC",
"AEG",
"AVI",
"AIL",
"ATH",
"AIJ",
"AEN",
"AUQ",
"ABG",
"ABL",
"AFD",
"AUR",
"AUZ",
"AIP",
"AHZ",
"ABD",
"AIO",
"ABA",
"AVN",
"ALG",
"ALH",
"AQD",
"DAN",
"AAF",
"CED",
"DL",
"AOI",
"AHM",
"ABP",
"ABE",
"AJQ",
"DA",
"DQ",
"AEL",
"AAJ",
"AUS",
"AAN",
"AGL",
"AOQ",
"AMV",
"AIB",
"ANL",
"AAK",
"AEZ",
"AAU",
"AKJ",
"AFT",
"AFU",
"ASA",
"AGG",
"DI",
"DR",
"AAW",
"DM",
"LI",
"ARO",
"CAW",
"AWR",
"ARS",
"AWC",
"AAC",
"AOA",
"AGQ",
"ALB",
"ANN",
"AEQ",
"AAL",
"AQP",
"AQR",
"ASF",
"ASE",
"ACY",
"AVY",
"EEP",
"EN",
"EB",
"AGS",
"EI",
"AEW",
"AJU",
"ABB",
"JE",
"EA",
"EE",
"AAV",
"AUX",
"CAU",
"AQA",
"AQC",
"AQB",
"EQ",
"APC",
"SQ",
"ACZ",
"AWL",
"ACV",
"AOY",
"AEE",
"CAX",
"AIV",
"ATT",
"ET",
"ABR",
"AVJ",
"AFE",
"ED",
"AIC",
"EX",
"ERN",
"ATS",
"AJV",
"ANI",
"AQY",
"FI",
"FV",
"FS",
"ATA",
"ALY",
"ARW",
"AMX",
"ANU",
"AXE",
"AVA",
"FC",
"ATW",
"FLW",
"FO",
"FX",
"AJP",
"ASX",
"ASP",
"ASH",
"AXM",
"AKT",
"AVV",
"FT",
"FN",
"AHY",
"AOO",
"ASQ",
"AHD",
"AKR",
"GDN",
"OR",
"APG",
"AMT",
"ABT",
"AAE",
"AVM",
"AEA",
"AKH",
"GC",
"AMI",
"GN",
"CAZ",
"ADT",
"AST",
"ATM",
"AWZ",
"HS",
"AVW",
"AMD",
"ACP",
"BH",
"HWB",
"AWS",
"CAS",
"ICA",
"AUI",
"AFK",
"AFI",
"AOZ",
"ABS",
"IP",
"ABQ",
"AUG",
"ARV",
"IB",
"APA",
"AIM",
"II",
"ADN",
"ATR",
"AQX",
"AXB",
"AXA",
"ICE",
"ICO",
"AMM",
"AMU",
"INN",
"INO",
"INB",
"IT",
"AWG",
"IL",
"IA",
"AQH",
"AQJ",
"AQI",
"AGR",
"AUY",
"ABV",
"API",
"AVD",
"ASB",
"IV",
"IS",
"APH",
"ACO",
"AUC",
"AFR",
"JB",
"AHN",
"ATC",
"ATQ",
"AHH",
"ATF",
"AWP",
"AKV",
"LC",
"ADW",
"LO",
"LAN",
"ADC",
"AVZ",
"LB",
"ACU",
"LAR",
"MRN",
"AHF",
"AVS",
"AHV",
"APW",
"MSS",
"MF",
"MH",
"AUL",
"AUW",
"AFF",
"ASS",
"MWB",
"MB",
"AAT",
"AJM",
"CAT",
"CAV",
"ADB",
"AVH",
"AHS",
"AGU",
"ALL",
"AQL",
"MR",
"MS",
"AKK",
"AKL",
"MG",
"AXC",
"AVE",
"AJO",
"AIE",
"ALX",
"VT",
"AVX",
"AAR",
"ZZZ",
"ANM",
"ARA",
"AWJ",
"AUT",
"AMB",
"ALJ",
"AQS",
"AHG",
"AEX",
"AQT",
"NA",
"NF",
"ALZ",
"AGM",
"ARE",
"AAG",
"AAA",
"ON",
"VN",
"CBB",
"AXD",
"ADL",
"AKI",
"AOM",
"AIR",
"ARN",
"AVR",
"OP",
"APX",
"APZ",
"APY",
"ABO",
"ACI",
"CW",
"AHA",
"ACH",
"PK",
"AIQ",
"AJJ",
"AND",
"AJA",
"AAP",
"ASG",
"AUB",
"APM",
"AVF",
"AIG",
"ASO",
"ARF",
"PB",
"RT",
"AHK",
"RR",
"ANC",
"APB",
"AEK",
"AMJ",
"PQ",
"AFY",
"AXR",
"AGZ",
"AUH",
"AVP",
"ARJ",
"AWV",
"ALN",
"ASZ",
"AWU",
"ASL",
"ASK",
"AVO",
"AMZ",
"AVQ",
"AUA",
"AOT",
"PE",
"ANH",
"AWI",
"AKZ",
"AEJ",
"AXN",
"AMO",
"ANS",
"ATE",
"XP",
"ALD",
"AIF",
"ALM",
"SH",
"OI",
"AGV",
"ALI",
"AMA",
"AGX",
"ALT",
"PL",
"PI",
"PR",
"APK",
"APF",
"AES",
"PF",
"ACL",
"ANR",
"AOH",
"ARY",
"ARB",
"AKY",
"PW",
"ASN",
"AIS",
"ALA",
"AXO",
"AKQ",
"AVB",
"ASV",
"AXF",
"AEO",
"AIN",
"AXQ",
"PC",
"AMG",
"AAB",
"AEP",
"AER",
"PD",
"ASI",
"AUJ",
"ARP",
"ARM",
"ATB",
"PP",
"PS",
"POR",
"APN",
"AJC",
"AFV",
"AFW",
"AHT",
"ABJ",
"WY",
"RC",
"RCN",
"ACR",
"AWA",
"AHX",
"AOF",
"ALO",
"ANW",
"ATJ",
"AGY",
"ANK",
"AMC",
"AGN",
"ACW",
"APL",
"AIY",
"AIX",
"ARQ",
"ALV",
"AQU",
"AEI",
"ARG",
"ARH",
"ATV",
"APE",
"ACE",
"AWO",
"RE",
"RA",
"ANQ",
"AME",
"ABF",
"AMK",
"ABM",
"AFH",
"AML",
"AKM",
"ADY",
"ALE",
"AET",
"AHU",
"AGI",
"LRC",
"AVT",
"AWY",
"ALP",
"ALQ",
"CMR",
"ASR",
"ATI",
"SD",
"ALR",
"SM",
"SA",
"SB",
"ALS",
"SP",
"AGW",
"AFP",
"AFM",
"ATD",
"ADX",
"ABN",
"SS",
"AQO",
"AOE",
"AGO",
"ANY",
"ATK",
"SE",
"AXI",
"AWM",
"AGT",
"AWK",
"AXH",
"SF",
"MA",
"ATZ",
"SRN",
"ADM",
"LA",
"AEV",
"ACC",
"SI",
"AHE",
"AGJ",
"AJL",
"AFZ",
"AIT",
"AVG",
"ARR",
"AUM",
"AUO",
"AUN",
"AOG",
"APU",
"AJK",
"SZ",
"AXG",
"AAZ",
"AJT",
"ALW",
"GD",
"GA",
"AMY",
"AQW",
"ADP",
"AOR",
"STA",
"AQV",
"AQK",
"ARZ",
"ARU",
"ABW",
"ANE",
"ABH",
"AEY",
"AJY",
"AEU",
"ASJ",
"AVC",
"SW",
"AEC",
"ARK",
"ARL",
"AFG",
"TL",
"ABI",
"AHP",
"CST",
"AJW",
"AJX",
"ARX",
"ANG",
"TE",
"TCR",
"TP",
"AXJ",
"ABX",
"AKN",
"AFA",
"CBA",
"AUU",
"TI",
"ARI",
"AXL",
"AXS",
"ADZ",
"ASM",
"AHC",
"TN",
"TF",
"ABK",
"AAS",
"AHI",
"AKW",
"ATX",
"VOR",
"VGR",
"AAQ",
"ATY",
"AKC",
"SN",
"AKX",
"AKF",
"AKD",
"AKU",
"AKE",
"TIN",
"CRN",
"AEM",
"AIW",
"AXK",
"AJZ",
"AOW",
"AFJ",
"AUE",
"ADF",
"TB",
"AJB",
"AJD",
"AJN",
"AJG",
"AJI",
"AJH",
"UO",
"UC",
"URI",
"ACT",
"UCN",
"AVU",
"ADQ",
"UN",
"UAR",
"AQM",
"ACB",
"AMQ",
"AMS",
"AMR",
"VA",
"AKG",
"ABZ",
"VC",
"VR",
"VS",
"VP",
"VM",
"VV",
"VON",
"AJR",
"WE",
"WR",
"WS",
"AAM",
"WM",
"WN",
"AHQ",
"AHR",
"AOL",
"AWF",
"AOV",
"AOS",
"AOK",
"AON",
"AOP"
],
"description": "UNCL1153 reference code qualifier",
"externalDocs": {
"url": "https://service.unece.org/trade/untdid/d99a/uncl/uncl1153.htm"
},
"type": [
"string",
"null"
]
}
}
},
"B2bShippingInput": {
"type": "object",
"required": [
"shipToCountry"
],
"properties": {
"shipToCountry": {
"description": "ISO 3166-1 alpha-2 delivery country code",
"example": "FR",
"type": "string"
},
"shipToName": {
"type": [
"string",
"null"
]
},
"shipToCityName": {
"type": [
"string",
"null"
]
},
"shipToPostalCode": {
"type": [
"string",
"null"
]
},
"shipToAddressLine": {
"type": [
"string",
"null"
]
},
"deliveryDate": {
"description": "Delivery date (YYYY-MM-DD)",
"externalDocs": {
"url": "https://schema.org/Date"
},
"example": "2026-01-20",
"type": [
"string",
"null"
]
}
}
},
"B2bTaxDetailInput": {
"type": "object",
"required": [
"taxableAmount",
"taxAmount",
"percent",
"taxCategoryCode"
],
"properties": {
"taxableAmount": {
"type": "string"
},
"taxAmount": {
"type": "string"
},
"percent": {
"description": "VAT rate percentage",
"example": "20.0",
"type": "string"
},
"taxCategoryCode": {
"enum": [
"S",
"Z",
"E",
"AE",
"K",
"G",
"O",
"L",
"M"
],
"description": "VAT category code (UNCL5305)",
"externalDocs": {
"url": "https://service.unece.org/trade/untdid/d99a/uncl/uncl5305.htm"
},
"example": "S",
"type": "string"
}
}
},
"B2bTransactionLineInput": {
"type": "object",
"required": [
"id",
"totalAmount",
"taxableAmount",
"taxCategoryCode"
],
"properties": {
"id": {
"description": "Line identifier",
"example": "1",
"type": "string"
},
"totalAmount": {
"description": "Line total amount",
"example": "500.00",
"type": "string"
},
"taxableAmount": {
"description": "Line net (pre-tax) amount",
"example": "500.00",
"type": "string"
},
"taxCategoryCode": {
"enum": [
"S",
"Z",
"E",
"AE",
"K",
"G",
"O",
"L",
"M"
],
"description": "UNCL5305 VAT category type code",
"externalDocs": {
"url": "https://service.unece.org/trade/untdid/d99a/uncl/uncl5305.htm"
},
"example": "S",
"type": "string"
},
"taxPercent": {
"type": [
"string",
"null"
]
},
"itemName": {
"type": [
"string",
"null"
]
},
"quantity": {
"type": [
"string",
"null"
]
},
"unitCode": {
"enum": [
"10",
"11",
"13",
"14",
"15",
"20",
"21",
"22",
"23",
"24",
"25",
"27",
"28",
"33",
"34",
"35",
"37",
"38",
"40",
"41",
"56",
"57",
"58",
"59",
"60",
"61",
"74",
"77",
"80",
"81",
"85",
"87",
"89",
"91",
"1I",
"2A",
"2B",
"2C",
"2G",
"2H",
"2I",
"2J",
"2K",
"2L",
"2M",
"2N",
"2P",
"2Q",
"2R",
"2U",
"2X",
"2Y",
"2Z",
"3B",
"3C",
"4C",
"4G",
"4H",
"4K",
"4L",
"4M",
"4N",
"4O",
"4P",
"4Q",
"4R",
"4T",
"4U",
"4W",
"4X",
"5A",
"5B",
"5E",
"5J",
"A10",
"A11",
"A12",
"A13",
"A14",
"A15",
"A16",
"A17",
"A18",
"A19",
"A2",
"A20",
"A21",
"A22",
"A23",
"A24",
"A26",
"A27",
"A28",
"A29",
"A3",
"A30",
"A31",
"A32",
"A33",
"A34",
"A35",
"A36",
"A37",
"A38",
"A39",
"A4",
"A40",
"A41",
"A42",
"A43",
"A44",
"A45",
"A47",
"A48",
"A5",
"A53",
"A54",
"A55",
"A56",
"A59",
"A6",
"A68",
"A69",
"A7",
"A70",
"A71",
"A73",
"A74",
"A75",
"A76",
"A8",
"A84",
"A85",
"A86",
"A87",
"A88",
"A89",
"A9",
"A90",
"A91",
"A93",
"A94",
"A95",
"A96",
"A97",
"A98",
"A99",
"AA",
"AB",
"ACR",
"ACT",
"AD",
"AE",
"AH",
"AI",
"AK",
"AL",
"AMH",
"AMP",
"ANN",
"APZ",
"AQ",
"AS",
"ASM",
"ASU",
"ATM",
"AWG",
"AY",
"AZ",
"B1",
"B10",
"B11",
"B12",
"B13",
"B14",
"B15",
"B16",
"B17",
"B18",
"B19",
"B20",
"B21",
"B22",
"B23",
"B24",
"B25",
"B26",
"B27",
"B28",
"B29",
"B3",
"B30",
"B31",
"B32",
"B33",
"B34",
"B35",
"B4",
"B41",
"B42",
"B43",
"B44",
"B45",
"B46",
"B47",
"B48",
"B49",
"B50",
"B52",
"B53",
"B54",
"B55",
"B56",
"B57",
"B58",
"B59",
"B60",
"B61",
"B62",
"B63",
"B64",
"B66",
"B67",
"B68",
"B69",
"B7",
"B70",
"B71",
"B72",
"B73",
"B74",
"B75",
"B76",
"B77",
"B78",
"B79",
"B8",
"B80",
"B81",
"B82",
"B83",
"B84",
"B85",
"B86",
"B87",
"B88",
"B89",
"B90",
"B91",
"B92",
"B93",
"B94",
"B95",
"B96",
"B97",
"B98",
"B99",
"BAR",
"BB",
"BFT",
"BHP",
"BIL",
"BLD",
"BLL",
"BP",
"BPM",
"BQL",
"BTU",
"BUA",
"BUI",
"C0",
"C10",
"C11",
"C12",
"C13",
"C14",
"C15",
"C16",
"C17",
"C18",
"C19",
"C20",
"C21",
"C22",
"C23",
"C24",
"C25",
"C26",
"C27",
"C28",
"C29",
"C3",
"C30",
"C31",
"C32",
"C33",
"C34",
"C35",
"C36",
"C37",
"C38",
"C39",
"C40",
"C41",
"C42",
"C43",
"C44",
"C45",
"C46",
"C47",
"C48",
"C49",
"C50",
"C51",
"C52",
"C53",
"C54",
"C55",
"C56",
"C57",
"C58",
"C59",
"C60",
"C61",
"C62",
"C63",
"C64",
"C65",
"C66",
"C67",
"C68",
"C69",
"C7",
"C70",
"C71",
"C72",
"C73",
"C74",
"C75",
"C76",
"C78",
"C79",
"C8",
"C80",
"C81",
"C82",
"C83",
"C84",
"C85",
"C86",
"C87",
"C88",
"C89",
"C9",
"C90",
"C91",
"C92",
"C93",
"C94",
"C95",
"C96",
"C97",
"C99",
"CCT",
"CDL",
"CEL",
"CEN",
"CG",
"CGM",
"CKG",
"CLF",
"CLT",
"CMK",
"CMQ",
"CMT",
"CNP",
"CNT",
"COU",
"CTG",
"CTM",
"CTN",
"CUR",
"CWA",
"CWI",
"D03",
"D04",
"D1",
"D10",
"D11",
"D12",
"D13",
"D15",
"D16",
"D17",
"D18",
"D19",
"D2",
"D20",
"D21",
"D22",
"D23",
"D24",
"D25",
"D26",
"D27",
"D29",
"D30",
"D31",
"D32",
"D33",
"D34",
"D36",
"D41",
"D42",
"D43",
"D44",
"D45",
"D46",
"D47",
"D48",
"D49",
"D5",
"D50",
"D51",
"D52",
"D53",
"D54",
"D55",
"D56",
"D57",
"D58",
"D59",
"D6",
"D60",
"D61",
"D62",
"D63",
"D65",
"D68",
"D69",
"D73",
"D74",
"D77",
"D78",
"D80",
"D81",
"D82",
"D83",
"D85",
"D86",
"D87",
"D88",
"D89",
"D91",
"D93",
"D94",
"D95",
"DAA",
"DAD",
"DAY",
"DB",
"DD",
"DEC",
"DG",
"DJ",
"DLT",
"DMA",
"DMK",
"DMO",
"DMQ",
"DMT",
"DN",
"DPC",
"DPR",
"DPT",
"DRA",
"DRI",
"DRL",
"DT",
"DTN",
"DWT",
"DZN",
"DZP",
"E01",
"E07",
"E08",
"E09",
"E10",
"E12",
"E14",
"E15",
"E16",
"E17",
"E18",
"E19",
"E20",
"E21",
"E22",
"E23",
"E25",
"E27",
"E28",
"E30",
"E31",
"E32",
"E33",
"E34",
"E35",
"E36",
"E37",
"E38",
"E39",
"E4",
"E40",
"E41",
"E42",
"E43",
"E44",
"E45",
"E46",
"E47",
"E48",
"E49",
"E50",
"E51",
"E52",
"E53",
"E54",
"E55",
"E56",
"E57",
"E58",
"E59",
"E60",
"E61",
"E62",
"E63",
"E64",
"E65",
"E66",
"E67",
"E68",
"E69",
"E70",
"E71",
"E72",
"E73",
"E74",
"E75",
"E76",
"E77",
"E78",
"E79",
"E80",
"E81",
"E82",
"E83",
"E84",
"E85",
"E86",
"E87",
"E88",
"E89",
"E90",
"E91",
"E92",
"E93",
"E94",
"E95",
"E96",
"E97",
"E98",
"E99",
"EA",
"EB",
"EQ",
"F01",
"F02",
"F03",
"F04",
"F05",
"F06",
"F07",
"F08",
"F10",
"F11",
"F12",
"F13",
"F14",
"F15",
"F16",
"F17",
"F18",
"F19",
"F20",
"F21",
"F22",
"F23",
"F24",
"F25",
"F26",
"F27",
"F28",
"F29",
"F30",
"F31",
"F32",
"F33",
"F34",
"F35",
"F36",
"F37",
"F38",
"F39",
"F40",
"F41",
"F42",
"F43",
"F44",
"F45",
"F46",
"F47",
"F48",
"F49",
"F50",
"F51",
"F52",
"F53",
"F54",
"F55",
"F56",
"F57",
"F58",
"F59",
"F60",
"F61",
"F62",
"F63",
"F64",
"F65",
"F66",
"F67",
"F68",
"F69",
"F70",
"F71",
"F72",
"F73",
"F74",
"F75",
"F76",
"F77",
"F78",
"F79",
"F80",
"F81",
"F82",
"F83",
"F84",
"F85",
"F86",
"F87",
"F88",
"F89",
"F90",
"F91",
"F92",
"F93",
"F94",
"F95",
"F96",
"F97",
"F98",
"F99",
"FAH",
"FAR",
"FBM",
"FC",
"FF",
"FH",
"FIT",
"FL",
"FOT",
"FP",
"FR",
"FS",
"FTK",
"FTQ",
"G01",
"G04",
"G05",
"G06",
"G08",
"G09",
"G10",
"G11",
"G12",
"G13",
"G14",
"G15",
"G16",
"G17",
"G18",
"G19",
"G2",
"G20",
"G21",
"G23",
"G24",
"G25",
"G26",
"G27",
"G28",
"G29",
"G3",
"G30",
"G31",
"G32",
"G33",
"G34",
"G35",
"G36",
"G37",
"G38",
"G39",
"G40",
"G41",
"G42",
"G43",
"G44",
"G45",
"G46",
"G47",
"G48",
"G49",
"G50",
"G51",
"G52",
"G53",
"G54",
"G55",
"G56",
"G57",
"G58",
"G59",
"G60",
"G61",
"G62",
"G63",
"G64",
"G65",
"G66",
"G67",
"G68",
"G69",
"G70",
"G71",
"G72",
"G73",
"G74",
"G75",
"G76",
"G77",
"G78",
"G79",
"G80",
"G81",
"G82",
"G83",
"G84",
"G85",
"G86",
"G87",
"G88",
"G89",
"G90",
"G91",
"G92",
"G93",
"G94",
"G95",
"G96",
"G97",
"G98",
"G99",
"GB",
"GBQ",
"GDW",
"GE",
"GF",
"GFI",
"GGR",
"GIA",
"GIC",
"GII",
"GIP",
"GJ",
"GL",
"GLD",
"GLI",
"GLL",
"GM",
"GO",
"GP",
"GQ",
"GRM",
"GRN",
"GRO",
"GV",
"GWH",
"H03",
"H04",
"H05",
"H06",
"H07",
"H08",
"H09",
"H10",
"H11",
"H12",
"H13",
"H14",
"H15",
"H16",
"H18",
"H19",
"H20",
"H21",
"H22",
"H23",
"H24",
"H25",
"H26",
"H27",
"H28",
"H29",
"H30",
"H31",
"H32",
"H33",
"H34",
"H35",
"H36",
"H37",
"H38",
"H39",
"H40",
"H41",
"H42",
"H43",
"H44",
"H45",
"H46",
"H47",
"H48",
"H49",
"H50",
"H51",
"H52",
"H53",
"H54",
"H55",
"H56",
"H57",
"H58",
"H59",
"H60",
"H61",
"H62",
"H63",
"H64",
"H65",
"H66",
"H67",
"H68",
"H69",
"H70",
"H71",
"H72",
"H73",
"H74",
"H75",
"H76",
"H77",
"H79",
"H80",
"H81",
"H82",
"H83",
"H84",
"H85",
"H87",
"H88",
"H89",
"H90",
"H91",
"H92",
"H93",
"H94",
"H95",
"H96",
"H98",
"H99",
"HA",
"HBA",
"HBX",
"HC",
"HDW",
"HEA",
"HGM",
"HH",
"HIU",
"HKM",
"HLT",
"HM",
"HMQ",
"HMT",
"HPA",
"HTZ",
"HUR",
"IA",
"IE",
"INH",
"INK",
"INQ",
"ISD",
"IU",
"IUG",
"IV",
"J10",
"J12",
"J13",
"J14",
"J15",
"J16",
"J17",
"J18",
"J19",
"J2",
"J20",
"J21",
"J22",
"J23",
"J24",
"J25",
"J26",
"J27",
"J28",
"J29",
"J30",
"J31",
"J32",
"J33",
"J34",
"J35",
"J36",
"J38",
"J39",
"J40",
"J41",
"J42",
"J43",
"J44",
"J45",
"J46",
"J47",
"J48",
"J49",
"J50",
"J51",
"J52",
"J53",
"J54",
"J55",
"J56",
"J57",
"J58",
"J59",
"J60",
"J61",
"J62",
"J63",
"J64",
"J65",
"J66",
"J67",
"J68",
"J69",
"J70",
"J71",
"J72",
"J73",
"J74",
"J75",
"J76",
"J78",
"J79",
"J81",
"J82",
"J83",
"J84",
"J85",
"J87",
"J90",
"J91",
"J92",
"J93",
"J95",
"J96",
"J97",
"J98",
"J99",
"JE",
"JK",
"JM",
"JNT",
"JOU",
"JPS",
"JWL",
"K1",
"K10",
"K11",
"K12",
"K13",
"K14",
"K15",
"K16",
"K17",
"K18",
"K19",
"K2",
"K20",
"K21",
"K22",
"K23",
"K26",
"K27",
"K28",
"K3",
"K30",
"K31",
"K32",
"K33",
"K34",
"K35",
"K36",
"K37",
"K38",
"K39",
"K40",
"K41",
"K42",
"K43",
"K45",
"K46",
"K47",
"K48",
"K49",
"K50",
"K51",
"K52",
"K53",
"K54",
"K55",
"K58",
"K59",
"K6",
"K60",
"K61",
"K62",
"K63",
"K64",
"K65",
"K66",
"K67",
"K68",
"K69",
"K70",
"K71",
"K73",
"K74",
"K75",
"K76",
"K77",
"K78",
"K79",
"K80",
"K81",
"K82",
"K83",
"K84",
"K85",
"K86",
"K87",
"K88",
"K89",
"K90",
"K91",
"K92",
"K93",
"K94",
"K95",
"K96",
"K97",
"K98",
"K99",
"KA",
"KAT",
"KB",
"KBA",
"KCC",
"KDW",
"KEL",
"KGM",
"KGS",
"KHY",
"KHZ",
"KI",
"KIC",
"KIP",
"KJ",
"KJO",
"KL",
"KLK",
"KLX",
"KMA",
"KMH",
"KMK",
"KMQ",
"KMT",
"KNI",
"KNM",
"KNS",
"KNT",
"KO",
"KPA",
"KPH",
"KPO",
"KPP",
"KR",
"KSD",
"KSH",
"KT",
"KTN",
"KUR",
"KVA",
"KVR",
"KVT",
"KW",
"KWH",
"KWN",
"KWO",
"KWS",
"KWT",
"KX",
"L10",
"L11",
"L12",
"L13",
"L14",
"L15",
"L16",
"L17",
"L18",
"L19",
"L2",
"L20",
"L21",
"L23",
"L24",
"L25",
"L26",
"L27",
"L28",
"L29",
"L30",
"L31",
"L32",
"L33",
"L34",
"L35",
"L36",
"L37",
"L38",
"L39",
"L40",
"L41",
"L42",
"L43",
"L44",
"L45",
"L46",
"L47",
"L48",
"L49",
"L50",
"L51",
"L52",
"L53",
"L54",
"L55",
"L56",
"L57",
"L58",
"L59",
"L60",
"L63",
"L64",
"L65",
"L66",
"L67",
"L68",
"L69",
"L70",
"L71",
"L72",
"L73",
"L74",
"L75",
"L76",
"L77",
"L78",
"L79",
"L80",
"L81",
"L82",
"L83",
"L84",
"L85",
"L86",
"L87",
"L88",
"L89",
"L90",
"L91",
"L92",
"L93",
"L94",
"L95",
"L96",
"L98",
"L99",
"LA",
"LAC",
"LBR",
"LBT",
"LD",
"LEF",
"LF",
"LH",
"LK",
"LM",
"LN",
"LO",
"LP",
"LPA",
"LR",
"LS",
"LTN",
"LTR",
"LUB",
"LUM",
"LUX",
"LY",
"M1",
"M10",
"M11",
"M12",
"M13",
"M14",
"M15",
"M16",
"M17",
"M18",
"M19",
"M20",
"M21",
"M22",
"M23",
"M24",
"M25",
"M26",
"M27",
"M29",
"M30",
"M31",
"M32",
"M33",
"M34",
"M35",
"M36",
"M37",
"M38",
"M39",
"M4",
"M40",
"M41",
"M42",
"M43",
"M44",
"M45",
"M46",
"M47",
"M48",
"M49",
"M5",
"M50",
"M51",
"M52",
"M53",
"M55",
"M56",
"M57",
"M58",
"M59",
"M60",
"M61",
"M62",
"M63",
"M64",
"M65",
"M66",
"M67",
"M68",
"M69",
"M7",
"M70",
"M71",
"M72",
"M73",
"M74",
"M75",
"M76",
"M77",
"M78",
"M79",
"M80",
"M81",
"M82",
"M83",
"M84",
"M85",
"M86",
"M87",
"M88",
"M89",
"M9",
"M90",
"M91",
"M92",
"M93",
"M94",
"M95",
"M96",
"M97",
"M98",
"M99",
"MAH",
"MAL",
"MAM",
"MAR",
"MAW",
"MBE",
"MBF",
"MBR",
"MC",
"MCU",
"MD",
"MGM",
"MHZ",
"MIK",
"MIL",
"MIN",
"MIO",
"MIU",
"MLD",
"MLT",
"MMK",
"MMQ",
"MMT",
"MND",
"MON",
"MPA",
"MQH",
"MQS",
"MSK",
"MTK",
"MTQ",
"MTR",
"MTS",
"MVA",
"MWH",
"N1",
"N10",
"N11",
"N12",
"N13",
"N14",
"N15",
"N16",
"N17",
"N18",
"N19",
"N20",
"N21",
"N22",
"N23",
"N24",
"N25",
"N26",
"N27",
"N28",
"N29",
"N3",
"N30",
"N31",
"N32",
"N33",
"N34",
"N35",
"N36",
"N37",
"N38",
"N39",
"N40",
"N41",
"N42",
"N43",
"N44",
"N45",
"N46",
"N47",
"N48",
"N49",
"N50",
"N51",
"N52",
"N53",
"N54",
"N55",
"N56",
"N57",
"N58",
"N59",
"N60",
"N61",
"N62",
"N63",
"N64",
"N65",
"N66",
"N67",
"N68",
"N69",
"N70",
"N71",
"N72",
"N73",
"N74",
"N75",
"N76",
"N77",
"N78",
"N79",
"N80",
"N81",
"N82",
"N83",
"N84",
"N85",
"N86",
"N87",
"N88",
"N89",
"N90",
"N91",
"N92",
"N93",
"N94",
"N95",
"N96",
"N97",
"N98",
"N99",
"NA",
"NAR",
"NCL",
"NEW",
"NF",
"NIL",
"NIU",
"NL",
"NM3",
"NMI",
"NMP",
"NPT",
"NT",
"NU",
"NX",
"OA",
"ODE",
"ODG",
"ODK",
"ODM",
"OHM",
"ON",
"ONZ",
"OPM",
"OT",
"OZA",
"OZI",
"P1",
"P10",
"P11",
"P12",
"P13",
"P14",
"P15",
"P16",
"P17",
"P18",
"P19",
"P2",
"P20",
"P21",
"P22",
"P23",
"P24",
"P25",
"P26",
"P27",
"P28",
"P29",
"P30",
"P31",
"P32",
"P33",
"P34",
"P35",
"P36",
"P37",
"P38",
"P39",
"P40",
"P41",
"P42",
"P43",
"P44",
"P45",
"P46",
"P47",
"P48",
"P49",
"P5",
"P50",
"P51",
"P52",
"P53",
"P54",
"P55",
"P56",
"P57",
"P58",
"P59",
"P60",
"P61",
"P62",
"P63",
"P64",
"P65",
"P66",
"P67",
"P68",
"P69",
"P70",
"P71",
"P72",
"P73",
"P74",
"P75",
"P76",
"P77",
"P78",
"P79",
"P80",
"P81",
"P82",
"P83",
"P84",
"P85",
"P86",
"P87",
"P88",
"P89",
"P90",
"P91",
"P92",
"P93",
"P94",
"P95",
"P96",
"P97",
"P98",
"P99",
"PAL",
"PD",
"PFL",
"PGL",
"PI",
"PLA",
"PO",
"PQ",
"PR",
"PS",
"PTD",
"PTI",
"PTL",
"PTN",
"Q10",
"Q11",
"Q12",
"Q13",
"Q14",
"Q15",
"Q16",
"Q17",
"Q18",
"Q19",
"Q20",
"Q21",
"Q22",
"Q23",
"Q24",
"Q25",
"Q26",
"Q27",
"Q28",
"Q29",
"Q30",
"Q31",
"Q32",
"Q33",
"Q34",
"Q35",
"Q36",
"Q37",
"Q38",
"Q39",
"Q40",
"Q41",
"Q42",
"Q3",
"QA",
"QAN",
"QB",
"QR",
"QTD",
"QTI",
"QTL",
"QTR",
"R1",
"R9",
"RH",
"RM",
"ROM",
"RP",
"RPM",
"RPS",
"RT",
"S3",
"S4",
"SAN",
"SCO",
"SCR",
"SEC",
"SET",
"SG",
"SIE",
"SM3",
"SMI",
"SQ",
"SQR",
"SR",
"STC",
"STI",
"STK",
"STL",
"STN",
"STW",
"SW",
"SX",
"SYR",
"T0",
"T3",
"TAH",
"TAN",
"TI",
"TIC",
"TIP",
"TKM",
"TMS",
"TNE",
"TP",
"TPI",
"TPR",
"TQD",
"TRL",
"TST",
"TTS",
"U1",
"U2",
"UB",
"UC",
"VA",
"VLT",
"VP",
"W2",
"WA",
"WB",
"WCD",
"WE",
"WEB",
"WEE",
"WG",
"WHR",
"WM",
"WSD",
"WTT",
"X1",
"YDK",
"YDQ",
"YRD",
"Z11",
"ZP",
"ZZ",
"X1A",
"X1B",
"X1D",
"X1F",
"X1G",
"X1W",
"X2C",
"X3A",
"X3H",
"X43",
"X44",
"X4A",
"X4B",
"X4C",
"X4D",
"X4F",
"X4G",
"X4H",
"X5H",
"X5L",
"X5M",
"X6H",
"X6P",
"X7A",
"X7B",
"X8A",
"X8B",
"X8C",
"XAA",
"XAB",
"XAC",
"XAD",
"XAE",
"XAF",
"XAG",
"XAH",
"XAI",
"XAJ",
"XAL",
"XAM",
"XAP",
"XAT",
"XAV",
"XB4",
"XBA",
"XBB",
"XBC",
"XBD",
"XBE",
"XBF",
"XBG",
"XBH",
"XBI",
"XBJ",
"XBK",
"XBL",
"XBM",
"XBN",
"XBO",
"XBP",
"XBQ",
"XBR",
"XBS",
"XBT",
"XBU",
"XBV",
"XBW",
"XBX",
"XBY",
"XBZ",
"XCA",
"XCB",
"XCC",
"XCD",
"XCE",
"XCF",
"XCG",
"XCH",
"XCI",
"XCJ",
"XCK",
"XCL",
"XCM",
"XCN",
"XCO",
"XCP",
"XCQ",
"XCR",
"XCS",
"XCT",
"XCU",
"XCV",
"XCW",
"XCX",
"XCY",
"XCZ",
"XDA",
"XDB",
"XDC",
"XDG",
"XDH",
"XDI",
"XDJ",
"XDK",
"XDL",
"XDM",
"XDN",
"XDP",
"XDR",
"XDS",
"XDT",
"XDU",
"XDV",
"XDW",
"XDX",
"XDY",
"XEC",
"XED",
"XEE",
"XEF",
"XEG",
"XEH",
"XEI",
"XEN",
"XFB",
"XFC",
"XFD",
"XFE",
"XFI",
"XFL",
"XFO",
"XFP",
"XFR",
"XFT",
"XFW",
"XFX",
"XGB",
"XGI",
"XGL",
"XGR",
"XGU",
"XGY",
"XGZ",
"XHA",
"XHB",
"XHC",
"XHG",
"XHN",
"XHR",
"XIA",
"XIB",
"XIC",
"XID",
"XIE",
"XIF",
"XIG",
"XIH",
"XIK",
"XIL",
"XIN",
"XIZ",
"XJB",
"XJC",
"XJG",
"XJR",
"XJT",
"XJY",
"XKG",
"XKI",
"XLE",
"XLG",
"XLT",
"XLU",
"XLV",
"XLZ",
"XMA",
"XMB",
"XMC",
"XME",
"XMR",
"XMS",
"XMT",
"XMW",
"XMX",
"XNA",
"XNE",
"XNF",
"XNG",
"XNS",
"XNT",
"XNU",
"XNV",
"XOA",
"XOB",
"XOC",
"XOD",
"XOE",
"XOF",
"XOK",
"XOT",
"XOU",
"XP2",
"XPA",
"XPB",
"XPC",
"XPD",
"XPE",
"XPF",
"XPG",
"XPH",
"XPI",
"XPJ",
"XPK",
"XPL",
"XPN",
"XPO",
"XPP",
"XPR",
"XPT",
"XPU",
"XPV",
"XPX",
"XPY",
"XPZ",
"XQA",
"XQB",
"XQC",
"XQD",
"XQF",
"XQG",
"XQH",
"XQJ",
"XQK",
"XQL",
"XQM",
"XQN",
"XQP",
"XQQ",
"XQR",
"XQS",
"XRD",
"XRG",
"XRJ",
"XRK",
"XRL",
"XRO",
"XRT",
"XRZ",
"XSA",
"XSB",
"XSC",
"XSD",
"XSE",
"XSH",
"XSI",
"XSK",
"XSL",
"XSM",
"XSO",
"XSP",
"XSS",
"XST",
"XSU",
"XSV",
"XSW",
"XSY",
"XSZ",
"XT1",
"XTB",
"XTC",
"XTD",
"XTE",
"XTG",
"XTI",
"XTK",
"XTL",
"XTN",
"XTO",
"XTR",
"XTS",
"XTT",
"XTU",
"XTV",
"XTW",
"XTY",
"XTZ",
"XUC",
"XUN",
"XVA",
"XVG",
"XVI",
"XVK",
"XVL",
"XVO",
"XVP",
"XVQ",
"XVN",
"XVR",
"XVS",
"XVY",
"XWA",
"XWB",
"XWC",
"XWD",
"XWF",
"XWG",
"XWH",
"XWJ",
"XWK",
"XWL",
"XWM",
"XWN",
"XWP",
"XWQ",
"XWR",
"XWS",
"XWT",
"XWU",
"XWV",
"XWW",
"XWX",
"XWY",
"XWZ",
"XXA",
"XXB",
"XXC",
"XXD",
"XXF",
"XXG",
"XXH",
"XXJ",
"XXK",
"XYA",
"XYB",
"XYC",
"XYD",
"XYF",
"XYG",
"XYH",
"XYJ",
"XYK",
"XYL",
"XYM",
"XYN",
"XYP",
"XYQ",
"XYR",
"XYS",
"XYT",
"XYV",
"XYW",
"XYX",
"XYY",
"XYZ",
"XZA",
"XZB",
"XZC",
"XZD",
"XZF",
"XZG",
"XZH",
"XZJ",
"XZK",
"XZL",
"XZM",
"XZN",
"XZP",
"XZQ",
"XZR",
"XZS",
"XZT",
"XZU",
"XZV",
"XZW",
"XZX",
"XZY",
"XZZ"
],
"description": "UNCL6411 unit of measure code",
"externalDocs": {
"url": "https://service.unece.org/trade/untdid/d99a/uncl/uncl6411.htm"
},
"type": [
"string",
"null"
]
}
}
},
"B2bTransactionReport.B2bTransactionReportInput": {
"type": "object",
"required": [
"invoiceNumber",
"invoiceDate",
"invoiceType",
"processType",
"invoiceDueDate",
"taxPaymentOption",
"invoiceCurrency",
"taxableTotalAmount",
"taxTotalAmount",
"buyer",
"seller"
],
"properties": {
"invoiceNumber": {
"description": "Invoice number",
"example": "INV-2026-0001",
"type": "string"
},
"invoiceDate": {
"description": "Invoice issue date (YYYY-MM-DD)",
"externalDocs": {
"url": "https://schema.org/Date"
},
"example": "2026-07-01",
"type": "string"
},
"invoiceType": {
"enum": [
"80",
"81",
"82",
"83",
"84",
"130",
"202",
"203",
"204",
"211",
"261",
"262",
"295",
"296",
"308",
"325",
"326",
"380",
"381",
"383",
"384",
"385",
"386",
"387",
"388",
"389",
"390",
"393",
"394",
"395",
"396",
"420",
"456",
"457",
"458",
"527",
"575",
"623",
"633",
"751",
"780",
"935",
"1380"
],
"description": "Invoice type code from the UNCL1001 list",
"externalDocs": {
"url": "https://service.unece.org/trade/untdid/d99a/uncl/uncl1001.htm"
},
"example": "380",
"type": "string"
},
"processType": {
"description": "Business scenario identifier",
"example": "S1",
"type": "string",
"enum": [
"B1",
"S1",
"M1",
"B2",
"S2",
"M2",
"B4",
"S4",
"M4",
"S5",
"S6",
"B7",
"S7"
]
},
"invoiceDueDate": {
"description": "Invoice due date (YYYY-MM-DD)",
"externalDocs": {
"url": "https://schema.org/Date"
},
"example": "2026-07-31",
"type": "string"
},
"taxPaymentOption": {
"description": "Tax payment option (e.g., \"VAT on payment\" or \"VAT on invoice\")",
"type": "string",
"enum": [
"invoice",
"delivery",
"payment"
]
},
"invoiceCurrency": {
"enum": [
"AED",
"AFN",
"ALL",
"AMD",
"ANG",
"AOA",
"ARS",
"AUD",
"AWG",
"AZN",
"BAM",
"BBD",
"BDT",
"BGN",
"BHD",
"BIF",
"BMD",
"BND",
"BOB",
"BOV",
"BRL",
"BSD",
"BTN",
"BWP",
"BYN",
"BZD",
"CAD",
"CDF",
"CHE",
"CHF",
"CHW",
"CLF",
"CLP",
"CNY",
"COP",
"COU",
"CRC",
"CUC",
"CUP",
"CVE",
"CZK",
"DJF",
"DKK",
"DOP",
"DZD",
"EGP",
"ERN",
"ETB",
"EUR",
"FJD",
"FKP",
"GBP",
"GEL",
"GHS",
"GIP",
"GMD",
"GNF",
"GTQ",
"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",
"LYD",
"MAD",
"MDL",
"MGA",
"MKD",
"MMK",
"MXN",
"MXV",
"MYR",
"MZN",
"NAD",
"NGN",
"NIO",
"NOK",
"NPR",
"NZD",
"OMR",
"PAB",
"PEN",
"PGK",
"PHP",
"PKR",
"PLN",
"PYG",
"QAR",
"RON",
"RSD",
"RUB",
"RWF",
"SAR",
"SBD",
"SCR",
"SDG",
"SEK",
"SGD",
"SHP",
"SLL",
"SOS",
"SRD",
"SSP",
"STN",
"SVC",
"SYP",
"SZL",
"THB",
"TJS",
"TMT",
"TND",
"TOP",
"TRY",
"TTD",
"TWD",
"TZS",
"UAH",
"UGX",
"USD",
"USN",
"UYI",
"UYU",
"UYW",
"UZS",
"VES",
"VND",
"VUV",
"WST",
"XAF",
"XAG",
"XAU",
"XBA",
"XBB",
"XBC",
"XBD",
"XCD",
"XDR",
"XOF",
"XPD",
"XPF",
"XPT",
"XSU",
"XTS",
"XUA",
"XXX",
"YER",
"ZAR",
"ZMW",
"ZWL"
],
"description": "ISO 4217 invoice currency",
"example": "EUR",
"type": "string"
},
"taxableTotalAmount": {
"description": "Pre-tax total amount",
"example": "1000.00",
"type": "string"
},
"taxTotalAmount": {
"description": "Tax total amount",
"example": "200.00",
"type": "string"
},
"taxDetails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/B2bTaxDetailInput"
}
},
"buyer": {
"$ref": "#/components/schemas/B2bPartyInput"
},
"seller": {
"$ref": "#/components/schemas/B2bPartyInput"
},
"referenceData": {
"anyOf": [
{
"$ref": "#/components/schemas/B2bReferenceDataInput"
},
{
"type": "null"
}
]
},
"payee": {
"anyOf": [
{
"$ref": "#/components/schemas/B2bPartyInput"
},
{
"type": "null"
}
]
},
"invoicee": {
"anyOf": [
{
"$ref": "#/components/schemas/B2bPartyInput"
},
{
"type": "null"
}
]
},
"invoicer": {
"anyOf": [
{
"$ref": "#/components/schemas/B2bPartyInput"
},
{
"type": "null"
}
]
},
"sellerAgent": {
"anyOf": [
{
"$ref": "#/components/schemas/B2bPartyInput"
},
{
"type": "null"
}
]
},
"sellerTaxRepresentative": {
"anyOf": [
{
"$ref": "#/components/schemas/B2bPartyInput"
},
{
"type": "null"
}
]
},
"payer": {
"anyOf": [
{
"$ref": "#/components/schemas/B2bPartyInput"
},
{
"type": "null"
}
]
},
"buyerAgent": {
"anyOf": [
{
"$ref": "#/components/schemas/B2bPartyInput"
},
{
"type": "null"
}
]
},
"charges": {
"type": "array",
"items": {
"$ref": "#/components/schemas/B2bChargeInput"
}
},
"allowances": {
"type": "array",
"items": {
"$ref": "#/components/schemas/B2bAllowanceInput"
}
},
"paymentMeans": {
"type": "array",
"items": {
"$ref": "#/components/schemas/B2bPaymentMeansInput"
}
},
"paymentTerms": {
"type": [
"string",
"null"
]
},
"billingPeriodBegin": {
"externalDocs": {
"url": "https://schema.org/Date"
},
"type": [
"string",
"null"
]
},
"billingPeriodEnd": {
"externalDocs": {
"url": "https://schema.org/Date"
},
"type": [
"string",
"null"
]
},
"referencedDocuments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/B2bReferencedDocumentInput"
}
},
"notes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/B2bNoteInput"
}
},
"shipping": {
"anyOf": [
{
"$ref": "#/components/schemas/B2bShippingInput"
},
{
"type": "null"
}
]
},
"lines": {
"type": "array",
"items": {
"$ref": "#/components/schemas/B2bTransactionLineInput"
}
},
"attachments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/B2bAttachmentInput"
}
}
}
},
"B2bTransactionReport.B2bTransactionReportOutput": {
"type": "object",
"properties": {
"uuid": {
"type": "string"
},
"siren": {
"type": "string"
},
"invoiceId": {
"type": "string"
},
"invoiceDate": {
"type": "string"
},
"invoiceDueDate": {
"type": "string"
},
"invoiceType": {
"type": "string"
},
"processType": {
"type": "string"
},
"cancelledAt": {
"type": [
"string",
"null"
]
}
}
},
"B2bTransactionReport.B2bTransactionReportOutput.jsonld": {
"allOf": [
{
"$ref": "#/components/schemas/HydraItemBaseSchema"
},
{
"type": "object",
"properties": {
"uuid": {
"type": "string"
},
"siren": {
"type": "string"
},
"invoiceId": {
"type": "string"
},
"invoiceDate": {
"type": "string"
},
"invoiceDueDate": {
"type": "string"
},
"invoiceType": {
"type": "string"
},
"processType": {
"type": "string"
},
"cancelledAt": {
"type": [
"string",
"null"
]
}
}
}
]
},
"B2cPaymentItemInput": {
"type": "object",
"required": [
"collectedAmount",
"taxRate"
],
"properties": {
"collectedAmount": {
"pattern": "^(\\d+(\\.\\d{1,2})?)$",
"description": "Total collected amount, including tax. Up to 2 decimal places.",
"example": "100.00",
"type": "string"
},
"taxRate": {
"pattern": "^(\\d{1,3}(\\.\\d{1,2})?)$",
"description": "Tax rate applied to the payment. Up to 2 decimal places.",
"example": "20.00",
"type": "string"
}
}
},
"B2cPaymentReport.B2bTransactionReportOutput": {
"type": "object",
"properties": {
"uuid": {
"type": "string"
},
"siren": {
"type": "string"
},
"invoiceId": {
"type": "string"
},
"invoiceDate": {
"type": "string"
},
"invoiceDueDate": {
"type": "string"
},
"invoiceType": {
"type": "string"
},
"processType": {
"type": "string"
},
"cancelledAt": {
"type": [
"string",
"null"
]
}
}
},
"B2cPaymentReport.B2bTransactionReportOutput.jsonld": {
"allOf": [
{
"$ref": "#/components/schemas/HydraItemBaseSchema"
},
{
"type": "object",
"properties": {
"uuid": {
"type": "string"
},
"siren": {
"type": "string"
},
"invoiceId": {
"type": "string"
},
"invoiceDate": {
"type": "string"
},
"invoiceDueDate": {
"type": "string"
},
"invoiceType": {
"type": "string"
},
"processType": {
"type": "string"
},
"cancelledAt": {
"type": [
"string",
"null"
]
}
}
}
]
},
"B2cPaymentReport.B2cPaymentReportInput": {
"type": "object",
"required": [
"paymentDate"
],
"properties": {
"paymentDate": {
"description": "Date of the payment (YYYY-MM-DD)",
"externalDocs": {
"url": "https://schema.org/Date"
},
"example": "2026-07-31",
"type": "string"
},
"paymentDetails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/B2cPaymentItemInput"
}
}
}
},
"B2cPaymentReport.B2cPaymentReportOutput": {
"type": "object",
"properties": {
"uuid": {
"type": "string"
},
"siren": {
"type": "string"
},
"paymentDate": {
"type": "string"
},
"totalAmount": {
"type": "string"
},
"cancelledAt": {
"type": [
"string",
"null"
]
}
}
},
"B2cPaymentReport.B2cPaymentReportOutput.jsonld": {
"allOf": [
{
"$ref": "#/components/schemas/HydraItemBaseSchema"
},
{
"type": "object",
"properties": {
"uuid": {
"type": "string"
},
"siren": {
"type": "string"
},
"paymentDate": {
"type": "string"
},
"totalAmount": {
"type": "string"
},
"cancelledAt": {
"type": [
"string",
"null"
]
}
}
}
]
},
"B2cTaxDetailInput": {
"type": "object",
"required": [
"taxableAmount",
"taxAmount",
"percent"
],
"properties": {
"taxableAmount": {
"type": "string"
},
"taxAmount": {
"type": "string"
},
"percent": {
"description": "VAT rate percentage",
"example": "20.0",
"type": "string"
},
"taxCategoryCode": {
"enum": [
"S",
"Z",
"E",
"AE",
"K",
"G",
"O",
"L",
"M"
],
"description": "VAT category code (UNCL5305)",
"externalDocs": {
"url": "https://service.unece.org/trade/untdid/d99a/uncl/uncl5305.htm"
},
"example": "S",
"type": [
"string",
"null"
]
}
}
},
"B2cTransactionItemInput": {
"type": "object",
"required": [
"categoryCode",
"taxableTotalAmount",
"taxTotalAmount",
"taxDetails",
"currency"
],
"properties": {
"categoryCode": {
"description": "Nature of the transaction",
"example": "TPS1",
"type": "string",
"enum": [
"TLB1",
"TPS1",
"TNT1",
"TMA1"
]
},
"taxableTotalAmount": {
"description": "Pre-tax total amount",
"example": "100.00",
"type": "string"
},
"taxTotalAmount": {
"description": "Tax total amount",
"example": "20.00",
"type": "string"
},
"taxDetails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/B2cTaxDetailInput"
}
},
"currency": {
"enum": [
"AED",
"AFN",
"ALL",
"AMD",
"ANG",
"AOA",
"ARS",
"AUD",
"AWG",
"AZN",
"BAM",
"BBD",
"BDT",
"BGN",
"BHD",
"BIF",
"BMD",
"BND",
"BOB",
"BOV",
"BRL",
"BSD",
"BTN",
"BWP",
"BYN",
"BZD",
"CAD",
"CDF",
"CHE",
"CHF",
"CHW",
"CLF",
"CLP",
"CNY",
"COP",
"COU",
"CRC",
"CUC",
"CUP",
"CVE",
"CZK",
"DJF",
"DKK",
"DOP",
"DZD",
"EGP",
"ERN",
"ETB",
"EUR",
"FJD",
"FKP",
"GBP",
"GEL",
"GHS",
"GIP",
"GMD",
"GNF",
"GTQ",
"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",
"LYD",
"MAD",
"MDL",
"MGA",
"MKD",
"MMK",
"MXN",
"MXV",
"MYR",
"MZN",
"NAD",
"NGN",
"NIO",
"NOK",
"NPR",
"NZD",
"OMR",
"PAB",
"PEN",
"PGK",
"PHP",
"PKR",
"PLN",
"PYG",
"QAR",
"RON",
"RSD",
"RUB",
"RWF",
"SAR",
"SBD",
"SCR",
"SDG",
"SEK",
"SGD",
"SHP",
"SLL",
"SOS",
"SRD",
"SSP",
"STN",
"SVC",
"SYP",
"SZL",
"THB",
"TJS",
"TMT",
"TND",
"TOP",
"TRY",
"TTD",
"TWD",
"TZS",
"UAH",
"UGX",
"USD",
"USN",
"UYI",
"UYU",
"UYW",
"UZS",
"VES",
"VND",
"VUV",
"WST",
"XAF",
"XAG",
"XAU",
"XBA",
"XBB",
"XBC",
"XBD",
"XCD",
"XDR",
"XOF",
"XPD",
"XPF",
"XPT",
"XSU",
"XTS",
"XUA",
"XXX",
"YER",
"ZAR",
"ZMW",
"ZWL"
],
"description": "ISO 4217 currency code",
"example": "EUR",
"type": "string"
},
"taxPaymentOption": {
"description": "Tax payment option (required when categoryCode is TPS1)",
"type": [
"string",
"null"
],
"enum": [
"invoice",
"delivery",
"payment",
null
]
}
}
},
"B2cTransactionReport.B2cTransactionReportInput": {
"type": "object",
"required": [
"transactionDate"
],
"properties": {
"transactionDate": {
"description": "Date of the POS closure/batch (YYYY-MM-DD)",
"externalDocs": {
"url": "https://schema.org/Date"
},
"example": "2023-01-01",
"type": "string"
},
"transactions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/B2cTransactionItemInput"
}
},
"registerId": {
"description": "POS terminal identifier",
"example": "REG123",
"type": [
"string",
"null"
]
},
"storeId": {
"description": "Physical or logical store identifier",
"example": "STORE456",
"type": [
"string",
"null"
]
},
"closureId": {
"description": "Register closure identifier",
"example": "CLOSURE789",
"type": [
"string",
"null"
]
}
}
},
"B2cTransactionReport.B2cTransactionReportOutput": {
"type": "object",
"properties": {
"uuid": {
"type": "string"
},
"siren": {
"type": "string"
},
"transactionDate": {
"type": "string"
},
"transactionCount": {
"type": "integer"
},
"registerId": {
"type": [
"string",
"null"
]
},
"storeId": {
"type": [
"string",
"null"
]
},
"closureId": {
"type": [
"string",
"null"
]
},
"cancelledAt": {
"type": [
"string",
"null"
]
}
}
},
"B2cTransactionReport.B2cTransactionReportOutput.jsonld": {
"allOf": [
{
"$ref": "#/components/schemas/HydraItemBaseSchema"
},
{
"type": "object",
"properties": {
"uuid": {
"type": "string"
},
"siren": {
"type": "string"
},
"transactionDate": {
"type": "string"
},
"transactionCount": {
"type": "integer"
},
"registerId": {
"type": [
"string",
"null"
]
},
"storeId": {
"type": [
"string",
"null"
]
},
"closureId": {
"type": [
"string",
"null"
]
},
"cancelledAt": {
"type": [
"string",
"null"
]
}
}
}
]
},
"ConstraintViolation": {
"type": "object",
"description": "Unprocessable entity",
"properties": {
"status": {
"default": 422,
"type": "integer"
},
"violations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"propertyPath": {
"type": "string",
"description": "The property path of the violation"
},
"message": {
"type": "string",
"description": "The message associated with the violation"
},
"code": {
"type": "string",
"description": "The code of the violation"
},
"hint": {
"type": "string",
"description": "An extra hint to understand the violation"
},
"payload": {
"type": "object",
"additionalProperties": true,
"description": "The serialized payload of the violation"
}
},
"required": [
"propertyPath",
"message"
]
}
},
"detail": {
"readOnly": true,
"type": "string"
},
"type": {
"readOnly": true,
"type": "string"
},
"title": {
"readOnly": true,
"type": [
"string",
"null"
]
},
"instance": {
"readOnly": true,
"type": [
"string",
"null"
]
}
}
},
"ConstraintViolation.jsonld": {
"allOf": [
{
"$ref": "#/components/schemas/HydraItemBaseSchema"
},
{
"type": "object",
"properties": {
"status": {
"default": 422,
"type": "integer"
},
"violations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"propertyPath": {
"type": "string",
"description": "The property path of the violation"
},
"message": {
"type": "string",
"description": "The message associated with the violation"
},
"code": {
"type": "string",
"description": "The code of the violation"
},
"hint": {
"type": "string",
"description": "An extra hint to understand the violation"
},
"payload": {
"type": "object",
"additionalProperties": true,
"description": "The serialized payload of the violation"
}
},
"required": [
"propertyPath",
"message"
]
}
},
"detail": {
"readOnly": true,
"type": "string"
},
"description": {
"readOnly": true,
"type": "string"
},
"type": {
"readOnly": true,
"type": "string"
},
"title": {
"readOnly": true,
"type": [
"string",
"null"
]
},
"instance": {
"readOnly": true,
"type": [
"string",
"null"
]
}
}
}
],
"description": "Unprocessable entity"
},
"CreditNote.InvoiceOutput": {
"type": "object",
"properties": {
"uuid": {
"type": "string"
},
"direction": {
"type": "string"
},
"status": {
"type": "string"
},
"afnorStatus": {
"type": "integer"
},
"invoiceTypeCode": {
"type": [
"string",
"null"
]
},
"invoiceNumber": {
"type": "string"
},
"invoiceDate": {
"type": "string"
},
"dueDate": {
"type": [
"string",
"null"
]
},
"party": {
"$ref": "#/components/schemas/InvoicePartyOutput"
},
"counterparty": {
"$ref": "#/components/schemas/InvoicePartyOutput"
},
"sender": {
"$ref": "#/components/schemas/InvoicePartyOutput"
},
"recipient": {
"$ref": "#/components/schemas/InvoicePartyOutput"
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": [
"string",
"null"
]
},
"rejectionReason": {
"anyOf": [
{
"$ref": "#/components/schemas/RejectionReasonOutput"
},
{
"type": "null"
}
]
},
"referencedInvoiceUuid": {
"type": [
"string",
"null"
]
},
"isSelfBilling": {
"default": false,
"type": "boolean"
}
}
},
"CreditNote.InvoiceOutput.jsonld": {
"allOf": [
{
"$ref": "#/components/schemas/HydraItemBaseSchema"
},
{
"type": "object",
"properties": {
"uuid": {
"type": "string"
},
"direction": {
"type": "string"
},
"status": {
"type": "string"
},
"afnorStatus": {
"type": "integer"
},
"invoiceTypeCode": {
"type": [
"string",
"null"
]
},
"invoiceNumber": {
"type": "string"
},
"invoiceDate": {
"type": "string"
},
"dueDate": {
"type": [
"string",
"null"
]
},
"party": {
"$ref": "#/components/schemas/InvoicePartyOutput.jsonld"
},
"counterparty": {
"$ref": "#/components/schemas/InvoicePartyOutput.jsonld"
},
"sender": {
"$ref": "#/components/schemas/InvoicePartyOutput.jsonld"
},
"recipient": {
"$ref": "#/components/schemas/InvoicePartyOutput.jsonld"
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": [
"string",
"null"
]
},
"rejectionReason": {
"anyOf": [
{
"$ref": "#/components/schemas/RejectionReasonOutput.jsonld"
},
{
"type": "null"
}
]
},
"referencedInvoiceUuid": {
"type": [
"string",
"null"
]
},
"isSelfBilling": {
"default": false,
"type": "boolean"
}
}
}
]
},
"CreditNote.InvoiceStatusOutput": {
"type": "object",
"properties": {
"afnorStatusCode": {
"type": "integer",
"enum": [
200,
201,
202,
203,
204,
205,
206,
207,
208,
209,
210,
211,
212,
213
]
},
"codeLabel": {
"type": "string"
},
"receivedAt": {
"type": "string",
"format": "date-time"
},
"rejectionReason": {
"anyOf": [
{
"$ref": "#/components/schemas/RejectionReasonOutput"
},
{
"type": "null"
}
]
}
}
},
"CreditNote.InvoiceStatusOutput.jsonld": {
"allOf": [
{
"$ref": "#/components/schemas/HydraItemBaseSchema"
},
{
"type": "object",
"properties": {
"afnorStatusCode": {
"type": "integer",
"enum": [
200,
201,
202,
203,
204,
205,
206,
207,
208,
209,
210,
211,
212,
213
]
},
"codeLabel": {
"type": "string"
},
"receivedAt": {
"type": "string",
"format": "date-time"
},
"rejectionReason": {
"anyOf": [
{
"$ref": "#/components/schemas/RejectionReasonOutput.jsonld"
},
{
"type": "null"
}
]
}
}
}
]
},
"CreditNote.UpdateInvoiceStatusInput": {
"type": "object",
"required": [
"afnorStatusCode"
],
"properties": {
"afnorStatusCode": {
"enum": [
200,
"SUBMITTED",
201,
"ISSUED",
202,
"RECEIVED",
203,
"MADE_AVAILABLE",
204,
"IN_HAND",
205,
"APPROVED",
206,
"PARTIALLY_APPROVED",
207,
"DISPUTED",
208,
"SUSPENDED",
209,
"COMPLETED",
210,
"REFUSED",
211,
"PAYMENT_SENT",
212,
"PAYMENT_RECEIVED",
213,
"REJECTED"
],
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"rejectionDetails": {
"anyOf": [
{
"$ref": "#/components/schemas/InvoiceRejectionDataInput"
},
{
"type": "null"
}
]
},
"paymentDetails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InvoicePaymentDataInput"
}
}
}
},
"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",
"credit_note.status",
"credit_note.inbound",
"credit_note.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"
]
}
}
},
"FrenchDirectoryEntry.FrenchDirectoryEntryOutput": {
"type": "object",
"description": "Search French companies in the directory.\n\n**At least one** of `siren`, `siret`, or `name` is required.\n\n`siren` and `siret` are mutually exclusive: supplying both returns a 400 error.",
"properties": {
"displayName": {
"type": "string"
},
"countryCode": {
"type": "string"
},
"type": {
"type": [
"string",
"null"
],
"enum": [
"LEGAL_UNIT",
"OFFICE",
null
]
},
"siren": {
"type": [
"string",
"null"
]
},
"siret": {
"type": [
"string",
"null"
]
},
"networkIdentifiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NetworkIdentifierOutput"
}
}
}
},
"FrenchDirectoryEntry.FrenchDirectoryEntryOutput.jsonld": {
"allOf": [
{
"$ref": "#/components/schemas/HydraItemBaseSchema"
},
{
"type": "object",
"properties": {
"displayName": {
"type": "string"
},
"countryCode": {
"type": "string"
},
"type": {
"type": [
"string",
"null"
],
"enum": [
"LEGAL_UNIT",
"OFFICE",
null
]
},
"siren": {
"type": [
"string",
"null"
]
},
"siret": {
"type": [
"string",
"null"
]
},
"networkIdentifiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NetworkIdentifierOutput.jsonld"
}
}
}
}
],
"description": "Search French companies in the directory.\n\n**At least one** of `siren`, `siret`, or `name` is required.\n\n`siren` and `siret` are mutually exclusive: supplying both returns a 400 error."
},
"HydraCollectionBaseSchema": {
"allOf": [
{
"$ref": "#/components/schemas/HydraCollectionBaseSchemaNoPagination"
},
{
"type": "object",
"properties": {
"hydra:view": {
"type": "object",
"properties": {
"@id": {
"type": "string",
"format": "iri-reference"
},
"@type": {
"type": "string"
},
"hydra:first": {
"type": "string",
"format": "iri-reference"
},
"hydra:last": {
"type": "string",
"format": "iri-reference"
},
"hydra:previous": {
"type": "string",
"format": "iri-reference"
},
"hydra:next": {
"type": "string",
"format": "iri-reference"
}
},
"example": {
"@id": "string",
"@type": "string",
"hydra:first": "string",
"hydra:last": "string",
"hydra:previous": "string",
"hydra:next": "string"
}
}
}
}
]
},
"HydraCollectionBaseSchemaNoPagination": {
"type": "object",
"properties": {
"hydra:totalItems": {
"type": "integer",
"minimum": 0
},
"hydra:search": {
"type": "object",
"properties": {
"@type": {
"type": "string"
},
"hydra:template": {
"type": "string"
},
"hydra:variableRepresentation": {
"type": "string"
},
"hydra:mapping": {
"type": "array",
"items": {
"type": "object",
"properties": {
"@type": {
"type": "string"
},
"variable": {
"type": "string"
},
"property": {
"type": [
"string",
"null"
]
},
"required": {
"type": "boolean"
}
}
}
}
}
}
}
},
"HydraItemBaseSchema": {
"type": "object",
"properties": {
"@context": {
"oneOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"@vocab": {
"type": "string"
},
"hydra": {
"type": "string",
"enum": [
"http://www.w3.org/ns/hydra/core#"
]
}
},
"required": [
"@vocab",
"hydra"
],
"additionalProperties": true
}
]
},
"@id": {
"type": "string"
},
"@type": {
"type": "string"
}
},
"required": [
"@id",
"@type"
]
},
"Invoice.InvoiceOutput": {
"type": "object",
"properties": {
"uuid": {
"type": "string"
},
"direction": {
"type": "string"
},
"status": {
"type": "string"
},
"afnorStatus": {
"type": "integer"
},
"invoiceTypeCode": {
"type": [
"string",
"null"
]
},
"invoiceNumber": {
"type": "string"
},
"invoiceDate": {
"type": "string"
},
"dueDate": {
"type": [
"string",
"null"
]
},
"party": {
"$ref": "#/components/schemas/InvoicePartyOutput"
},
"counterparty": {
"$ref": "#/components/schemas/InvoicePartyOutput"
},
"sender": {
"$ref": "#/components/schemas/InvoicePartyOutput"
},
"recipient": {
"$ref": "#/components/schemas/InvoicePartyOutput"
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": [
"string",
"null"
]
},
"rejectionReason": {
"anyOf": [
{
"$ref": "#/components/schemas/RejectionReasonOutput"
},
{
"type": "null"
}
]
},
"referencedInvoiceUuid": {
"type": [
"string",
"null"
]
},
"isSelfBilling": {
"default": false,
"type": "boolean"
}
}
},
"Invoice.InvoiceOutput.jsonld": {
"allOf": [
{
"$ref": "#/components/schemas/HydraItemBaseSchema"
},
{
"type": "object",
"properties": {
"uuid": {
"type": "string"
},
"direction": {
"type": "string"
},
"status": {
"type": "string"
},
"afnorStatus": {
"type": "integer"
},
"invoiceTypeCode": {
"type": [
"string",
"null"
]
},
"invoiceNumber": {
"type": "string"
},
"invoiceDate": {
"type": "string"
},
"dueDate": {
"type": [
"string",
"null"
]
},
"party": {
"$ref": "#/components/schemas/InvoicePartyOutput.jsonld"
},
"counterparty": {
"$ref": "#/components/schemas/InvoicePartyOutput.jsonld"
},
"sender": {
"$ref": "#/components/schemas/InvoicePartyOutput.jsonld"
},
"recipient": {
"$ref": "#/components/schemas/InvoicePartyOutput.jsonld"
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": [
"string",
"null"
]
},
"rejectionReason": {
"anyOf": [
{
"$ref": "#/components/schemas/RejectionReasonOutput.jsonld"
},
{
"type": "null"
}
]
},
"referencedInvoiceUuid": {
"type": [
"string",
"null"
]
},
"isSelfBilling": {
"default": false,
"type": "boolean"
}
}
}
]
},
"Invoice.InvoiceStatusOutput": {
"type": "object",
"properties": {
"afnorStatusCode": {
"type": "integer",
"enum": [
200,
201,
202,
203,
204,
205,
206,
207,
208,
209,
210,
211,
212,
213
]
},
"codeLabel": {
"type": "string"
},
"receivedAt": {
"type": "string",
"format": "date-time"
},
"rejectionReason": {
"anyOf": [
{
"$ref": "#/components/schemas/RejectionReasonOutput"
},
{
"type": "null"
}
]
}
}
},
"Invoice.InvoiceStatusOutput.jsonld": {
"allOf": [
{
"$ref": "#/components/schemas/HydraItemBaseSchema"
},
{
"type": "object",
"properties": {
"afnorStatusCode": {
"type": "integer",
"enum": [
200,
201,
202,
203,
204,
205,
206,
207,
208,
209,
210,
211,
212,
213
]
},
"codeLabel": {
"type": "string"
},
"receivedAt": {
"type": "string",
"format": "date-time"
},
"rejectionReason": {
"anyOf": [
{
"$ref": "#/components/schemas/RejectionReasonOutput.jsonld"
},
{
"type": "null"
}
]
}
}
}
]
},
"Invoice.UpdateInvoiceStatusInput": {
"type": "object",
"required": [
"afnorStatusCode"
],
"properties": {
"afnorStatusCode": {
"enum": [
200,
"SUBMITTED",
201,
"ISSUED",
202,
"RECEIVED",
203,
"MADE_AVAILABLE",
204,
"IN_HAND",
205,
"APPROVED",
206,
"PARTIALLY_APPROVED",
207,
"DISPUTED",
208,
"SUSPENDED",
209,
"COMPLETED",
210,
"REFUSED",
211,
"PAYMENT_SENT",
212,
"PAYMENT_RECEIVED",
213,
"REJECTED"
],
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"rejectionDetails": {
"anyOf": [
{
"$ref": "#/components/schemas/InvoiceRejectionDataInput"
},
{
"type": "null"
}
]
},
"paymentDetails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InvoicePaymentDataInput"
}
}
}
},
"InvoicePartyOutput": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"siren": {
"type": [
"string",
"null"
]
},
"siret": {
"type": [
"string",
"null"
]
},
"identifierScheme": {
"type": [
"string",
"null"
]
},
"identifierValue": {
"type": [
"string",
"null"
]
}
}
},
"InvoicePartyOutput.jsonld": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"siren": {
"type": [
"string",
"null"
]
},
"siret": {
"type": [
"string",
"null"
]
},
"identifierScheme": {
"type": [
"string",
"null"
]
},
"identifierValue": {
"type": [
"string",
"null"
]
}
}
},
"InvoicePaymentDataInput": {
"type": "object",
"properties": {
"vatRate": {
"type": "string"
},
"amount": {
"type": "string"
},
"currency": {
"enum": [
"AED",
"AFN",
"ALL",
"AMD",
"ANG",
"AOA",
"ARS",
"AUD",
"AWG",
"AZN",
"BAM",
"BBD",
"BDT",
"BGN",
"BHD",
"BIF",
"BMD",
"BND",
"BOB",
"BOV",
"BRL",
"BSD",
"BTN",
"BWP",
"BYN",
"BZD",
"CAD",
"CDF",
"CHE",
"CHF",
"CHW",
"CLF",
"CLP",
"CNY",
"COP",
"COU",
"CRC",
"CUC",
"CUP",
"CVE",
"CZK",
"DJF",
"DKK",
"DOP",
"DZD",
"EGP",
"ERN",
"ETB",
"EUR",
"FJD",
"FKP",
"GBP",
"GEL",
"GHS",
"GIP",
"GMD",
"GNF",
"GTQ",
"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",
"LYD",
"MAD",
"MDL",
"MGA",
"MKD",
"MMK",
"MXN",
"MXV",
"MYR",
"MZN",
"NAD",
"NGN",
"NIO",
"NOK",
"NPR",
"NZD",
"OMR",
"PAB",
"PEN",
"PGK",
"PHP",
"PKR",
"PLN",
"PYG",
"QAR",
"RON",
"RSD",
"RUB",
"RWF",
"SAR",
"SBD",
"SCR",
"SDG",
"SEK",
"SGD",
"SHP",
"SLL",
"SOS",
"SRD",
"SSP",
"STN",
"SVC",
"SYP",
"SZL",
"THB",
"TJS",
"TMT",
"TND",
"TOP",
"TRY",
"TTD",
"TWD",
"TZS",
"UAH",
"UGX",
"USD",
"USN",
"UYI",
"UYU",
"UYW",
"UZS",
"VES",
"VND",
"VUV",
"WST",
"XAF",
"XAG",
"XAU",
"XBA",
"XBB",
"XBC",
"XBD",
"XCD",
"XDR",
"XOF",
"XPD",
"XPF",
"XPT",
"XSU",
"XTS",
"XUA",
"XXX",
"YER",
"ZAR",
"ZMW",
"ZWL"
],
"type": "string"
}
}
},
"InvoiceRejectionDataInput": {
"type": "object",
"required": [
"rejectionReason"
],
"properties": {
"rejectionReason": {
"enum": [
"LEGAL_INFORMATION_MISSING",
"INCORRECT_RECIPIENT",
"EINVOICING_ADDRESS_INCORRECT",
"UNKNOWN_TRANSACTION",
"PO_REFERENCE_INCORRECT_OR_MISSING",
"CONTRACT_REFERENCE_MISSING",
"VAT_RATE_INCORRECT",
"TOTAL_AMOUNT_INCORRECT",
"CALCULATION_ERROR",
"DUPLICATED_INVOICE",
"DOUBLE_INVOICING",
"CONTRACT_TERMINATED",
"UNKNOWN_ISSUER",
"FINANCE_TERMS_INCORRECT",
"PRICES_INCORRECT",
"SIRET_INCORRECT_OR_MISSING",
"ROUTING_FAILURE",
"REFERENCE_INCORRECT",
"QUANTITY_INCORRECT",
"ITEM_INCORRECT",
"ITEM_QUALITY_INSUFFICIENT",
"DELIVERY_ISSUE",
"PAYMENT_TERMS_INCORRECT",
"OTHER",
"UNIT_PRICE_INCORRECT",
"DISCOUNT_INCORRECT",
"BANK_DETAILS_INCORRECT",
"MISSING_DOCUMENTS"
],
"type": "string"
},
"message": {
"maxLength": 1024,
"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"
},
"status": {
"type": "string",
"enum": [
"TO_BE_ONBOARDED",
"ONBOARDING_CREATED",
"ONBOARDING_STARTED",
"ONBOARDING_ACTION_REQUIRED",
"ONBOARDING_IN_PROGRESS",
"ONBOARDED"
]
},
"displayName": {
"type": "string"
},
"countryCode": {
"type": "string"
},
"siren": {
"type": [
"string",
"null"
]
},
"vatRegime": {
"type": [
"string",
"null"
]
},
"networkIdentifiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NetworkIdentifierOutput"
}
},
"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"
},
"status": {
"type": "string",
"enum": [
"TO_BE_ONBOARDED",
"ONBOARDING_CREATED",
"ONBOARDING_STARTED",
"ONBOARDING_ACTION_REQUIRED",
"ONBOARDING_IN_PROGRESS",
"ONBOARDED"
]
},
"displayName": {
"type": "string"
},
"countryCode": {
"type": "string"
},
"siren": {
"type": [
"string",
"null"
]
},
"vatRegime": {
"type": [
"string",
"null"
]
},
"networkIdentifiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NetworkIdentifierOutput.jsonld"
}
},
"contactEmail": {
"type": [
"string",
"null"
]
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": [
"string",
"null"
]
}
}
}
]
},
"LegalEntity.NetworkRegisterInput": {
"type": "object",
"properties": {
"suffixes": {
"uniqueItems": true,
"example": [
"SUFFIX1",
"SUFFIX2"
],
"type": "array",
"items": {
"type": "string"
}
}
}
},
"LegalEntity.VatRegimeInput": {
"type": "object",
"required": [
"vatRegime"
],
"properties": {
"vatRegime": {
"enum": [
"MONTHLY",
"QUARTERLY",
"SIMPLIFIED",
"EXEMPT"
],
"example": "MONTHLY",
"type": "string"
}
}
},
"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.LegalEntitySubAccountOutput": {
"type": "object",
"properties": {
"uuid": {
"type": "string"
},
"email": {
"type": "string"
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": [
"string",
"null"
]
}
}
},
"LegalEntitySubAccount.LegalEntitySubAccountOutput.jsonld": {
"allOf": [
{
"$ref": "#/components/schemas/HydraItemBaseSchema"
},
{
"type": "object",
"properties": {
"uuid": {
"type": "string"
},
"email": {
"type": "string"
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": [
"string",
"null"
]
}
}
}
]
},
"NetworkIdentifierOutput": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"siren",
"siret",
"routing_code",
"suffix"
]
},
"value": {
"type": "string"
},
"validFrom": {
"type": "string"
}
}
},
"NetworkIdentifierOutput.jsonld": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"siren",
"siret",
"routing_code",
"suffix"
]
},
"value": {
"type": "string"
},
"validFrom": {
"type": "string"
}
}
},
"Office.NetworkRegisterInput": {
"type": "object",
"properties": {
"suffixes": {
"uniqueItems": true,
"example": [
"SUFFIX1",
"SUFFIX2"
],
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Office.OfficeCreateInput": {
"type": "object",
"required": [
"siret"
],
"properties": {
"siret": {
"pattern": "^(\\d{14})$",
"type": "string"
}
}
},
"Office.OfficeOutput": {
"type": "object",
"properties": {
"uuid": {
"type": "string"
},
"displayName": {
"type": "string"
},
"siren": {
"type": "string"
},
"siret": {
"type": "string"
},
"networkIdentifiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NetworkIdentifierOutput"
}
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": [
"string",
"null"
]
}
}
},
"Office.OfficeOutput.jsonld": {
"allOf": [
{
"$ref": "#/components/schemas/HydraItemBaseSchema"
},
{
"type": "object",
"properties": {
"uuid": {
"type": "string"
},
"displayName": {
"type": "string"
},
"siren": {
"type": "string"
},
"siret": {
"type": "string"
},
"networkIdentifiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NetworkIdentifierOutput.jsonld"
}
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": [
"string",
"null"
]
}
}
}
]
},
"RejectionReasonOutput": {
"type": "object",
"properties": {
"reasonCode": {
"type": "string",
"enum": [
"LEGAL_INFORMATION_MISSING",
"INCORRECT_RECIPIENT",
"EINVOICING_ADDRESS_INCORRECT",
"UNKNOWN_TRANSACTION",
"PO_REFERENCE_INCORRECT_OR_MISSING",
"CONTRACT_REFERENCE_MISSING",
"VAT_RATE_INCORRECT",
"TOTAL_AMOUNT_INCORRECT",
"CALCULATION_ERROR",
"DUPLICATED_INVOICE",
"DOUBLE_INVOICING",
"CONTRACT_TERMINATED",
"UNKNOWN_ISSUER",
"FINANCE_TERMS_INCORRECT",
"PRICES_INCORRECT",
"SIRET_INCORRECT_OR_MISSING",
"ROUTING_FAILURE",
"REFERENCE_INCORRECT",
"QUANTITY_INCORRECT",
"ITEM_INCORRECT",
"ITEM_QUALITY_INSUFFICIENT",
"DELIVERY_ISSUE",
"PAYMENT_TERMS_INCORRECT",
"OTHER",
"UNIT_PRICE_INCORRECT",
"DISCOUNT_INCORRECT",
"BANK_DETAILS_INCORRECT",
"MISSING_DOCUMENTS"
]
},
"codeLabel": {
"type": "string"
},
"description": {
"type": [
"string",
"null"
]
}
}
},
"RejectionReasonOutput.jsonld": {
"type": "object",
"properties": {
"reasonCode": {
"type": "string",
"enum": [
"LEGAL_INFORMATION_MISSING",
"INCORRECT_RECIPIENT",
"EINVOICING_ADDRESS_INCORRECT",
"UNKNOWN_TRANSACTION",
"PO_REFERENCE_INCORRECT_OR_MISSING",
"CONTRACT_REFERENCE_MISSING",
"VAT_RATE_INCORRECT",
"TOTAL_AMOUNT_INCORRECT",
"CALCULATION_ERROR",
"DUPLICATED_INVOICE",
"DOUBLE_INVOICING",
"CONTRACT_TERMINATED",
"UNKNOWN_ISSUER",
"FINANCE_TERMS_INCORRECT",
"PRICES_INCORRECT",
"SIRET_INCORRECT_OR_MISSING",
"ROUTING_FAILURE",
"REFERENCE_INCORRECT",
"QUANTITY_INCORRECT",
"ITEM_INCORRECT",
"ITEM_QUALITY_INSUFFICIENT",
"DELIVERY_ISSUE",
"PAYMENT_TERMS_INCORRECT",
"OTHER",
"UNIT_PRICE_INCORRECT",
"DISCOUNT_INCORRECT",
"BANK_DETAILS_INCORRECT",
"MISSING_DOCUMENTS"
]
},
"codeLabel": {
"type": "string"
},
"description": {
"type": [
"string",
"null"
]
}
}
},
"UserConfig.UserConfigCreateInput": {
"type": "object",
"additionalProperties": false,
"required": [
"email"
],
"properties": {
"email": {
"format": "email",
"maxLength": 255,
"description": "Email of the user to configure. If it is not a sub-account of your account yet, it is created.",
"externalDocs": {
"url": "https://schema.org/email"
},
"type": "string"
},
"password": {
"description": "Password used only when the sub-account has to be created. Ignored if the user already exists.",
"type": [
"string",
"null"
]
},
"preferences": {
"$ref": "#/components/schemas/UserConfigPreferences"
}
}
},
"UserConfig.UserConfigOutput": {
"type": "object",
"properties": {
"uuid": {
"type": "string"
},
"email": {
"type": "string"
},
"preferences": {
"$ref": "#/components/schemas/UserConfigPreferences"
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": [
"string",
"null"
]
}
}
},
"UserConfig.UserConfigOutput.jsonld": {
"allOf": [
{
"$ref": "#/components/schemas/HydraItemBaseSchema"
},
{
"type": "object",
"properties": {
"uuid": {
"type": "string"
},
"email": {
"type": "string"
},
"preferences": {
"$ref": "#/components/schemas/UserConfigPreferences.jsonld"
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": [
"string",
"null"
]
}
}
}
]
},
"UserConfig.UserConfigUpdateInput": {
"type": "object",
"additionalProperties": false,
"properties": {
"preferences": {
"$ref": "#/components/schemas/UserConfigPreferences"
}
}
},
"UserConfigPreferences": {
"type": "object",
"properties": {
"accessAllInvoices": {
"description": "Whether the sub-account is allowed to see documents owned by any legal entity of the account. If false, the sub-account can only see documents owned by legal entities it is explicitly assigned to.",
"type": "boolean"
}
}
},
"UserConfigPreferences.jsonld": {
"type": "object",
"properties": {
"accessAllInvoices": {
"description": "Whether the sub-account is allowed to see documents owned by any legal entity of the account. If false, the sub-account can only see documents owned by legal entities it is explicitly assigned to.",
"type": "boolean"
}
}
}
},
"responses": {},
"parameters": {},
"examples": {},
"requestBodies": {},
"headers": {},
"securitySchemes": {}
},
"security": [],
"tags": [
{
"name": "FrenchDirectoryEntry",
"description": "Resource 'FrenchDirectoryEntry' operations."
},
{
"name": "Reporting",
"description": "Resource 'Reporting' operations."
},
{
"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": "Credit Notes",
"description": "Resource 'Credit Notes' operations."
},
{
"name": "LegalEntity",
"description": "Resource 'LegalEntity' operations."
},
{
"name": "LegalEntitySubAccount",
"description": "Resource 'LegalEntitySubAccount' operations."
},
{
"name": "Office",
"description": "Resource 'Office' operations."
},
{
"name": "UserConfig",
"description": "Resource 'UserConfig' operations."
}
],
"webhooks": {}
}