{ "openapi": "3.1.0", "info": { "title": "Flowie Exchange API", "description": "\n## Flowie Exchange API\n\n**The Flowie Exchange API for every persona** — from a solo freelancer to a white-label ISV managing 10,000 companies.\n\nDesign principle: **Stripe Connect for Peppol**. Simple for the simple case, powerful for the complex one.\n\n### Worldwide Coverage\n\nFlowie covers **47 countries** across four continents — Europe (EU-27, EEA, UK, Switzerland),\nthe Middle East (KSA, UAE, Israel, Egypt, Türkiye), Asia (India, Singapore, Malaysia, Thailand,\nVietnam, Japan, South Korea, China), and the Pacific (Australia, New Zealand). The API auto-\ndetects the country from the identifier scheme and enriches data from national registries.\n\n### 4 Personas, 1 API\n\n| Persona | What they need | Example |\n|---------|----------------|---------|\n| **Client** | Send/receive invoices | Accountant using Flowie dashboard |\n| **Agent** | Structured data, batch ops, idempotency | AI workflow, n8n, Make.com |\n| **Integrator** | Connect their app to Peppol for their users | Odoo plugin, WinBooks connector |\n| **White-label** | Run their own branded Peppol service | Accounting firm offering Peppol |\n\n---\n\n### Authentication\n\nAll requests require a Bearer token in the `Authorization` header. **Two authentication methods** are supported — use whichever fits your use case:\n\n#### Method 1: Flowie JWT Token (existing users)\n\nIf you already use the Flowie platform, use your existing JWT token. No extra setup needed.\n\n```\nAuthorization: Bearer eyJhbGciOiJSUzI1NiIs...\n```\n\n- Issued by Flowie's Auth0 tenant\n- Organization resolved from the `_permissions` claim in the token\n- Full access (`*` scope) — permissions are managed at the organization level\n- **Best for**: Dashboard users, existing Flowie apps, internal services\n\n#### Method 2: Exchange API Key (external consumers)\n\nFor programmatic access, generate an API key from the Platform endpoints.\n\n```\nAuthorization: Bearer flw_live_a1b2c3d4e5f6...\n```\n\n**Key types:**\n\n| Type | Prefix | Scope | Use case |\n|------|--------|-------|----------|\n| **Personal** | `flw_live_` | Single company | Client, Agent |\n| **Platform** | `flw_plat_live_` | All managed companies | Integrator |\n| **White-label** | `flw_wl_live_` | Branded instance | White-label partner |\n\n**Scoped permissions** (API keys only):\n\n| Scope | Allows |\n|-------|--------|\n| `send` | Send documents |\n| `receive` | Configure receiving (webhooks, SMP) |\n| `documents.read` | Read documents, download XML/PDF |\n| `documents.search` | Search documents |\n| `documents.write` | Mark read, archive, tag, add notes |\n| `companies.read` | Read company details |\n| `companies.write` | Update company details |\n| `directory` | Search directory, verify recipients |\n| `partners` | Manage trading partners |\n| `payments` | Manage payment methods, terms, and partner sharing |\n| `lifecycle` | Update document lifecycle status |\n| `compliance` | View compliance dashboard and reports |\n| `stats` | Read usage statistics |\n| `platform` | Manage platform (onboard, keys, settings) |\n| `*` | All scopes (default for personal keys) |\n\n**Sandbox**: Use `flw_test_` prefix keys — same endpoints, no real Peppol delivery.\n\nPlatform keys use the `X-Flowie-Company` header to act on behalf of a managed company.\n\n#### How it works\n\nBoth methods return the same result to the API — the caller is identified by their organization ID,\nand endpoints behave identically regardless of which auth method is used.\n\n```\nAuthorization: Bearer \n │\n ├─ starts with flw_ → API Key (database lookup)\n │\n └─ otherwise → JWT (Auth0 JWKS verification)\n```\n\n---\n\n### Built-in Compliance\n\nFlowie auto-reports lifecycle changes to government platforms and handles hard\nclearance across **47 jurisdictions** worldwide. Highlights:\n\n**Europe**\n- **France**: PPF (Portail Public de Facturation), Flowie is registered Plateforme Agréée (PA, formerly PDP) number 0040 — mandate Sept 2026\n- **Italy**: SDI (Sistema di Interscambio) — mandatory since 2019\n- **Belgium**: Peppol BIS — B2B mandate live since 1 January 2026 (HERMES decommissioned 2025-12-31)\n- **Germany**: XRechnung / ZUGFeRD — phased B2B 2025–2028 (Wachstumschancengesetz)\n- **Spain**: Veri*Factu + Crea y Crece B2B mandate phasing\n- **Poland**: KSeF mandatory clearance — large taxpayers Feb 2026, all April 2026\n- **Romania**: RO e-Factura mandatory clearance, universal B2B since July 2024\n- **Hungary**: NAV Online Számla 3.0 — universal real-time reporting\n- **Croatia**: Fiscalisation 2.0 — B2B mandate live since January 2026\n\n**Middle East / Africa**\n- **Saudi Arabia**: ZATCA Fatoora clearance, Wave 24 (full register) by 30 June 2026\n- **UAE**: Peppol 5-corner with FTA Data Reporting Platform — Phase 1 large taxpayers from 1 July 2026\n- **Israel**: ITA SHAAM clearance — threshold drops to NIS 5,000 from June 2026\n- **Egypt**: ETA e-invoicing universal clearance + e-receipt for B2C\n- **Türkiye**: GİB e-Fatura + e-Arşiv, universal from January 2026\n\n**Asia / Pacific**\n- **India**: GST IRP-issued IRN — universal above ₹5 cr turnover, 30-day reporting cap above ₹10 cr\n- **Singapore**: Peppol InvoiceNow + GST 5-corner with IRAS — phased through 2031\n- **Malaysia**: LHDN MyInvois clearance — final wave 1 January 2026 (RM 1m floor)\n- **Australia**: Peppol PINT A-NZ via ATO — federal B2G default by Dec 2026\n- **New Zealand**: Peppol PINT A-NZ via MBIE — supplier mandate Jan 2027 (revenue > NZ$33m)\n- **Japan**: Peppol JP PINT + Qualified Invoice System\n- **South Korea**: NTS HomeTax e-Tax invoice — universal corporate clearance since 2011\n- **China**: Fully Digitalized e-fapiao + Golden Tax IV — codified by 2026 VAT Law\n- **Vietnam**: GDT mandatory e-invoice + Decree 70/2025 expansion\n- **Thailand**: Voluntary e-Tax Invoice / e-Receipt\n\nSee `docs/compliance/index.html` for the full coverage map across all 47 countries.\n\n### AFNOR XP Z12-013\n\nEndpoints under `/afnor/` implement the French AFNOR certification standard for PA / PDP interoperability.\nSame backend, different contract — use these for French e-invoicing certification compliance.\n\n### Idempotency\n\nAll `POST` endpoints accept an `Idempotency-Key` header. Same key within 24 hours returns the cached response.\n\n### Pagination\n\nAll list endpoints use cursor-based pagination: `?limit=50&cursor=xxx`\n\n### Rate Limiting\n\nStandard headers on every response: `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset`.\n\n| Tier | Requests/min |\n|------|-------------|\n| Free | 60 |\n| Starter | 120 |\n| Pro | 300 |\n| Platform | 600 |\n| White-label | 1,200 |\n", "version": "3.0.0" }, "paths": { "/health/liveness": { "get": { "tags": [ "Health" ], "summary": "Liveness", "operationId": "liveness_health_liveness_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Liveness Health Liveness Get" } } } } } } }, "/health/readiness": { "get": { "tags": [ "Health" ], "summary": "Readiness", "operationId": "readiness_health_readiness_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Readiness Health Readiness Get" } } } } } } }, "/health/contracts": { "get": { "tags": [ "Health" ], "summary": "Contract Status", "operationId": "contract_status_health_contracts_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Contract Status Health Contracts Get" } } } } } } }, "/v1/companies": { "post": { "tags": [ "Companies" ], "summary": "Create Company", "operationId": "create_company_v1_companies_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } }, { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Companies" ], "summary": "List Companies", "operationId": "list_companies_v1_companies_get", "parameters": [ { "name": "country", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country" } }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "name": "search", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Search" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 20, "title": "Limit" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } }, { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_CompanyListItem_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/companies/resolve": { "get": { "tags": [ "Companies" ], "summary": "Resolve Company", "description": "Resolve a company from VAT number or SIREN. Creates it in Flowie if not found.", "operationId": "resolve_company_v1_companies_resolve_get", "parameters": [ { "name": "countryCode", "in": "query", "required": true, "schema": { "type": "string", "title": "Countrycode" } }, { "name": "vatNumber", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vatnumber" } }, { "name": "registrationNumber", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Registrationnumber" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } }, { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/companies/search": { "get": { "tags": [ "Companies" ], "summary": "Search Companies", "description": "Autocomplete search in public registries for companies not yet in Flowie.", "operationId": "search_companies_v1_companies_search_get", "parameters": [ { "name": "q", "in": "query", "required": true, "schema": { "type": "string", "title": "Q" } }, { "name": "countryCode", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Countrycode" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 10, "title": "Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } }, { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "title": "Response Search Companies V1 Companies Search Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/companies/join-requests": { "get": { "tags": [ "Companies" ], "summary": "List Join Requests", "description": "List the current user's pending join requests.", "operationId": "list_join_requests_v1_companies_join_requests_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } }, { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "title": "Response List Join Requests V1 Companies Join Requests Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/companies/{company_id}": { "get": { "tags": [ "Companies" ], "summary": "Get Company", "operationId": "get_company_v1_companies__company_id__get", "parameters": [ { "name": "company_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Company Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } }, { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "Companies" ], "summary": "Update Company", "operationId": "update_company_v1_companies__company_id__patch", "parameters": [ { "name": "company_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Company Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } }, { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Companies" ], "summary": "Deregister Company", "operationId": "deregister_company_v1_companies__company_id__delete", "parameters": [ { "name": "company_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Company Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } }, { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/companies/{company_id}/join": { "post": { "tags": [ "Companies" ], "summary": "Request Join", "description": "Request to join a company.", "operationId": "request_join_v1_companies__company_id__join_post", "parameters": [ { "name": "company_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Company Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } }, { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } } ], "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Request Join V1 Companies Company Id Join Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/companies/{company_id}/join-requests/{request_id}/accept": { "post": { "tags": [ "Companies" ], "summary": "Accept Join Request", "description": "Accept a join request (org admin).", "operationId": "accept_join_request_v1_companies__company_id__join_requests__request_id__accept_post", "parameters": [ { "name": "company_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Company Id" } }, { "name": "request_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Request Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } }, { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Accept Join Request V1 Companies Company Id Join Requests Request Id Accept Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/companies/{company_id}/join-requests/{request_id}/reject": { "post": { "tags": [ "Companies" ], "summary": "Reject Join Request", "description": "Reject a join request (org admin).", "operationId": "reject_join_request_v1_companies__company_id__join_requests__request_id__reject_post", "parameters": [ { "name": "company_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Company Id" } }, { "name": "request_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Request Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } }, { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Reject Join Request V1 Companies Company Id Join Requests Request Id Reject Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/documents/send": { "post": { "tags": [ "Documents" ], "summary": "Send Document", "operationId": "send_document_v1_documents_send_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } }, { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendDocumentRequest" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendDocumentResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/documents/send/batch": { "post": { "tags": [ "Documents" ], "summary": "Batch Send", "operationId": "batch_send_v1_documents_send_batch_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } }, { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchSendRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchSendResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/documents/validate": { "post": { "tags": [ "Documents" ], "summary": "Validate Document", "operationId": "validate_document_v1_documents_validate_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } }, { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidateResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/documents": { "get": { "tags": [ "Documents" ], "summary": "List Documents", "operationId": "list_documents_v1_documents_get", "parameters": [ { "name": "direction", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Direction" } }, { "name": "type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Type" } }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "name": "deliveryStatus", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Deliverystatus" } }, { "name": "from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "From" } }, { "name": "to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "To" } }, { "name": "amountMin", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Amountmin" } }, { "name": "amountMax", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Amountmax" } }, { "name": "companyId", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Companyid" } }, { "name": "search", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Search" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 20, "title": "Limit" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } }, { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_DocumentListItem_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/documents/search": { "post": { "tags": [ "Documents" ], "summary": "Search Documents", "operationId": "search_documents_v1_documents_search_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } }, { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_DocumentListItem_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/documents/{document_id}": { "get": { "tags": [ "Documents" ], "summary": "Get Document", "operationId": "get_document_v1_documents__document_id__get", "parameters": [ { "name": "document_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Document Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } }, { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/documents/{document_id}/xml": { "get": { "tags": [ "Documents" ], "summary": "Get Document Xml", "operationId": "get_document_xml_v1_documents__document_id__xml_get", "parameters": [ { "name": "document_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Document Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } }, { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/documents/{document_id}/pdf": { "get": { "tags": [ "Documents" ], "summary": "Get Document Pdf", "operationId": "get_document_pdf_v1_documents__document_id__pdf_get", "parameters": [ { "name": "document_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Document Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } }, { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/documents/{document_id}/structured": { "get": { "tags": [ "Documents" ], "summary": "Get Document Structured", "operationId": "get_document_structured_v1_documents__document_id__structured_get", "parameters": [ { "name": "document_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Document Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } }, { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StructuredDocumentResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/documents/{document_id}/actions": { "post": { "tags": [ "Documents" ], "summary": "Perform Action", "operationId": "perform_action_v1_documents__document_id__actions_post", "parameters": [ { "name": "document_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Document Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } }, { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/documents/{document_id}/lifecycle": { "get": { "tags": [ "Lifecycle" ], "summary": "Get Lifecycle", "operationId": "get_lifecycle_v1_documents__document_id__lifecycle_get", "parameters": [ { "name": "document_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Document Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } }, { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LifecycleHistoryResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "Lifecycle" ], "summary": "Update Lifecycle", "operationId": "update_lifecycle_v1_documents__document_id__lifecycle_post", "parameters": [ { "name": "document_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Document Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } }, { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LifecycleUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LifecycleUpdateResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/documents/lifecycle/batch": { "post": { "tags": [ "Lifecycle" ], "summary": "Batch Lifecycle Update", "operationId": "batch_lifecycle_update_v1_documents_lifecycle_batch_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } }, { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchLifecycleUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LifecycleUpdateResponse" }, "title": "Response Batch Lifecycle Update V1 Documents Lifecycle Batch Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/compliance/status": { "get": { "tags": [ "Compliance" ], "summary": "Get Compliance Status", "operationId": "get_compliance_status_v1_compliance_status_get", "parameters": [ { "name": "companyId", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Companyid" } }, { "name": "country", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } }, { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComplianceStatusResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/compliance/reports": { "get": { "tags": [ "Compliance" ], "summary": "List Compliance Reports", "operationId": "list_compliance_reports_v1_compliance_reports_get", "parameters": [ { "name": "companyId", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Companyid" } }, { "name": "country", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country" } }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "name": "from_", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "From " } }, { "name": "to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "To" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 20, "title": "Limit" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } }, { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComplianceReportResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/directory/search": { "get": { "tags": [ "Directory" ], "summary": "Search Directory", "operationId": "search_directory_v1_directory_search_get", "parameters": [ { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Q" } }, { "name": "vatNumber", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vatnumber" } }, { "name": "country", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country" } }, { "name": "city", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "City" } }, { "name": "postalCode", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Postalcode" } }, { "name": "naceCodes", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Nacecodes" } }, { "name": "documentTypes", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Documenttypes" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 20, "title": "Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } }, { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_DirectorySearchResult_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/directory/{peppol_id}": { "get": { "tags": [ "Directory" ], "summary": "Lookup Peppol Id", "operationId": "lookup_peppol_id_v1_directory__peppol_id__get", "parameters": [ { "name": "peppol_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Peppol Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } }, { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DirectoryLookupResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/directory/verify": { "post": { "tags": [ "Directory" ], "summary": "Verify Recipient", "operationId": "verify_recipient_v1_directory_verify_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } }, { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerifyRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerifyResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/partners": { "post": { "tags": [ "Partners" ], "summary": "Create Partner", "operationId": "create_partner_v1_partners_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } }, { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Partners" ], "summary": "List Partners", "operationId": "list_partners_v1_partners_get", "parameters": [ { "name": "role", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Role" } }, { "name": "search", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Search" } }, { "name": "country", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country" } }, { "name": "tags", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tags" } }, { "name": "hasActivity", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Hasactivity" } }, { "name": "peppolStatus", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Peppolstatus" } }, { "name": "sortBy", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sortby" } }, { "name": "order", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Order" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 20, "title": "Limit" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } }, { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_PartnerListItem_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/partners/{partner_id}": { "get": { "tags": [ "Partners" ], "summary": "Get Partner", "operationId": "get_partner_v1_partners__partner_id__get", "parameters": [ { "name": "partner_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Partner Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } }, { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "Partners" ], "summary": "Update Partner", "operationId": "update_partner_v1_partners__partner_id__patch", "parameters": [ { "name": "partner_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Partner Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } }, { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Partners" ], "summary": "Delete Partner", "operationId": "delete_partner_v1_partners__partner_id__delete", "parameters": [ { "name": "partner_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Partner Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } }, { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/webhooks": { "post": { "tags": [ "Webhooks" ], "summary": "Create Webhook", "operationId": "create_webhook_v1_webhooks_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } }, { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Webhooks" ], "summary": "List Webhooks", "operationId": "list_webhooks_v1_webhooks_get", "parameters": [ { "name": "companyId", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Companyid" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } }, { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_WebhookResponse_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/webhooks/{webhook_id}": { "patch": { "tags": [ "Webhooks" ], "summary": "Update Webhook", "operationId": "update_webhook_v1_webhooks__webhook_id__patch", "parameters": [ { "name": "webhook_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Webhook Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } }, { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Webhooks" ], "summary": "Delete Webhook", "operationId": "delete_webhook_v1_webhooks__webhook_id__delete", "parameters": [ { "name": "webhook_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Webhook Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } }, { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/events": { "get": { "tags": [ "Events" ], "summary": "List Events", "operationId": "list_events_v1_events_get", "parameters": [ { "name": "type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Type" } }, { "name": "companyId", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Companyid" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 20, "title": "Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } }, { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_EventResponse_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/events/{event_id}/ack": { "post": { "tags": [ "Events" ], "summary": "Ack Event", "operationId": "ack_event_v1_events__event_id__ack_post", "parameters": [ { "name": "event_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Event Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } }, { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/events/ack": { "post": { "tags": [ "Events" ], "summary": "Batch Ack Events", "operationId": "batch_ack_events_v1_events_ack_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } }, { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AckRequest" } } } }, "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/events/{event_id}/replay": { "post": { "tags": [ "Events" ], "summary": "Replay Event", "description": "Re-deliver a previously emitted event to all matching webhooks.\n\nReturns a summary of the replay attempt:\n``{eventId, matched, delivered, deliveryId}``. Each delivery uses a fresh\n``X-Flowie-Delivery`` id and ``X-Flowie-Signature`` timestamp; the payload\nis byte-identical to the original.", "operationId": "replay_event_v1_events__event_id__replay_post", "parameters": [ { "name": "event_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Event Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } }, { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Replay Event V1 Events Event Id Replay Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/stats": { "get": { "tags": [ "Stats" ], "summary": "Get Stats", "operationId": "get_stats_v1_stats_get", "parameters": [ { "name": "period", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Period" } }, { "name": "companyId", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Companyid" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } }, { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatsResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/platform/companies": { "post": { "tags": [ "Platform" ], "summary": "Onboard Company", "operationId": "onboard_company_v1_platform_companies_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } }, { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformOnboardRequest" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformOnboardResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Platform" ], "summary": "List Managed Companies", "operationId": "list_managed_companies_v1_platform_companies_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } }, { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_CompanyListItem_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/platform/api-keys": { "post": { "tags": [ "Platform" ], "summary": "Create Api Key", "operationId": "create_api_key_v1_platform_api_keys_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } }, { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiKeyCreateRequest" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiKeyCreateResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Platform" ], "summary": "List Api Keys", "operationId": "list_api_keys_v1_platform_api_keys_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } }, { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_ApiKeyResponse_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/platform/api-keys/{key_id}": { "delete": { "tags": [ "Platform" ], "summary": "Revoke Api Key", "operationId": "revoke_api_key_v1_platform_api_keys__key_id__delete", "parameters": [ { "name": "key_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Key Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } }, { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/platform/usage": { "get": { "tags": [ "Platform" ], "summary": "Get Usage", "operationId": "get_usage_v1_platform_usage_get", "parameters": [ { "name": "period", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Period" } }, { "name": "groupBy", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Groupby" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } }, { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformUsageResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/platform/events": { "get": { "tags": [ "Platform" ], "summary": "Get Platform Events", "operationId": "get_platform_events_v1_platform_events_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } }, { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_EventResponse_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/platform/settings": { "patch": { "tags": [ "Platform" ], "summary": "Update Platform Settings", "operationId": "update_platform_settings_v1_platform_settings_patch", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } }, { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformSettingsUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformSettingsUpdate" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/api-keys": { "post": { "tags": [ "API Keys" ], "summary": "Create Api Key", "description": "Create a new API key for your organization.\n\nAvailable to any authenticated user (JWT or API key).\nThe new key inherits the caller's organization and tier.", "operationId": "create_api_key_v1_api_keys_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } }, { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiKeyCreateRequest" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiKeyCreateResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "API Keys" ], "summary": "List Api Keys", "description": "List all API keys for your organization.", "operationId": "list_api_keys_v1_api_keys_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } }, { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_ApiKeyResponse_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/api-keys/{key_id}": { "delete": { "tags": [ "API Keys" ], "summary": "Revoke Api Key", "description": "Revoke an API key.", "operationId": "revoke_api_key_v1_api_keys__key_id__delete", "parameters": [ { "name": "key_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Key Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } }, { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/categorization/groups": { "get": { "tags": [ "Categorization" ], "summary": "List Groups", "description": "List available tag groups (UNSPSC, Accounting, etc.).", "operationId": "list_groups_v1_categorization_groups_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } }, { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/categorization/groups/{group_id}/tags": { "get": { "tags": [ "Categorization" ], "summary": "List Group Tags", "description": "List tags within a group.", "operationId": "list_group_tags_v1_categorization_groups__group_id__tags_get", "parameters": [ { "name": "group_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Group Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } }, { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/categorization/objects/{object_id}/tags": { "get": { "tags": [ "Categorization" ], "summary": "Get Object Tags", "description": "Get all tags assigned to a document/partner/supplier.", "operationId": "get_object_tags_v1_categorization_objects__object_id__tags_get", "parameters": [ { "name": "object_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Object Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } }, { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "Categorization" ], "summary": "Assign Tag", "description": "Assign a tag to an object (body: {tagId, objectType}).", "operationId": "assign_tag_v1_categorization_objects__object_id__tags_post", "parameters": [ { "name": "object_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Object Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } }, { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Body" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/categorization/objects/{object_id}/tags/{tag_id}": { "delete": { "tags": [ "Categorization" ], "summary": "Remove Tag", "description": "Remove a tag from an object.", "operationId": "remove_tag_v1_categorization_objects__object_id__tags__tag_id__delete", "parameters": [ { "name": "object_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Object Id" } }, { "name": "tag_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Tag Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } }, { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/categorization/objects/tags/auto": { "post": { "tags": [ "Categorization" ], "summary": "Auto Recommend", "description": "Get AI-recommended tags for an object.", "operationId": "auto_recommend_v1_categorization_objects_tags_auto_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } }, { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Body" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/payments/documents/{documentId}": { "get": { "tags": [ "Payments" ], "summary": "Get Document Payments", "description": "Get payment information linked to a document (invoice, PO).", "operationId": "get_document_payments_v1_payments_documents__documentId__get", "parameters": [ { "name": "documentId", "in": "path", "required": true, "schema": { "type": "string", "title": "Documentid" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } }, { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/payments/documents/{documentId}/pay": { "post": { "tags": [ "Payments" ], "summary": "Record Document Payment", "description": "Record a payment against a document.", "operationId": "record_document_payment_v1_payments_documents__documentId__pay_post", "parameters": [ { "name": "documentId", "in": "path", "required": true, "schema": { "type": "string", "title": "Documentid" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } }, { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Body" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/payments/export/iso20022": { "post": { "tags": [ "Payments" ], "summary": "Export Iso20022", "description": "Generate an ISO 20022 (SEPA) payment file.", "operationId": "export_iso20022_v1_payments_export_iso20022_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } }, { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Body" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/me": { "get": { "tags": [ "Identity" ], "summary": "Get the caller identity + accessible organizations", "description": "Return identity + the orgs the caller can switch to.\n\nFor JWT auth, ``organizationIds`` is every org in the user's\n``_permissions`` claim. For API-key auth, it's the single org the\nkey is bound to (no switching). Use the\n``X-Flowie-Organization-Id`` header on subsequent requests to act\nas a specific org.", "operationId": "get_me_v1_me_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } }, { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Me V1 Me Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/afnor/flow-service/v1/healthcheck": { "get": { "tags": [ "AFNOR Flow Service" ], "summary": "Health check", "description": "Return 200 with service status.", "operationId": "healthcheck_afnor_flow_service_v1_healthcheck_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Healthcheck Afnor Flow Service V1 Healthcheck Get" } } } } } } }, "/afnor/flow-service/v1/flows": { "post": { "tags": [ "AFNOR Flow Service" ], "summary": "Submit a flow (createFlow)", "description": "Submit a document flow (multipart/form-data).\n\n- `flowInfo` part: JSON FlowInfo object\n- `file` part: binary document content", "operationId": "create_flow_afnor_flow_service_v1_flows_post", "parameters": [ { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } }, { "name": "Request-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Request-Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_create_flow_afnor_flow_service_v1_flows_post" } } } }, "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FullFlowInfo" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/afnor/flow-service/v1/flows/search": { "post": { "tags": [ "AFNOR Flow Service" ], "summary": "Search flows (searchFlows)", "description": "Search flows with AFNOR filter semantics.\n\nFilters are AND-combined; arrays within a filter are OR-combined.\nResults are ordered by updatedAt ascending. Use updatedAfter = last\nresult's updatedAt for cursor-based pagination (no offset).", "operationId": "search_flows_afnor_flow_service_v1_flows_search_post", "parameters": [ { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchFlowParams" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchFlowResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/afnor/flow-service/v1/flows/{flow_id}": { "get": { "tags": [ "AFNOR Flow Service" ], "summary": "Download a flow (getFlow)", "description": "Download a flow by ID.\n\n- Metadata: returns JSON flow description\n- Original / Converted: returns raw XML bytes\n- ReadableView: returns PDF bytes", "operationId": "get_flow_afnor_flow_service_v1_flows__flow_id__get", "parameters": [ { "name": "flow_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Flow Id" } }, { "name": "docType", "in": "query", "required": false, "schema": { "type": "string", "description": "Metadata | Original | ReadableView | Converted", "default": "Metadata", "title": "Doctype" }, "description": "Metadata | Original | ReadableView | Converted" }, { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/afnor/flow-service/v1/webhooks": { "get": { "tags": [ "AFNOR Flow Service" ], "summary": "List webhooks (listWebhooks)", "description": "List all webhooks in AFNOR format.", "operationId": "list_webhooks_afnor_flow_service_v1_webhooks_get", "parameters": [ { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AfnorWebhook" }, "title": "Response List Webhooks Afnor Flow Service V1 Webhooks Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "AFNOR Flow Service" ], "summary": "Create webhook (createWebhook)", "description": "Create a new webhook subscription.", "operationId": "create_webhook_afnor_flow_service_v1_webhooks_post", "parameters": [ { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookParams" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AfnorWebhook" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/afnor/flow-service/v1/webhooks/{webhook_uid}": { "get": { "tags": [ "AFNOR Flow Service" ], "summary": "Get webhook detail (getWebhook)", "description": "Get a specific webhook by ID.", "operationId": "get_webhook_afnor_flow_service_v1_webhooks__webhook_uid__get", "parameters": [ { "name": "webhook_uid", "in": "path", "required": true, "schema": { "type": "string", "title": "Webhook Uid" } }, { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AfnorWebhook" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "AFNOR Flow Service" ], "summary": "Update webhook technical params (updateWebhook)", "description": "Update webhook technical parameters (headers, auth, signature).\n\nPer XP Z12-013: metadata cannot be changed; only callback technical params.\nReturns 204 No Content.", "operationId": "update_webhook_afnor_flow_service_v1_webhooks__webhook_uid__patch", "parameters": [ { "name": "webhook_uid", "in": "path", "required": true, "schema": { "type": "string", "title": "Webhook Uid" } }, { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookPatchPayload" } } } }, "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "AFNOR Flow Service" ], "summary": "Delete webhook (deleteWebhook)", "description": "Unsubscribe a webhook.", "operationId": "delete_webhook_afnor_flow_service_v1_webhooks__webhook_uid__delete", "parameters": [ { "name": "webhook_uid", "in": "path", "required": true, "schema": { "type": "string", "title": "Webhook Uid" } }, { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/afnor/directory-service/v1/healthcheck": { "get": { "tags": [ "AFNOR Directory Service" ], "summary": "Health check", "description": "Return 200 with service status.", "operationId": "healthcheck_afnor_directory_service_v1_healthcheck_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Healthcheck Afnor Directory Service V1 Healthcheck Get" } } } } } } }, "/afnor/directory-service/v1/siren/search": { "post": { "tags": [ "AFNOR Directory Service" ], "summary": "Search companies by SIREN (searchCompanyBySiren)", "description": "Search legal units by SIREN via the Peppol directory.\n\nMinimum supported filter: exact SIREN match. Additional filters\n(businessName, entityType, administrativeStatus) are applied\npost-fetch as best-effort.", "operationId": "search_siren_afnor_directory_service_v1_siren_search_post", "parameters": [ { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SirenSearchRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SirenSearchResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/afnor/directory-service/v1/siren/code-insee:{siren}": { "get": { "tags": [ "AFNOR Directory Service" ], "summary": "Get company by SIREN (getCompanyBySiren)", "description": "Look up a legal unit by its 9-digit SIREN number.", "operationId": "get_siren_afnor_directory_service_v1_siren_code_insee__siren__get", "parameters": [ { "name": "siren", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^([0-9]{9})$", "description": "SIREN (9 digits)", "title": "Siren" }, "description": "SIREN (9 digits)" }, { "name": "fields", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Fields" } }, { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Siren Afnor Directory Service V1 Siren Code Insee Siren Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/afnor/directory-service/v1/siret/search": { "post": { "tags": [ "AFNOR Directory Service" ], "summary": "Search establishments by SIRET (searchFacilityBySiret)", "description": "Search establishments via ppf-annuaire.\n\nPriority:\n1. Exact SIRET filter → /api/siret/{siret}\n2. SIREN filter → /api/siren/{siren} (first 9 digits used as SIREN)\n3. Name filter → /api/search/name?q={name}\n4. Empty results if no usable filter.", "operationId": "search_siret_afnor_directory_service_v1_siret_search_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } }, { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SiretSearchRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SiretSearchResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/afnor/directory-service/v1/siret/code-insee:{siret}": { "get": { "tags": [ "AFNOR Directory Service" ], "summary": "Get establishment by SIRET (getFacilityBySiret)", "description": "Get establishment detail from ppf-annuaire by SIRET.", "operationId": "get_siret_afnor_directory_service_v1_siret_code_insee__siret__get", "parameters": [ { "name": "siret", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^([0-9]{14})$", "description": "SIRET (14 digits)", "title": "Siret" }, "description": "SIRET (14 digits)" }, { "name": "fields", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Fields" } }, { "name": "include", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Include" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } }, { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Siret Afnor Directory Service V1 Siret Code Insee Siret Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/afnor/directory-service/v1/routing-code/search": { "post": { "tags": [ "AFNOR Directory Service" ], "summary": "Search routing codes (searchRoutingCode)", "description": "Search routing codes via ppf-annuaire /api/pa/{siren}.\n\nExtracts SIRET from filters, derives SIREN (first 9 digits), and\ncalls the PDP/PA routing plan endpoint. Returns the routing plan\nentries mapped to AFNOR routing-code format.", "operationId": "search_routing_code_afnor_directory_service_v1_routing_code_search_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } }, { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutingCodeSearchRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutingCodeSearchResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/afnor/directory-service/v1/routing-code/siret:{siret}/code:{routing_identifier}": { "get": { "tags": [ "AFNOR Directory Service" ], "summary": "Get routing code (getRoutingCodeBySiretAndId)", "description": "Get routing code detail from ppf-annuaire /api/pa/{siren}.\n\nLooks up all routing codes for the company then returns the one\nmatching routing_identifier. Returns 404 if not found.", "operationId": "get_routing_code_afnor_directory_service_v1_routing_code_siret__siret__code__routing_identifier__get", "parameters": [ { "name": "siret", "in": "path", "required": true, "schema": { "type": "string", "description": "SIRET (14 digits)", "title": "Siret" }, "description": "SIRET (14 digits)" }, { "name": "routing_identifier", "in": "path", "required": true, "schema": { "type": "string", "description": "Routing identifier (max 100 chars)", "title": "Routing Identifier" }, "description": "Routing identifier (max 100 chars)" }, { "name": "include", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Include" } }, { "name": "fields", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Fields" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } }, { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Routing Code Afnor Directory Service V1 Routing Code Siret Siret Code Routing Identifier Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/afnor/directory-service/v1/directory-line/search": { "post": { "tags": [ "AFNOR Directory Service" ], "summary": "Search directory lines (searchDirectoryLine) [stub]", "description": "Directory line search — returns empty results.\n\nInvoice reception points (directory lines / points de réception) are\nnot yet exposed by the ppf-annuaire service. The response is a valid\nempty AFNOR DirectoryLineSearchResponse until the upstream API is\navailable.", "operationId": "search_directory_line_afnor_directory_service_v1_directory_line_search_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } }, { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DirectoryLineSearchRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DirectoryLineSearchResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/document/callback": { "post": { "tags": [ "Document Callbacks" ], "summary": "Receive Punchout Cart", "description": "Receive a PunchOutOrderMessage from a supplier after catalog checkout.\n\nThis endpoint is called by the supplier's system (e.g. Lyreco) when\nthe user finishes shopping. The cXML body contains the cart items.\n\nAuthentication: SharedSecret in the cXML Header (not HTTP auth).\n\nThe document is uploaded to the document service for OCR processing,\nwhich parses the cXML and creates a purchase request.", "operationId": "receive_punchout_cart_document_callback_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/document/oci-callback": { "get": { "tags": [ "Document Callbacks" ], "summary": "Receive Oci Cart", "description": "Receive an OCI cart return.\n\nAuth model: the supplier-facing HOOK_URL must contain a ``flowie_cookie``\nquery parameter (or a ``flowie_cookie`` form field) carrying the agents-hub\nBuyerCookie ``flowie:{org_id}:{thread_id_or_empty}:{nonce}``. We use it to\nroute the cart to the right org and to redirect the user back into their\nchat thread, identical to the cXML callback's behaviour.", "operationId": "receive_oci_cart_document_oci_callback_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } }, "post": { "tags": [ "Document Callbacks" ], "summary": "Receive Oci Cart", "description": "Receive an OCI cart return.\n\nAuth model: the supplier-facing HOOK_URL must contain a ``flowie_cookie``\nquery parameter (or a ``flowie_cookie`` form field) carrying the agents-hub\nBuyerCookie ``flowie:{org_id}:{thread_id_or_empty}:{nonce}``. We use it to\nroute the cart to the right org and to redirect the user back into their\nchat thread, identical to the cXML callback's behaviour.", "operationId": "receive_oci_cart_document_oci_callback_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/v1/oauth/scopes": { "get": { "tags": [ "OAuth" ], "summary": "Get Scope Catalogue", "description": "Return every grantable scope with a human-readable description.\n\nPublic — no auth required. Agents call this once at boot to render an\nhonest scope-selection UI to the user.", "operationId": "get_scope_catalogue_v1_oauth_scopes_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScopeCatalogueResponse" } } } } } } }, "/v1/oauth/authorize": { "post": { "tags": [ "OAuth" ], "summary": "Authorize", "description": "Step 1 of the consent flow. Returns the URL the agent shows the user.", "operationId": "authorize_v1_oauth_authorize_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthorizeRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthorizeResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/oauth/token": { "post": { "tags": [ "OAuth" ], "summary": "Token", "description": "Step 4 — exchange the authorization code (with PKCE) for an API key.", "operationId": "token_v1_oauth_token_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/sandbox/bootstrap": { "post": { "tags": [ "Sandbox" ], "summary": "Bootstrap", "description": "Self-serve a fresh sandbox API key + starter company. **No auth required.**\n\nDesigned for the \"I just landed on the docs and want to try the API\" case.\nRate-limited to 120 calls per IP per hour. The returned ``apiKey`` is the\nfull secret — store it now, it will not be shown again. Bootstrapped keys\nexpire after 7 days; create a long-lived one from the dashboard later.", "operationId": "bootstrap_v1_sandbox_bootstrap_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SandboxBootstrapRequest", "default": { "label": "quickstart", "keyType": "personal" } } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SandboxBootstrapResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/sandbox/reset": { "post": { "tags": [ "Sandbox" ], "summary": "Reset Sandbox", "description": "Wipe events and idempotency cache for the caller's organization.\n\nRequires ``confirm: \"yes\"``. Use ``scope`` to narrow the wipe.", "operationId": "reset_sandbox_v1_sandbox_reset_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } }, { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SandboxResetRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SandboxResetResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/sandbox/rate-limit/exhaust": { "post": { "tags": [ "Sandbox" ], "summary": "Exhaust Rate Limit", "description": "Force every subsequent request to return 429 for *durationSeconds*.\n\nUseful for testing your retry/backoff implementation under realistic\nconditions.", "operationId": "exhaust_rate_limit_v1_sandbox_rate_limit_exhaust_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } }, { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SandboxRateLimitExhaustRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SandboxRateLimitExhaustResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/sandbox/clock/advance": { "post": { "tags": [ "Sandbox" ], "summary": "Advance Clock", "description": "Advance a single company's virtual clock by the supplied duration.\n\nAccepts ``s|m|h|d|w|y`` units, e.g. ``\"60d\"``, ``\"2h\"``, ``\"1y\"``. The\noffset is per-company and never affects other tenants.", "operationId": "advance_clock_v1_sandbox_clock_advance_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } }, { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SandboxClockAdvanceRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SandboxClockResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/sandbox/clock/reset": { "post": { "tags": [ "Sandbox" ], "summary": "Reset Clock", "description": "Snap a company's virtual clock back to wall-clock now.", "operationId": "reset_clock_v1_sandbox_clock_reset_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } }, { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SandboxClockResetRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SandboxClockResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/sandbox/idempotency/flush": { "post": { "tags": [ "Sandbox" ], "summary": "Flush Idempotency", "description": "Drop every idempotency entry stored against the calling key.", "operationId": "flush_idempotency_v1_sandbox_idempotency_flush_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } }, { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SandboxIdempotencyFlushResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/requests/{request_id}": { "get": { "tags": [ "Requests" ], "summary": "Get Request", "description": "Return a captured 4xx/5xx request envelope.\n\nAll secrets are redacted at capture time, so the body returned here is\nalways safe to share — paste a request_id into a Slack channel or\nSentry comment and your team can pull the same view.", "operationId": "get_request_v1_requests__request_id__get", "parameters": [ { "name": "request_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Request Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Flowie-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Flowie-Organization-Id" } }, { "name": "Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization-Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Request V1 Requests Request Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } } }, "components": { "schemas": { "AckDetail": { "properties": { "level": { "type": "string", "enum": [ "Error", "Warning" ], "title": "Level" }, "item": { "type": "string", "title": "Item" }, "reasonCode": { "type": "string", "title": "Reasoncode" }, "reasonMessage": { "type": "string", "title": "Reasonmessage" } }, "type": "object", "required": [ "level", "item", "reasonCode", "reasonMessage" ], "title": "AckDetail", "description": "Single acknowledgement detail line (AcknowledgementDetail)." }, "AckRequest": { "properties": { "eventIds": { "items": { "type": "string" }, "type": "array", "title": "Eventids" } }, "type": "object", "required": [ "eventIds" ], "title": "AckRequest" }, "ActionRequest": { "properties": { "action": { "type": "string", "enum": [ "mark-read", "mark-unread", "archive", "unarchive", "tag", "untag", "assign", "unassign", "add-note", "link" ], "title": "Action" }, "tag": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tag" }, "userId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Userid" }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Note" }, "relatedDocumentId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Relateddocumentid" } }, "type": "object", "required": [ "action" ], "title": "ActionRequest" }, "Address": { "properties": { "street": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Street" }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "City" }, "postalCode": { "anyOf": [ { "type": "string", "maxLength": 20 }, { "type": "null" } ], "title": "Postalcode" }, "region": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Region" }, "country": { "type": "string", "maxLength": 2, "minLength": 2, "pattern": "^[A-Z]{2}$", "title": "Country", "description": "ISO 3166-1 alpha-2" } }, "type": "object", "required": [ "country" ], "title": "Address", "examples": [ { "city": "Paris", "country": "FR", "postalCode": "75001", "street": "123 Rue de la Paix" } ] }, "AfnorWebhook": { "properties": { "webhookId": { "type": "string", "title": "Webhookid" }, "callback": { "$ref": "#/components/schemas/CallbackParams" }, "metadata": { "$ref": "#/components/schemas/WebhookMetadata" } }, "type": "object", "required": [ "webhookId", "callback", "metadata" ], "title": "AfnorWebhook", "description": "Webhook = WebhookIdParam + WebhookParams." }, "ApiKeyCreateRequest": { "properties": { "companyId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Companyid" }, "name": { "type": "string", "title": "Name" }, "scopes": { "items": { "type": "string" }, "type": "array", "title": "Scopes", "default": [] }, "expiresAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Expiresat" }, "rateLimit": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Ratelimit" } }, "type": "object", "required": [ "name" ], "title": "ApiKeyCreateRequest" }, "ApiKeyCreateResponse": { "properties": { "id": { "type": "string", "title": "Id" }, "key": { "type": "string", "title": "Key" }, "keyPrefix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Keyprefix" }, "name": { "type": "string", "title": "Name" }, "scopes": { "items": { "type": "string" }, "type": "array", "title": "Scopes", "default": [] }, "companyId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Companyid" }, "createdAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Createdat" }, "expiresAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Expiresat" } }, "type": "object", "required": [ "id", "key", "name" ], "title": "ApiKeyCreateResponse", "description": "Same as ApiKeyResponse but includes the full key (shown only once)." }, "ApiKeyResponse": { "properties": { "id": { "type": "string", "title": "Id" }, "keyPrefix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Keyprefix" }, "name": { "type": "string", "title": "Name" }, "scopes": { "items": { "type": "string" }, "type": "array", "title": "Scopes", "default": [] }, "companyId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Companyid" }, "createdAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Createdat" }, "expiresAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Expiresat" } }, "type": "object", "required": [ "id", "name" ], "title": "ApiKeyResponse" }, "AuthorizeRequest": { "properties": { "client_name": { "type": "string", "maxLength": 200, "minLength": 1, "title": "Client Name", "description": "Display name shown on the consent page (e.g. 'Claude Desktop · Acme')." }, "scopes": { "items": { "type": "string" }, "type": "array", "minItems": 1, "title": "Scopes", "description": "Requested scopes — must all be in the public catalogue." }, "redirect_uri": { "type": "string", "title": "Redirect Uri", "description": "Where to redirect with the auth code. Default = out-of-band (code shown on screen).", "default": "urn:ietf:wg:oauth:2.0:oob" }, "code_challenge": { "type": "string", "maxLength": 128, "minLength": 43, "title": "Code Challenge", "description": "Base64URL(SHA256(code_verifier)) — RFC 7636 PKCE." }, "code_challenge_method": { "type": "string", "const": "S256", "title": "Code Challenge Method", "description": "Only S256 is supported. ``plain`` is intentionally rejected.", "default": "S256" }, "state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "State", "description": "Opaque value the agent gets back on redirect — use it to bind the code to the session." } }, "type": "object", "required": [ "client_name", "scopes", "code_challenge" ], "title": "AuthorizeRequest", "description": "Step 1 — agent registers its consent intent.\n\nResponse carries a ``consent_url`` the agent must show to the user." }, "AuthorizeResponse": { "properties": { "request_id": { "type": "string", "title": "Request Id", "description": "Server-side handle for this consent request." }, "consent_url": { "type": "string", "title": "Consent Url", "description": "URL the agent shows to the user." }, "expires_in": { "type": "integer", "title": "Expires In", "description": "Seconds until the request expires (consent must complete inside this window)." } }, "type": "object", "required": [ "request_id", "consent_url", "expires_in" ], "title": "AuthorizeResponse" }, "BatchLifecycleUpdateRequest": { "properties": { "updates": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Updates" } }, "type": "object", "required": [ "updates" ], "title": "BatchLifecycleUpdateRequest" }, "BatchSendItem": { "properties": { "idempotencyKey": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotencykey" }, "type": { "type": "string", "enum": [ "invoice", "credit-note", "debit-note", "purchase-order", "sales-order", "quote", "event" ], "title": "Type" }, "format": { "anyOf": [ { "type": "string", "enum": [ "json", "ubl-xml", "auto", "raw" ] }, { "type": "null" } ], "title": "Format" }, "from": { "type": "string", "title": "From" }, "to": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "To" }, "document": { "anyOf": [ { "$ref": "#/components/schemas/DocumentBody-Input" }, { "type": "null" } ] }, "xml": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Xml" }, "file": { "anyOf": [ { "$ref": "#/components/schemas/FileAttachment" }, { "type": "null" } ] } }, "type": "object", "required": [ "type", "from" ], "title": "BatchSendItem" }, "BatchSendRequest": { "properties": { "documents": { "items": { "$ref": "#/components/schemas/BatchSendItem" }, "type": "array", "title": "Documents" } }, "type": "object", "required": [ "documents" ], "title": "BatchSendRequest" }, "BatchSendResponse": { "properties": { "results": { "items": {}, "type": "array", "title": "Results" }, "summary": { "additionalProperties": true, "type": "object", "title": "Summary" } }, "type": "object", "required": [ "results", "summary" ], "title": "BatchSendResponse" }, "Body_create_flow_afnor_flow_service_v1_flows_post": { "properties": { "flowInfo": { "type": "string", "title": "Flowinfo", "description": "JSON-encoded FlowInfo object" }, "file": { "anyOf": [ { "type": "string", "contentMediaType": "application/octet-stream" }, { "type": "null" } ], "title": "File" } }, "type": "object", "required": [ "flowInfo" ], "title": "Body_create_flow_afnor_flow_service_v1_flows_post" }, "CallbackParams": { "properties": { "url": { "type": "string", "title": "Url" }, "headers": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Headers" }, "authentication": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Authentication" }, "signature": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Signature" } }, "type": "object", "required": [ "url" ], "title": "CallbackParams", "description": "CallbackParameters for webhook creation/update." }, "CompanyComplianceItem": { "properties": { "companyId": { "type": "string", "title": "Companyid" }, "vatNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vatnumber" }, "peppolId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Peppolid" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" }, "smpRegistered": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Smpregistered" }, "smpRegisteredAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Smpregisteredat" }, "compliance": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Compliance" }, "lastCheckedAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Lastcheckedat" } }, "type": "object", "required": [ "companyId" ], "title": "CompanyComplianceItem" }, "CompanyCreate": { "properties": { "vatNumber": { "type": "string", "maxLength": 20, "minLength": 4, "pattern": "^[A-Z]{2}[A-Z0-9]+$", "title": "Vatnumber", "description": "VAT number with country prefix (e.g. FR86797978996)" }, "name": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ], "title": "Name" }, "address": { "anyOf": [ { "$ref": "#/components/schemas/Address" }, { "type": "null" } ] }, "additionalIdentifiers": { "anyOf": [ { "items": {}, "type": "array" }, { "type": "null" } ], "title": "Additionalidentifiers" }, "capabilities": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Capabilities" }, "settings": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Settings" }, "compliance": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Compliance" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Metadata" } }, "type": "object", "required": [ "vatNumber" ], "title": "CompanyCreate", "examples": [ { "address": { "city": "Paris", "country": "FR", "postalCode": "75001", "street": "123 Rue de la Paix" }, "name": "Acme SAS", "vatNumber": "FR86797978996" } ] }, "CompanyListItem": { "properties": { "id": { "type": "string", "title": "Id" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "vatNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vatnumber" }, "peppolId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Peppolid" }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" }, "stats": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Stats" } }, "type": "object", "required": [ "id" ], "title": "CompanyListItem" }, "CompanyResponse": { "properties": { "id": { "type": "string", "title": "Id", "description": "Organization ID" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "legalName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Legalname" }, "vatNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vatnumber" }, "country": { "anyOf": [ { "type": "string", "maxLength": 2 }, { "type": "null" } ], "title": "Country" }, "peppolId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Peppolid" }, "additionalIdentifiers": { "anyOf": [ { "items": {}, "type": "array" }, { "type": "null" } ], "title": "Additionalidentifiers" }, "address": { "anyOf": [ { "$ref": "#/components/schemas/Address" }, { "type": "null" } ] }, "capabilities": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Capabilities" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status", "description": "active, inactive, suspended" }, "smpRegistered": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Smpregistered" }, "smpRegisteredAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Smpregisteredat" }, "compliance": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Compliance" }, "enrichment": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Enrichment" }, "settings": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Settings" }, "stats": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Stats" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Metadata" }, "createdAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Createdat" }, "updatedAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updatedat" } }, "type": "object", "required": [ "id" ], "title": "CompanyResponse", "examples": [ { "country": "FR", "id": "comp_abc123", "name": "Acme SAS", "peppolId": "0009:FR86797978996", "status": "active", "vatNumber": "FR86797978996" } ] }, "CompanyUpdate": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "address": { "anyOf": [ { "$ref": "#/components/schemas/Address" }, { "type": "null" } ] }, "capabilities": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Capabilities" }, "settings": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Settings" }, "compliance": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Compliance" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Metadata" } }, "type": "object", "title": "CompanyUpdate" }, "ComplianceReportRecord": { "properties": { "documentId": { "type": "string", "title": "Documentid" }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Type" }, "number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Number" }, "issueDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Issuedate" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" }, "reportedAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Reportedat" }, "reportedTo": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reportedto" }, "platformResponse": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Platformresponse" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error" } }, "type": "object", "required": [ "documentId" ], "title": "ComplianceReportRecord" }, "ComplianceReportResponse": { "properties": { "records": { "items": { "$ref": "#/components/schemas/ComplianceReportRecord" }, "type": "array", "title": "Records", "default": [] } }, "type": "object", "title": "ComplianceReportResponse" }, "ComplianceStatusResponse": { "properties": { "companies": { "items": { "$ref": "#/components/schemas/CompanyComplianceItem" }, "type": "array", "title": "Companies", "default": [] } }, "type": "object", "title": "ComplianceStatusResponse" }, "DirectoryLineSearchRequest": { "properties": { "filters": { "additionalProperties": true, "type": "object", "title": "Filters" }, "sorting": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Sorting" }, "fields": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Fields" }, "limit": { "type": "integer", "maximum": 100.0, "minimum": 1.0, "title": "Limit", "default": 50 } }, "type": "object", "title": "DirectoryLineSearchRequest", "description": "Request body for POST /v1/directory-line/search." }, "DirectoryLineSearchResponse": { "properties": { "search": { "additionalProperties": true, "type": "object", "title": "Search" }, "totalNumberOfResults": { "type": "integer", "title": "Totalnumberofresults" }, "results": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Results" } }, "type": "object", "required": [ "search", "totalNumberOfResults", "results" ], "title": "DirectoryLineSearchResponse", "description": "Response body for POST /v1/directory-line/search." }, "DirectoryLookupResponse": { "properties": { "peppolId": { "type": "string", "title": "Peppolid" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country" }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "City" }, "postalCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Postalcode" }, "vatNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vatnumber" }, "registeredSince": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Registeredsince" }, "documentTypes": { "items": { "type": "string" }, "type": "array", "title": "Documenttypes", "default": [] }, "accessPoint": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accesspoint" }, "capabilities": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Capabilities" }, "enrichment": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Enrichment" }, "smpStatus": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Smpstatus" } }, "type": "object", "required": [ "peppolId" ], "title": "DirectoryLookupResponse" }, "DirectorySearchResult": { "properties": { "peppolId": { "type": "string", "title": "Peppolid" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country" }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "City" }, "postalCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Postalcode" }, "vatNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vatnumber" }, "registeredSince": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Registeredsince" }, "documentTypes": { "items": { "type": "string" }, "type": "array", "title": "Documenttypes", "default": [] }, "accessPoint": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accesspoint" } }, "type": "object", "required": [ "peppolId" ], "title": "DirectorySearchResult" }, "DocumentBody-Input": { "properties": { "number": { "type": "string", "maxLength": 100, "minLength": 1, "title": "Number" }, "issueDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "title": "Issuedate", "description": "ISO 8601 date (YYYY-MM-DD)" }, "dueDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Duedate" }, "currency": { "type": "string", "maxLength": 3, "minLength": 3, "pattern": "^[A-Z]{3}$", "title": "Currency", "description": "ISO 4217 currency code", "default": "EUR" }, "buyerReference": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Buyerreference" }, "orderReference": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Orderreference" }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Note" }, "seller": { "anyOf": [ { "$ref": "#/components/schemas/PartyInfo" }, { "type": "null" } ] }, "buyer": { "anyOf": [ { "$ref": "#/components/schemas/PartyInfo" }, { "type": "null" } ] }, "payment": { "anyOf": [ { "$ref": "#/components/schemas/PaymentInfo" }, { "type": "null" } ] }, "delivery": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Delivery" }, "lines": { "items": { "$ref": "#/components/schemas/InvoiceLine" }, "type": "array", "title": "Lines" }, "allowances": { "anyOf": [ { "items": {}, "type": "array" }, { "type": "null" } ], "title": "Allowances" }, "charges": { "anyOf": [ { "items": {}, "type": "array" }, { "type": "null" } ], "title": "Charges" }, "attachments": { "anyOf": [ { "items": {}, "type": "array" }, { "type": "null" } ], "title": "Attachments" }, "totals": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Totals" } }, "type": "object", "required": [ "number", "issueDate", "lines" ], "title": "DocumentBody" }, "DocumentBody-Output": { "properties": { "number": { "type": "string", "maxLength": 100, "minLength": 1, "title": "Number" }, "issueDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "title": "Issuedate", "description": "ISO 8601 date (YYYY-MM-DD)" }, "dueDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Duedate" }, "currency": { "type": "string", "maxLength": 3, "minLength": 3, "pattern": "^[A-Z]{3}$", "title": "Currency", "description": "ISO 4217 currency code", "default": "EUR" }, "buyerReference": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Buyerreference" }, "orderReference": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Orderreference" }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Note" }, "seller": { "anyOf": [ { "$ref": "#/components/schemas/PartyInfo" }, { "type": "null" } ] }, "buyer": { "anyOf": [ { "$ref": "#/components/schemas/PartyInfo" }, { "type": "null" } ] }, "payment": { "anyOf": [ { "$ref": "#/components/schemas/PaymentInfo" }, { "type": "null" } ] }, "delivery": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Delivery" }, "lines": { "items": { "$ref": "#/components/schemas/InvoiceLine" }, "type": "array", "title": "Lines" }, "allowances": { "anyOf": [ { "items": {}, "type": "array" }, { "type": "null" } ], "title": "Allowances" }, "charges": { "anyOf": [ { "items": {}, "type": "array" }, { "type": "null" } ], "title": "Charges" }, "attachments": { "anyOf": [ { "items": {}, "type": "array" }, { "type": "null" } ], "title": "Attachments" }, "totals": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Totals" } }, "type": "object", "required": [ "number", "issueDate", "lines" ], "title": "DocumentBody" }, "DocumentListItem": { "properties": { "id": { "type": "string", "title": "Id" }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Type" }, "direction": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Direction" }, "number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Number" }, "issueDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Issuedate" }, "dueDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Duedate" }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Currency" }, "grossAmount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Grossamount" }, "sender": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Sender" }, "receiver": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Receiver" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" }, "deliveryStatus": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Deliverystatus" }, "receivedAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Receivedat" } }, "type": "object", "required": [ "id" ], "title": "DocumentListItem" }, "DocumentResponse": { "properties": { "id": { "type": "string", "title": "Id" }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Type", "description": "INVOICE, CREDIT_NOTE, DEBIT_NOTE, PURCHASE_ORDER" }, "direction": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Direction", "description": "incoming or outgoing" }, "number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Number" }, "issueDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Issuedate" }, "dueDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Duedate" }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Currency" }, "grossAmount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Grossamount" }, "netAmount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Netamount" }, "vatAmount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Vatamount" }, "sender": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Sender" }, "receiver": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Receiver" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status", "description": "draft, sent, delivered, rejected, etc." }, "deliveryStatus": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Deliverystatus", "description": "pending, delivered, failed, rejected" }, "lifecycleStatus": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lifecyclestatus" }, "document": { "anyOf": [ { "$ref": "#/components/schemas/DocumentBody-Output" }, { "type": "null" } ] }, "xml": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Xml" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Metadata" }, "receivedAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Receivedat" }, "sentAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Sentat" }, "createdAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Createdat" }, "updatedAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updatedat" } }, "type": "object", "required": [ "id" ], "title": "DocumentResponse", "examples": [ { "currency": "EUR", "deliveryStatus": "delivered", "direction": "outgoing", "grossAmount": 1815.0, "id": "doc_abc123", "issueDate": "2026-04-15", "netAmount": 1500.0, "number": "INV-2026-0042", "status": "sent", "type": "INVOICE", "vatAmount": 315.0 } ] }, "ErrorDetail": { "properties": { "field": { "type": "string", "title": "Field" }, "rule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Rule" }, "message": { "type": "string", "title": "Message" } }, "type": "object", "required": [ "field", "message" ], "title": "ErrorDetail" }, "EventResponse": { "properties": { "id": { "type": "string", "title": "Id" }, "type": { "type": "string", "title": "Type" }, "createdAt": { "type": "string", "format": "date-time", "title": "Createdat" }, "data": { "additionalProperties": true, "type": "object", "title": "Data", "default": {} } }, "type": "object", "required": [ "id", "type", "createdAt" ], "title": "EventResponse" }, "FileAttachment": { "properties": { "content": { "type": "string", "minLength": 1, "title": "Content", "description": "Base64-encoded file bytes. No data: prefix." }, "contentType": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ], "title": "Contenttype", "description": "MIME type. Optional — server falls back to magic-byte sniff." }, "filename": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ], "title": "Filename", "description": "Original filename, persisted on the file record." } }, "type": "object", "required": [ "content" ], "title": "FileAttachment", "description": "Raw file payload — used when sending a document whose body cannot be\nrepresented as structured JSON or UBL XML (e.g. a scanned PDF, an image,\na proprietary format). The content is base64-encoded; the server sniffs\nthe bytes to decide whether to route through the structured pipeline or\njust persist the file as-is via the document file API." }, "Flow": { "properties": { "flowId": { "type": "string", "maxLength": 36, "title": "Flowid" }, "submittedAt": { "type": "string", "format": "date-time", "title": "Submittedat" }, "name": { "type": "string", "maxLength": 255, "title": "Name" }, "flowSyntax": { "type": "string", "enum": [ "CII", "UBL", "Factur-X", "CDAR", "FRR" ], "title": "Flowsyntax" }, "trackingId": { "anyOf": [ { "type": "string", "maxLength": 36 }, { "type": "null" } ], "title": "Trackingid" }, "processingRule": { "anyOf": [ { "type": "string", "enum": [ "B2B", "B2C", "B2G", "B2BInt", "B2GInt", "B2GOutOfScope", "OutOfScope", "ArchiveOnly", "NotApplicable" ] }, { "type": "null" } ], "title": "Processingrule" }, "flowProfile": { "anyOf": [ { "type": "string", "enum": [ "Basic", "CIUS", "Extended-CTC-FR" ] }, { "type": "null" } ], "title": "Flowprofile" }, "updatedAt": { "type": "string", "format": "date-time", "title": "Updatedat" }, "flowType": { "type": "string", "title": "Flowtype" }, "processingRuleSource": { "type": "string", "enum": [ "Input", "Computed" ], "title": "Processingrulesource" }, "flowDirection": { "type": "string", "enum": [ "In", "Out" ], "title": "Flowdirection" }, "acknowledgement": { "$ref": "#/components/schemas/FlowAcknowledgement" } }, "type": "object", "required": [ "flowId", "submittedAt", "name", "flowSyntax", "updatedAt", "flowType", "processingRuleSource", "flowDirection", "acknowledgement" ], "title": "Flow", "description": "CoreFlowInfo + FullFlowInfoExtension + FlowExtension." }, "FlowAcknowledgement": { "properties": { "status": { "type": "string", "enum": [ "Pending", "Ok", "Error" ], "title": "Status" }, "details": { "items": { "$ref": "#/components/schemas/AckDetail" }, "type": "array", "title": "Details", "default": [] } }, "type": "object", "required": [ "status" ], "title": "FlowAcknowledgement", "description": "Acknowledgement block embedded in a Flow object." }, "FullFlowInfo": { "properties": { "flowId": { "type": "string", "maxLength": 36, "title": "Flowid" }, "submittedAt": { "type": "string", "format": "date-time", "title": "Submittedat" }, "name": { "type": "string", "maxLength": 255, "title": "Name" }, "flowSyntax": { "type": "string", "enum": [ "CII", "UBL", "Factur-X", "CDAR", "FRR" ], "title": "Flowsyntax" }, "trackingId": { "anyOf": [ { "type": "string", "maxLength": 36 }, { "type": "null" } ], "title": "Trackingid" }, "processingRule": { "anyOf": [ { "type": "string", "enum": [ "B2B", "B2C", "B2G", "B2BInt", "B2GInt", "B2GOutOfScope", "OutOfScope", "ArchiveOnly", "NotApplicable" ] }, { "type": "null" } ], "title": "Processingrule" }, "flowProfile": { "anyOf": [ { "type": "string", "enum": [ "Basic", "CIUS", "Extended-CTC-FR" ] }, { "type": "null" } ], "title": "Flowprofile" }, "sha256": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sha256" } }, "type": "object", "required": [ "flowId", "submittedAt", "name", "flowSyntax" ], "title": "FullFlowInfo", "description": "FullFlowInfoExtension + FlowInfo." }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" }, "InvoiceLine": { "properties": { "description": { "type": "string", "maxLength": 500, "minLength": 1, "title": "Description" }, "quantity": { "type": "number", "exclusiveMinimum": 0.0, "title": "Quantity" }, "unit": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Unit" }, "unitPrice": { "type": "number", "minimum": 0.0, "title": "Unitprice" }, "vatRate": { "type": "number", "maximum": 100.0, "minimum": 0.0, "title": "Vatrate", "description": "VAT rate as percentage (e.g. 20.0)" }, "vatCategory": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vatcategory" }, "itemCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Itemcode" }, "period": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Period" } }, "type": "object", "required": [ "description", "quantity", "unitPrice", "vatRate" ], "title": "InvoiceLine", "examples": [ { "description": "Consulting services - April 2026", "quantity": 10.0, "unit": "HUR", "unitPrice": 150.0, "vatRate": 21.0 } ] }, "LifecycleHistoryEntry": { "properties": { "status": { "type": "string", "title": "Status" }, "at": { "type": "string", "format": "date-time", "title": "At" }, "setBy": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Setby" }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Note" }, "reported": { "type": "boolean", "title": "Reported", "default": false }, "reportedTo": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reportedto" }, "reportedAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Reportedat" } }, "type": "object", "required": [ "status", "at" ], "title": "LifecycleHistoryEntry" }, "LifecycleHistoryResponse": { "properties": { "documentId": { "type": "string", "title": "Documentid" }, "currentStatus": { "type": "string", "title": "Currentstatus" }, "currentStatusAt": { "type": "string", "format": "date-time", "title": "Currentstatusat" }, "compliance": { "additionalProperties": true, "type": "object", "title": "Compliance", "default": {} }, "history": { "items": { "$ref": "#/components/schemas/LifecycleHistoryEntry" }, "type": "array", "title": "History", "default": [] }, "allowedTransitions": { "items": { "type": "string" }, "type": "array", "title": "Allowedtransitions", "default": [] } }, "type": "object", "required": [ "documentId", "currentStatus", "currentStatusAt" ], "title": "LifecycleHistoryResponse" }, "LifecycleUpdateRequest": { "properties": { "status": { "type": "string", "enum": [ "under_review", "approved", "rejected", "partially_paid", "paid", "disputed" ], "title": "Status" }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reason" }, "reasonCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reasoncode" }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Note" }, "paymentDate": { "anyOf": [ { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, { "type": "null" } ], "title": "Paymentdate" }, "paymentReference": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Paymentreference" }, "paymentAmount": { "anyOf": [ { "type": "number", "minimum": 0.0 }, { "type": "null" } ], "title": "Paymentamount" }, "paymentCurrency": { "anyOf": [ { "type": "string", "maxLength": 3, "minLength": 3, "pattern": "^[A-Z]{3}$" }, { "type": "null" } ], "title": "Paymentcurrency" }, "remainingAmount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Remainingamount" } }, "type": "object", "required": [ "status" ], "title": "LifecycleUpdateRequest", "examples": [ { "note": "Invoice verified against PO", "status": "approved" }, { "paymentAmount": 1815.0, "paymentCurrency": "EUR", "paymentDate": "2026-04-15", "paymentReference": "PAY-2026-0042", "status": "paid" } ] }, "LifecycleUpdateResponse": { "properties": { "documentId": { "type": "string", "title": "Documentid" }, "previousStatus": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Previousstatus" }, "currentStatus": { "type": "string", "title": "Currentstatus" }, "updatedAt": { "type": "string", "format": "date-time", "title": "Updatedat" }, "compliance": { "additionalProperties": true, "type": "object", "title": "Compliance", "default": {} }, "allowedTransitions": { "items": { "type": "string" }, "type": "array", "title": "Allowedtransitions", "default": [] } }, "type": "object", "required": [ "documentId", "currentStatus", "updatedAt" ], "title": "LifecycleUpdateResponse" }, "PaginatedResponse_ApiKeyResponse_": { "properties": { "data": { "items": { "$ref": "#/components/schemas/ApiKeyResponse" }, "type": "array", "title": "Data" }, "hasMore": { "type": "boolean", "title": "Hasmore" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, "type": "object", "required": [ "data", "hasMore" ], "title": "PaginatedResponse[ApiKeyResponse]" }, "PaginatedResponse_CompanyListItem_": { "properties": { "data": { "items": { "$ref": "#/components/schemas/CompanyListItem" }, "type": "array", "title": "Data" }, "hasMore": { "type": "boolean", "title": "Hasmore" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, "type": "object", "required": [ "data", "hasMore" ], "title": "PaginatedResponse[CompanyListItem]" }, "PaginatedResponse_DirectorySearchResult_": { "properties": { "data": { "items": { "$ref": "#/components/schemas/DirectorySearchResult" }, "type": "array", "title": "Data" }, "hasMore": { "type": "boolean", "title": "Hasmore" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, "type": "object", "required": [ "data", "hasMore" ], "title": "PaginatedResponse[DirectorySearchResult]" }, "PaginatedResponse_DocumentListItem_": { "properties": { "data": { "items": { "$ref": "#/components/schemas/DocumentListItem" }, "type": "array", "title": "Data" }, "hasMore": { "type": "boolean", "title": "Hasmore" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, "type": "object", "required": [ "data", "hasMore" ], "title": "PaginatedResponse[DocumentListItem]" }, "PaginatedResponse_EventResponse_": { "properties": { "data": { "items": { "$ref": "#/components/schemas/EventResponse" }, "type": "array", "title": "Data" }, "hasMore": { "type": "boolean", "title": "Hasmore" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, "type": "object", "required": [ "data", "hasMore" ], "title": "PaginatedResponse[EventResponse]" }, "PaginatedResponse_PartnerListItem_": { "properties": { "data": { "items": { "$ref": "#/components/schemas/PartnerListItem" }, "type": "array", "title": "Data" }, "hasMore": { "type": "boolean", "title": "Hasmore" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, "type": "object", "required": [ "data", "hasMore" ], "title": "PaginatedResponse[PartnerListItem]" }, "PaginatedResponse_WebhookResponse_": { "properties": { "data": { "items": { "$ref": "#/components/schemas/WebhookResponse" }, "type": "array", "title": "Data" }, "hasMore": { "type": "boolean", "title": "Hasmore" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, "type": "object", "required": [ "data", "hasMore" ], "title": "PaginatedResponse[WebhookResponse]" }, "PartnerCreate": { "properties": { "peppolId": { "anyOf": [ { "type": "string", "pattern": "^\\d{4}:.+$" }, { "type": "null" } ], "title": "Peppolid", "description": "Peppol participant ID (scheme:identifier)" }, "vatNumber": { "anyOf": [ { "type": "string", "maxLength": 20, "minLength": 4 }, { "type": "null" } ], "title": "Vatnumber" }, "role": { "anyOf": [ { "type": "string", "enum": [ "supplier", "buyer", "both" ] }, { "type": "null" } ], "title": "Role" }, "contactName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Contactname" }, "contactEmail": { "anyOf": [ { "type": "string", "pattern": "^[^@]+@[^@]+\\.[^@]+$" }, { "type": "null" } ], "title": "Contactemail" }, "defaults": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Defaults" }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tags" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Metadata" } }, "type": "object", "title": "PartnerCreate", "examples": [ { "contactEmail": "jean@example.com", "contactName": "Jean Dupont", "peppolId": "0009:BE0123456789", "role": "supplier", "vatNumber": "BE0123456789" } ] }, "PartnerListItem": { "properties": { "id": { "type": "string", "title": "Id" }, "peppolId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Peppolid" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country" }, "role": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Role" }, "peppolStatus": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Peppolstatus" }, "tags": { "items": { "type": "string" }, "type": "array", "title": "Tags", "default": [] }, "stats": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Stats" } }, "type": "object", "required": [ "id" ], "title": "PartnerListItem" }, "PartnerResponse": { "properties": { "id": { "type": "string", "title": "Id" }, "peppolId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Peppolid" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "vatNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vatnumber" }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country" }, "role": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Role" }, "contactName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Contactname" }, "contactEmail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Contactemail" }, "peppolStatus": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Peppolstatus" }, "defaults": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Defaults" }, "tags": { "items": { "type": "string" }, "type": "array", "title": "Tags", "default": [] }, "enrichment": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Enrichment" }, "stats": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Stats" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Metadata" }, "createdAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Createdat" }, "updatedAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updatedat" } }, "type": "object", "required": [ "id" ], "title": "PartnerResponse", "examples": [ { "country": "BE", "id": "part_abc123", "name": "Acme BVBA", "peppolId": "0009:BE0123456789", "peppolStatus": "active", "role": "supplier", "tags": [ "preferred" ], "vatNumber": "BE0123456789" } ] }, "PartnerUpdate": { "properties": { "peppolId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Peppolid" }, "vatNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vatnumber" }, "role": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Role" }, "contactName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Contactname" }, "contactEmail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Contactemail" }, "defaults": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Defaults" }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tags" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Metadata" } }, "type": "object", "title": "PartnerUpdate" }, "PartyInfo": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "vatNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vatnumber" }, "address": { "anyOf": [ { "$ref": "#/components/schemas/Address" }, { "type": "null" } ] }, "contact": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Contact" } }, "type": "object", "title": "PartyInfo" }, "PaymentInfo": { "properties": { "means": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Means" }, "iban": { "anyOf": [ { "type": "string", "maxLength": 34, "pattern": "^[A-Z]{2}\\d{2}[A-Z0-9]+$" }, { "type": "null" } ], "title": "Iban" }, "bic": { "anyOf": [ { "type": "string", "maxLength": 11, "pattern": "^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$" }, { "type": "null" } ], "title": "Bic" }, "reference": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reference" }, "discountTerms": { "anyOf": [ { "items": {}, "type": "array" }, { "type": "null" } ], "title": "Discountterms" } }, "type": "object", "title": "PaymentInfo" }, "PlatformOnboardRequest": { "properties": { "vatNumber": { "type": "string", "title": "Vatnumber" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "address": { "anyOf": [ { "$ref": "#/components/schemas/Address" }, { "type": "null" } ] }, "receiveDocuments": { "type": "boolean", "title": "Receivedocuments", "default": true }, "autoVerify": { "type": "boolean", "title": "Autoverify", "default": false }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Metadata" }, "webhook": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Webhook" }, "apiKey": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Apikey" } }, "type": "object", "required": [ "vatNumber" ], "title": "PlatformOnboardRequest" }, "PlatformOnboardResponse": { "properties": { "company": { "$ref": "#/components/schemas/CompanyResponse" }, "apiKey": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Apikey" }, "webhook": { "anyOf": [ { "$ref": "#/components/schemas/WebhookResponse" }, { "type": "null" } ] } }, "type": "object", "required": [ "company" ], "title": "PlatformOnboardResponse" }, "PlatformSettingsUpdate": { "properties": { "branding": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Branding" }, "defaults": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Defaults" }, "customDomain": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Customdomain" } }, "type": "object", "title": "PlatformSettingsUpdate" }, "PlatformUsageResponse": { "properties": { "period": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Period" }, "total": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Total" }, "byCompany": { "anyOf": [ { "items": {}, "type": "array" }, { "type": "null" } ], "title": "Bycompany" } }, "type": "object", "title": "PlatformUsageResponse" }, "RoutingCodeSearchRequest": { "properties": { "filters": { "additionalProperties": true, "type": "object", "title": "Filters" }, "include": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Include" }, "limit": { "type": "integer", "maximum": 100.0, "minimum": 1.0, "title": "Limit", "default": 50 } }, "type": "object", "title": "RoutingCodeSearchRequest", "description": "Request body for POST /v1/routing-code/search." }, "RoutingCodeSearchResponse": { "properties": { "search": { "additionalProperties": true, "type": "object", "title": "Search" }, "totalNumberOfResults": { "type": "integer", "title": "Totalnumberofresults" }, "results": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Results" } }, "type": "object", "required": [ "search", "totalNumberOfResults", "results" ], "title": "RoutingCodeSearchResponse", "description": "Response body for POST /v1/routing-code/search." }, "SandboxBootstrapRequest": { "properties": { "label": { "type": "string", "maxLength": 64, "title": "Label", "description": "Free-form tag for the issued key — appears in the dashboard.", "default": "quickstart" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email", "description": "Optional contact email (we may follow up with usage tips)." }, "keyType": { "type": "string", "pattern": "^(personal|platform|white_label)$", "title": "Keytype", "description": "Key type to mint. `personal` (default) is the regular tenant key every integrator gets. `platform` and `white_label` mint a key that satisfies the platform-key gate on `/v1/platform/*` so you can exercise multi-tenant ops in sandbox without involving sales.", "default": "personal" } }, "type": "object", "title": "SandboxBootstrapRequest", "description": "Optional metadata for the bootstrapped sandbox tenant." }, "SandboxBootstrapResponse": { "properties": { "organizationId": { "type": "string", "title": "Organizationid" }, "apiKey": { "type": "string", "title": "Apikey" }, "keyPrefix": { "type": "string", "title": "Keyprefix" }, "keyType": { "type": "string", "title": "Keytype", "default": "personal" }, "company": { "additionalProperties": true, "type": "object", "title": "Company" }, "expiresAt": { "type": "string", "title": "Expiresat" }, "nextSteps": { "items": { "type": "string" }, "type": "array", "title": "Nextsteps" }, "docs": { "additionalProperties": true, "type": "object", "title": "Docs" } }, "type": "object", "required": [ "organizationId", "apiKey", "keyPrefix", "company", "expiresAt", "nextSteps", "docs" ], "title": "SandboxBootstrapResponse", "description": "The single response a brand-new integrator needs to start testing." }, "SandboxClockAdvanceRequest": { "properties": { "companyId": { "type": "string", "title": "Companyid", "description": "Company whose virtual clock should be advanced." }, "by": { "type": "string", "title": "By", "description": "How far to jump. Accepts compact units: `1h`, `3d`, `2w`, `1m`, `1y`.", "examples": [ "60d", "12h", "1y" ] } }, "type": "object", "required": [ "companyId", "by" ], "title": "SandboxClockAdvanceRequest" }, "SandboxClockResetRequest": { "properties": { "companyId": { "type": "string", "title": "Companyid" } }, "type": "object", "required": [ "companyId" ], "title": "SandboxClockResetRequest" }, "SandboxClockResponse": { "properties": { "companyId": { "type": "string", "title": "Companyid" }, "offsetSeconds": { "type": "integer", "title": "Offsetseconds" }, "virtualNow": { "type": "string", "title": "Virtualnow" } }, "type": "object", "required": [ "companyId", "offsetSeconds", "virtualNow" ], "title": "SandboxClockResponse" }, "SandboxIdempotencyFlushResponse": { "properties": { "organizationId": { "type": "string", "title": "Organizationid" }, "deletedEntries": { "type": "integer", "title": "Deletedentries" } }, "type": "object", "required": [ "organizationId", "deletedEntries" ], "title": "SandboxIdempotencyFlushResponse" }, "SandboxRateLimitExhaustRequest": { "properties": { "durationSeconds": { "type": "integer", "maximum": 3600.0, "minimum": 1.0, "title": "Durationseconds", "description": "How long the forced 429 should last. Max 1 hour.", "default": 60 } }, "type": "object", "title": "SandboxRateLimitExhaustRequest" }, "SandboxRateLimitExhaustResponse": { "properties": { "organizationId": { "type": "string", "title": "Organizationid" }, "durationSeconds": { "type": "integer", "title": "Durationseconds" }, "expiresAt": { "type": "string", "title": "Expiresat" } }, "type": "object", "required": [ "organizationId", "durationSeconds", "expiresAt" ], "title": "SandboxRateLimitExhaustResponse" }, "SandboxResetRequest": { "properties": { "confirm": { "type": "string", "const": "yes", "title": "Confirm", "description": "Type the literal string `yes` to acknowledge the wipe." }, "scope": { "type": "string", "enum": [ "all", "documents", "events", "idempotency" ], "title": "Scope", "description": "What to wipe. Defaults to everything.", "default": "all" } }, "type": "object", "required": [ "confirm" ], "title": "SandboxResetRequest", "description": "Body for POST /v1/sandbox/reset.\n\nRequires ``confirm: \"yes\"`` to prevent accidental wipes of an integrator's\nfixtures during day-to-day work. ``scope`` lets the caller narrow the\nblast radius to a single resource type." }, "SandboxResetResponse": { "properties": { "deletedDocuments": { "type": "integer", "title": "Deleteddocuments", "default": 0 }, "deletedEvents": { "type": "integer", "title": "Deletedevents", "default": 0 }, "deletedIdempotencyEntries": { "type": "integer", "title": "Deletedidempotencyentries", "default": 0 }, "organizationId": { "type": "string", "title": "Organizationid" } }, "type": "object", "required": [ "organizationId" ], "title": "SandboxResetResponse" }, "ScopeCatalogueResponse": { "properties": { "scopes": { "items": { "$ref": "#/components/schemas/ScopeDescriptor" }, "type": "array", "title": "Scopes" } }, "type": "object", "required": [ "scopes" ], "title": "ScopeCatalogueResponse" }, "ScopeDescriptor": { "properties": { "scope": { "type": "string", "title": "Scope" }, "label": { "type": "string", "title": "Label" }, "description": { "type": "string", "title": "Description" } }, "type": "object", "required": [ "scope", "label", "description" ], "title": "ScopeDescriptor" }, "SearchFlowFilters": { "properties": { "updatedAfter": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updatedafter" }, "updatedBefore": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updatedbefore" }, "processingRule": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Processingrule" }, "flowType": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Flowtype" }, "flowDirection": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Flowdirection" }, "trackingId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Trackingid" }, "ackStatus": { "anyOf": [ { "type": "string", "enum": [ "Pending", "Ok", "Error" ] }, { "type": "null" } ], "title": "Ackstatus" } }, "type": "object", "title": "SearchFlowFilters", "description": "Filters for POST /v1/flows/search (SearchFlowFilters)." }, "SearchFlowParams": { "properties": { "limit": { "type": "integer", "maximum": 100.0, "minimum": 1.0, "title": "Limit", "default": 25 }, "where": { "$ref": "#/components/schemas/SearchFlowFilters" } }, "type": "object", "title": "SearchFlowParams", "description": "Request body for POST /v1/flows/search." }, "SearchFlowResponse": { "properties": { "limit": { "type": "integer", "title": "Limit" }, "filters": { "additionalProperties": true, "type": "object", "title": "Filters" }, "results": { "items": { "$ref": "#/components/schemas/Flow" }, "type": "array", "title": "Results" } }, "type": "object", "required": [ "limit", "filters", "results" ], "title": "SearchFlowResponse", "description": "SearchFlowContent — response body for POST /v1/flows/search." }, "SearchRequest": { "properties": { "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Query" }, "filters": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Filters" }, "sort": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Sort" }, "limit": { "type": "integer", "title": "Limit", "default": 20 }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, "type": "object", "title": "SearchRequest" }, "SendDocumentRequest": { "properties": { "type": { "type": "string", "enum": [ "invoice", "credit-note", "debit-note", "purchase-order", "sales-order", "quote", "event" ], "title": "Type" }, "format": { "anyOf": [ { "type": "string", "enum": [ "json", "ubl-xml", "auto", "raw" ] }, { "type": "null" } ], "title": "Format" }, "from": { "type": "string", "title": "From" }, "to": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "To" }, "document": { "anyOf": [ { "$ref": "#/components/schemas/DocumentBody-Input" }, { "type": "null" } ] }, "xml": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Xml" }, "file": { "anyOf": [ { "$ref": "#/components/schemas/FileAttachment" }, { "type": "null" } ] } }, "type": "object", "required": [ "type", "from" ], "title": "SendDocumentRequest", "examples": [ { "document": { "currency": "EUR", "issueDate": "2026-04-15", "lines": [ { "description": "Consulting services", "quantity": 10.0, "unitPrice": 150.0, "vatRate": 21.0 } ], "number": "INV-2026-0042" }, "format": "json", "from": "0009:FR86797978996", "to": "0009:BE0123456789", "type": "invoice" }, { "file": { "content": "JVBERi0xLjQKJeLjz9MKMyAwIG9iag... (base64)", "contentType": "application/pdf", "filename": "INV-2026-0042.pdf" }, "format": "auto", "from": "0009:FR86797978996", "to": "0009:BE0123456789", "type": "invoice" } ] }, "SendDocumentResponse": { "properties": { "id": { "type": "string", "title": "Id" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Type" }, "number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Number" }, "from": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "From" }, "to": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "To" }, "totals": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Totals" }, "deliveryStatus": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Deliverystatus" }, "sentAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Sentat" }, "fileId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Fileid" }, "storedFormat": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Storedformat" } }, "type": "object", "required": [ "id" ], "title": "SendDocumentResponse" }, "SirenSearchRequest": { "properties": { "filters": { "additionalProperties": true, "type": "object", "title": "Filters" }, "sorting": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Sorting" }, "fields": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Fields" }, "limit": { "type": "integer", "maximum": 100.0, "minimum": 1.0, "title": "Limit", "default": 50 }, "ignore": { "type": "integer", "minimum": 0.0, "title": "Ignore", "default": 0 } }, "type": "object", "title": "SirenSearchRequest", "description": "Request body for POST /v1/siren/search." }, "SirenSearchResponse": { "properties": { "search": { "additionalProperties": true, "type": "object", "title": "Search" }, "totalNumberOfResults": { "type": "integer", "title": "Totalnumberofresults" }, "results": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Results" } }, "type": "object", "required": [ "search", "totalNumberOfResults", "results" ], "title": "SirenSearchResponse", "description": "Response body for POST /v1/siren/search." }, "SiretSearchRequest": { "properties": { "filters": { "additionalProperties": true, "type": "object", "title": "Filters" }, "sorting": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Sorting" }, "fields": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Fields" }, "include": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Include" }, "limit": { "type": "integer", "maximum": 100.0, "minimum": 1.0, "title": "Limit", "default": 50 }, "ignore": { "type": "integer", "minimum": 0.0, "title": "Ignore", "default": 0 } }, "type": "object", "title": "SiretSearchRequest", "description": "Request body for POST /v1/siret/search." }, "SiretSearchResponse": { "properties": { "search": { "additionalProperties": true, "type": "object", "title": "Search" }, "totalNumberOfResults": { "type": "integer", "title": "Totalnumberofresults" }, "results": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Results" } }, "type": "object", "required": [ "search", "totalNumberOfResults", "results" ], "title": "SiretSearchResponse", "description": "Response body for POST /v1/siret/search." }, "StatsResponse": { "properties": { "period": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Period" }, "quota": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Quota" }, "rateLimit": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Ratelimit" }, "documents": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Documents" }, "byType": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Bytype" }, "byCountry": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Bycountry" }, "partners": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Partners" } }, "type": "object", "title": "StatsResponse" }, "StructuredDocumentResponse": { "properties": { "id": { "type": "string", "title": "Id" }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Type" }, "direction": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Direction" }, "number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Number" }, "issueDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Issuedate" }, "dueDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Duedate" }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Currency" }, "grossAmount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Grossamount" }, "netAmount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Netamount" }, "vatAmount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Vatamount" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" }, "lifecycleStatus": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lifecyclestatus" }, "deliveryStatus": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Deliverystatus" }, "senderPeppolId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Senderpeppolid" }, "senderName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sendername" }, "senderVatNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sendervatnumber" }, "receiverPeppolId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Receiverpeppolid" }, "receiverName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Receivername" }, "receiverVatNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Receivervatnumber" }, "buyerReference": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Buyerreference" }, "orderReference": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Orderreference" }, "paymentIban": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Paymentiban" }, "paymentReference": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Paymentreference" }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Note" }, "receivedAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Receivedat" }, "sentAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Sentat" }, "createdAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Createdat" }, "updatedAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updatedat" } }, "type": "object", "required": [ "id" ], "title": "StructuredDocumentResponse", "description": "Flat agent-friendly version with all primitives." }, "TokenRequest": { "properties": { "grant_type": { "type": "string", "const": "authorization_code", "title": "Grant Type" }, "code": { "type": "string", "minLength": 10, "title": "Code", "description": "The one-time code returned on consent." }, "code_verifier": { "type": "string", "maxLength": 128, "minLength": 43, "title": "Code Verifier", "description": "The original PKCE verifier (the agent's secret)." } }, "type": "object", "required": [ "grant_type", "code", "code_verifier" ], "title": "TokenRequest", "description": "Step 4 — agent exchanges the auth code for an API key.\n\nImplements RFC 7636 PKCE: server hashes ``code_verifier`` with SHA-256\nand compares to the original ``code_challenge``." }, "TokenResponse": { "properties": { "access_token": { "type": "string", "title": "Access Token", "description": "The issued API key. Format: flw_test_…" }, "token_type": { "type": "string", "const": "Bearer", "title": "Token Type", "default": "Bearer" }, "scopes": { "items": { "type": "string" }, "type": "array", "title": "Scopes" }, "expires_in": { "type": "integer", "title": "Expires In", "description": "Seconds until the issued key expires." }, "company_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Company Id", "description": "Sandbox company tied to the key." }, "organization_id": { "type": "string", "title": "Organization Id", "description": "Sandbox org the key belongs to." } }, "type": "object", "required": [ "access_token", "scopes", "expires_in", "organization_id" ], "title": "TokenResponse" }, "ValidateRequest": { "properties": { "type": { "type": "string", "enum": [ "invoice", "credit-note", "debit-note", "purchase-order", "sales-order", "quote", "event" ], "title": "Type" }, "format": { "anyOf": [ { "type": "string", "enum": [ "json", "ubl-xml" ] }, { "type": "null" } ], "title": "Format" }, "from": { "type": "string", "title": "From" }, "to": { "type": "string", "title": "To" }, "document": { "anyOf": [ { "$ref": "#/components/schemas/DocumentBody-Input" }, { "type": "null" } ] }, "xml": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Xml" } }, "type": "object", "required": [ "type", "from", "to" ], "title": "ValidateRequest" }, "ValidateResponse": { "properties": { "valid": { "type": "boolean", "title": "Valid" }, "errors": { "items": { "$ref": "#/components/schemas/ErrorDetail" }, "type": "array", "title": "Errors", "default": [] }, "warnings": { "items": { "$ref": "#/components/schemas/ErrorDetail" }, "type": "array", "title": "Warnings", "default": [] }, "preview": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Preview" } }, "type": "object", "required": [ "valid" ], "title": "ValidateResponse" }, "ValidationError": { "properties": { "loc": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "type": "array", "title": "Location" }, "msg": { "type": "string", "title": "Message" }, "type": { "type": "string", "title": "Error Type" }, "input": { "title": "Input" }, "ctx": { "type": "object", "title": "Context" } }, "type": "object", "required": [ "loc", "msg", "type" ], "title": "ValidationError" }, "VerifyRequest": { "properties": { "peppolId": { "type": "string", "title": "Peppolid" }, "documentType": { "type": "string", "title": "Documenttype" } }, "type": "object", "required": [ "peppolId", "documentType" ], "title": "VerifyRequest" }, "VerifyResponse": { "properties": { "peppolId": { "type": "string", "title": "Peppolid" }, "exists": { "type": "boolean", "title": "Exists" }, "canReceive": { "type": "boolean", "title": "Canreceive" }, "recipientName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Recipientname" }, "documentType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Documenttype" }, "accessPoint": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accesspoint" } }, "type": "object", "required": [ "peppolId", "exists", "canReceive" ], "title": "VerifyResponse" }, "WebhookCreate": { "properties": { "url": { "type": "string", "pattern": "^https?://", "title": "Url", "description": "HTTPS webhook endpoint URL" }, "events": { "items": { "type": "string" }, "type": "array", "minItems": 1, "title": "Events", "description": "Event types to subscribe to: document.received, document.updated, document.sent, document.delivered, document.failed, lifecycle.updated, *" }, "secret": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Secret" }, "companyId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Companyid" } }, "type": "object", "required": [ "url", "events" ], "title": "WebhookCreate", "examples": [ { "events": [ "document.received", "document.delivered" ], "secret": "whsec_abc123", "url": "https://example.com/webhooks/peppol" } ] }, "WebhookMetadata": { "properties": { "flowType": { "type": "string", "title": "Flowtype" }, "flowDirection": { "type": "string", "title": "Flowdirection" }, "processingRule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Processingrule" }, "ackStatus": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ackstatus" } }, "type": "object", "required": [ "flowType", "flowDirection" ], "title": "WebhookMetadata", "description": "WebhookMetadata — subscription filters." }, "WebhookParams": { "properties": { "callback": { "$ref": "#/components/schemas/CallbackParams" }, "metadata": { "$ref": "#/components/schemas/WebhookMetadata" } }, "type": "object", "required": [ "callback", "metadata" ], "title": "WebhookParams", "description": "Request body for POST /v1/webhooks." }, "WebhookPatchPayload": { "properties": { "headers": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Headers" }, "authentication": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Authentication" }, "signature": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Signature" } }, "type": "object", "title": "WebhookPatchPayload", "description": "Request body for PATCH /v1/webhooks/{webhookUid} (technical-only update)." }, "WebhookResponse": { "properties": { "id": { "type": "string", "title": "Id" }, "url": { "type": "string", "title": "Url" }, "events": { "items": { "type": "string" }, "type": "array", "title": "Events", "default": [] }, "status": { "anyOf": [ { "type": "string", "enum": [ "active", "paused", "disabled" ] }, { "type": "null" } ], "title": "Status" }, "companyId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Companyid" }, "createdAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Createdat" }, "lastDeliveredAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Lastdeliveredat" }, "failureCount": { "type": "integer", "title": "Failurecount", "default": 0 } }, "type": "object", "required": [ "id", "url" ], "title": "WebhookResponse", "examples": [ { "events": [ "document.received", "document.delivered" ], "failureCount": 0, "id": "wh_abc123", "status": "active", "url": "https://example.com/webhooks/peppol" } ] }, "WebhookUpdate": { "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Url" }, "events": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Events" }, "rotateSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Rotatesecret" } }, "type": "object", "title": "WebhookUpdate" } } }, "servers": [ { "url": "https://back.p2p-flowie.com/exchange", "description": "Production" }, { "url": "https://back.flowie.ink/exchange", "description": "Sandbox" } ], "externalDocs": { "url": "https://docs.flowie.ink", "description": "Full developer documentation (HTML)" } }