{"openapi":"3.0.1","info":{"title":"Platform operator Iopole API","description":"## Iopole API\n\nTo use the Iopole APIs, you must have a **`clientId`** and a **`clientSecret`**.\n\nYou can obtain these credentials by one of the following methods:\n- 📧 Contact the Iopole team at **support@iopole.com**\n- 🧪 Connect to **[Iopole Labs](https://labs.iopole.io)** to create your own sandbox environment\n\n### 📚 API Documentation\n- 🧪 **Preproduction**: [https://docs.ppd.iopole.fr/](https://docs.ppd.iopole.fr/)\n- 🚀 **Production**: [https://docs.iopole.com/](https://docs.iopole.com/)\n\n### 🛠️ Support & Monitoring (production only)\n- 📈 **System status**: [https://uptime.iopole.com](https://uptime.iopole.com)\n  - View real-time platform availability\n  - Subscribe to incident notifications\n  - Receive alerts for planned maintenance periods\n- 📝 **Release notes**: [https://release.iopole.com](https://release.iopole.com)\n","version":"1.0.0","contact":{"name":"Iopole","email":"support@iopole.com"},"x-doc":{"text":"## Iopole API\n\nTo use the Iopole APIs, you must have a **`clientId`** and a **`clientSecret`**.\n\nYou can obtain these credentials by one of the following methods:\n- 📧 Contact the Iopole team at **support@iopole.com**\n- 🧪 Connect to **[Iopole Labs](https://labs.iopole.io)** to create your own sandbox environment\n\n### 📚 API Documentation\n- 🧪 **Preproduction**: [https://docs.ppd.iopole.fr/](https://docs.ppd.iopole.fr/)\n- 🚀 **Production**: [https://docs.iopole.com/](https://docs.iopole.com/)\n\n### 🛠️ Support & Monitoring (production only)\n- 📈 **System status**: [https://uptime.iopole.com](https://uptime.iopole.com)\n  - View real-time platform availability\n  - Subscribe to incident notifications\n  - Receive alerts for planned maintenance periods\n- 📝 **Release notes**: [https://release.iopole.com](https://release.iopole.com)\n"}},"security":[{"oauth2ClientCredentials":[]}],"components":{"securitySchemes":{"oauth2ClientCredentials":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.preprod.iopole.fr/realms/iopole/protocol/openid-connect/token","scopes":{}}}}}},"paths":{"/v1/edi/message/{messageType}":{"post":{"summary":"Send Edi message","description":"Send Edi message.","tags":["Edi"],"security":[{"oauth2ClientCredentials":[]}],"parameters":[{"in":"path","name":"messageType","required":true,"description":"EDI message type (Use AUTO for auto-detection of message type).","schema":{"type":"string","default":"AUTO"},"x-doc":{"text":"EDI message type (Use AUTO for auto-detection of message type)."}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"description":"EDI message document","type":"string","format":"binary","x-doc":{"text":"EDI message document"}}}}},"application/json":{"schema":{"type":"object","additionalProperties":true}},"application/xml":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"201":{"description":"Returns created Iopole EDI message identifier.","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["WEBHOOK","SECRET","STREAM","INVOICE","STATUS","BUSINESS_ENTITY","BUSINESS_ENTITY_IDENTIFIER","DIRECTORY","EDI_MESSAGE"],"description":"The type of the response object.","x-doc":{"text":"The type of the response object."}},"id":{"type":"string","format":"uuid","description":"The unique identifier for the created element.","x-doc":{"text":"The unique identifier for the created element."}}},"required":["type","id"],"description":"Response model for the element creation response.","x-doc":{"text":"Response model for the element creation response."}},"example":{"type":"EDI_MESSAGE","id":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}}},"x-doc":{"text":"Returns created Iopole EDI message identifier."}},"401":{"description":"Unauthorized - Authentication is required and has failed or has not yet been provided.","x-doc":{"text":"Unauthorized - Authentication is required and has failed or has not yet been provided."}},"403":{"description":"Forbidden - The server understood the request, but it refuses to authorize it.","x-doc":{"text":"Forbidden - The server understood the request, but it refuses to authorize it."}}},"x-doc":{"text":"Send Edi message."}}},"/v1/invoice":{"post":{"summary":"Send invoice to Iopole Pdp","description":"Send invoice to Iopole Pdp (invoice format can be FacturX PDF, UBL, or CII XML).","tags":["Invoice"],"security":[{"oauth2ClientCredentials":[]}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"description":"Invoice file path (PDF or XML file)","type":"string","format":"binary","x-doc":{"text":"Invoice file path (PDF or XML file)"}}}}}}},"responses":{"201":{"description":"Returns created Iopole invoice identifier.","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["WEBHOOK","SECRET","STREAM","INVOICE","STATUS","BUSINESS_ENTITY","BUSINESS_ENTITY_IDENTIFIER","DIRECTORY","EDI_MESSAGE"],"description":"The type of the response object.","x-doc":{"text":"The type of the response object."}},"id":{"type":"string","format":"uuid","description":"The unique identifier for the created element.","x-doc":{"text":"The unique identifier for the created element."}}},"required":["type","id"],"description":"Response model for the element creation response.","x-doc":{"text":"Response model for the element creation response."}},"example":{"type":"INVOICE","id":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}}},"x-doc":{"text":"Returns created Iopole invoice identifier."}},"401":{"description":"Unauthorized - Authentication is required and has failed or has not yet been provided.","x-doc":{"text":"Unauthorized - Authentication is required and has failed or has not yet been provided."}},"403":{"description":"Forbidden - The server understood the request, but it refuses to authorize it.","x-doc":{"text":"Forbidden - The server understood the request, but it refuses to authorize it."}}},"x-doc":{"text":"Send invoice to Iopole Pdp (invoice format can be FacturX PDF, UBL, or CII XML)."}}},"/v1/invoice/status":{"post":{"summary":"Send invoice status to Iopole Pdp","description":"Send invoice status to Iopole Pdp (status must be under CDAR XML format).","tags":["Invoice"],"security":[{"oauth2ClientCredentials":[]}],"parameters":[{"name":"source-type","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"description":"Status format","required":true,"content":{"application/xml":{"schema":{"type":"string","format":"binary"}}},"x-doc":{"text":"Status format"}},"responses":{"201":{"description":"Returns Iopole invoice identifier.","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["WEBHOOK","SECRET","STREAM","INVOICE","STATUS","BUSINESS_ENTITY","BUSINESS_ENTITY_IDENTIFIER","DIRECTORY","EDI_MESSAGE"],"description":"The type of the response object.","x-doc":{"text":"The type of the response object."}},"id":{"type":"string","format":"uuid","description":"The unique identifier for the created element.","x-doc":{"text":"The unique identifier for the created element."}}},"required":["type","id"],"description":"Response model for the element creation response.","x-doc":{"text":"Response model for the element creation response."}},"example":{"type":"INVOICE","id":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}}},"x-doc":{"text":"Returns Iopole invoice identifier."}},"401":{"description":"Unauthorized - Authentication is required and has failed or has not yet been provided.","x-doc":{"text":"Unauthorized - Authentication is required and has failed or has not yet been provided."}},"403":{"description":"Forbidden - The server understood the request, but it refuses to authorize it.","x-doc":{"text":"Forbidden - The server understood the request, but it refuses to authorize it."}}},"x-doc":{"text":"Send invoice status to Iopole Pdp (status must be under CDAR XML format)."}}}}}