{ "openapi": "3.0.0", "info": { "title": "API Partner", "description": "Documentation de l'API Partner pour les intégrations externes", "version": "1.0.0" }, "paths": { "/api/v1/medias/{uid}": { "get": { "tags": [ "Partner - Medias" ], "summary": "Get media file content.", "operationId": "get_media_display", "parameters": [ { "name": "uid", "in": "path", "description": "Unique identifier of the media", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "550e8400-e29b-41d4-a716-446655440000" } ], "responses": { "200": { "description": "Media file content", "content": { "image/jpeg": { "schema": { "type": "string", "format": "binary" } }, "image/png": { "schema": { "type": "string", "format": "binary" } }, "application/pdf": { "schema": { "type": "string", "format": "binary" } }, "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "401": { "description": "Unauthorized - Authentication required", "content": { "application/json": { "schema": {}, "example": { "error": "The error message" } } } }, "403": { "description": "Forbidden - Insufficient permissions", "content": { "application/json": { "schema": {}, "example": { "error": "The error message" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": {}, "example": { "error": "The error message" } } } } } }, "delete": { "tags": [ "Partner - Medias" ], "summary": "Delete a media.", "operationId": "delete_media_delete", "parameters": [ { "name": "uid", "in": "path", "description": "Unique identifier of the media to delete", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "550e8400-e29b-41d4-a716-446655440000" } ], "responses": { "204": { "description": "Media successfully deleted" }, "401": { "description": "Unauthorized - Authentication required", "content": { "application/json": { "schema": {}, "example": { "error": "The error message" } } } }, "403": { "description": "Forbidden - Insufficient permissions", "content": { "application/json": { "schema": {}, "example": { "error": "The error message" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": {}, "example": { "error": "The error message" } } } } } } }, "/api/v1/medias": { "post": { "tags": [ "Partner - Medias" ], "summary": "Upload a media.", "description": "You have to send a multipart/form-data request with a file and a visibility parameter.", "operationId": "post_media_create", "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "required": [ "file" ], "properties": { "file": { "description": "The file to upload", "type": "string", "format": "binary" }, "visibility": { "description": "Visibility of the media", "type": "string", "default": "public", "enum": [ "public", "private" ] } }, "type": "object" } }, "application/json": { "schema": { "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "default": "public", "pattern": "(public|private)" } }, "type": "object" } } } }, "responses": { "201": { "description": "Media successfully created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Media" } } } }, "400": { "description": "Bad Request - Invalid input parameters", "content": { "application/json": { "schema": { "properties": { "error": { "type": "string", "example": "The error message" }, "message": { "type": "string", "example": "Validation Failed" }, "errors": { "type": "object", "example": { "children": { "parameter_example": "contraints_example" } } } }, "type": "object" } } } }, "401": { "description": "Unauthorized - Authentication required", "content": { "application/json": { "schema": {}, "example": { "error": "The error message" } } } }, "403": { "description": "Forbidden - Insufficient permissions", "content": { "application/json": { "schema": {}, "example": { "error": "The error message" } } } } } } }, "/api/v1/partner/organisations/{organisationId}/request/{requestId}/cashout/{id}": { "get": { "tags": [ "Partner - CashOut" ], "summary": "Get cashout detail.", "operationId": "get_partner_cashout_details", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "requestId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Cash out detail", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CashOut5" } } } }, "400": { "description": "Bad Request - Invalid input parameters", "content": { "application/json": { "schema": { "properties": { "error": { "type": "string", "example": "The error message" }, "message": { "type": "string", "example": "Validation Failed" }, "errors": { "type": "object", "example": { "children": { "parameter_example": "contraints_example" } } } }, "type": "object" } } } }, "401": { "description": "Unauthorized - Authentication required", "content": { "application/json": { "schema": {}, "example": { "error": "The error message" } } } }, "403": { "description": "Forbidden - Insufficient permissions", "content": { "application/json": { "schema": {}, "example": { "error": "The error message" } } } } } } }, "/api/v1/partner/organisations/{organisationId}/request/{requestId}/cashout": { "post": { "tags": [ "Partner - CashOut" ], "summary": "Create cashout.", "operationId": "post_partner_create_cash_out", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "requestId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CashOutCreateType" } } } }, "responses": { "200": { "description": "Created cashOut detail", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CashOut5" } } } }, "400": { "description": "Bad Request - Invalid input parameters", "content": { "application/json": { "schema": { "properties": { "error": { "type": "string", "example": "The error message" }, "message": { "type": "string", "example": "Validation Failed" }, "errors": { "type": "object", "example": { "children": { "parameter_example": "contraints_example" } } } }, "type": "object" } } } }, "401": { "description": "Unauthorized - Authentication required", "content": { "application/json": { "schema": {}, "example": { "error": "The error message" } } } }, "403": { "description": "Forbidden - Insufficient permissions", "content": { "application/json": { "schema": {}, "example": { "error": "The error message" } } } } } } }, "/api/v1/partner/organisations/{organisationId}/request/{requestId}/cashout/{id}/cancel": { "patch": { "tags": [ "Partner - CashOut" ], "summary": "Update cashout.", "operationId": "patch_partner_cancel_cashout", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "requestId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Updated cashout detail", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CashOut5" } } } }, "400": { "description": "Bad Request - Invalid input parameters", "content": { "application/json": { "schema": { "properties": { "error": { "type": "string", "example": "The error message" }, "message": { "type": "string", "example": "Validation Failed" }, "errors": { "type": "object", "example": { "children": { "parameter_example": "contraints_example" } } } }, "type": "object" } } } }, "401": { "description": "Unauthorized - Authentication required", "content": { "application/json": { "schema": {}, "example": { "error": "The error message" } } } }, "403": { "description": "Forbidden - Insufficient permissions", "content": { "application/json": { "schema": {}, "example": { "error": "The error message" } } } } } } }, "/api/v1/partner/organisations/{organisationId}/request/{requestId}/cashout/{id}/discuss": { "post": { "tags": [ "Partner - CashOut" ], "summary": "Create cashout discussion.", "operationId": "post_partner_discuss_cashout", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "requestId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CashOutDiscussionType" } } } }, "responses": { "200": { "description": "Created CashOutDiscussion detail", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CashOutDiscussion5" } } } }, "400": { "description": "Bad Request - Invalid input parameters", "content": { "application/json": { "schema": { "properties": { "error": { "type": "string", "example": "The error message" }, "message": { "type": "string", "example": "Validation Failed" }, "errors": { "type": "object", "example": { "children": { "parameter_example": "contraints_example" } } } }, "type": "object" } } } }, "401": { "description": "Unauthorized - Authentication required", "content": { "application/json": { "schema": {}, "example": { "error": "The error message" } } } }, "403": { "description": "Forbidden - Insufficient permissions", "content": { "application/json": { "schema": {}, "example": { "error": "The error message" } } } } } } }, "/api/v1/partner/organisations/{organisationId}/me": { "get": { "tags": [ "Partner - Me" ], "summary": "Get partner details.", "operationId": "get_partner_details", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Partner details", "content": { "application/json": { "schema": { "properties": { "id": { "type": "string", "example": "3a7a708a-8fd0-4847-8260-f20786277b17" }, "name": { "type": "string", "example": "JOHN DOE" }, "status": { "type": "string", "example": "active" }, "environment": { "type": "string", "example": "dev" } }, "type": "object" } } } }, "400": { "description": "Bad Request - Invalid input parameters", "content": { "application/json": { "schema": { "properties": { "error": { "type": "string", "example": "The error message" }, "message": { "type": "string", "example": "Validation Failed" }, "errors": { "type": "object", "example": { "children": { "parameter_example": "contraints_example" } } } }, "type": "object" } } } }, "401": { "description": "Unauthorized - Authentication required", "content": { "application/json": { "schema": {}, "example": { "error": "The error message" } } } }, "403": { "description": "Forbidden - Insufficient permissions", "content": { "application/json": { "schema": {}, "example": { "error": "The error message" } } } } } } }, "/api/v1/partner/login": { "post": { "tags": [ "Partner - Login" ], "summary": "Generates access token depending on the configuration.", "operationId": "post_app_partner_partnerlogin_login", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CredentialModel" } } } }, "responses": { "200": { "description": "Returns a json containing the access token details", "content": { "application/json": { "schema": { "type": "array", "items": {} }, "example": [ { "token_type": "Bearer", "expires_in": 2592000, "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJI4VWMpz1S-hBxCZm8-WdgGt6hzzQ" } ] } } }, "400": { "description": "Bad Request - Invalid input parameters", "content": { "application/json": { "schema": { "properties": { "error": { "type": "string", "example": "The error message" }, "message": { "type": "string", "example": "Validation Failed" }, "errors": { "type": "object", "example": { "children": { "parameter_example": "contraints_example" } } } }, "type": "object" } } } } } } }, "/api/v1/partner/organisations/{organisationId}/model-request/list/{type}": { "get": { "tags": [ "Partner - ModelRequest" ], "summary": "List model requests.", "operationId": "get_partner_model_request_list", "parameters": [ { "name": "length", "in": "query", "schema": { "type": "integer" } }, { "name": "offset", "in": "query", "schema": { "type": "integer" } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "order", "in": "query", "schema": { "type": "string", "default": "createdAt", "enum": [ "createdAt", "name", "description" ] } }, { "name": "direction", "in": "query", "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "type", "in": "path", "description": "ModelRequest type", "required": true, "schema": { "type": "string", "enum": [ "payment", "security_deposit" ] } }, { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Model request listing", "content": { "application/json": { "schema": { "properties": { "count": { "type": "integer", "example": 10 }, "data": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/ModelRequestSecurityDeposit2" }, { "$ref": "#/components/schemas/ModelRequestPayment2" } ] } } }, "type": "object" } } } }, "400": { "description": "Bad Request - Invalid input parameters", "content": { "application/json": { "schema": { "properties": { "error": { "type": "string", "example": "The error message" }, "message": { "type": "string", "example": "Validation Failed" }, "errors": { "type": "object", "example": { "children": { "parameter_example": "contraints_example" } } } }, "type": "object" } } } }, "401": { "description": "Unauthorized - Authentication required", "content": { "application/json": { "schema": {}, "example": { "error": "The error message" } } } }, "403": { "description": "Forbidden - Insufficient permissions", "content": { "application/json": { "schema": {}, "example": { "error": "The error message" } } } } } } }, "/api/v1/partner/organisations/{organisationId}/model-request/{id}": { "get": { "tags": [ "Partner - ModelRequest" ], "summary": "Get model request details.", "operationId": "get_partner_model_request_details", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Model request detail", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ModelRequestSecurityDeposit2" }, { "$ref": "#/components/schemas/ModelRequestPayment2" } ] } } } }, "400": { "description": "Bad Request - Invalid input parameters", "content": { "application/json": { "schema": { "properties": { "error": { "type": "string", "example": "The error message" }, "message": { "type": "string", "example": "Validation Failed" }, "errors": { "type": "object", "example": { "children": { "parameter_example": "contraints_example" } } } }, "type": "object" } } } }, "401": { "description": "Unauthorized - Authentication required", "content": { "application/json": { "schema": {}, "example": { "error": "The error message" } } } }, "403": { "description": "Forbidden - Insufficient permissions", "content": { "application/json": { "schema": {}, "example": { "error": "The error message" } } } } } }, "delete": { "tags": [ "Partner - ModelRequest" ], "summary": "Delete model request", "operationId": "delete_partner_model_request_remove", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Data of the delete modelRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelRequest4" } } } }, "400": { "description": "Bad Request - Invalid input parameters", "content": { "application/json": { "schema": { "properties": { "error": { "type": "string", "example": "The error message" }, "message": { "type": "string", "example": "Validation Failed" }, "errors": { "type": "object", "example": { "children": { "parameter_example": "contraints_example" } } } }, "type": "object" } } } }, "401": { "description": "Unauthorized - Authentication required", "content": { "application/json": { "schema": {}, "example": { "error": "The error message" } } } }, "403": { "description": "Forbidden - Insufficient permissions", "content": { "application/json": { "schema": {}, "example": { "error": "The error message" } } } } } }, "patch": { "tags": [ "Partner - ModelRequest" ], "summary": "Update model request.", "operationId": "patch_partner_model_request_update", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ModelRequestPaymentType" }, { "$ref": "#/components/schemas/ModelRequestSecurityDepositType" } ] } } } }, "responses": { "200": { "description": "Model request updated successfully", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ModelRequestSecurityDeposit2" }, { "$ref": "#/components/schemas/ModelRequestPayment2" } ] } } } }, "400": { "description": "Bad Request - Invalid input parameters", "content": { "application/json": { "schema": { "properties": { "error": { "type": "string", "example": "The error message" }, "message": { "type": "string", "example": "Validation Failed" }, "errors": { "type": "object", "example": { "children": { "parameter_example": "contraints_example" } } } }, "type": "object" } } } }, "401": { "description": "Unauthorized - Authentication required", "content": { "application/json": { "schema": {}, "example": { "error": "The error message" } } } }, "403": { "description": "Forbidden - Insufficient permissions", "content": { "application/json": { "schema": {}, "example": { "error": "The error message" } } } } } } }, "/api/v1/partner/organisations/{organisationId}/model-request/{type}": { "post": { "tags": [ "Partner - ModelRequest" ], "summary": "Create model request", "operationId": "post_partner_model_request_create", "parameters": [ { "name": "type", "in": "path", "description": "ModelRequest type", "required": true, "schema": { "type": "string", "enum": [ "payment", "security_deposit" ] } }, { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ModelRequestPaymentType" }, { "$ref": "#/components/schemas/ModelRequestSecurityDepositType" } ] } } } }, "responses": { "200": { "description": "Model request created successfully", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ModelRequestSecurityDeposit2" }, { "$ref": "#/components/schemas/ModelRequestPayment2" } ] } } } }, "400": { "description": "Bad Request - Invalid input parameters", "content": { "application/json": { "schema": { "properties": { "error": { "type": "string", "example": "The error message" }, "message": { "type": "string", "example": "Validation Failed" }, "errors": { "type": "object", "example": { "children": { "parameter_example": "contraints_example" } } } }, "type": "object" } } } }, "401": { "description": "Unauthorized - Authentication required", "content": { "application/json": { "schema": {}, "example": { "error": "The error message" } } } }, "403": { "description": "Forbidden - Insufficient permissions", "content": { "application/json": { "schema": {}, "example": { "error": "The error message" } } } } } } }, "/api/v1/partner/organisations/{organisationId}/request/list/{type}": { "get": { "tags": [ "Partner - Request" ], "summary": "List requests.", "operationId": "get_partner_request_list", "parameters": [ { "name": "length", "in": "query", "schema": { "type": "integer" } }, { "name": "offset", "in": "query", "schema": { "type": "integer" } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "order", "in": "query", "schema": { "type": "string", "default": "createdAt", "enum": [ "createdAt", "name", "description" ] } }, { "name": "direction", "in": "query", "schema": { "type": "string" } }, { "name": "model", "in": "query", "schema": { "type": "string" } }, { "name": "type", "in": "path", "description": "Request type", "required": true, "schema": { "type": "string", "enum": [ "payment", "security_deposit" ] } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "endDate", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Request listing", "content": { "application/json": { "schema": { "properties": { "count": { "type": "integer", "example": 10 }, "data": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/RequestSecurityDeposit8" }, { "$ref": "#/components/schemas/RequestPayment7" } ] } } }, "type": "object" } } } }, "400": { "description": "Bad Request - Invalid input parameters", "content": { "application/json": { "schema": { "properties": { "error": { "type": "string", "example": "The error message" }, "message": { "type": "string", "example": "Validation Failed" }, "errors": { "type": "object", "example": { "children": { "parameter_example": "contraints_example" } } } }, "type": "object" } } } }, "401": { "description": "Unauthorized - Authentication required", "content": { "application/json": { "schema": {}, "example": { "error": "The error message" } } } }, "403": { "description": "Forbidden - Insufficient permissions", "content": { "application/json": { "schema": {}, "example": { "error": "The error message" } } } } } } }, "/api/v1/partner/organisations/{organisationId}/request/{id}": { "get": { "tags": [ "Partner - Request" ], "summary": "Get request details.", "operationId": "get_partner_request_details", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Request detail", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/RequestSecurityDeposit9" }, { "$ref": "#/components/schemas/RequestPayment8" } ] } } } }, "400": { "description": "Bad Request - Invalid input parameters", "content": { "application/json": { "schema": { "properties": { "error": { "type": "string", "example": "The error message" }, "message": { "type": "string", "example": "Validation Failed" }, "errors": { "type": "object", "example": { "children": { "parameter_example": "contraints_example" } } } }, "type": "object" } } } }, "401": { "description": "Unauthorized - Authentication required", "content": { "application/json": { "schema": {}, "example": { "error": "The error message" } } } }, "403": { "description": "Forbidden - Insufficient permissions", "content": { "application/json": { "schema": {}, "example": { "error": "The error message" } } } } } }, "patch": { "tags": [ "Partner - Request" ], "summary": "Update request.", "operationId": "patch_partner_request_update", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/RequestPaymentType" }, { "$ref": "#/components/schemas/RequestSecurityDepositType" } ] } } } }, "responses": { "200": { "description": "Request updated successfully", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/RequestSecurityDeposit10" }, { "$ref": "#/components/schemas/RequestPayment9" } ] } } } }, "400": { "description": "Bad Request - Invalid input parameters", "content": { "application/json": { "schema": { "properties": { "error": { "type": "string", "example": "The error message" }, "message": { "type": "string", "example": "Validation Failed" }, "errors": { "type": "object", "example": { "children": { "parameter_example": "contraints_example" } } } }, "type": "object" } } } }, "401": { "description": "Unauthorized - Authentication required", "content": { "application/json": { "schema": {}, "example": { "error": "The error message" } } } }, "403": { "description": "Forbidden - Insufficient permissions", "content": { "application/json": { "schema": {}, "example": { "error": "The error message" } } } } } } }, "/api/v1/partner/organisations/{organisationId}/request/{id}/send-email": { "patch": { "tags": [ "Partner - Request" ], "summary": "Resend request email.", "operationId": "patch_partner_request_send_email", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Request updated successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestSecurityDeposit10" } } } }, "400": { "description": "Bad Request - Invalid input parameters", "content": { "application/json": { "schema": { "properties": { "error": { "type": "string", "example": "The error message" }, "message": { "type": "string", "example": "Validation Failed" }, "errors": { "type": "object", "example": { "children": { "parameter_example": "contraints_example" } } } }, "type": "object" } } } }, "401": { "description": "Unauthorized - Authentication required", "content": { "application/json": { "schema": {}, "example": { "error": "The error message" } } } }, "403": { "description": "Forbidden - Insufficient permissions", "content": { "application/json": { "schema": {}, "example": { "error": "The error message" } } } } } } }, "/api/v1/partner/organisations/{organisationId}/request/{id}/admin_message": { "patch": { "tags": [ "Partner - Request" ], "summary": "Add message for admin.", "operationId": "patch_partner_request_send_admin_message", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketSendOwnerMessageType" } } } }, "responses": { "200": { "description": "Message send", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/RequestSecurityDeposit11" }, { "$ref": "#/components/schemas/RequestPayment10" } ] } } } }, "400": { "description": "Bad Request - Invalid input parameters", "content": { "application/json": { "schema": { "properties": { "error": { "type": "string", "example": "The error message" }, "message": { "type": "string", "example": "Validation Failed" }, "errors": { "type": "object", "example": { "children": { "parameter_example": "contraints_example" } } } }, "type": "object" } } } }, "401": { "description": "Unauthorized - Authentication required", "content": { "application/json": { "schema": {}, "example": { "error": "The error message" } } } }, "403": { "description": "Forbidden - Insufficient permissions", "content": { "application/json": { "schema": {}, "example": { "error": "The error message" } } } } } } }, "/api/v1/partner/organisations/{organisationId}/request/{type}": { "post": { "tags": [ "Partner - Request" ], "summary": "Create request", "operationId": "post_partner_request_create", "parameters": [ { "name": "type", "in": "path", "description": "Request type", "required": true, "schema": { "type": "string", "enum": [ "payment", "security_deposit" ] } }, { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/RequestPaymentType" }, { "$ref": "#/components/schemas/RequestSecurityDepositType" } ] } } } }, "responses": { "200": { "description": "Request created successfully", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/RequestSecurityDeposit10" }, { "$ref": "#/components/schemas/RequestPayment9" } ] } } } }, "400": { "description": "Bad Request - Invalid input parameters", "content": { "application/json": { "schema": { "properties": { "error": { "type": "string", "example": "The error message" }, "message": { "type": "string", "example": "Validation Failed" }, "errors": { "type": "object", "example": { "children": { "parameter_example": "contraints_example" } } } }, "type": "object" } } } }, "401": { "description": "Unauthorized - Authentication required", "content": { "application/json": { "schema": {}, "example": { "error": "The error message" } } } }, "403": { "description": "Forbidden - Insufficient permissions", "content": { "application/json": { "schema": {}, "example": { "error": "The error message" } } } } } } }, "/api/v1/partner/organisations/{organisationId}/request/{id}/cancel": { "patch": { "tags": [ "Partner - Request" ], "summary": "Cancel request.", "operationId": "patch_partner_request_cancel", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Request updated successfully", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/RequestSecurityDeposit10" }, { "$ref": "#/components/schemas/RequestPayment9" } ] } } } }, "400": { "description": "Bad Request - Invalid input parameters", "content": { "application/json": { "schema": { "properties": { "error": { "type": "string", "example": "The error message" }, "message": { "type": "string", "example": "Validation Failed" }, "errors": { "type": "object", "example": { "children": { "parameter_example": "contraints_example" } } } }, "type": "object" } } } }, "401": { "description": "Unauthorized - Authentication required", "content": { "application/json": { "schema": {}, "example": { "error": "The error message" } } } }, "403": { "description": "Forbidden - Insufficient permissions", "content": { "application/json": { "schema": {}, "example": { "error": "The error message" } } } } } } }, "/api/v1/partner/organisations/{organisationId}/request/{id}/finish": { "patch": { "tags": [ "Partner - Request" ], "summary": "Finish request.", "operationId": "patch_partner_request_finish", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Request updated successfully", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/RequestSecurityDeposit10" }, { "$ref": "#/components/schemas/RequestPayment9" } ] } } } }, "400": { "description": "Bad Request - Invalid input parameters", "content": { "application/json": { "schema": { "properties": { "error": { "type": "string", "example": "The error message" }, "message": { "type": "string", "example": "Validation Failed" }, "errors": { "type": "object", "example": { "children": { "parameter_example": "contraints_example" } } } }, "type": "object" } } } }, "401": { "description": "Unauthorized - Authentication required", "content": { "application/json": { "schema": {}, "example": { "error": "The error message" } } } }, "403": { "description": "Forbidden - Insufficient permissions", "content": { "application/json": { "schema": {}, "example": { "error": "The error message" } } } } } } } }, "components": { "schemas": { "ModelRequest": { "required": [ "id", "publicLink" ], "properties": { "deletedAt": { "type": "string", "format": "date-time", "nullable": true }, "id": { "type": "string" }, "publicLink": { "description": "Public link of the model request.", "type": "string" }, "internalReference": { "description": "Reference of the request. You can put an utile reference to identify the request to your side.", "type": "string", "nullable": true } }, "type": "object" }, "Organisation": { "type": "object" }, "PhysicalPerson": { "type": "object" }, "OrganisationTransaction": { "required": [ "id", "provider", "status" ], "properties": { "id": { "type": "string" }, "provider": { "description": "External provider of the transaction. Our payment partner.", "type": "string" }, "providerId": { "description": "External id of the transaction. Our payment partner transaction ID.", "type": "string", "nullable": true }, "payer": { "description": "Account who paid the transaction.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Organisation" } ] }, "status": { "type": "string" }, "authorizedAmount": { "description": "3DS authorisation amount.", "type": "number", "format": "float", "nullable": true }, "amount": { "description": "Amount.", "type": "number", "format": "float", "nullable": true } }, "type": "object" }, "RequestEvent": { "type": "object" }, "Request": { "title": "Request", "description": "Base model for all request", "required": [ "id", "owner", "publicLink", "organisationTransactions", "requestEvents", "fullLink", "canEdit", "dtype" ], "properties": { "id": { "description": "The unique identifier of the request.", "type": "string" }, "model": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ModelRequest" } ] }, "owner": { "$ref": "#/components/schemas/Organisation" }, "recipient": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Organisation" } ] }, "recipientPreFill": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PhysicalPerson" } ] }, "publicLink": { "description": "Public link of the request.", "type": "string" }, "source": { "description": "Source of the request.", "type": "string", "default": "app", "enum": [ "app", "app_public_link", "api", "connector" ], "nullable": true }, "locale": { "description": "Locale of the request. It's use to send email in the good language for the recipient.", "type": "string", "enum": [ "en", "fr", "de", "es" ], "nullable": true }, "email": { "description": "Email ot the recipient to send the request.", "type": "string", "nullable": true }, "status": { "description": "State of the request.", "type": "string", "default": "waiting", "enum": [ "waiting", "in_progress", "litigation", "error", "finish", "cancel", "done", "payed" ] }, "emailSendTiming": { "description": "Timing at which the request email should be sent.", "type": "string", "default": "instant", "enum": [ "instant", "month_before", "week_before", "72_hours_before", "48_hours_before", "24_hours_before", "none" ] }, "organisationTransactions": { "description": "Card transactions link to the request.", "type": "array", "items": { "$ref": "#/components/schemas/OrganisationTransaction" } }, "requestEvents": { "description": "All events of the request.", "type": "array", "items": { "$ref": "#/components/schemas/RequestEvent" } }, "partnerIntegrationType": { "description": "Partner integration type", "type": "string", "default": "default", "enum": [ "default", "integrated", "fully_integrated" ], "nullable": true }, "partnerReturnSuccessUrl": { "description": "URL to which the user is redirected after completing their request. This URL is required if the partnerIntegrationType is integrated", "type": "string", "nullable": true }, "partnerReturnFailedUrl": { "description": "URL to which the user is redirected after a failed during the completion of their request. This URL is required if the partnerIntegrationType is integrated", "type": "string", "nullable": true }, "partnerName": { "description": "Property that you can use to identify the request to your side", "type": "string", "nullable": true }, "partnerRef": { "description": "Property that you can use to identify the request to your side", "type": "string", "nullable": true }, "internalReference": { "description": "Reference of the request. You can put an utile reference to identify the request to your side.", "type": "string", "nullable": true }, "fullLink": { "description": "Full link that you can send to the recipient for him to complete the request.", "type": "string" }, "canEdit": { "description": "Property to know if the request ca be edit or no.", "type": "boolean" }, "recipientId": { "type": "string", "nullable": true }, "dtype": { "type": "string" } }, "type": "object" }, "ModelRequest2": { "required": [ "id", "publicLink", "dtype" ], "properties": { "id": { "type": "string" }, "owner": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Organisation" } ] }, "publicLink": { "description": "Public link of the model request.", "type": "string" }, "status": { "description": "Status of the model request.", "type": "string", "default": "inline", "enum": [ "inline", "desactivate" ], "nullable": true }, "emailSendTiming": { "description": "Timing at which the request email should be sent.", "type": "string", "default": "instant", "enum": [ "instant", "month_before", "week_before", "72_hours_before", "48_hours_before", "24_hours_before", "none" ], "nullable": true }, "internalReference": { "description": "Reference of the request. You can put an utile reference to identify the request to your side.", "type": "string", "nullable": true }, "dtype": { "description": "Type of the request.", "type": "string", "enum": [ "security_deposit", "payment" ] } }, "type": "object" }, "Address": { "properties": { "address": { "type": "string", "nullable": true }, "addressComplementary": { "type": "string", "nullable": true }, "zipCode": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true } }, "type": "object" }, "Media": { "required": [ "id", "name", "originalName", "extension" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "originalName": { "type": "string" }, "extension": { "type": "string" }, "visibility": { "type": "string", "default": "public" }, "apiMoneyStatus": { "type": "string", "nullable": true } }, "type": "object" }, "Document": { "required": [ "id", "type", "medias" ], "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "status": { "type": "string", "default": "provide" }, "validationError": { "type": "string", "nullable": true }, "validationDescription": { "type": "string", "nullable": true }, "medias": { "type": "array", "items": { "$ref": "#/components/schemas/Media" } } }, "type": "object" }, "PhysicalPerson2": { "required": [ "id" ], "properties": { "id": { "type": "string" }, "secondaryEmail": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "secondaryPhone": { "type": "string", "nullable": true }, "firstname": { "type": "string", "nullable": true }, "lastname": { "type": "string", "nullable": true }, "birthday": { "type": "string", "format": "date-time", "nullable": true }, "birthdayAddress": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Address" } ] }, "address": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Address" } ] }, "monthlyIncome": { "description": "Monthly income.", "type": "string", "enum": [ "LOWER_THAN_1200_EUROS", "BETWEEN_1200_2500_EUROS", "BETWEEN_2500_4000_EUROS", "GREATER_THAN_4000_EUROS" ], "nullable": true }, "profession": { "description": "Profession.", "type": "string", "enum": [ "FARMER", "CRAFTSMAN_MERCHANT_ENTREPRENEUR", "LIBERAL_PROFESSION", "EXECUTIVE", "RETIREE", "EMPLOYEE", "WORKER", "NO_ACTIVITY" ], "nullable": true }, "nationality": { "description": "Nationality in alpha3 country code.", "type": "string", "enum": [ "afg", "zaf", "alb", "dza", "deu", "and", "ago", "atg", "sau", "arg", "arm", "aus", "aut", "aze", "bhs", "bhr", "bgd", "brb", "blr", "bel", "blz", "ben", "btn", "bol", "bih", "bwa", "bra", "brn", "bgr", "bfa", "bdi", "khm", "cmr", "can", "cpv", "caf", "chl", "chn", "cyp", "col", "com", "cog", "cod", "kor", "prk", "cri", "civ", "hrv", "cub", "dnk", "dji", "dom", "dma", "egy", "slv", "are", "ecu", "eri", "esp", "est", "usa", "eth", "fji", "fin", "fra", "gab", "gmb", "geo", "gha", "grc", "grd", "gtm", "gin", "gnb", "gnq", "guy", "hti", "hnd", "hun", "ind", "idn", "irn", "irq", "irl", "isl", "isr", "ita", "jam", "jpn", "jor", "kaz", "ken", "kgz", "kir", "kwt", "lao", "lso", "lva", "lbn", "lbr", "lby", "lie", "ltu", "lux", "mkd", "mdg", "mys", "mwi", "mdv", "mli", "mlt", "mar", "mhl", "mus", "mrt", "mex", "fsm", "mda", "mco", "mng", "mne", "moz", "mmr", "nam", "nru", "npl", "nic", "ner", "nga", "nor", "nzl", "omn", "uga", "uzb", "pak", "plw", "pan", "png", "pry", "nld", "per", "phl", "pol", "prt", "qat", "rou", "gbr", "rus", "rwa", "kna", "smr", "vct", "lca", "slb", "wsm", "stp", "sen", "srb", "syc", "sle", "sgp", "svk", "svn", "som", "sdn", "ssd", "lka", "swe", "che", "sur", "swz", "syr", "tjk", "tza", "tcd", "cze", "tha", "tls", "tgo", "ton", "tto", "tun", "tkm", "tur", "tuv", "ukr", "ury", "vut", "ven", "vnm", "yem", "zmb", "zwe" ], "nullable": true }, "status": { "type": "string", "default": "waiting" }, "identityDocument": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Document" } ] }, "mandatoryInfos": { "type": "array", "items": { "type": "string" }, "default": [] }, "uncompletedInfos": { "type": "array", "items": { "type": "string" }, "default": [] }, "email": { "type": "string", "nullable": true } }, "type": "object" }, "MoralPerson": { "properties": { "companyName": { "type": "string", "nullable": true }, "companyEmail": { "type": "string", "nullable": true }, "companyType": { "type": "string", "nullable": true }, "companyRegistrationNumber": { "type": "string", "nullable": true }, "address": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Address" } ] }, "status": { "type": "string", "default": "waiting" }, "headOfCompany": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PhysicalPerson2" } ] }, "proofOfAddressDocument": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Document" } ] }, "kbisDocument": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Document" } ] }, "financialInfoDocument": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Document" } ] }, "statusDocument": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Document" } ] }, "mandatoryInfos": { "type": "array", "items": { "type": "string" }, "default": [] }, "uncompletedInfos": { "type": "array", "items": { "type": "string" }, "default": [] } }, "type": "object" }, "OrganisationUserModel": { "properties": { "email": { "type": "string", "default": null, "nullable": true }, "status": { "type": "string", "default": null, "nullable": true }, "rank": { "type": "string", "default": null, "nullable": true } }, "type": "object" }, "ReceiverBankAccount": { "required": [ "number", "holderName" ], "properties": { "number": { "type": "string" }, "bic": { "type": "string", "nullable": true }, "holderName": { "type": "string" }, "ibanDocument": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Document" } ] }, "amBankAccountId": { "type": "string", "nullable": true } }, "type": "object" }, "OrganisationConnector": { "required": [ "type" ], "properties": { "type": { "type": "string" }, "settingSendEmailByTyllt": { "type": "boolean", "default": false } }, "type": "object" }, "Organisation2": { "required": [ "accountType", "organisationConnectors", "id", "createdAt", "updatedAt", "name", "walletFunctionalities", "invoiceFunctionalities" ], "properties": { "organisationName": { "type": "string", "nullable": true }, "accountType": { "type": "string" }, "legalType": { "type": "string", "nullable": true }, "kycLevel": { "type": "string", "default": "LEVEL_0", "nullable": true }, "amAccountId": { "type": "string", "nullable": true }, "amWalletId": { "type": "string", "nullable": true }, "amSequestrationWalletId": { "type": "string", "nullable": true }, "amAccountStatus": { "type": "string", "nullable": true }, "amAccountErrorCode": { "type": "integer", "nullable": true }, "amValidationAskAt": { "type": "string", "format": "date-time", "nullable": true }, "amValidationUpdateAt": { "type": "string", "format": "date-time", "nullable": true }, "amValidationStatus": { "type": "string", "nullable": true }, "amValidationError": { "type": "string", "nullable": true }, "amValidationErrorDescription": { "type": "string", "nullable": true }, "moralPerson": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MoralPerson" } ] }, "physicalPerson": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PhysicalPerson2" } ] }, "creatorPhysicalPerson": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PhysicalPerson2" } ] }, "accountForWho": { "type": "string", "nullable": true }, "currentRelation": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OrganisationUserModel" } ] }, "activity": { "type": "string", "nullable": true }, "displayEmail": { "description": "Public email.", "type": "string", "nullable": true }, "displayPhone": { "description": "Public phone.", "type": "string", "nullable": true }, "displayWebsite": { "description": "Public website.", "type": "string", "nullable": true }, "displayLogo": { "description": "Public logo.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Media" } ] }, "receiverBankAccount": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ReceiverBankAccount" } ] }, "activatedFunctionality": { "type": "string", "nullable": true }, "settingClosingTime": { "type": "integer", "default": 10 }, "settingMaxDepositAmount": { "type": "integer", "default": 2500 }, "settingRequestEmailSendTiming": { "type": "string", "default": "instant", "nullable": true }, "settingForceIdentityDocument": { "type": "boolean", "default": false }, "settingMultipleCashOut": { "type": "boolean", "default": false }, "settingInsurance": { "type": "boolean", "default": true }, "mandatoryInfos": { "type": "array", "items": { "type": "string" }, "default": [] }, "uncompletedInfos": { "type": "array", "items": { "type": "string" }, "default": [] }, "accountMainAlert": { "type": "string", "nullable": true }, "accountAlerts": { "type": "array", "items": { "type": "string" }, "default": [] }, "organisationConnectors": { "type": "array", "items": { "$ref": "#/components/schemas/OrganisationConnector" } }, "objectName": { "description": "Name of the object", "type": "string", "default": "organisation", "example": "organisation" }, "id": { "description": "Unique identifier of the organisation", "type": "string", "format": "uuid", "example": "550e8400-e29b-41d4-a716-446655440000" }, "createdAt": { "description": "Creation date of the organisation", "type": "string", "format": "date-time", "example": "2023-01-01T12:00:00+00:00" }, "updatedAt": { "description": "Last update date of the organisation", "type": "string", "format": "date-time", "example": "2023-01-01T15:30:00+00:00" }, "name": { "description": "Name of the organisation", "type": "string", "example": "Example Organisation" }, "parent": { "type": "string", "nullable": true }, "parentData": { "nullable": true, "oneOf": [ { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Organisation2" } ] }, { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Organisation3" } ] } ] }, "displayName": { "description": "Public name.", "type": "string", "nullable": true }, "displayIdentifier": { "type": "string", "nullable": true }, "displayCreatedAt": { "description": "Public created at date.", "type": "string", "format": "date-time", "nullable": true }, "displayAddress": { "description": "Public address.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Address" } ] }, "effectiveFunctionality": { "type": "string", "nullable": true }, "walletFunctionalities": { "type": "boolean" }, "invoiceFunctionalities": { "type": "boolean" }, "littleBondSubscription": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Subscription" } ] }, "email": { "type": "string", "nullable": true } }, "type": "object" }, "Organisation3": { "required": [ "id", "createdAt", "updatedAt", "name", "email" ], "properties": { "objectName": { "description": "Name of the object", "type": "string", "default": "organisation", "example": "organisation" }, "id": { "description": "Unique identifier of the organisation", "type": "string", "format": "uuid", "example": "550e8400-e29b-41d4-a716-446655440000" }, "createdAt": { "description": "Creation date of the organisation", "type": "string", "format": "date-time", "example": "2023-01-01T12:00:00+00:00" }, "updatedAt": { "description": "Last update date of the organisation", "type": "string", "format": "date-time", "example": "2023-01-01T15:30:00+00:00" }, "name": { "description": "Name of the organisation", "type": "string", "example": "Example Organisation" }, "email": { "description": "Contact email address of the organisation", "type": "string", "format": "email", "example": "contact@example-organisation.com" }, "displayIdentifier": { "type": "string", "nullable": true } }, "type": "object" }, "Subscription": { "required": [ "type", "startDate" ], "properties": { "type": { "type": "string" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time", "nullable": true }, "renewalDate": { "type": "string", "format": "date-time", "nullable": true }, "status": { "type": "string", "default": "active" } }, "type": "object" }, "OrganisationUser": { "required": [ "organisation", "rank", "createdAt", "updatedAt", "locks" ], "properties": { "notificationEmail": { "type": "boolean", "default": true, "nullable": true }, "notificationPush": { "type": "boolean", "default": true, "nullable": true }, "objectName": { "description": "Name of the object", "type": "string", "default": "organisation_user", "example": "organisation_user" }, "id": { "description": "Unique identifier of the organisation user", "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000", "nullable": true }, "organisation": { "$ref": "#/components/schemas/Organisation2" }, "rank": { "description": "Rank or role type of the user in the organisation. The ranks depend on the configuration.", "type": "string", "enum": [ "default", "..." ], "example": "default" }, "createdAt": { "description": "Creation date of the relationship between user and organisation", "type": "string", "format": "date-time", "example": "2023-05-15T14:30:00+00:00" }, "updatedAt": { "description": "Last update date of the relationship", "type": "string", "format": "date-time", "example": "2023-08-22T09:45:00+00:00" }, "requestAccessAt": { "description": "Date of the access request to the organisation", "type": "string", "format": "date-time", "example": "2023-07-10T11:20:00+00:00", "nullable": true }, "locks": { "type": "array", "items": { "type": "string" } }, "status": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "inherited": { "type": "boolean", "nullable": true } }, "type": "object" }, "User": { "required": [ "id", "email", "phone" ], "properties": { "emailValidated": { "type": "boolean", "default": false, "nullable": true }, "phoneValidated": { "type": "boolean", "default": false, "nullable": true }, "language": { "type": "string", "default": "fr", "nullable": true }, "lastSelectedOrganisation": { "type": "string", "nullable": true }, "cguAccepted": { "type": "boolean", "default": false }, "cguAcceptedAt": { "type": "string", "format": "date-time", "nullable": true }, "dataProtectionAccepted": { "type": "boolean", "default": false }, "viewableOrganisations": { "type": "array", "items": { "$ref": "#/components/schemas/OrganisationUser" }, "nullable": true }, "dataProtectionAcceptedAt": { "type": "string", "format": "date-time", "nullable": true }, "disabled": { "type": "boolean", "default": false }, "lastLoginAt": { "type": "string", "format": "date-time", "nullable": true }, "notificationPush": { "type": "boolean", "default": true, "nullable": true }, "notificationEmail": { "type": "boolean", "default": true, "nullable": true }, "physicalPerson": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PhysicalPerson2" } ] }, "objectName": { "description": "Name of the object", "type": "string", "default": "user", "example": "organisation" }, "id": { "description": "Unique identifier of the user", "type": "string", "example": "550e8400-e29b-41d4-a716-446655440000" }, "email": { "description": "Email address of the user", "type": "string", "example": "user@example.com" }, "roles": { "description": "Roles assigned or inherited to the user", "type": "array", "items": { "type": "string" }, "default": [], "example": "[\"ROLE_USER\"]" }, "resetPasswordAt": { "description": "Date of the last password reset", "type": "string", "format": "date-time", "example": "2023-01-01T12:00:00+00:00", "nullable": true }, "needResetPassword": { "description": "Indicates if the user needs to reset their password", "type": "boolean", "default": false, "example": false, "nullable": true }, "validated": { "description": "Indicates if the user account is validated", "type": "boolean", "default": false, "example": false, "nullable": true }, "loginDate": { "description": "Date of the last login", "type": "string", "format": "date-time", "example": "2023-01-01T12:00:00+00:00", "nullable": true }, "createdAt": { "description": "Date when the account was created", "type": "string", "format": "date-time", "example": "2023-01-01T12:00:00+00:00", "nullable": true }, "updatedAt": { "description": "Date of the last account update", "type": "string", "format": "date-time", "example": "2023-01-01T12:00:00+00:00", "nullable": true }, "deletedAt": { "description": "Date when the account was deleted", "type": "string", "format": "date-time", "example": "2023-01-01T12:00:00+00:00", "nullable": true }, "crmContactListings": { "description": "Listing of cmr contact list ids", "type": "array", "items": { "type": "string" }, "default": [], "example": [ "1", "list_1" ], "nullable": true }, "phone": { "description": "Phone number of the user. It has to respect a phone number regex ^[+]{1}[0-9]*$", "type": "string", "example": "+33476210239" }, "completed": { "type": "boolean", "nullable": true }, "canCreateOwnerMeParticular": { "type": "boolean", "nullable": true }, "canCreateTenantMeParticular": { "type": "boolean", "nullable": true } }, "type": "object" }, "ApiHealthResponseModel": { "title": "ApiHealthResponse", "description": "Information about the server and API health status", "required": [ "timestamp", "api", "status", "php", "symfony" ], "properties": { "timestamp": { "description": "Timestamp when the health check was performed", "type": "integer", "format": "int", "example": 1762965322 }, "api": { "description": "API availability status", "type": "string", "enum": [ "available", "unavailable" ], "example": "available" }, "status": { "description": "Overall server status", "type": "string", "enum": [ "running", "alert" ], "example": "running" }, "php": { "description": "PHP version running on the server", "type": "string", "example": "8.2.12" }, "symfony": { "description": "Symfony version used by the application", "type": "string", "example": "6.4.12" }, "ram": { "description": "Server RAM usage percentage", "type": "number", "format": "float", "example": 45.2, "nullable": true }, "cpu": { "description": "Current CPU load percentage (load average)", "type": "number", "format": "float", "example": 2.34, "nullable": true }, "disk": { "description": "Disk space usage percentage", "type": "float", "example": 65.3, "nullable": true } }, "type": "object" }, "InseeOrganisationModel": { "title": "INSEE Organisation", "description": "Model representing organisation information from the INSEE database", "required": [ "name", "officialIdentifier", "officialIdentifierType" ], "properties": { "name": { "description": "Name of the organisation", "type": "string", "example": "example company" }, "address": { "description": "Address of the organisation", "type": "string", "example": "123 example street", "nullable": true }, "zipcode": { "description": "Postal code of the organisation", "type": "string", "example": "75001", "nullable": true }, "town": { "description": "City of the organisation", "type": "string", "example": "paris", "nullable": true }, "officialIdentifier": { "description": "Official identifier of the organisation (SIREN, SIRET, etc.)", "type": "string", "example": "123456789" }, "officialIdentifierType": { "description": "Type of official identifier (SIREN, SIRET, etc.)", "type": "string", "example": "SIREN" } }, "type": "object" }, "Log": { "description": "Entity representing system logs with request details and status", "required": [ "id", "code", "method", "route", "timestamp" ], "properties": { "objectName": { "description": "Name of the object", "type": "string", "default": "log", "example": "log" }, "id": { "description": "Unique identifier (UUID) for the log entry", "type": "string", "format": "uuid", "example": "7c0b30d1-e7d4-4a13-8ef1-c7c224d50453" }, "code": { "description": "HTTP response status code", "type": "integer", "example": 200 }, "method": { "description": "HTTP request method", "type": "string", "example": "GET" }, "route": { "description": "Request route path", "type": "string", "example": "/api/users" }, "ip": { "description": "IP address of the client", "type": "string", "format": "ipv4", "example": "192.168.1.1", "nullable": true }, "timestamp": { "description": "Unix timestamp when the log was created", "type": "integer", "example": 1625147809 }, "userIdentifier": { "description": "Identifier of the user who made the request", "type": "uuid", "example": "7c0b30d1-e7d4-4a13-8ef1-c7c224d50453", "nullable": true }, "accountIdentifier": { "description": "Identifier of the user who made the request", "type": "uuid", "example": "eiWUVAUMuLdW1VpWtMER", "nullable": true }, "error": { "description": "Detailed error message if an error occurred", "type": "string", "example": "Invalid authentication credentials", "nullable": true }, "status": { "description": "Status of the request", "type": "string", "enum": [ "ok", "error" ], "example": "ok", "nullable": true } }, "type": "object" }, "Mail": { "title": "Mail", "description": "Email entity that stores information about emails sent by the application", "required": [ "id", "receiver", "template", "status", "transport" ], "properties": { "objectName": { "description": "Name of the object", "type": "string", "default": "mail", "example": "mail" }, "id": { "description": "Unique identifier of the email", "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "receiver": { "description": "Email recipient address", "type": "string", "example": "recipient@example.com" }, "externalId": { "description": "External system identifier", "type": "string", "example": "EXT-789", "nullable": true }, "template": { "description": "Email template identifier", "type": "string", "example": "@ApbMailer/message.mjml.twig" }, "wasSentOn": { "description": "Sending date of the mail", "type": "string", "format": "date-time", "example": "2023-01-01T12:05:00+00:00", "nullable": true }, "internalErrors": { "description": "Internal system errors encountered during email processing", "type": "array", "items": { "type": "string" }, "nullable": true }, "status": { "description": "List of status updates for the email", "type": "array", "items": { "type": "string" }, "example": [ "sent", "error", "created", "transport_failure", "failed" ] }, "externalErrors": { "description": "Errors reported by external mail services", "type": "array", "items": { "type": "string" }, "nullable": true }, "transport": { "description": "Last transport used to send the mail", "type": "string", "example": "mailhog" } }, "type": "object" }, "WebhookMessage": { "required": [ "service" ], "properties": { "service": { "description": "Webhook service provider", "type": "string", "example": "mailhog" } }, "type": "object" }, "Device": { "description": "Represents a device owned by a owner", "required": [ "id", "token", "type", "owner", "createdAt", "updatedAt", "notification", "language" ], "properties": { "objectName": { "description": "Name of the object", "type": "string", "default": "device", "example": "device" }, "id": { "description": "Unique identifier of the device", "type": "string", "format": "uuid", "example": "f47ac10b-58cc-4372-a567-0e02b2c3d479" }, "token": { "description": "Device token for push notifications", "type": "string", "example": "dYF8H7sQ9rVzXyT3nM2pK5gB1cL4eA7j" }, "type": { "description": "Type of device (ios, android)", "type": "string", "example": "android" }, "owner": { "description": "The identifier of the owner of the device", "type": "string", "example": "f47ac10b-58cc-4372-a567-0e02b2c3d479" }, "createdAt": { "description": "Creation date of the device", "type": "string", "format": "date-time", "example": "2023-05-28T12:34:56+00:00" }, "updatedAt": { "description": "Last update date of the device", "type": "string", "format": "date-time", "example": "2023-06-15T09:45:30+00:00" }, "notification": { "description": "Allow notification on device", "type": "boolean", "example": true }, "language": { "description": "Language of the device", "type": "string", "example": "fr" } }, "type": "object" }, "DeviceEditType": { "required": [ "token", "type", "owner", "notification" ], "properties": { "token": { "type": "string" }, "type": { "type": "string" }, "owner": { "type": "string" }, "notification": { "type": "boolean" } }, "type": "object" }, "NotificationAdmin": { "description": "Represents an notification created by administrator to be send to user", "required": [ "id", "title", "description", "defaultTitle", "sendOn", "toSendOn", "link", "linkLabel", "status", "recurrence", "notificationType", "relatedRef" ], "properties": { "objectName": { "description": "Name of the object", "type": "string", "default": "notification_admin", "example": "notification_admin" }, "id": { "description": "Unique identifier of the notification", "type": "string", "format": "uuid", "example": "f47ac10b-58cc-4372-a567-0e02b2c3d479" }, "titles": { "description": "Titles of the notification in different languages", "type": "array", "items": { "type": "string" }, "default": [], "example": { "en": "The english title of the notification", "fr": "The french title of the notification" } }, "title": { "description": "Title of the notification in the current language", "type": "string", "example": "New feature available" }, "description": { "description": "Description of the notification in the current language", "type": "string", "example": "A new feature is now available in your application" }, "defaultTitle": { "description": "Default title of the notification used for listing", "type": "string", "example": "Important notification" }, "descriptions": { "description": "Descriptions of the notification in different languages", "type": "array", "items": { "type": "string" }, "default": [], "example": { "en": "The english description of the notification", "fr": "The french description of the notification" } }, "languages": { "description": "Available languages for this notification", "type": "array", "items": { "type": "string" }, "default": [], "example": "[\"en\", \"fr\", \"es\"]" }, "sendOn": { "description": "Date when the notification was sent", "type": "string", "format": "date-time", "example": "2023-05-28T12:34:56+00:00" }, "toSendOn": { "description": "Date when the notification should be sent", "type": "string", "format": "date-time", "example": "2023-06-15T09:00:00+00:00" }, "link": { "description": "Link associated with the notification", "type": "string", "example": "https://example.com/feature" }, "linkLabel": { "description": "Label for the link associated with the notification", "type": "string", "example": "Learn more" }, "status": { "description": "Status of the notification (draft, scheduled, sent, etc.)", "type": "string", "enum": [ "status_draft", "status_published", "status_sent", "status_sent_with_recurrence" ], "example": "status_draft" }, "recurrence": { "description": "Recurrence pattern for sending the notification (daily, weekly, monthly, etc.)", "type": "string", "enum": [ "day", "week", "month" ], "example": "day" }, "receivingConditions": { "description": "Simple condition for receiving the notification. The condition must be specified in the bundle configuration allowed_receiving_conditions", "type": "array", "items": { "type": "string" }, "default": [], "example": { "socialType": { "expression": "LIKE", "value": "facebook" }, "createdAt": { "expression": ">=", "value": "2O25-01-01" } }, "nullable": true }, "notificationType": { "description": "The type of the notification generated", "type": "string" }, "relatedRef": { "description": "The reference of the related object linked to the notification. Will be in the notification ref", "type": "string" } }, "type": "object" }, "NotificationAdminConditionCreateType": { "required": [ "expression", "value" ], "properties": { "expression": { "type": "string" }, "value": { "type": "string" } }, "type": "object" }, "NotificationAdminEditType": { "required": [ "titles", "descriptions", "languages", "toSendOn", "link", "linkLabel", "recurrence", "receivingConditions", "notificationType", "relatedRef" ], "properties": { "titles": { "type": "array", "items": { "type": "string" } }, "descriptions": { "type": "array", "items": { "type": "string" } }, "languages": { "type": "array", "items": { "type": "string" } }, "toSendOn": { "type": "string" }, "link": { "type": "string" }, "linkLabel": { "type": "string" }, "recurrence": { "type": "string", "enum": [ "day", "week", "month" ] }, "receivingConditions": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationAdminConditionCreateType" } }, "notificationType": { "type": "string" }, "relatedRef": { "type": "string" } }, "type": "object" }, "NotificationAdmin2": { "description": "Represents an notification created by administrator to be send to user", "required": [ "id", "title", "defaultTitle", "sendOn", "toSendOn", "link", "linkLabel", "status", "recurrence", "createdAt", "updateAt", "notificationType", "relatedRef" ], "properties": { "objectName": { "description": "Name of the object", "type": "string", "default": "notification_admin", "example": "notification_admin" }, "id": { "description": "Unique identifier of the notification", "type": "string", "format": "uuid", "example": "f47ac10b-58cc-4372-a567-0e02b2c3d479" }, "title": { "description": "Title of the notification in the current language", "type": "string", "example": "New feature available" }, "defaultTitle": { "description": "Default title of the notification used for listing", "type": "string", "example": "Important notification" }, "sendOn": { "description": "Date when the notification was sent", "type": "string", "format": "date-time", "example": "2023-05-28T12:34:56+00:00" }, "toSendOn": { "description": "Date when the notification should be sent", "type": "string", "format": "date-time", "example": "2023-06-15T09:00:00+00:00" }, "link": { "description": "Link associated with the notification", "type": "string", "example": "https://example.com/feature" }, "linkLabel": { "description": "Label for the link associated with the notification", "type": "string", "example": "Learn more" }, "status": { "description": "Status of the notification (draft, scheduled, sent, etc.)", "type": "string", "enum": [ "status_draft", "status_published", "status_sent", "status_sent_with_recurrence" ], "example": "status_draft" }, "recurrence": { "description": "Recurrence pattern for sending the notification (daily, weekly, monthly, etc.)", "type": "string", "enum": [ "day", "week", "month" ], "example": "day" }, "receivingConditions": { "description": "Simple condition for receiving the notification. The condition must be specified in the bundle configuration allowed_receiving_conditions", "type": "array", "items": { "type": "string" }, "default": [], "example": { "socialType": { "expression": "LIKE", "value": "facebook" }, "createdAt": { "expression": ">=", "value": "2O25-01-01" } }, "nullable": true }, "createdAt": { "description": "Creation date of the notification", "type": "string", "format": "date-time", "example": "2023-05-28T12:34:56+00:00" }, "updateAt": { "description": "Update date of the notification", "type": "string", "format": "date-time", "example": "2023-05-28T12:34:56+00:00" }, "notificationType": { "description": "The type of the notification generated", "type": "string" }, "relatedRef": { "description": "The reference of the related object linked to the notification. Will be in the notification ref", "type": "string" } }, "type": "object" }, "Notification": { "type": "object" }, "Notification2": { "required": [ "id", "type", "title", "description", "createdAt", "updateAt", "owner" ], "properties": { "objectName": { "description": "Name of the notification", "type": "string", "default": "notification", "example": "notification" }, "id": { "description": "Unique identifier of the notification", "type": "string", "format": "uuid", "example": "f47ac10b-58cc-4372-a567-0e02b2c3d479" }, "type": { "description": "Type of the notification (e.g., info, warning, alert)", "type": "string", "example": "info" }, "title": { "description": "Title of the notification", "type": "string", "example": "New message received" }, "description": { "description": "Description of the notification", "type": "string", "example": "You have received a new message from John Doe" }, "wasRead": { "description": "Indicates whether the notification has been read", "type": "boolean", "default": false, "example": false }, "wasShown": { "description": "Indicates whether the notification has been shown", "type": "boolean", "default": false, "example": false }, "wasSent": { "description": "Indicates whether the notification has been send", "type": "boolean", "default": false, "example": false }, "createdAt": { "description": "Creation date of the notification", "type": "string", "format": "date-time", "example": "2023-05-28T12:34:56+00:00" }, "updateAt": { "description": "Update date of the notification", "type": "string", "format": "date-time", "example": "2023-05-28T12:34:56+00:00" }, "wasSentAt": { "description": "Sending date of the notification", "type": "string", "format": "date-time", "example": "2023-05-28T12:34:56+00:00", "nullable": true }, "ref": { "description": "Reference of the object creating the notification", "type": "string", "example": "notification_123", "nullable": true }, "owner": { "description": "Owner identifier of the notification", "type": "string", "example": "1f0784de-34e5-6e1c-988e-f161b3e66390" }, "link": { "description": "Internal link related to the notification", "type": "string", "example": "/dashboard/messages/123", "nullable": true }, "externalLink": { "description": "External link related to the notification", "type": "string", "example": "https://example.com/resource/123", "nullable": true }, "service": { "description": "Service used to push the notification", "type": "string", "example": "firebase", "nullable": true } }, "type": "object" }, "OrganisationChildCreateType": { "required": [ "redirect", "name", "email" ], "properties": { "redirect": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" } }, "type": "object" }, "Organisation4": { "required": [ "id", "name" ], "properties": { "objectName": { "description": "Name of the object", "type": "string", "default": "organisation", "example": "organisation" }, "id": { "description": "Unique identifier of the organisation", "type": "string", "format": "uuid", "example": "550e8400-e29b-41d4-a716-446655440000" }, "name": { "description": "Name of the organisation", "type": "string", "example": "Example Organisation" }, "displayIdentifier": { "type": "string", "nullable": true } }, "type": "object" }, "OrganisationChildEditType": { "required": [ "redirect", "name", "email" ], "properties": { "redirect": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" } }, "type": "object" }, "ClientCreateType": { "required": [ "name", "active" ], "properties": { "name": { "type": "string" }, "active": { "type": "boolean" } }, "type": "object" }, "Media2": { "type": "object" }, "Subscription2": { "type": "object" }, "Organisation5": { "required": [ "id", "createdAt", "updatedAt", "name", "walletFunctionalities", "invoiceFunctionalities" ], "properties": { "currentRelation": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OrganisationUserModel" } ] }, "activity": { "type": "string", "nullable": true }, "displayEmail": { "description": "Public email.", "type": "string", "nullable": true }, "displayPhone": { "description": "Public phone.", "type": "string", "nullable": true }, "displayWebsite": { "description": "Public website.", "type": "string", "nullable": true }, "displayLogo": { "description": "Public logo.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Media2" } ] }, "activatedFunctionality": { "type": "string", "nullable": true }, "mandatoryInfos": { "type": "array", "items": { "type": "string" }, "default": [] }, "uncompletedInfos": { "type": "array", "items": { "type": "string" }, "default": [] }, "accountMainAlert": { "type": "string", "nullable": true }, "accountAlerts": { "type": "array", "items": { "type": "string" }, "default": [] }, "objectName": { "description": "Name of the object", "type": "string", "default": "organisation", "example": "organisation" }, "id": { "description": "Unique identifier of the organisation", "type": "string", "format": "uuid", "example": "550e8400-e29b-41d4-a716-446655440000" }, "createdAt": { "description": "Creation date of the organisation", "type": "string", "format": "date-time", "example": "2023-01-01T12:00:00+00:00" }, "updatedAt": { "description": "Last update date of the organisation", "type": "string", "format": "date-time", "example": "2023-01-01T15:30:00+00:00" }, "name": { "description": "Name of the organisation", "type": "string", "example": "Example Organisation" }, "displayName": { "description": "Public name.", "type": "string", "nullable": true }, "displayIdentifier": { "type": "string", "nullable": true }, "effectiveFunctionality": { "type": "string", "nullable": true }, "walletFunctionalities": { "type": "boolean" }, "invoiceFunctionalities": { "type": "boolean" }, "littleBondSubscription": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Subscription2" } ] }, "email": { "type": "string", "nullable": true } }, "type": "object" }, "User2": { "required": [ "id", "email", "phone" ], "properties": { "objectName": { "description": "Name of the object", "type": "string", "default": "user", "example": "organisation" }, "id": { "description": "Unique identifier of the user", "type": "string", "example": "550e8400-e29b-41d4-a716-446655440000" }, "email": { "description": "Email address of the user", "type": "string", "example": "user@example.com" }, "roles": { "description": "Roles assigned or inherited to the user", "type": "array", "items": { "type": "string" }, "default": [], "example": "[\"ROLE_USER\"]" }, "loginDate": { "description": "Date of the last login", "type": "string", "format": "date-time", "example": "2023-01-01T12:00:00+00:00", "nullable": true }, "createdAt": { "description": "Date when the account was created", "type": "string", "format": "date-time", "example": "2023-01-01T12:00:00+00:00", "nullable": true }, "updatedAt": { "description": "Date of the last account update", "type": "string", "format": "date-time", "example": "2023-01-01T12:00:00+00:00", "nullable": true }, "deletedAt": { "description": "Date when the account was deleted", "type": "string", "format": "date-time", "example": "2023-01-01T12:00:00+00:00", "nullable": true }, "crmContactListings": { "description": "Listing of cmr contact list ids", "type": "array", "items": { "type": "string" }, "default": [], "example": [ "1", "list_1" ], "nullable": true }, "phone": { "description": "Phone number of the user. It has to respect a phone number regex ^[+]{1}[0-9]*$", "type": "string", "example": "+33476210239" } }, "type": "object" }, "OrganisationUser2": { "required": [ "organisation", "rank", "createdAt", "updatedAt", "status" ], "properties": { "objectName": { "description": "Name of the object", "type": "string", "default": "organisation_user", "example": "organisation_user" }, "id": { "description": "Unique identifier of the organisation user", "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000", "nullable": true }, "organisation": { "$ref": "#/components/schemas/Organisation5" }, "user": { "description": "User linked to this organisation relationship", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/User2" } ] }, "rank": { "description": "Rank or role type of the user in the organisation. The ranks depend on the configuration.", "type": "string", "enum": [ "default", "..." ], "example": "default" }, "createdAt": { "description": "Creation date of the relationship between user and organisation", "type": "string", "format": "date-time", "example": "2023-05-15T14:30:00+00:00" }, "updatedAt": { "description": "Last update date of the relationship", "type": "string", "format": "date-time", "example": "2023-08-22T09:45:00+00:00" }, "requestAccessAt": { "description": "Date of the access request to the organisation", "type": "string", "format": "date-time", "example": "2023-07-10T11:20:00+00:00", "nullable": true }, "locks": { "description": "List of access locks applied to the user", "type": "array", "items": { "type": "string" }, "default": [], "example": [ "update", "delete" ] }, "status": { "description": "The status of the relation", "type": "string", "enum": [ "send", "accepted", "requested", "rejected", "expired" ], "example": "send" }, "email": { "description": "Email address of the invited user", "type": "string", "format": "email", "example": "john.doe@example.com", "nullable": true }, "inherited": { "description": "Indicates if the organisation is inherited from the current organisation", "type": "boolean", "default": false, "example": false, "nullable": true } }, "type": "object" }, "OrganisationUserCreateType": { "required": [ "redirect", "rank", "email" ], "properties": { "redirect": { "type": "string" }, "rank": { "type": "string", "enum": [ "admin", "user" ] }, "email": { "type": "string" } }, "type": "object" }, "User3": { "required": [ "id", "email", "phone" ], "properties": { "objectName": { "description": "Name of the object", "type": "string", "default": "user", "example": "organisation" }, "id": { "description": "Unique identifier of the user", "type": "string", "example": "550e8400-e29b-41d4-a716-446655440000" }, "email": { "description": "Email address of the user", "type": "string", "example": "user@example.com" }, "roles": { "description": "Roles assigned or inherited to the user", "type": "array", "items": { "type": "string" }, "default": [], "example": "[\"ROLE_USER\"]" }, "loginDate": { "description": "Date of the last login", "type": "string", "format": "date-time", "example": "2023-01-01T12:00:00+00:00", "nullable": true }, "createdAt": { "description": "Date when the account was created", "type": "string", "format": "date-time", "example": "2023-01-01T12:00:00+00:00", "nullable": true }, "updatedAt": { "description": "Date of the last account update", "type": "string", "format": "date-time", "example": "2023-01-01T12:00:00+00:00", "nullable": true }, "deletedAt": { "description": "Date when the account was deleted", "type": "string", "format": "date-time", "example": "2023-01-01T12:00:00+00:00", "nullable": true }, "crmContactListings": { "description": "Listing of cmr contact list ids", "type": "array", "items": { "type": "string" }, "default": [], "example": [ "1", "list_1" ], "nullable": true }, "phone": { "description": "Phone number of the user. It has to respect a phone number regex ^[+]{1}[0-9]*$", "type": "string", "example": "+33476210239" } }, "type": "object" }, "OrganisationUser3": { "properties": { "objectName": { "description": "Name of the object", "type": "string", "default": "organisation_user", "example": "organisation_user" }, "id": { "description": "Unique identifier of the organisation user", "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000", "nullable": true } }, "type": "object" }, "OrganisationUserEditType": { "required": [ "redirect", "rank", "email", "status" ], "properties": { "redirect": { "type": "string" }, "rank": { "type": "string", "enum": [ "admin", "user" ] }, "email": { "type": "string" }, "status": { "type": "string", "enum": [ "accepted", "requested", "rejected" ] } }, "type": "object" }, "ReceiverBankAccount2": { "required": [ "number", "holderName" ], "properties": { "number": { "type": "string" }, "bic": { "type": "string", "nullable": true }, "holderName": { "type": "string" } }, "type": "object" }, "Organisation6": { "required": [ "accountType", "id", "createdAt", "updatedAt", "name", "walletFunctionalities", "invoiceFunctionalities" ], "properties": { "accountType": { "type": "string" }, "currentRelation": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OrganisationUserModel" } ] }, "activity": { "type": "string", "nullable": true }, "displayEmail": { "description": "Public email.", "type": "string", "nullable": true }, "displayPhone": { "description": "Public phone.", "type": "string", "nullable": true }, "displayWebsite": { "description": "Public website.", "type": "string", "nullable": true }, "displayLogo": { "description": "Public logo.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Media2" } ] }, "receiverBankAccount": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ReceiverBankAccount2" } ] }, "activatedFunctionality": { "type": "string", "nullable": true }, "mandatoryInfos": { "type": "array", "items": { "type": "string" }, "default": [] }, "uncompletedInfos": { "type": "array", "items": { "type": "string" }, "default": [] }, "accountMainAlert": { "type": "string", "nullable": true }, "accountAlerts": { "type": "array", "items": { "type": "string" }, "default": [] }, "objectName": { "description": "Name of the object", "type": "string", "default": "organisation", "example": "organisation" }, "id": { "description": "Unique identifier of the organisation", "type": "string", "format": "uuid", "example": "550e8400-e29b-41d4-a716-446655440000" }, "createdAt": { "description": "Creation date of the organisation", "type": "string", "format": "date-time", "example": "2023-01-01T12:00:00+00:00" }, "updatedAt": { "description": "Last update date of the organisation", "type": "string", "format": "date-time", "example": "2023-01-01T15:30:00+00:00" }, "name": { "description": "Name of the organisation", "type": "string", "example": "Example Organisation" }, "parent": { "type": "string", "nullable": true }, "parentData": { "nullable": true, "oneOf": [ { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Organisation6" } ] }, { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Organisation3" } ] } ] }, "displayName": { "description": "Public name.", "type": "string", "nullable": true }, "displayIdentifier": { "type": "string", "nullable": true }, "displayCreatedAt": { "description": "Public created at date.", "type": "string", "format": "date-time", "nullable": true }, "displayAddress": { "description": "Public address.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Address2" } ] }, "effectiveFunctionality": { "type": "string", "nullable": true }, "walletFunctionalities": { "type": "boolean" }, "invoiceFunctionalities": { "type": "boolean" }, "littleBondSubscription": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Subscription2" } ] }, "email": { "type": "string", "nullable": true } }, "type": "object" }, "Address2": { "type": "object" }, "OrganisationUser4": { "required": [ "organisation", "rank", "createdAt", "updatedAt", "status" ], "properties": { "objectName": { "description": "Name of the object", "type": "string", "default": "organisation_user", "example": "organisation_user" }, "id": { "description": "Unique identifier of the organisation user", "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000", "nullable": true }, "organisation": { "$ref": "#/components/schemas/Organisation6" }, "user": { "description": "User linked to this organisation relationship", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/User2" } ] }, "rank": { "description": "Rank or role type of the user in the organisation. The ranks depend on the configuration.", "type": "string", "enum": [ "default", "..." ], "example": "default" }, "createdAt": { "description": "Creation date of the relationship between user and organisation", "type": "string", "format": "date-time", "example": "2023-05-15T14:30:00+00:00" }, "updatedAt": { "description": "Last update date of the relationship", "type": "string", "format": "date-time", "example": "2023-08-22T09:45:00+00:00" }, "requestAccessAt": { "description": "Date of the access request to the organisation", "type": "string", "format": "date-time", "example": "2023-07-10T11:20:00+00:00", "nullable": true }, "locks": { "description": "List of access locks applied to the user", "type": "array", "items": { "type": "string" }, "default": [], "example": [ "update", "delete" ] }, "status": { "description": "The status of the relation", "type": "string", "enum": [ "send", "accepted", "requested", "rejected", "expired" ], "example": "send" }, "email": { "description": "Email address of the invited user", "type": "string", "format": "email", "example": "john.doe@example.com", "nullable": true }, "inherited": { "description": "Indicates if the organisation is inherited from the current organisation", "type": "boolean", "default": false, "example": false, "nullable": true } }, "type": "object" }, "Organisation7": { "required": [ "accountType", "id", "createdAt", "updatedAt", "name", "walletFunctionalities", "invoiceFunctionalities" ], "properties": { "accountType": { "type": "string" }, "currentRelation": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OrganisationUserModel" } ] }, "activity": { "type": "string", "nullable": true }, "displayEmail": { "description": "Public email.", "type": "string", "nullable": true }, "displayPhone": { "description": "Public phone.", "type": "string", "nullable": true }, "displayWebsite": { "description": "Public website.", "type": "string", "nullable": true }, "displayLogo": { "description": "Public logo.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Media2" } ] }, "receiverBankAccount": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ReceiverBankAccount2" } ] }, "activatedFunctionality": { "type": "string", "nullable": true }, "mandatoryInfos": { "type": "array", "items": { "type": "string" }, "default": [] }, "uncompletedInfos": { "type": "array", "items": { "type": "string" }, "default": [] }, "accountMainAlert": { "type": "string", "nullable": true }, "accountAlerts": { "type": "array", "items": { "type": "string" }, "default": [] }, "objectName": { "description": "Name of the object", "type": "string", "default": "organisation", "example": "organisation" }, "id": { "description": "Unique identifier of the organisation", "type": "string", "format": "uuid", "example": "550e8400-e29b-41d4-a716-446655440000" }, "createdAt": { "description": "Creation date of the organisation", "type": "string", "format": "date-time", "example": "2023-01-01T12:00:00+00:00" }, "updatedAt": { "description": "Last update date of the organisation", "type": "string", "format": "date-time", "example": "2023-01-01T15:30:00+00:00" }, "name": { "description": "Name of the organisation", "type": "string", "example": "Example Organisation" }, "parent": { "type": "string", "nullable": true }, "parentData": { "nullable": true, "oneOf": [ { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Organisation7" } ] }, { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Organisation3" } ] } ] }, "displayName": { "description": "Public name.", "type": "string", "nullable": true }, "displayIdentifier": { "type": "string", "nullable": true }, "displayCreatedAt": { "description": "Public created at date.", "type": "string", "format": "date-time", "nullable": true }, "displayAddress": { "description": "Public address.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Address2" } ] }, "effectiveFunctionality": { "type": "string", "nullable": true }, "walletFunctionalities": { "type": "boolean" }, "invoiceFunctionalities": { "type": "boolean" }, "littleBondSubscription": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Subscription2" } ] }, "email": { "type": "string", "nullable": true } }, "type": "object" }, "OrganisationUser5": { "required": [ "organisation", "rank", "createdAt", "updatedAt", "status" ], "properties": { "objectName": { "description": "Name of the object", "type": "string", "default": "organisation_user", "example": "organisation_user" }, "id": { "description": "Unique identifier of the organisation user", "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000", "nullable": true }, "organisation": { "$ref": "#/components/schemas/Organisation7" }, "rank": { "description": "Rank or role type of the user in the organisation. The ranks depend on the configuration.", "type": "string", "enum": [ "default", "..." ], "example": "default" }, "createdAt": { "description": "Creation date of the relationship between user and organisation", "type": "string", "format": "date-time", "example": "2023-05-15T14:30:00+00:00" }, "updatedAt": { "description": "Last update date of the relationship", "type": "string", "format": "date-time", "example": "2023-08-22T09:45:00+00:00" }, "requestAccessAt": { "description": "Date of the access request to the organisation", "type": "string", "format": "date-time", "example": "2023-07-10T11:20:00+00:00", "nullable": true }, "locks": { "description": "List of access locks applied to the user", "type": "array", "items": { "type": "string" }, "default": [], "example": [ "update", "delete" ] }, "status": { "description": "The status of the relation", "type": "string", "enum": [ "send", "accepted", "requested", "rejected", "expired" ], "example": "send" }, "email": { "description": "Email address of the invited user", "type": "string", "format": "email", "example": "john.doe@example.com", "nullable": true }, "inherited": { "description": "Indicates if the organisation is inherited from the current organisation", "type": "boolean", "default": false, "example": false, "nullable": true } }, "type": "object" }, "OrganisationUserInvitationAcceptType": { "required": [ "redirect", "status", "code" ], "properties": { "redirect": { "type": "string" }, "status": { "type": "string", "enum": [ "accepted", "rejected" ] }, "code": { "type": "string" } }, "type": "object" }, "User4": { "type": "object" }, "OrganisationUser6": { "properties": { "codeExpireAt": { "description": "Expiration date of the invitation code", "type": "string", "format": "date-time", "example": "2023-09-22T23:59:59+00:00", "nullable": true } }, "type": "object" }, "Organisation8": { "required": [ "name" ], "properties": { "name": { "description": "Name of the organisation", "type": "string", "example": "Example Organisation" } }, "type": "object" }, "PublicInformationDetail": { "required": [ "invitation" ], "properties": { "invitation": { "$ref": "#/components/schemas/OrganisationUser6" }, "organisation": { "description": "Public information of the organisation", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Organisation8" } ] } }, "type": "object" }, "ResetPasswordModel": { "required": [ "email", "redirect" ], "properties": { "email": { "description": "The email address connected to the user account.", "type": "string", "example": "john.doe@email.com" }, "redirect": { "description": "The redirection url on which to send the user from the mail redirection button.", "type": "string", "example": "localhost" } }, "type": "object" }, "PasswordEditType": { "required": [ "newPassword" ], "properties": { "newPassword": { "required": [ "first", "second" ], "properties": { "first": { "type": "string", "format": "password" }, "second": { "type": "string", "format": "password" } }, "type": "object" } }, "type": "object" }, "User5": { "required": [ "id", "email", "phone" ], "properties": { "objectName": { "description": "Name of the object", "type": "string", "default": "user", "example": "organisation" }, "id": { "description": "Unique identifier of the user", "type": "string", "example": "550e8400-e29b-41d4-a716-446655440000" }, "email": { "description": "Email address of the user", "type": "string", "example": "user@example.com" }, "roles": { "description": "Roles assigned or inherited to the user", "type": "array", "items": { "type": "string" }, "default": [], "example": "[\"ROLE_USER\"]" }, "resetPasswordAt": { "description": "Date of the last password reset", "type": "string", "format": "date-time", "example": "2023-01-01T12:00:00+00:00", "nullable": true }, "needResetPassword": { "description": "Indicates if the user needs to reset their password", "type": "boolean", "default": false, "example": false, "nullable": true }, "validated": { "description": "Indicates if the user account is validated", "type": "boolean", "default": false, "example": false, "nullable": true }, "loginDate": { "description": "Date of the last login", "type": "string", "format": "date-time", "example": "2023-01-01T12:00:00+00:00", "nullable": true }, "createdAt": { "description": "Date when the account was created", "type": "string", "format": "date-time", "example": "2023-01-01T12:00:00+00:00", "nullable": true }, "updatedAt": { "description": "Date of the last account update", "type": "string", "format": "date-time", "example": "2023-01-01T12:00:00+00:00", "nullable": true }, "deletedAt": { "description": "Date when the account was deleted", "type": "string", "format": "date-time", "example": "2023-01-01T12:00:00+00:00", "nullable": true }, "crmContactListings": { "description": "Listing of cmr contact list ids", "type": "array", "items": { "type": "string" }, "default": [], "example": [ "1", "list_1" ], "nullable": true }, "phone": { "description": "Phone number of the user. It has to respect a phone number regex ^[+]{1}[0-9]*$", "type": "string", "example": "+33476210239" } }, "type": "object" }, "CredentialModel": { "required": [ "username", "password", "redirect", "grant_type", "client_id", "client_secret" ], "properties": { "username": { "description": "Username of the user", "type": "string", "example": "john.doe@email.com" }, "password": { "description": "Password of the user", "type": "string", "example": "XakrrVzYbiRJH" }, "redirect": { "description": "Use to redirect the user when unlocking his account", "type": "string", "example": "localhost" }, "grant_type": { "description": "The grand type of the client (required if oauth i set to true)", "type": "string", "example": "password refresh_token" }, "client_id": { "description": "The unique identifier for the client (required if oauth i set to true)", "type": "string", "example": "XakrrVzYbiRJHr7Dxb5utEAi7QXyanxpNy3HLFm91ZV8G3j67r" }, "client_secret": { "description": "The client secret (required if oauth i set to true)", "type": "string", "example": "4XpGwqmsvPwm8H9H5i6nq6Ku112vR6yS8Sdpko6a6VQRmxqX2u" }, "scope": { "description": "Scope configured for the client (required if oauth i set to true)", "type": "string", "default": "USER", "example": "USER" } }, "type": "object" }, "SocialCredentialModel": { "required": [ "social", "username", "grant_type", "client_id", "client_secret" ], "properties": { "social": { "description": "Social identifier used to identify the user", "type": "string", "enum": [ "facebook", "google", "apple" ], "example": "facebook" }, "username": { "description": "Username of the user", "type": "string", "example": "john.doe@email.com" }, "grant_type": { "description": "The grand type of the client (required if oauth i set to true)", "type": "string", "example": "password refresh_token" }, "client_id": { "description": "The unique identifier for the client (required if oauth i set to true)", "type": "string", "example": "XakrrVzYbiRJHr7Dxb5utEAi7QXyanxpNy3HLFm91ZV8G3j67r" }, "client_secret": { "description": "The client secret (required if oauth i set to true)", "type": "string", "example": "4XpGwqmsvPwm8H9H5i6nq6Ku112vR6yS8Sdpko6a6VQRmxqX2u" }, "scope": { "description": "Scope configured for the client (required if oauth i set to true)", "type": "string", "default": "USER", "example": "USER" } }, "type": "object" }, "RegistrationModel": { "required": [ "username", "password", "mode", "phone", "grant_type", "client_id", "client_secret" ], "properties": { "username": { "description": "Username of the user", "type": "string", "example": "user@example.com" }, "password": { "description": "Password of the user", "type": "string", "example": "XakrrVzYbiRJH" }, "redirect": { "description": "Use to redirect the user when unlocking his account", "type": "string", "example": "localhost", "nullable": true }, "mode": { "description": "Account validation mode", "type": "string", "enum": [ "sms", "mail" ], "example": "mail" }, "phone": { "description": "Phone number of the user. It has to respect a phone number regex ^[+]{1}[0-9]*$", "type": "string", "example": "+33476210239" }, "newPassword": { "description": "The new password of the user. first and second must be the same.", "type": "array", "items": { "type": "string" }, "example": { "first": "BvpigcVf", "second": "BvpigcVf" }, "nullable": true }, "grant_type": { "description": "The grand type of the client (required if oauth i set to true)", "type": "string", "example": "password refresh_token" }, "client_id": { "description": "The unique identifier for the client (required if oauth i set to true)", "type": "string", "example": "XakrrVzYbiRJHr7Dxb5utEAi7QXyanxpNy3HLFm91ZV8G3j67r" }, "client_secret": { "description": "The client secret (required if oauth i set to true)", "type": "string", "example": "4XpGwqmsvPwm8H9H5i6nq6Ku112vR6yS8Sdpko6a6VQRmxqX2u" }, "scope": { "description": "Scope configured for the client (required if oauth i set to true)", "type": "string", "default": "USER", "example": "USER" } }, "type": "object" }, "RegistrationModel2": { "required": [ "phone" ], "properties": { "redirect": { "description": "Use to redirect the user when unlocking his account", "type": "string", "example": "localhost", "nullable": true }, "phone": { "description": "Phone number of the user. It has to respect a phone number regex ^[+]{1}[0-9]*$", "type": "string", "example": "+33476210239" } }, "type": "object" }, "User6": { "required": [ "email", "phone" ], "properties": { "objectName": { "description": "Name of the object", "type": "string", "default": "user", "example": "organisation" }, "email": { "description": "Email address of the user", "type": "string", "example": "user@example.com" }, "validated": { "description": "Indicates if the user account is validated", "type": "boolean", "default": false, "example": false, "nullable": true }, "phone": { "description": "Phone number of the user. It has to respect a phone number regex ^[+]{1}[0-9]*$", "type": "string", "example": "+33476210239" }, "unlocked": { "description": "Show if the user is locked or not.", "type": "boolean", "default": true, "example": true } }, "type": "object" }, "RegistrationModel3": { "required": [ "code" ], "properties": { "code": { "description": "Account validation code received by the user by mail and/or sms.", "type": "string", "example": "13JD9E" } }, "type": "object" }, "CredentialModel2": { "type": "object" }, "Webhook": { "required": [ "id" ], "properties": { "objectName": { "description": "Name of the object", "type": "string", "default": "webhook", "example": "webhook" }, "id": { "description": "Unique identifier of the webhook", "type": "uuid", "example": "550e8400-e29b-41d4-a716-446655440000" }, "createdAt": { "description": "Creation date of the webhook", "type": "string", "format": "date-time", "example": "2023-01-15T14:30:00+00:00", "nullable": true }, "updatedAt": { "description": "Last modification date of the webhook", "type": "string", "format": "date-time", "example": "2023-01-20T09:45:00+00:00", "nullable": true }, "name": { "description": "Name of the webhook", "type": "string", "example": "Webhook", "nullable": true }, "description": { "description": "Detailed description of the webhook", "type": "string", "example": "Webhook for payment notifications", "nullable": true }, "status": { "description": "Current status of the webhook", "type": "string", "example": "active", "nullable": true }, "endpoint": { "description": "Destination URL for webhook calls", "type": "string", "example": "https://example.com/api/webhook", "nullable": true }, "authentication": { "description": "Authentication type used to authenticate on the server", "type": "string", "example": "oauth2", "nullable": true }, "secret": { "description": "Secret key used to sign webhook requests. Visible only during creation", "type": "string", "example": "sk_Hdy7nJJGfUYwFrKP8d2xP", "nullable": true }, "oauth2": { "description": "OAuth2 client information. Can not be used with apiKey.", "type": "object", "default": null, "example": "{ \"client_id\": \"abc123\", \"client_secret\": \"xyz789\", \"scope\": \"USER\", \"grant_type\": \"client_credentials\" }", "nullable": true }, "apiKey": { "description": "API key for request authentication. Can not be used with oauth2.", "type": "string", "example": "api_3dK8fLpW9sQnVjX7yZrT", "nullable": true }, "apiHeaderKey": { "description": "Header name used to send the API key", "type": "string", "example": "X-API-KEY", "nullable": true }, "events": { "description": "List of events the webhook is subscribed to", "type": "array", "items": { "type": "string" }, "example": "[\"payment.created\", \"payment.updated\", \"payment.failed\"]", "nullable": true } }, "type": "object" }, "Webhook2": { "required": [ "id" ], "properties": { "objectName": { "description": "Name of the object", "type": "string", "default": "webhook", "example": "webhook" }, "id": { "description": "Unique identifier of the webhook", "type": "uuid", "example": "550e8400-e29b-41d4-a716-446655440000" }, "deletedAt": { "description": "Deletion date of the webhook", "type": "string", "format": "date-time", "example": "2023-01-25T16:20:00+00:00", "nullable": true } }, "type": "object" }, "Webhook3": { "properties": { "name": { "description": "Name of the webhook", "type": "string", "example": "Webhook", "nullable": true }, "description": { "description": "Detailed description of the webhook", "type": "string", "example": "Webhook for payment notifications", "nullable": true }, "status": { "description": "Current status of the webhook", "type": "string", "example": "active", "nullable": true }, "endpoint": { "description": "Destination URL for webhook calls", "type": "string", "example": "https://example.com/api/webhook", "nullable": true }, "authentication": { "description": "Authentication type used to authenticate on the server", "type": "string", "example": "oauth2", "nullable": true }, "secret": { "description": "Secret key used to sign webhook requests. Visible only during creation", "type": "string", "example": "sk_Hdy7nJJGfUYwFrKP8d2xP", "nullable": true }, "oauth2": { "description": "OAuth2 client information. Can not be used with apiKey.", "type": "object", "default": null, "example": "{ \"client_id\": \"abc123\", \"client_secret\": \"xyz789\", \"scope\": \"USER\", \"grant_type\": \"client_credentials\" }", "nullable": true }, "apiKey": { "description": "API key for request authentication. Can not be used with oauth2.", "type": "string", "example": "api_3dK8fLpW9sQnVjX7yZrT", "nullable": true }, "apiHeaderKey": { "description": "Header name used to send the API key", "type": "string", "example": "X-API-KEY", "nullable": true }, "events": { "description": "List of events the webhook is subscribed to", "type": "array", "items": { "type": "string" }, "example": "[\"payment.created\", \"payment.updated\", \"payment.failed\"]", "nullable": true } }, "type": "object" }, "WebhookEvent": { "required": [ "timestamp", "status" ], "properties": { "objectName": { "description": "Name of the webhook object", "type": "string", "default": "event", "example": "webhook" }, "id": { "description": "Unique identifier of the webhook", "type": "string", "format": "uuid", "example": "550e8400-e29b-41d4-a716-446655440000", "nullable": true }, "timestamp": { "description": "Unix timestamp when the log was created", "type": "integer", "example": 1625147809 }, "data": { "description": "The data payload of the webhook event", "type": "object", "example": "{\"id\": \"pay_123\", \"status\": \"completed\", \"amount\": 1000}", "nullable": true }, "type": { "description": "Type of the webhook event", "type": "string", "example": "payment.created", "nullable": true }, "status": { "description": "Current status of the webhook event", "type": "string", "enum": [ "success", "error", "processing" ], "example": "success" }, "errorMessage": { "description": "Error message if the webhook event processing failed", "type": "string", "example": "Connection timeout after 30 seconds", "nullable": true } }, "type": "object" }, "Document2": { "type": "object" }, "PhysicalPerson3": { "required": [ "id" ], "properties": { "auditAt": { "type": "string", "format": "date-time", "nullable": true }, "id": { "type": "string" }, "secondaryEmail": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "secondaryPhone": { "type": "string", "nullable": true }, "firstname": { "type": "string", "nullable": true }, "lastname": { "type": "string", "nullable": true }, "birthday": { "type": "string", "format": "date-time", "nullable": true }, "birthdayAddress": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Address" } ] }, "address": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Address" } ] }, "monthlyIncome": { "description": "Monthly income.", "type": "string", "enum": [ "LOWER_THAN_1200_EUROS", "BETWEEN_1200_2500_EUROS", "BETWEEN_2500_4000_EUROS", "GREATER_THAN_4000_EUROS" ], "nullable": true }, "profession": { "description": "Profession.", "type": "string", "enum": [ "FARMER", "CRAFTSMAN_MERCHANT_ENTREPRENEUR", "LIBERAL_PROFESSION", "EXECUTIVE", "RETIREE", "EMPLOYEE", "WORKER", "NO_ACTIVITY" ], "nullable": true }, "nationality": { "description": "Nationality in alpha3 country code.", "type": "string", "enum": [ "afg", "zaf", "alb", "dza", "deu", "and", "ago", "atg", "sau", "arg", "arm", "aus", "aut", "aze", "bhs", "bhr", "bgd", "brb", "blr", "bel", "blz", "ben", "btn", "bol", "bih", "bwa", "bra", "brn", "bgr", "bfa", "bdi", "khm", "cmr", "can", "cpv", "caf", "chl", "chn", "cyp", "col", "com", "cog", "cod", "kor", "prk", "cri", "civ", "hrv", "cub", "dnk", "dji", "dom", "dma", "egy", "slv", "are", "ecu", "eri", "esp", "est", "usa", "eth", "fji", "fin", "fra", "gab", "gmb", "geo", "gha", "grc", "grd", "gtm", "gin", "gnb", "gnq", "guy", "hti", "hnd", "hun", "ind", "idn", "irn", "irq", "irl", "isl", "isr", "ita", "jam", "jpn", "jor", "kaz", "ken", "kgz", "kir", "kwt", "lao", "lso", "lva", "lbn", "lbr", "lby", "lie", "ltu", "lux", "mkd", "mdg", "mys", "mwi", "mdv", "mli", "mlt", "mar", "mhl", "mus", "mrt", "mex", "fsm", "mda", "mco", "mng", "mne", "moz", "mmr", "nam", "nru", "npl", "nic", "ner", "nga", "nor", "nzl", "omn", "uga", "uzb", "pak", "plw", "pan", "png", "pry", "nld", "per", "phl", "pol", "prt", "qat", "rou", "gbr", "rus", "rwa", "kna", "smr", "vct", "lca", "slb", "wsm", "stp", "sen", "srb", "syc", "sle", "sgp", "svk", "svn", "som", "sdn", "ssd", "lka", "swe", "che", "sur", "swz", "syr", "tjk", "tza", "tcd", "cze", "tha", "tls", "tgo", "ton", "tto", "tun", "tkm", "tur", "tuv", "ukr", "ury", "vut", "ven", "vnm", "yem", "zmb", "zwe" ], "nullable": true }, "status": { "type": "string", "default": "waiting" }, "identityDocument": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Document2" } ] }, "mandatoryInfos": { "type": "array", "items": { "type": "string" }, "default": [] }, "uncompletedInfos": { "type": "array", "items": { "type": "string" }, "default": [] }, "createdAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true }, "email": { "type": "string", "nullable": true } }, "type": "object" }, "MoralPerson2": { "properties": { "companyName": { "type": "string", "nullable": true }, "companyEmail": { "type": "string", "nullable": true }, "companyType": { "type": "string", "nullable": true }, "companyRegistrationNumber": { "type": "string", "nullable": true }, "address": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Address" } ] }, "status": { "type": "string", "default": "waiting" }, "headOfCompany": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PhysicalPerson3" } ] }, "proofOfAddressDocument": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Document2" } ] }, "kbisDocument": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Document2" } ] }, "financialInfoDocument": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Document2" } ] }, "statusDocument": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Document2" } ] }, "mandatoryInfos": { "type": "array", "items": { "type": "string" }, "default": [] }, "uncompletedInfos": { "type": "array", "items": { "type": "string" }, "default": [] }, "createdAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true } }, "type": "object" }, "OrganisationUserModel2": { "type": "object" }, "ReceiverBankAccount3": { "required": [ "number", "holderName" ], "properties": { "number": { "type": "string" }, "bic": { "type": "string", "nullable": true }, "holderName": { "type": "string" }, "ibanDocument": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Document2" } ] }, "amBankAccountId": { "type": "string", "nullable": true } }, "type": "object" }, "OrganisationConnector2": { "required": [ "type" ], "properties": { "type": { "type": "string" }, "settingSendEmailByTyllt": { "type": "boolean", "default": false }, "createdAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true } }, "type": "object" }, "Organisation9": { "required": [ "accountType", "organisationConnectors", "id", "walletFunctionalities", "invoiceFunctionalities" ], "properties": { "organisationName": { "type": "string", "nullable": true }, "accountType": { "type": "string" }, "legalType": { "type": "string", "nullable": true }, "kycLevel": { "type": "string", "default": "LEVEL_0", "nullable": true }, "amAccountId": { "type": "string", "nullable": true }, "amWalletId": { "type": "string", "nullable": true }, "amSequestrationWalletId": { "type": "string", "nullable": true }, "amAccountStatus": { "type": "string", "nullable": true }, "amAccountErrorCode": { "type": "integer", "nullable": true }, "amValidationAskAt": { "type": "string", "format": "date-time", "nullable": true }, "amValidationUpdateAt": { "type": "string", "format": "date-time", "nullable": true }, "amValidationStatus": { "type": "string", "nullable": true }, "amValidationError": { "type": "string", "nullable": true }, "amValidationErrorDescription": { "type": "string", "nullable": true }, "moralPerson": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MoralPerson2" } ] }, "physicalPerson": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PhysicalPerson3" } ] }, "creatorPhysicalPerson": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PhysicalPerson3" } ] }, "accountForWho": { "type": "string", "nullable": true }, "currentRelation": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OrganisationUserModel2" } ] }, "activity": { "type": "string", "nullable": true }, "displayEmail": { "description": "Public email.", "type": "string", "nullable": true }, "displayPhone": { "description": "Public phone.", "type": "string", "nullable": true }, "displayWebsite": { "description": "Public website.", "type": "string", "nullable": true }, "displayLogo": { "description": "Public logo.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Media2" } ] }, "receiverBankAccount": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ReceiverBankAccount3" } ] }, "activatedFunctionality": { "type": "string", "nullable": true }, "auditAt": { "type": "string", "format": "date-time", "nullable": true }, "settingClosingTime": { "type": "integer", "default": 10 }, "settingMaxDepositAmount": { "type": "integer", "default": 2500 }, "settingRequestEmailSendTiming": { "type": "string", "default": "instant", "nullable": true }, "settingForceIdentityDocument": { "type": "boolean", "default": false }, "settingMultipleCashOut": { "type": "boolean", "default": false }, "settingInsurance": { "type": "boolean", "default": true }, "organisationConnectors": { "type": "array", "items": { "$ref": "#/components/schemas/OrganisationConnector2" } }, "id": { "description": "Unique identifier of the organisation", "type": "string", "format": "uuid", "example": "550e8400-e29b-41d4-a716-446655440000" }, "parent": { "type": "string", "nullable": true }, "parentData": { "nullable": true, "oneOf": [ { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Organisation9" } ] }, { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Organisation10" } ] } ] }, "displayName": { "description": "Public name.", "type": "string", "nullable": true }, "displayCreatedAt": { "description": "Public created at date.", "type": "string", "format": "date-time", "nullable": true }, "displayAddress": { "description": "Public address.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Address" } ] }, "effectiveFunctionality": { "type": "string", "nullable": true }, "walletFunctionalities": { "type": "boolean" }, "invoiceFunctionalities": { "type": "boolean" }, "littleBondSubscription": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Subscription3" } ] } }, "type": "object" }, "Organisation10": { "type": "object" }, "Subscription3": { "required": [ "type", "startDate" ], "properties": { "type": { "type": "string" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time", "nullable": true }, "renewalDate": { "type": "string", "format": "date-time", "nullable": true }, "status": { "type": "string", "default": "active" }, "createdAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true } }, "type": "object" }, "CheckInOut": { "properties": { "recipient": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Organisation9" } ] }, "createdAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true } }, "type": "object" }, "CashOutDiscussion": { "required": [ "medias", "type" ], "properties": { "medias": { "type": "array", "items": { "$ref": "#/components/schemas/Media2" } }, "amountProposed": { "description": "New amount proposed by the owner for the cashout.", "type": "number", "format": "float", "nullable": true }, "comment": { "description": "Message of the discussion put by the owner or the recipient.", "type": "string", "nullable": true }, "type": { "description": "Type of discussion.", "type": "string", "enum": [ "recipient_reclamation", "owner_new_offer", "recipient_accept", "owner_deny" ] }, "createdAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true } }, "type": "object" }, "CashOut": { "required": [ "id", "amount", "reason", "medias", "cashOutDiscussions", "sequestrationAmount", "actualFinalAmount" ], "properties": { "id": { "type": "string" }, "amount": { "description": "Amount of the cashout.", "type": "number", "format": "float" }, "reason": { "description": "Reason of the cashout.", "type": "string" }, "medias": { "description": "Documents related to the cashout.", "type": "array", "items": { "$ref": "#/components/schemas/Media2" } }, "status": { "description": "CashOut statut.", "type": "string", "default": "waiting", "enum": [ "waiting", "done", "reclamation", "failed", "cancel" ] }, "cashOutDiscussions": { "type": "array", "items": { "$ref": "#/components/schemas/CashOutDiscussion" } }, "sequestrationSuccess": { "description": "Know if the sequestration of the cashout worked fine.", "type": "boolean", "default": false }, "sequestrationAmount": { "description": "Amount of the sequestrate amount.", "type": "number", "format": "float" }, "refundFailed": { "description": "Know if a refound failed.", "type": "boolean", "default": false }, "transferFailed": { "type": "boolean", "default": false, "nullable": true }, "transferProviderId": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true }, "actualFinalAmount": { "type": "number", "format": "float" } }, "type": "object" }, "ModelRequest3": { "required": [ "id", "publicLink" ], "properties": { "deletedAt": { "type": "string", "format": "date-time", "nullable": true }, "id": { "type": "string" }, "publicLink": { "description": "Public link of the model request.", "type": "string" }, "internalReference": { "description": "Reference of the request. You can put an utile reference to identify the request to your side.", "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true } }, "type": "object" }, "OrganisationTransaction2": { "required": [ "id", "provider", "status" ], "properties": { "id": { "type": "string" }, "provider": { "description": "External provider of the transaction. Our payment partner.", "type": "string" }, "providerId": { "description": "External id of the transaction. Our payment partner transaction ID.", "type": "string", "nullable": true }, "payer": { "description": "Account who paid the transaction.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Organisation9" } ] }, "status": { "type": "string" }, "authorizedAmount": { "description": "3DS authorisation amount.", "type": "number", "format": "float", "nullable": true }, "amount": { "description": "Amount.", "type": "number", "format": "float", "nullable": true } }, "type": "object" }, "RequestEvent2": { "properties": { "createdAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true } }, "type": "object" }, "RequestSecurityDeposit": { "required": [ "cashOuts", "recipientInformationDocuments", "name", "description", "insuranceActive", "canEdit", "id", "owner", "publicLink", "status", "emailSendTiming", "organisationTransactions", "requestEvents", "dtype" ], "properties": { "depositRecipientsNumber": { "description": "Number of participants for the deposit of the request. Recipients can choose if they want to pay all the security deposit or split it between multiple participants.", "type": "integer", "default": 1, "nullable": true }, "startAt": { "description": "Start date of the request.", "type": "string", "format": "date-time", "nullable": true }, "endAt": { "description": "End date of the request.", "type": "string", "format": "date-time", "nullable": true }, "recipientAllowToUpdateStartAt": { "description": "Know if recipient is allow to update start date.", "type": "boolean", "nullable": true }, "recipientAllowToUpdateEndAt": { "description": "Know if recipient is allow to update end date.", "type": "boolean", "nullable": true }, "settingMultipleProductInformationResponse": { "description": "Recipient response to the multiple product information label.", "type": "string", "nullable": true }, "recipientMoreInformationResponse": { "description": "Recipient response to the more information label.", "type": "string", "nullable": true }, "remoteCheckInStatus": { "description": "Status of the check in.", "type": "string", "default": "waiting", "enum": [ "waiting", "done" ], "nullable": true }, "remoteCheckOutStatus": { "description": "Status of the check out.", "type": "string", "default": "waiting", "enum": [ "waiting", "done" ], "nullable": true }, "depositStatus": { "description": "Status of the deposit.", "type": "string", "default": "waiting", "enum": [ "waiting", "done", "in_error" ], "nullable": true }, "identityVerificationStatus": { "description": "Status of the identity verification.", "type": "string", "default": "waiting", "enum": [ "waiting", "done" ], "nullable": true }, "remoteCheckIn": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CheckInOut" } ] }, "remoteCheckOut": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CheckInOut" } ] }, "cashOuts": { "type": "array", "items": { "$ref": "#/components/schemas/CashOut" } }, "createdAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true }, "recipientInformationDocuments": { "description": "Informations documents related to the recipient.", "type": "array", "items": { "$ref": "#/components/schemas/Media2" } }, "name": { "description": "Name of the request.", "type": "string" }, "description": { "description": "Description of the request.", "type": "string" }, "remoteCheckInOut": { "description": "Active or not the remote check in and check out section.", "type": "boolean", "nullable": true }, "remoteCheckInOutInformation": { "description": "Active or not the remote check in and check out.", "type": "string", "nullable": true }, "depositAmount": { "description": "Amount ask for the deposit.", "type": "number", "format": "float", "nullable": true }, "deposit": { "description": "Active or not the deposit section.", "type": "boolean", "nullable": true }, "depositType": { "description": "Deposit type.", "type": "string", "enum": [ "verification", "blocked", "debit" ], "nullable": true }, "settingMultipleProduct": { "description": "Active or not the multiple product section.", "type": "boolean", "nullable": true }, "settingMultipleProductInformationLabel": { "description": "Display label for recipient who can answer to it in an input text. You can ask a product identification or whatever you want to know what product is in news", "type": "string", "nullable": true }, "recipientMoreInformationLabel": { "description": "Display label for recipient who can answer to it in an input text. You can ask all information you want.", "type": "string", "nullable": true }, "recipientWelcomeMessage": { "description": "Display message for recipient in the deposit asking email.", "type": "string", "nullable": true }, "recipientConfirmMessage": { "description": "Display message for recipient in the deposit confirm email.", "type": "string", "nullable": true }, "recipientVigilancePoints": { "description": "List of vigilance point you want to display for recipient.", "type": "string", "nullable": true }, "settingDateOptional": { "description": "Active or not the date optional for the recipient. If you pass true, recipient can choose to not fill the date field.", "type": "boolean", "nullable": true }, "settingDepositAutomaticEmailRelaunch": { "description": "Active or not the automatic email relaunch for deposit. If the recipient have not completed the deposit, an email will be sent to him.", "type": "boolean", "nullable": true }, "settingMultipleCashOutOption": { "description": "Active or not the possibility to do multiple cashOut on the same request. (This is not disponible for all owner - contact us to know more)", "type": "boolean", "nullable": true }, "settingAuthorizeDepositSharing": { "description": "Setting to authorize deposit sharing, if set to false recipients can't split the deposit. We recommend leaving it set to `true` for large deposits.", "type": "boolean", "default": true, "nullable": true }, "identityVerificationType": { "description": "Type of identity verification to do on the recipient.", "type": "string", "enum": [ "simple", "advanced" ], "nullable": true }, "insurance": { "description": "If it's set to true, recipient can take an insurance during deposit to protect the deposit amount.", "type": "boolean", "nullable": true }, "insuranceMaximumAmount": { "description": "Maximum amount protected by the insurance.", "type": "number", "format": "float", "nullable": true }, "estimatedReleasedAt": { "description": "Estimated release date of the deposit. It's based on the end date of the request and the closing time of the owner.", "type": "string", "format": "date-time", "nullable": true }, "insuranceActive": { "description": "To know if one recipient take the insurance.", "type": "boolean" }, "depositRecipientsPayed": { "description": "Number of recipients that have paid their share.", "type": "integer", "nullable": true }, "depositRecipientsAmountPayed": { "description": "Amount payed by recipients that have paid their share.", "type": "number", "format": "float", "nullable": true }, "depositTransactionAmountPayedDetail": { "description": "Name and amount of the recipients that that have paid their share.", "type": "array", "items": {}, "nullable": true }, "cashOutAllow": { "description": "Property to know if a cashOut request is actually allow on the deposit.", "type": "boolean", "nullable": true }, "cashOutMaximumAmount": { "description": "Property to know the maximum amount that can be set to a cashOut request.", "type": "number", "format": "float", "nullable": true }, "canEdit": { "description": "Property to know if the request ca be edit or no.", "type": "boolean" }, "id": { "type": "string" }, "model": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ModelRequest3" } ] }, "owner": { "$ref": "#/components/schemas/Organisation9" }, "recipient": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Organisation9" } ] }, "recipientPreFill": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PhysicalPerson3" } ] }, "publicLink": { "type": "string" }, "source": { "type": "string", "nullable": true }, "locale": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "status": { "type": "string" }, "emailSendTiming": { "type": "string" }, "organisationTransactions": { "type": "array", "items": { "$ref": "#/components/schemas/OrganisationTransaction2" } }, "requestEvents": { "type": "array", "items": { "$ref": "#/components/schemas/RequestEvent2" } }, "partnerIntegrationType": { "type": "string", "nullable": true }, "partnerReturnSuccessUrl": { "type": "string", "nullable": true }, "partnerReturnFailedUrl": { "type": "string", "nullable": true }, "partnerName": { "type": "string", "nullable": true }, "partnerRef": { "type": "string", "nullable": true }, "internalReference": { "type": "string", "nullable": true }, "fullLink": { "type": "string", "nullable": true }, "recipientId": { "type": "string", "nullable": true }, "dtype": { "type": "string" } }, "type": "object", "allOf": [ { "$ref": "#/components/schemas/Request" } ] }, "RequestPayment": { "required": [ "name", "description", "tvaType", "amount", "amountWithTax", "tvaValue", "canEdit", "id", "owner", "publicLink", "status", "emailSendTiming", "organisationTransactions", "requestEvents", "dtype" ], "properties": { "startAt": { "description": "Start date of the request. Use for the timing of the request email sending", "type": "string", "format": "date-time", "nullable": true }, "payedAt": { "description": "Date of the payment.", "type": "string", "format": "date-time", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true }, "name": { "description": "Name of the payment request.", "type": "string" }, "description": { "description": "Description of the payment request.", "type": "string" }, "tvaType": { "description": "TVA type of the payment request.", "type": "string", "enum": [ "FR_09", "FR_21", "FR_40", "FR_55", "FR_60", "FR_65", "FR_85", "FR_92", "FR_100", "FR_130", "FR_196", "FR_200", "AT_100", "AT_130", "AT_200", "BE_60", "BE_120", "BE_210", "BG_90", "BG_200", "CH_25", "CH_37", "CH_77", "CH_26", "CH_38", "CH_81", "CY_50", "CY_90", "CY_190", "CZ_100", "CZ_150", "CZ_210", "DE_70", "DE_190", "DK_250", "EE_90", "EE_200", "ES_40", "ES_100", "ES_210", "FI_100", "FI_140", "FI_240", "GB_50", "GB_200", "GR_60", "GR_130", "GR_240", "HR_50", "HR_130", "HR_250", "HU_50", "HU_180", "HU_270", "IE_48", "IE_90", "IE_135", "IE_210", "IE_230", "IT_40", "IT_50", "IT_100", "IT_220", "LT_50", "LT_90", "LT_210", "LU_30", "LU_70", "LU_80", "LU_130", "LU_140", "LU_160", "LU_170", "LV_50", "LV_120", "LV_210", "MC_09", "MC_21", "MC_55", "MC_85", "MC_100", "MC_200", "MT_50", "MT_70", "MT_180", "NL_90", "NL_210", "PL_50", "PL_80", "PL_230", "PT_60", "PT_130", "PT_230", "RO_50", "RO_90", "RO_190", "SE_60", "SE_120", "SE_250", "SI_50", "SI_95", "SI_220", "SK_100", "SK_200", "exempt", "crossborder", "extracom", "FR_100_construction", "FR_200_construction" ] }, "amount": { "description": "Amount of the payment request.", "type": "number", "format": "float" }, "amountWithTax": { "description": "Amount of the payment request with taxes.", "type": "number", "format": "float" }, "tvaValue": { "description": "TVA value of the payment request.", "type": "number", "format": "float" }, "canEdit": { "description": "Property to know if the request ca be edit or no.", "type": "boolean" }, "id": { "type": "string" }, "model": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ModelRequest3" } ] }, "owner": { "$ref": "#/components/schemas/Organisation9" }, "recipient": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Organisation9" } ] }, "recipientPreFill": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PhysicalPerson3" } ] }, "publicLink": { "type": "string" }, "source": { "type": "string", "nullable": true }, "locale": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "status": { "type": "string" }, "emailSendTiming": { "type": "string" }, "organisationTransactions": { "type": "array", "items": { "$ref": "#/components/schemas/OrganisationTransaction2" } }, "requestEvents": { "type": "array", "items": { "$ref": "#/components/schemas/RequestEvent2" } }, "partnerIntegrationType": { "type": "string", "nullable": true }, "partnerReturnSuccessUrl": { "type": "string", "nullable": true }, "partnerReturnFailedUrl": { "type": "string", "nullable": true }, "partnerName": { "type": "string", "nullable": true }, "partnerRef": { "type": "string", "nullable": true }, "internalReference": { "type": "string", "nullable": true }, "fullLink": { "type": "string", "nullable": true }, "recipientId": { "type": "string", "nullable": true }, "dtype": { "type": "string" } }, "type": "object", "allOf": [ { "$ref": "#/components/schemas/Request" } ] }, "PhysicalPerson4": { "properties": { "auditAt": { "type": "string", "format": "date-time", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true } }, "type": "object" }, "MoralPerson3": { "properties": { "companyName": { "type": "string", "nullable": true }, "companyEmail": { "type": "string", "nullable": true }, "companyType": { "type": "string", "nullable": true }, "companyRegistrationNumber": { "type": "string", "nullable": true }, "address": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Address2" } ] }, "status": { "type": "string", "default": "waiting" }, "headOfCompany": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PhysicalPerson4" } ] }, "proofOfAddressDocument": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Document2" } ] }, "kbisDocument": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Document2" } ] }, "financialInfoDocument": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Document2" } ] }, "statusDocument": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Document2" } ] }, "mandatoryInfos": { "type": "array", "items": { "type": "string" }, "default": [] }, "uncompletedInfos": { "type": "array", "items": { "type": "string" }, "default": [] }, "createdAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true } }, "type": "object" }, "Organisation11": { "required": [ "accountType", "organisationConnectors", "id", "createdAt", "updatedAt", "name", "walletFunctionalities", "invoiceFunctionalities" ], "properties": { "organisationName": { "type": "string", "nullable": true }, "accountType": { "type": "string" }, "legalType": { "type": "string", "nullable": true }, "kycLevel": { "type": "string", "default": "LEVEL_0", "nullable": true }, "amAccountId": { "type": "string", "nullable": true }, "amWalletId": { "type": "string", "nullable": true }, "amSequestrationWalletId": { "type": "string", "nullable": true }, "amAccountStatus": { "type": "string", "nullable": true }, "amAccountErrorCode": { "type": "integer", "nullable": true }, "amValidationAskAt": { "type": "string", "format": "date-time", "nullable": true }, "amValidationUpdateAt": { "type": "string", "format": "date-time", "nullable": true }, "amValidationStatus": { "type": "string", "nullable": true }, "amValidationError": { "type": "string", "nullable": true }, "amValidationErrorDescription": { "type": "string", "nullable": true }, "moralPerson": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MoralPerson3" } ] }, "physicalPerson": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PhysicalPerson4" } ] }, "creatorPhysicalPerson": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PhysicalPerson4" } ] }, "accountForWho": { "type": "string", "nullable": true }, "currentRelation": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OrganisationUserModel" } ] }, "activity": { "type": "string", "nullable": true }, "displayEmail": { "description": "Public email.", "type": "string", "nullable": true }, "displayPhone": { "description": "Public phone.", "type": "string", "nullable": true }, "displayWebsite": { "description": "Public website.", "type": "string", "nullable": true }, "displayLogo": { "description": "Public logo.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Media2" } ] }, "receiverBankAccount": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ReceiverBankAccount3" } ] }, "activatedFunctionality": { "type": "string", "nullable": true }, "auditAt": { "type": "string", "format": "date-time", "nullable": true }, "settingClosingTime": { "type": "integer", "default": 10 }, "settingMaxDepositAmount": { "type": "integer", "default": 2500 }, "settingRequestEmailSendTiming": { "type": "string", "default": "instant", "nullable": true }, "settingForceIdentityDocument": { "type": "boolean", "default": false }, "settingMultipleCashOut": { "type": "boolean", "default": false }, "settingInsurance": { "type": "boolean", "default": true }, "mandatoryInfos": { "type": "array", "items": { "type": "string" }, "default": [] }, "uncompletedInfos": { "type": "array", "items": { "type": "string" }, "default": [] }, "accountMainAlert": { "type": "string", "nullable": true }, "accountAlerts": { "type": "array", "items": { "type": "string" }, "default": [] }, "organisationConnectors": { "type": "array", "items": { "$ref": "#/components/schemas/OrganisationConnector2" } }, "objectName": { "description": "Name of the object", "type": "string", "default": "organisation", "example": "organisation" }, "id": { "description": "Unique identifier of the organisation", "type": "string", "format": "uuid", "example": "550e8400-e29b-41d4-a716-446655440000" }, "createdAt": { "description": "Creation date of the organisation", "type": "string", "format": "date-time", "example": "2023-01-01T12:00:00+00:00" }, "updatedAt": { "description": "Last update date of the organisation", "type": "string", "format": "date-time", "example": "2023-01-01T15:30:00+00:00" }, "name": { "description": "Name of the organisation", "type": "string", "example": "Example Organisation" }, "parent": { "type": "string", "nullable": true }, "parentData": { "nullable": true, "oneOf": [ { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Organisation11" } ] }, { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Organisation3" } ] } ] }, "displayName": { "description": "Public name.", "type": "string", "nullable": true }, "displayIdentifier": { "type": "string", "nullable": true }, "displayCreatedAt": { "description": "Public created at date.", "type": "string", "format": "date-time", "nullable": true }, "displayAddress": { "description": "Public address.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Address2" } ] }, "effectiveFunctionality": { "type": "string", "nullable": true }, "walletFunctionalities": { "type": "boolean" }, "invoiceFunctionalities": { "type": "boolean" }, "littleBondSubscription": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Subscription3" } ] }, "email": { "type": "string", "nullable": true } }, "type": "object" }, "CheckInOut2": { "properties": { "recipient": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Organisation11" } ] }, "createdAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true } }, "type": "object" }, "OrganisationTransaction3": { "required": [ "id", "provider", "status" ], "properties": { "id": { "type": "string" }, "provider": { "description": "External provider of the transaction. Our payment partner.", "type": "string" }, "providerId": { "description": "External id of the transaction. Our payment partner transaction ID.", "type": "string", "nullable": true }, "payer": { "description": "Account who paid the transaction.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Organisation11" } ] }, "status": { "type": "string" }, "authorizedAmount": { "description": "3DS authorisation amount.", "type": "number", "format": "float", "nullable": true }, "amount": { "description": "Amount.", "type": "number", "format": "float", "nullable": true } }, "type": "object" }, "Invoice": { "type": "object" }, "OrganisationRequestInsurance": { "properties": { "createdAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true } }, "type": "object" }, "RequestEvent3": { "required": [ "type", "medias" ], "properties": { "type": { "description": "Event type.", "type": "string", "enum": [ "email_send", "email_open", "email_processed", "email_delivered", "email_click", "email_bounce", "email_spamreport", "email_unsubscribe", "email_dropped", "email_deferred", "email_blocked", "email_invalid", "email_reply", "email_blacklisted", "ticket_admin_message", "new_transaction_manual_cancel", "ticket_owner_message" ] }, "subType": { "description": "Event subtype. For email event only.", "type": "string", "enum": [ "request_email", "cashout_email" ], "nullable": true }, "message": { "type": "string", "nullable": true }, "recipientMessage": { "type": "string", "nullable": true }, "ownerMessage": { "type": "string", "nullable": true }, "amount": { "type": "number", "format": "float", "nullable": true }, "visibility": { "type": "array", "items": { "type": "string" }, "nullable": true }, "cashOut": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CashOut" } ] }, "checkIn": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CheckInOut2" } ] }, "checkOut": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CheckInOut2" } ] }, "organisationTransaction": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OrganisationTransaction3" } ] }, "medias": { "type": "array", "items": { "$ref": "#/components/schemas/Media2" } }, "mail": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Mail" } ] }, "invoice": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Invoice" } ] }, "organisationRequestInsurance": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OrganisationRequestInsurance" } ] }, "createdAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true } }, "type": "object" }, "RequestSecurityDeposit2": { "required": [ "cashOuts", "recipientInformationDocuments", "name", "description", "insuranceActive", "canEdit", "id", "owner", "publicLink", "status", "emailSendTiming", "organisationTransactions", "requestEvents", "dtype" ], "properties": { "depositRecipientsNumber": { "description": "Number of participants for the deposit of the request. Recipients can choose if they want to pay all the security deposit or split it between multiple participants.", "type": "integer", "default": 1, "nullable": true }, "startAt": { "description": "Start date of the request.", "type": "string", "format": "date-time", "nullable": true }, "endAt": { "description": "End date of the request.", "type": "string", "format": "date-time", "nullable": true }, "recipientAllowToUpdateStartAt": { "description": "Know if recipient is allow to update start date.", "type": "boolean", "nullable": true }, "recipientAllowToUpdateEndAt": { "description": "Know if recipient is allow to update end date.", "type": "boolean", "nullable": true }, "settingMultipleProductInformationResponse": { "description": "Recipient response to the multiple product information label.", "type": "string", "nullable": true }, "recipientMoreInformationResponse": { "description": "Recipient response to the more information label.", "type": "string", "nullable": true }, "remoteCheckInStatus": { "description": "Status of the check in.", "type": "string", "default": "waiting", "enum": [ "waiting", "done" ], "nullable": true }, "remoteCheckOutStatus": { "description": "Status of the check out.", "type": "string", "default": "waiting", "enum": [ "waiting", "done" ], "nullable": true }, "depositStatus": { "description": "Status of the deposit.", "type": "string", "default": "waiting", "enum": [ "waiting", "done", "in_error" ], "nullable": true }, "identityVerificationStatus": { "description": "Status of the identity verification.", "type": "string", "default": "waiting", "enum": [ "waiting", "done" ], "nullable": true }, "remoteCheckIn": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CheckInOut2" } ] }, "remoteCheckOut": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CheckInOut2" } ] }, "cashOuts": { "type": "array", "items": { "$ref": "#/components/schemas/CashOut" } }, "createdAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true }, "recipientInformationDocuments": { "description": "Informations documents related to the recipient.", "type": "array", "items": { "$ref": "#/components/schemas/Media2" } }, "name": { "description": "Name of the request.", "type": "string" }, "description": { "description": "Description of the request.", "type": "string" }, "remoteCheckInOut": { "description": "Active or not the remote check in and check out section.", "type": "boolean", "nullable": true }, "remoteCheckInOutInformation": { "description": "Active or not the remote check in and check out.", "type": "string", "nullable": true }, "depositAmount": { "description": "Amount ask for the deposit.", "type": "number", "format": "float", "nullable": true }, "deposit": { "description": "Active or not the deposit section.", "type": "boolean", "nullable": true }, "depositType": { "description": "Deposit type.", "type": "string", "enum": [ "verification", "blocked", "debit" ], "nullable": true }, "settingMultipleProduct": { "description": "Active or not the multiple product section.", "type": "boolean", "nullable": true }, "settingMultipleProductInformationLabel": { "description": "Display label for recipient who can answer to it in an input text. You can ask a product identification or whatever you want to know what product is in news", "type": "string", "nullable": true }, "recipientMoreInformationLabel": { "description": "Display label for recipient who can answer to it in an input text. You can ask all information you want.", "type": "string", "nullable": true }, "recipientWelcomeMessage": { "description": "Display message for recipient in the deposit asking email.", "type": "string", "nullable": true }, "recipientConfirmMessage": { "description": "Display message for recipient in the deposit confirm email.", "type": "string", "nullable": true }, "recipientVigilancePoints": { "description": "List of vigilance point you want to display for recipient.", "type": "string", "nullable": true }, "settingDateOptional": { "description": "Active or not the date optional for the recipient. If you pass true, recipient can choose to not fill the date field.", "type": "boolean", "nullable": true }, "settingDepositAutomaticEmailRelaunch": { "description": "Active or not the automatic email relaunch for deposit. If the recipient have not completed the deposit, an email will be sent to him.", "type": "boolean", "nullable": true }, "settingMultipleCashOutOption": { "description": "Active or not the possibility to do multiple cashOut on the same request. (This is not disponible for all owner - contact us to know more)", "type": "boolean", "nullable": true }, "settingAuthorizeDepositSharing": { "description": "Setting to authorize deposit sharing, if set to false recipients can't split the deposit. We recommend leaving it set to `true` for large deposits.", "type": "boolean", "default": true, "nullable": true }, "identityVerificationType": { "description": "Type of identity verification to do on the recipient.", "type": "string", "enum": [ "simple", "advanced" ], "nullable": true }, "insurance": { "description": "If it's set to true, recipient can take an insurance during deposit to protect the deposit amount.", "type": "boolean", "nullable": true }, "insuranceMaximumAmount": { "description": "Maximum amount protected by the insurance.", "type": "number", "format": "float", "nullable": true }, "estimatedReleasedAt": { "description": "Estimated release date of the deposit. It's based on the end date of the request and the closing time of the owner.", "type": "string", "format": "date-time", "nullable": true }, "insuranceActive": { "description": "To know if one recipient take the insurance.", "type": "boolean" }, "depositRecipientsPayed": { "description": "Number of recipients that have paid their share.", "type": "integer", "nullable": true }, "depositRecipientsAmountPayed": { "description": "Amount payed by recipients that have paid their share.", "type": "number", "format": "float", "nullable": true }, "depositTransactionAmountPayedDetail": { "description": "Name and amount of the recipients that that have paid their share.", "type": "array", "items": {}, "nullable": true }, "cashOutAllow": { "description": "Property to know if a cashOut request is actually allow on the deposit.", "type": "boolean", "nullable": true }, "cashOutMaximumAmount": { "description": "Property to know the maximum amount that can be set to a cashOut request.", "type": "number", "format": "float", "nullable": true }, "canEdit": { "description": "Property to know if the request ca be edit or no.", "type": "boolean" }, "id": { "type": "string" }, "model": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ModelRequest3" } ] }, "owner": { "$ref": "#/components/schemas/Organisation11" }, "recipient": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Organisation11" } ] }, "recipientPreFill": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PhysicalPerson4" } ] }, "publicLink": { "type": "string" }, "source": { "type": "string", "nullable": true }, "locale": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "status": { "type": "string" }, "emailSendTiming": { "type": "string" }, "organisationTransactions": { "type": "array", "items": { "$ref": "#/components/schemas/OrganisationTransaction3" } }, "requestEvents": { "type": "array", "items": { "$ref": "#/components/schemas/RequestEvent3" } }, "partnerIntegrationType": { "type": "string", "nullable": true }, "partnerReturnSuccessUrl": { "type": "string", "nullable": true }, "partnerReturnFailedUrl": { "type": "string", "nullable": true }, "partnerName": { "type": "string", "nullable": true }, "partnerRef": { "type": "string", "nullable": true }, "internalReference": { "type": "string", "nullable": true }, "fullLink": { "type": "string", "nullable": true }, "recipientId": { "type": "string", "nullable": true }, "dtype": { "type": "string" } }, "type": "object", "allOf": [ { "$ref": "#/components/schemas/Request" } ] }, "Ticket": { "required": [ "id", "type" ], "properties": { "id": { "type": "integer" }, "status": { "type": "string", "default": "waiting" }, "type": { "type": "string" }, "request": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/RequestSecurityDeposit2" } ] }, "organisationRequestInsurance": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OrganisationRequestInsurance" } ] }, "cashout": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CashOut" } ] }, "createdAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true } }, "type": "object" }, "TicketInternalNoteType": { "required": [ "message" ], "properties": { "message": { "type": "string" } }, "type": "object" }, "TicketRetryType": { "required": [ "message", "amount" ], "properties": { "message": { "type": "string" }, "amount": { "type": "number" } }, "type": "object" }, "TicketSendOwnerMessageType": { "required": [ "message" ], "properties": { "message": { "type": "string" } }, "type": "object" }, "TicketCloseType": { "required": [ "transactionId", "recipientMessage", "ownerMessage" ], "properties": { "transactionId": { "type": "string" }, "recipientMessage": { "type": "string" }, "ownerMessage": { "type": "string" } }, "type": "object" }, "OrganisationTransaction4": { "type": "object" }, "CashOutDiscussion2": { "required": [ "medias", "type" ], "properties": { "medias": { "type": "array", "items": { "$ref": "#/components/schemas/Media" } }, "amountProposed": { "description": "New amount proposed by the owner for the cashout.", "type": "number", "format": "float", "nullable": true }, "comment": { "description": "Message of the discussion put by the owner or the recipient.", "type": "string", "nullable": true }, "type": { "description": "Type of discussion.", "type": "string", "enum": [ "recipient_reclamation", "owner_new_offer", "recipient_accept", "owner_deny" ] } }, "type": "object" }, "CashOut2": { "required": [ "id", "amount", "reason", "medias", "cashOutDiscussions", "sequestrationAmount", "actualFinalAmount" ], "properties": { "id": { "type": "string" }, "amount": { "description": "Amount of the cashout.", "type": "number", "format": "float" }, "reason": { "description": "Reason of the cashout.", "type": "string" }, "medias": { "description": "Documents related to the cashout.", "type": "array", "items": { "$ref": "#/components/schemas/Media" } }, "status": { "description": "CashOut statut.", "type": "string", "default": "waiting", "enum": [ "waiting", "done", "reclamation", "failed", "cancel" ] }, "cashOutDiscussions": { "type": "array", "items": { "$ref": "#/components/schemas/CashOutDiscussion2" } }, "sequestrationSuccess": { "description": "Know if the sequestration of the cashout worked fine.", "type": "boolean", "default": false }, "sequestrationAmount": { "description": "Amount of the sequestrate amount.", "type": "number", "format": "float" }, "refundFailed": { "description": "Know if a refound failed.", "type": "boolean", "default": false }, "transferFailed": { "type": "boolean", "default": false, "nullable": true }, "transferProviderId": { "type": "string", "nullable": true }, "actualFinalAmount": { "type": "number", "format": "float" } }, "type": "object" }, "CashOutCreateType": { "required": [ "amount", "reason", "medias" ], "properties": { "amount": { "type": "number" }, "reason": { "type": "string" }, "medias": { "type": "array", "format": "[App\\Entity\\Media id]", "items": { "type": "string" } } }, "type": "object" }, "CashOutDiscussionType": { "required": [ "amountProposed", "comment", "type", "medias" ], "properties": { "amountProposed": { "type": "number" }, "comment": { "type": "string" }, "type": { "type": "string", "enum": [ "recipient_reclamation", "owner_new_offer", "recipient_accept", "owner_deny" ] }, "medias": { "type": "array", "format": "[App\\Entity\\Media id]", "items": { "type": "string" } } }, "type": "object" }, "CheckInOut3": { "required": [ "id", "type", "comment", "medias" ], "properties": { "id": { "type": "string" }, "type": { "description": "Type.", "type": "string", "enum": [ "check_in", "check_out" ] }, "comment": { "description": "Comment.", "type": "string" }, "medias": { "type": "array", "items": { "$ref": "#/components/schemas/Media" } } }, "type": "object" }, "CheckInOutType": { "required": [ "type", "comment", "medias", "noMedia" ], "properties": { "type": { "type": "string", "enum": [ "check_in", "check_out" ] }, "comment": { "type": "string" }, "medias": { "type": "array", "format": "[App\\Entity\\Media id]", "items": { "type": "string" } }, "noMedia": { "type": "boolean" } }, "type": "object" }, "OrganisationConnectorEditType": { "required": [ "settingSendEmailByTyllt" ], "properties": { "settingSendEmailByTyllt": { "type": "boolean" } }, "type": "object" }, "OrganisationConnector3": { "type": "object" }, "OrganisationCreateType": { "required": [ "name", "accountType", "accountForWho", "legalType", "parent", "activatedFunctionality" ], "properties": { "name": { "type": "string" }, "accountType": { "type": "string", "enum": [ "owner", "tenant", "manager" ] }, "accountForWho": { "type": "string", "enum": [ "me", "third" ] }, "legalType": { "type": "string", "enum": [ "company", "particular" ] }, "parent": { "type": "string", "format": "App\\Entity\\Organisation id" }, "activatedFunctionality": { "type": "string", "enum": [ "invoice", "wallet", "wallet_invoice" ] } }, "type": "object" }, "MoralPerson4": { "properties": { "companyName": { "type": "string", "nullable": true }, "companyEmail": { "type": "string", "nullable": true }, "companyType": { "type": "string", "nullable": true }, "companyRegistrationNumber": { "type": "string", "nullable": true }, "address": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Address" } ] }, "status": { "type": "string", "default": "waiting" }, "headOfCompany": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PhysicalPerson" } ] }, "proofOfAddressDocument": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Document2" } ] }, "kbisDocument": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Document2" } ] }, "financialInfoDocument": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Document2" } ] }, "statusDocument": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Document2" } ] }, "mandatoryInfos": { "type": "array", "items": { "type": "string" }, "default": [] }, "uncompletedInfos": { "type": "array", "items": { "type": "string" }, "default": [] } }, "type": "object" }, "Organisation12": { "required": [ "accountType", "organisationConnectors", "id", "createdAt", "updatedAt", "name", "walletFunctionalities", "invoiceFunctionalities" ], "properties": { "organisationName": { "type": "string", "nullable": true }, "accountType": { "type": "string" }, "legalType": { "type": "string", "nullable": true }, "kycLevel": { "type": "string", "default": "LEVEL_0", "nullable": true }, "amAccountId": { "type": "string", "nullable": true }, "amWalletId": { "type": "string", "nullable": true }, "amSequestrationWalletId": { "type": "string", "nullable": true }, "amAccountStatus": { "type": "string", "nullable": true }, "amAccountErrorCode": { "type": "integer", "nullable": true }, "amValidationAskAt": { "type": "string", "format": "date-time", "nullable": true }, "amValidationUpdateAt": { "type": "string", "format": "date-time", "nullable": true }, "amValidationStatus": { "type": "string", "nullable": true }, "amValidationError": { "type": "string", "nullable": true }, "amValidationErrorDescription": { "type": "string", "nullable": true }, "moralPerson": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MoralPerson4" } ] }, "physicalPerson": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PhysicalPerson" } ] }, "creatorPhysicalPerson": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PhysicalPerson" } ] }, "accountForWho": { "type": "string", "nullable": true }, "currentRelation": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OrganisationUserModel" } ] }, "activity": { "type": "string", "nullable": true }, "displayEmail": { "description": "Public email.", "type": "string", "nullable": true }, "displayPhone": { "description": "Public phone.", "type": "string", "nullable": true }, "displayWebsite": { "description": "Public website.", "type": "string", "nullable": true }, "displayLogo": { "description": "Public logo.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Media2" } ] }, "receiverBankAccount": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ReceiverBankAccount3" } ] }, "activatedFunctionality": { "type": "string", "nullable": true }, "settingClosingTime": { "type": "integer", "default": 10 }, "settingMaxDepositAmount": { "type": "integer", "default": 2500 }, "settingRequestEmailSendTiming": { "type": "string", "default": "instant", "nullable": true }, "settingForceIdentityDocument": { "type": "boolean", "default": false }, "settingMultipleCashOut": { "type": "boolean", "default": false }, "settingInsurance": { "type": "boolean", "default": true }, "mandatoryInfos": { "type": "array", "items": { "type": "string" }, "default": [] }, "uncompletedInfos": { "type": "array", "items": { "type": "string" }, "default": [] }, "accountMainAlert": { "type": "string", "nullable": true }, "accountAlerts": { "type": "array", "items": { "type": "string" }, "default": [] }, "organisationConnectors": { "type": "array", "items": { "$ref": "#/components/schemas/OrganisationConnector" } }, "objectName": { "description": "Name of the object", "type": "string", "default": "organisation", "example": "organisation" }, "id": { "description": "Unique identifier of the organisation", "type": "string", "format": "uuid", "example": "550e8400-e29b-41d4-a716-446655440000" }, "createdAt": { "description": "Creation date of the organisation", "type": "string", "format": "date-time", "example": "2023-01-01T12:00:00+00:00" }, "updatedAt": { "description": "Last update date of the organisation", "type": "string", "format": "date-time", "example": "2023-01-01T15:30:00+00:00" }, "name": { "description": "Name of the organisation", "type": "string", "example": "Example Organisation" }, "parent": { "type": "string", "nullable": true }, "parentData": { "nullable": true, "oneOf": [ { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Organisation12" } ] }, { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Organisation3" } ] } ] }, "displayName": { "description": "Public name.", "type": "string", "nullable": true }, "displayIdentifier": { "type": "string", "nullable": true }, "displayCreatedAt": { "description": "Public created at date.", "type": "string", "format": "date-time", "nullable": true }, "displayAddress": { "description": "Public address.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Address" } ] }, "effectiveFunctionality": { "type": "string", "nullable": true }, "walletFunctionalities": { "type": "boolean" }, "invoiceFunctionalities": { "type": "boolean" }, "littleBondSubscription": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Subscription" } ] }, "email": { "type": "string", "nullable": true } }, "type": "object" }, "AddressType": { "required": [ "zipCode", "country", "city" ], "properties": { "address": { "type": "string" }, "addressComplementary": { "type": "string" }, "zipCode": { "type": "string" }, "country": { "type": "string" }, "city": { "type": "string" } }, "type": "object" }, "PhysicalPersonType": { "required": [ "firstname", "lastname", "phone", "birthday", "address", "birthdayAddress" ], "properties": { "firstname": { "type": "string" }, "lastname": { "type": "string" }, "secondaryEmail": { "type": "string" }, "phone": { "type": "string" }, "secondaryPhone": { "type": "string" }, "birthday": { "type": "string", "format": "date" }, "address": { "$ref": "#/components/schemas/AddressType" }, "birthdayAddress": { "$ref": "#/components/schemas/AddressType" }, "profession": { "type": "string", "enum": [ "FARMER", "CRAFTSMAN_MERCHANT_ENTREPRENEUR", "LIBERAL_PROFESSION", "EXECUTIVE", "RETIREE", "EMPLOYEE", "WORKER", "NO_ACTIVITY" ] }, "monthlyIncome": { "type": "string", "enum": [ "LOWER_THAN_1200_EUROS", "BETWEEN_1200_2500_EUROS", "BETWEEN_2500_4000_EUROS", "GREATER_THAN_4000_EUROS" ] }, "nationality": { "type": "string", "enum": [ "afg", "zaf", "alb", "dza", "deu", "and", "ago", "atg", "sau", "arg", "arm", "aus", "aut", "aze", "bhs", "bhr", "bgd", "brb", "blr", "bel", "blz", "ben", "btn", "bol", "bih", "bwa", "bra", "brn", "bgr", "bfa", "bdi", "khm", "cmr", "can", "cpv", "caf", "chl", "chn", "cyp", "col", "com", "cog", "cod", "kor", "prk", "cri", "civ", "hrv", "cub", "dnk", "dji", "dom", "dma", "egy", "slv", "are", "ecu", "eri", "esp", "est", "usa", "eth", "fji", "fin", "fra", "gab", "gmb", "geo", "gha", "grc", "grd", "gtm", "gin", "gnb", "gnq", "guy", "hti", "hnd", "hun", "ind", "idn", "irn", "irq", "irl", "isl", "isr", "ita", "jam", "jpn", "jor", "kaz", "ken", "kgz", "kir", "kwt", "lao", "lso", "lva", "lbn", "lbr", "lby", "lie", "ltu", "lux", "mkd", "mdg", "mys", "mwi", "mdv", "mli", "mlt", "mar", "mhl", "mus", "mrt", "mex", "fsm", "mda", "mco", "mng", "mne", "moz", "mmr", "nam", "nru", "npl", "nic", "ner", "nga", "nor", "nzl", "omn", "uga", "uzb", "pak", "plw", "pan", "png", "pry", "nld", "per", "phl", "pol", "prt", "qat", "rou", "gbr", "rus", "rwa", "kna", "smr", "vct", "lca", "slb", "wsm", "stp", "sen", "srb", "syc", "sle", "sgp", "svk", "svn", "som", "sdn", "ssd", "lka", "swe", "che", "sur", "swz", "syr", "tjk", "tza", "tcd", "cze", "tha", "tls", "tgo", "ton", "tto", "tun", "tkm", "tur", "tuv", "ukr", "ury", "vut", "ven", "vnm", "yem", "zmb", "zwe" ] }, "identityDocument": { "type": "string", "format": " id" } }, "type": "object" }, "MoralPersonType": { "required": [ "companyName", "companyEmail", "companyType", "companyRegistrationNumber", "address", "headOfCompany" ], "properties": { "companyName": { "type": "string" }, "companyEmail": { "type": "string" }, "companyType": { "type": "string", "enum": [ "ASSO", "COMPANY", "SOLE_TRADER" ] }, "companyRegistrationNumber": { "type": "string" }, "address": { "$ref": "#/components/schemas/AddressType" }, "headOfCompany": { "$ref": "#/components/schemas/PhysicalPersonType" }, "proofOfAddressDocument": { "type": "string", "format": " id" }, "kbisDocument": { "type": "string", "format": " id" }, "statusDocument": { "type": "string", "format": " id" }, "financialInfoDocument": { "type": "string", "format": " id" } }, "type": "object" }, "ReceiverBankAccountType": { "required": [ "number", "bic", "holderName", "ibanDocument" ], "properties": { "number": { "type": "string" }, "bic": { "type": "string" }, "holderName": { "type": "string" }, "ibanDocument": { "type": "string", "format": " id" } }, "type": "object" }, "OrganisationUpdateType": { "required": [ "parent", "accountForWho", "legalType", "name", "activity", "displayWebsite", "displayPhone", "displayEmail", "displayLogo", "moralPerson", "physicalPerson", "creatorPhysicalPerson", "receiverBankAccount", "additionalValidationGroups", "settingClosingTime", "settingMaxDepositAmount", "settingRequestEmailSendTiming", "settingForceIdentityDocument", "settingMultipleCashOut", "settingInsurance", "activatedFunctionality" ], "properties": { "parent": { "type": "string", "format": "App\\Entity\\Organisation id" }, "accountForWho": { "type": "string", "enum": [ "me", "third" ] }, "legalType": { "type": "string", "enum": [ "company", "particular" ] }, "name": { "type": "string" }, "activity": { "type": "string" }, "displayWebsite": { "type": "string" }, "displayPhone": { "type": "string" }, "displayEmail": { "type": "string" }, "displayLogo": { "type": "string", "format": "App\\Entity\\Media id" }, "moralPerson": { "$ref": "#/components/schemas/MoralPersonType" }, "physicalPerson": { "$ref": "#/components/schemas/PhysicalPersonType" }, "creatorPhysicalPerson": { "$ref": "#/components/schemas/PhysicalPersonType" }, "receiverBankAccount": { "$ref": "#/components/schemas/ReceiverBankAccountType" }, "additionalValidationGroups": { "type": "array", "items": { "type": "string" } }, "settingClosingTime": { "type": "number" }, "settingMaxDepositAmount": { "type": "number" }, "settingRequestEmailSendTiming": { "type": "string", "enum": [ "instant", "month_before", "week_before", "72_hours_before", "48_hours_before", "24_hours_before", "none" ] }, "settingForceIdentityDocument": { "type": "boolean" }, "settingMultipleCashOut": { "type": "boolean" }, "settingInsurance": { "type": "boolean" }, "activatedFunctionality": { "type": "string", "enum": [ "invoice", "wallet", "wallet_invoice" ] } }, "type": "object" }, "Organisation13": { "required": [ "accountType", "organisationConnectors", "id", "createdAt", "updatedAt", "name", "walletFunctionalities", "invoiceFunctionalities" ], "properties": { "organisationName": { "type": "string", "nullable": true }, "accountType": { "type": "string" }, "legalType": { "type": "string", "nullable": true }, "kycLevel": { "type": "string", "default": "LEVEL_0", "nullable": true }, "amAccountId": { "type": "string", "nullable": true }, "amWalletId": { "type": "string", "nullable": true }, "amSequestrationWalletId": { "type": "string", "nullable": true }, "amAccountStatus": { "type": "string", "nullable": true }, "amAccountErrorCode": { "type": "integer", "nullable": true }, "amValidationAskAt": { "type": "string", "format": "date-time", "nullable": true }, "amValidationUpdateAt": { "type": "string", "format": "date-time", "nullable": true }, "amValidationStatus": { "type": "string", "nullable": true }, "amValidationError": { "type": "string", "nullable": true }, "amValidationErrorDescription": { "type": "string", "nullable": true }, "moralPerson": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MoralPerson" } ] }, "physicalPerson": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PhysicalPerson2" } ] }, "creatorPhysicalPerson": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PhysicalPerson2" } ] }, "accountForWho": { "type": "string", "nullable": true }, "currentRelation": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OrganisationUserModel" } ] }, "activity": { "type": "string", "nullable": true }, "displayEmail": { "description": "Public email.", "type": "string", "nullable": true }, "displayPhone": { "description": "Public phone.", "type": "string", "nullable": true }, "displayWebsite": { "description": "Public website.", "type": "string", "nullable": true }, "displayLogo": { "description": "Public logo.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Media" } ] }, "receiverBankAccount": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ReceiverBankAccount" } ] }, "activatedFunctionality": { "type": "string", "nullable": true }, "settingClosingTime": { "type": "integer", "default": 10 }, "settingMaxDepositAmount": { "type": "integer", "default": 2500 }, "settingRequestEmailSendTiming": { "type": "string", "default": "instant", "nullable": true }, "settingForceIdentityDocument": { "type": "boolean", "default": false }, "settingMultipleCashOut": { "type": "boolean", "default": false }, "settingInsurance": { "type": "boolean", "default": true }, "mandatoryInfos": { "type": "array", "items": { "type": "string" }, "default": [] }, "uncompletedInfos": { "type": "array", "items": { "type": "string" }, "default": [] }, "accountMainAlert": { "type": "string", "nullable": true }, "accountAlerts": { "type": "array", "items": { "type": "string" }, "default": [] }, "organisationConnectors": { "type": "array", "items": { "$ref": "#/components/schemas/OrganisationConnector" } }, "objectName": { "description": "Name of the object", "type": "string", "default": "organisation", "example": "organisation" }, "id": { "description": "Unique identifier of the organisation", "type": "string", "format": "uuid", "example": "550e8400-e29b-41d4-a716-446655440000" }, "createdAt": { "description": "Creation date of the organisation", "type": "string", "format": "date-time", "example": "2023-01-01T12:00:00+00:00" }, "updatedAt": { "description": "Last update date of the organisation", "type": "string", "format": "date-time", "example": "2023-01-01T15:30:00+00:00" }, "name": { "description": "Name of the organisation", "type": "string", "example": "Example Organisation" }, "parent": { "type": "string", "nullable": true }, "parentData": { "nullable": true, "oneOf": [ { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Organisation13" } ] }, { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Organisation3" } ] } ] }, "displayName": { "description": "Public name.", "type": "string", "nullable": true }, "displayIdentifier": { "type": "string", "nullable": true }, "displayCreatedAt": { "description": "Public created at date.", "type": "string", "format": "date-time", "nullable": true }, "displayAddress": { "description": "Public address.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Address" } ] }, "effectiveFunctionality": { "type": "string", "nullable": true }, "walletFunctionalities": { "type": "boolean" }, "invoiceFunctionalities": { "type": "boolean" }, "littleBondSubscription": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Subscription" } ] }, "email": { "type": "string", "nullable": true } }, "type": "object" }, "MoralPerson5": { "properties": { "companyName": { "type": "string", "nullable": true }, "companyEmail": { "type": "string", "nullable": true }, "companyType": { "type": "string", "nullable": true }, "companyRegistrationNumber": { "type": "string", "nullable": true }, "address": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Address2" } ] }, "status": { "type": "string", "default": "waiting" }, "headOfCompany": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PhysicalPerson" } ] }, "proofOfAddressDocument": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Document2" } ] }, "kbisDocument": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Document2" } ] }, "financialInfoDocument": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Document2" } ] }, "statusDocument": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Document2" } ] }, "mandatoryInfos": { "type": "array", "items": { "type": "string" }, "default": [] }, "uncompletedInfos": { "type": "array", "items": { "type": "string" }, "default": [] } }, "type": "object" }, "Organisation14": { "required": [ "accountType", "organisationConnectors", "id", "walletFunctionalities", "invoiceFunctionalities" ], "properties": { "organisationName": { "type": "string", "nullable": true }, "accountType": { "type": "string" }, "legalType": { "type": "string", "nullable": true }, "kycLevel": { "type": "string", "default": "LEVEL_0", "nullable": true }, "amAccountId": { "type": "string", "nullable": true }, "amWalletId": { "type": "string", "nullable": true }, "amSequestrationWalletId": { "type": "string", "nullable": true }, "amAccountStatus": { "type": "string", "nullable": true }, "amAccountErrorCode": { "type": "integer", "nullable": true }, "amValidationAskAt": { "type": "string", "format": "date-time", "nullable": true }, "amValidationUpdateAt": { "type": "string", "format": "date-time", "nullable": true }, "amValidationStatus": { "type": "string", "nullable": true }, "amValidationError": { "type": "string", "nullable": true }, "amValidationErrorDescription": { "type": "string", "nullable": true }, "moralPerson": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MoralPerson5" } ] }, "physicalPerson": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PhysicalPerson" } ] }, "creatorPhysicalPerson": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PhysicalPerson" } ] }, "accountForWho": { "type": "string", "nullable": true }, "currentRelation": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OrganisationUserModel2" } ] }, "activity": { "type": "string", "nullable": true }, "displayEmail": { "description": "Public email.", "type": "string", "nullable": true }, "displayPhone": { "description": "Public phone.", "type": "string", "nullable": true }, "displayWebsite": { "description": "Public website.", "type": "string", "nullable": true }, "displayLogo": { "description": "Public logo.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Media2" } ] }, "receiverBankAccount": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ReceiverBankAccount3" } ] }, "activatedFunctionality": { "type": "string", "nullable": true }, "settingClosingTime": { "type": "integer", "default": 10 }, "settingMaxDepositAmount": { "type": "integer", "default": 2500 }, "settingRequestEmailSendTiming": { "type": "string", "default": "instant", "nullable": true }, "settingForceIdentityDocument": { "type": "boolean", "default": false }, "settingMultipleCashOut": { "type": "boolean", "default": false }, "settingInsurance": { "type": "boolean", "default": true }, "organisationConnectors": { "type": "array", "items": { "$ref": "#/components/schemas/OrganisationConnector" } }, "id": { "description": "Unique identifier of the organisation", "type": "string", "format": "uuid", "example": "550e8400-e29b-41d4-a716-446655440000" }, "parent": { "type": "string", "nullable": true }, "parentData": { "nullable": true, "oneOf": [ { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Organisation14" } ] }, { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Organisation10" } ] } ] }, "displayName": { "description": "Public name.", "type": "string", "nullable": true }, "displayCreatedAt": { "description": "Public created at date.", "type": "string", "format": "date-time", "nullable": true }, "displayAddress": { "description": "Public address.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Address2" } ] }, "effectiveFunctionality": { "type": "string", "nullable": true }, "walletFunctionalities": { "type": "boolean" }, "invoiceFunctionalities": { "type": "boolean" }, "littleBondSubscription": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Subscription" } ] } }, "type": "object" }, "OrganisationStatsModel": { "properties": { "costs": { "type": "number", "format": "float", "default": null, "nullable": true }, "costsTTC": { "type": "number", "format": "float", "default": null, "nullable": true }, "securityDepositInProgress": { "type": "integer", "default": null, "nullable": true }, "securityDepositInError": { "type": "integer", "default": null, "nullable": true }, "walletAmount": { "type": "number", "format": "float", "default": null, "nullable": true }, "totalSecurityDeposits": { "type": "number", "format": "float", "default": null, "nullable": true }, "releasedPercent": { "type": "number", "format": "float", "default": null, "nullable": true }, "accountFillingPercent": { "type": "number", "format": "float", "default": null, "nullable": true } }, "type": "object" }, "MoralPerson6": { "properties": { "companyName": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true } }, "type": "object" }, "PhysicalPerson5": { "properties": { "auditAt": { "type": "string", "format": "date-time", "nullable": true }, "firstname": { "type": "string", "nullable": true }, "lastname": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true } }, "type": "object" }, "Organisation15": { "required": [ "accountType", "id" ], "properties": { "organisationName": { "type": "string", "nullable": true }, "accountType": { "type": "string" }, "legalType": { "type": "string", "nullable": true }, "moralPerson": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MoralPerson6" } ] }, "physicalPerson": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PhysicalPerson5" } ] }, "activity": { "type": "string", "nullable": true }, "displayEmail": { "description": "Public email.", "type": "string", "nullable": true }, "displayPhone": { "description": "Public phone.", "type": "string", "nullable": true }, "displayWebsite": { "description": "Public website.", "type": "string", "nullable": true }, "displayLogo": { "description": "Public logo.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Media" } ] }, "auditAt": { "type": "string", "format": "date-time", "nullable": true }, "settingClosingTime": { "type": "integer", "default": 10 }, "settingMaxDepositAmount": { "type": "integer", "default": 2500 }, "accountMainAlert": { "type": "string", "nullable": true }, "id": { "description": "Unique identifier of the organisation", "type": "string", "format": "uuid", "example": "550e8400-e29b-41d4-a716-446655440000" }, "displayName": { "description": "Public name.", "type": "string", "nullable": true }, "displayCreatedAt": { "description": "Public created at date.", "type": "string", "format": "date-time", "nullable": true }, "displayAddress": { "description": "Public address.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Address2" } ] } }, "type": "object" }, "RequestSecurityDeposit3": { "required": [ "name", "description", "insuranceActive", "id", "owner", "publicLink", "status", "dtype" ], "properties": { "depositRecipientsNumber": { "description": "Number of participants for the deposit of the request. Recipients can choose if they want to pay all the security deposit or split it between multiple participants.", "type": "integer", "default": 1, "nullable": true }, "startAt": { "description": "Start date of the request.", "type": "string", "format": "date-time", "nullable": true }, "endAt": { "description": "End date of the request.", "type": "string", "format": "date-time", "nullable": true }, "recipientAllowToUpdateStartAt": { "description": "Know if recipient is allow to update start date.", "type": "boolean", "nullable": true }, "recipientAllowToUpdateEndAt": { "description": "Know if recipient is allow to update end date.", "type": "boolean", "nullable": true }, "settingMultipleProductInformationResponse": { "description": "Recipient response to the multiple product information label.", "type": "string", "nullable": true }, "remoteCheckInStatus": { "description": "Status of the check in.", "type": "string", "default": "waiting", "enum": [ "waiting", "done" ], "nullable": true }, "remoteCheckOutStatus": { "description": "Status of the check out.", "type": "string", "default": "waiting", "enum": [ "waiting", "done" ], "nullable": true }, "depositStatus": { "description": "Status of the deposit.", "type": "string", "default": "waiting", "enum": [ "waiting", "done", "in_error" ], "nullable": true }, "identityVerificationStatus": { "description": "Status of the identity verification.", "type": "string", "default": "waiting", "enum": [ "waiting", "done" ], "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true }, "name": { "description": "Name of the request.", "type": "string" }, "description": { "description": "Description of the request.", "type": "string" }, "remoteCheckInOut": { "description": "Active or not the remote check in and check out section.", "type": "boolean", "nullable": true }, "remoteCheckInOutInformation": { "description": "Active or not the remote check in and check out.", "type": "string", "nullable": true }, "depositAmount": { "description": "Amount ask for the deposit.", "type": "number", "format": "float", "nullable": true }, "deposit": { "description": "Active or not the deposit section.", "type": "boolean", "nullable": true }, "depositType": { "description": "Deposit type.", "type": "string", "enum": [ "verification", "blocked", "debit" ], "nullable": true }, "settingMultipleProduct": { "description": "Active or not the multiple product section.", "type": "boolean", "nullable": true }, "settingMultipleProductInformationLabel": { "description": "Display label for recipient who can answer to it in an input text. You can ask a product identification or whatever you want to know what product is in news", "type": "string", "nullable": true }, "recipientMoreInformationLabel": { "description": "Display label for recipient who can answer to it in an input text. You can ask all information you want.", "type": "string", "nullable": true }, "recipientVigilancePoints": { "description": "List of vigilance point you want to display for recipient.", "type": "string", "nullable": true }, "settingDateOptional": { "description": "Active or not the date optional for the recipient. If you pass true, recipient can choose to not fill the date field.", "type": "boolean", "nullable": true }, "settingAuthorizeDepositSharing": { "description": "Setting to authorize deposit sharing, if set to false recipients can't split the deposit. We recommend leaving it set to `true` for large deposits.", "type": "boolean", "default": true, "nullable": true }, "identityVerificationType": { "description": "Type of identity verification to do on the recipient.", "type": "string", "enum": [ "simple", "advanced" ], "nullable": true }, "insurance": { "description": "If it's set to true, recipient can take an insurance during deposit to protect the deposit amount.", "type": "boolean", "nullable": true }, "insuranceMaximumAmount": { "description": "Maximum amount protected by the insurance.", "type": "number", "format": "float", "nullable": true }, "estimatedReleasedAt": { "description": "Estimated release date of the deposit. It's based on the end date of the request and the closing time of the owner.", "type": "string", "format": "date-time", "nullable": true }, "insuranceActive": { "description": "To know if one recipient take the insurance.", "type": "boolean" }, "depositRecipientsPayed": { "description": "Number of recipients that have paid their share.", "type": "integer", "nullable": true }, "depositRecipientsAmountPayed": { "description": "Amount payed by recipients that have paid their share.", "type": "number", "format": "float", "nullable": true }, "depositTransactionAmountPayedDetail": { "description": "Name and amount of the recipients that that have paid their share.", "type": "array", "items": {}, "nullable": true }, "id": { "type": "string" }, "owner": { "$ref": "#/components/schemas/Organisation15" }, "recipientPreFill": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PhysicalPerson5" } ] }, "publicLink": { "type": "string" }, "locale": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "status": { "type": "string" }, "partnerIntegrationType": { "type": "string", "nullable": true }, "partnerReturnSuccessUrl": { "type": "string", "nullable": true }, "partnerReturnFailedUrl": { "type": "string", "nullable": true }, "internalReference": { "type": "string", "nullable": true }, "fullLink": { "type": "string", "nullable": true }, "recipientId": { "type": "string", "nullable": true }, "dtype": { "type": "string" } }, "type": "object", "allOf": [ { "$ref": "#/components/schemas/Request" } ] }, "RequestPayment2": { "required": [ "name", "description", "tvaType", "amount", "amountWithTax", "tvaValue", "id", "owner", "publicLink", "status", "dtype" ], "properties": { "startAt": { "description": "Start date of the request. Use for the timing of the request email sending", "type": "string", "format": "date-time", "nullable": true }, "payedAt": { "description": "Date of the payment.", "type": "string", "format": "date-time", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true }, "name": { "description": "Name of the payment request.", "type": "string" }, "description": { "description": "Description of the payment request.", "type": "string" }, "tvaType": { "description": "TVA type of the payment request.", "type": "string", "enum": [ "FR_09", "FR_21", "FR_40", "FR_55", "FR_60", "FR_65", "FR_85", "FR_92", "FR_100", "FR_130", "FR_196", "FR_200", "AT_100", "AT_130", "AT_200", "BE_60", "BE_120", "BE_210", "BG_90", "BG_200", "CH_25", "CH_37", "CH_77", "CH_26", "CH_38", "CH_81", "CY_50", "CY_90", "CY_190", "CZ_100", "CZ_150", "CZ_210", "DE_70", "DE_190", "DK_250", "EE_90", "EE_200", "ES_40", "ES_100", "ES_210", "FI_100", "FI_140", "FI_240", "GB_50", "GB_200", "GR_60", "GR_130", "GR_240", "HR_50", "HR_130", "HR_250", "HU_50", "HU_180", "HU_270", "IE_48", "IE_90", "IE_135", "IE_210", "IE_230", "IT_40", "IT_50", "IT_100", "IT_220", "LT_50", "LT_90", "LT_210", "LU_30", "LU_70", "LU_80", "LU_130", "LU_140", "LU_160", "LU_170", "LV_50", "LV_120", "LV_210", "MC_09", "MC_21", "MC_55", "MC_85", "MC_100", "MC_200", "MT_50", "MT_70", "MT_180", "NL_90", "NL_210", "PL_50", "PL_80", "PL_230", "PT_60", "PT_130", "PT_230", "RO_50", "RO_90", "RO_190", "SE_60", "SE_120", "SE_250", "SI_50", "SI_95", "SI_220", "SK_100", "SK_200", "exempt", "crossborder", "extracom", "FR_100_construction", "FR_200_construction" ] }, "amount": { "description": "Amount of the payment request.", "type": "number", "format": "float" }, "amountWithTax": { "description": "Amount of the payment request with taxes.", "type": "number", "format": "float" }, "tvaValue": { "description": "TVA value of the payment request.", "type": "number", "format": "float" }, "id": { "type": "string" }, "owner": { "$ref": "#/components/schemas/Organisation15" }, "recipientPreFill": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PhysicalPerson5" } ] }, "publicLink": { "type": "string" }, "locale": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "status": { "type": "string" }, "partnerIntegrationType": { "type": "string", "nullable": true }, "partnerReturnSuccessUrl": { "type": "string", "nullable": true }, "partnerReturnFailedUrl": { "type": "string", "nullable": true }, "internalReference": { "type": "string", "nullable": true }, "fullLink": { "type": "string", "nullable": true }, "recipientId": { "type": "string", "nullable": true }, "dtype": { "type": "string" } }, "type": "object", "allOf": [ { "$ref": "#/components/schemas/Request" } ] }, "ModelRequestPayment": { "required": [ "name", "description", "tvaType", "amount", "amountWithTax", "tvaValue", "id", "publicLink", "dtype" ], "properties": { "createdAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true }, "name": { "description": "Name of the payment request.", "type": "string" }, "description": { "description": "Description of the payment request.", "type": "string" }, "tvaType": { "description": "TVA type of the payment request.", "type": "string", "enum": [ "FR_09", "FR_21", "FR_40", "FR_55", "FR_60", "FR_65", "FR_85", "FR_92", "FR_100", "FR_130", "FR_196", "FR_200", "AT_100", "AT_130", "AT_200", "BE_60", "BE_120", "BE_210", "BG_90", "BG_200", "CH_25", "CH_37", "CH_77", "CH_26", "CH_38", "CH_81", "CY_50", "CY_90", "CY_190", "CZ_100", "CZ_150", "CZ_210", "DE_70", "DE_190", "DK_250", "EE_90", "EE_200", "ES_40", "ES_100", "ES_210", "FI_100", "FI_140", "FI_240", "GB_50", "GB_200", "GR_60", "GR_130", "GR_240", "HR_50", "HR_130", "HR_250", "HU_50", "HU_180", "HU_270", "IE_48", "IE_90", "IE_135", "IE_210", "IE_230", "IT_40", "IT_50", "IT_100", "IT_220", "LT_50", "LT_90", "LT_210", "LU_30", "LU_70", "LU_80", "LU_130", "LU_140", "LU_160", "LU_170", "LV_50", "LV_120", "LV_210", "MC_09", "MC_21", "MC_55", "MC_85", "MC_100", "MC_200", "MT_50", "MT_70", "MT_180", "NL_90", "NL_210", "PL_50", "PL_80", "PL_230", "PT_60", "PT_130", "PT_230", "RO_50", "RO_90", "RO_190", "SE_60", "SE_120", "SE_250", "SI_50", "SI_95", "SI_220", "SK_100", "SK_200", "exempt", "crossborder", "extracom", "FR_100_construction", "FR_200_construction" ] }, "amount": { "description": "Amount of the payment request.", "type": "number", "format": "float" }, "amountWithTax": { "description": "Amount of the payment request with taxes.", "type": "number", "format": "float" }, "tvaValue": { "description": "TVA value of the payment request.", "type": "number", "format": "float" }, "id": { "type": "string" }, "owner": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Organisation15" } ] }, "publicLink": { "type": "string" }, "status": { "type": "string", "nullable": true }, "alreadyWaitingRequest": { "type": "string", "nullable": true }, "alreadyInProgressRequest": { "type": "string", "nullable": true }, "internalReference": { "type": "string", "nullable": true }, "dtype": { "description": "Type of the request.", "type": "string", "enum": [ "security_deposit", "payment" ] } }, "type": "object", "allOf": [ { "$ref": "#/components/schemas/ModelRequest" } ] }, "ModelRequestSecurityDeposit": { "required": [ "name", "description", "id", "publicLink", "dtype" ], "properties": { "createdAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true }, "name": { "description": "Name of the request.", "type": "string" }, "description": { "description": "Description of the request.", "type": "string" }, "remoteCheckInOut": { "description": "Active or not the remote check in and check out section.", "type": "boolean", "nullable": true }, "remoteCheckInOutInformation": { "description": "Active or not the remote check in and check out.", "type": "string", "nullable": true }, "depositAmount": { "description": "Amount ask for the deposit.", "type": "number", "format": "float", "nullable": true }, "deposit": { "description": "Active or not the deposit section.", "type": "boolean", "nullable": true }, "depositType": { "description": "Deposit type.", "type": "string", "enum": [ "verification", "blocked", "debit" ], "nullable": true }, "settingMultipleProduct": { "description": "Active or not the multiple product section.", "type": "boolean", "nullable": true }, "settingMultipleProductInformationLabel": { "description": "Display label for recipient who can answer to it in an input text. You can ask a product identification or whatever you want to know what product is in news", "type": "string", "nullable": true }, "recipientMoreInformationLabel": { "description": "Display label for recipient who can answer to it in an input text. You can ask all information you want.", "type": "string", "nullable": true }, "recipientVigilancePoints": { "description": "List of vigilance point you want to display for recipient.", "type": "string", "nullable": true }, "settingDateOptional": { "description": "Active or not the date optional for the recipient. If you pass true, recipient can choose to not fill the date field.", "type": "boolean", "nullable": true }, "settingAuthorizeDepositSharing": { "description": "Setting to authorize deposit sharing, if set to false recipients can't split the deposit. We recommend leaving it set to `true` for large deposits.", "type": "boolean", "default": true, "nullable": true }, "identityVerificationType": { "description": "Type of identity verification to do on the recipient.", "type": "string", "enum": [ "simple", "advanced" ], "nullable": true }, "insurance": { "description": "If it's set to true, recipient can take an insurance during deposit to protect the deposit amount.", "type": "boolean", "nullable": true }, "insuranceMaximumAmount": { "description": "Maximum amount protected by the insurance.", "type": "number", "format": "float", "nullable": true }, "id": { "type": "string" }, "owner": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Organisation15" } ] }, "publicLink": { "type": "string" }, "status": { "type": "string", "nullable": true }, "alreadyWaitingRequest": { "type": "string", "nullable": true }, "alreadyInProgressRequest": { "type": "string", "nullable": true }, "internalReference": { "type": "string", "nullable": true }, "dtype": { "description": "Type of the request.", "type": "string", "enum": [ "security_deposit", "payment" ] } }, "type": "object", "allOf": [ { "$ref": "#/components/schemas/ModelRequest" } ] }, "DepositRequestSecurityDepositType": { "required": [ "settingMultipleProductInformationResponse", "recipientMoreInformationResponse", "startAt", "endAt", "depositRecipientsNumber" ], "properties": { "settingMultipleProductInformationResponse": { "type": "string" }, "recipientMoreInformationResponse": { "type": "string" }, "startAt": { "type": "string", "format": "date" }, "endAt": { "type": "string", "format": "date" }, "depositRecipientsNumber": { "type": "number" } }, "type": "object" }, "GlobalDepositRequestType": { "required": [ "recipient", "request" ], "properties": { "recipient": { "$ref": "#/components/schemas/OrganisationUpdateType" }, "request": { "$ref": "#/components/schemas/DepositRequestSecurityDepositType" } }, "type": "object" }, "GlobalPaymentRequestType": { "required": [ "recipient" ], "properties": { "recipient": { "$ref": "#/components/schemas/OrganisationUpdateType" } }, "type": "object" }, "OrganisationPaymentMethod": { "required": [ "id", "type", "provider", "providerLibelle", "isExpired" ], "properties": { "id": { "type": "integer" }, "type": { "type": "string" }, "provider": { "type": "string" }, "providerLibelle": { "type": "string" }, "expiredAt": { "type": "string", "format": "date-time", "nullable": true }, "isExpired": { "type": "boolean" } }, "type": "object" }, "Organisation16": { "properties": { "invoiceRecipientName": { "type": "string", "nullable": true }, "invoiceRecipientVAT": { "type": "string", "nullable": true }, "invoiceRecipientVATNumber": { "type": "string", "nullable": true }, "invoiceRecipientSpecialNotes": { "type": "string", "nullable": true }, "invoiceRecipientAddress": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Address" } ] }, "invoiceRecipientEmails": { "type": "array", "items": { "type": "string" }, "nullable": true }, "defaultPaymentMethod": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OrganisationPaymentMethod" } ] }, "offerDefaultPrices": { "type": "array", "items": { "type": "string" }, "nullable": true }, "offerCustomPrices": { "type": "array", "items": { "type": "string" }, "nullable": true }, "offerOptions": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "type": "object" }, "ModelRequestSecurityDeposit2": { "required": [ "recipientInformationDocuments", "name", "description", "id", "publicLink", "dtype" ], "properties": { "recipientInformationDocuments": { "description": "Informations documents related to the recipient.", "type": "array", "items": { "$ref": "#/components/schemas/Media2" } }, "name": { "description": "Name of the request.", "type": "string" }, "description": { "description": "Description of the request.", "type": "string" }, "remoteCheckInOut": { "description": "Active or not the remote check in and check out section.", "type": "boolean", "nullable": true }, "remoteCheckInOutInformation": { "description": "Active or not the remote check in and check out.", "type": "string", "nullable": true }, "depositAmount": { "description": "Amount ask for the deposit.", "type": "number", "format": "float", "nullable": true }, "deposit": { "description": "Active or not the deposit section.", "type": "boolean", "nullable": true }, "depositType": { "description": "Deposit type.", "type": "string", "enum": [ "verification", "blocked", "debit" ], "nullable": true }, "settingMultipleProduct": { "description": "Active or not the multiple product section.", "type": "boolean", "nullable": true }, "settingMultipleProductInformationLabel": { "description": "Display label for recipient who can answer to it in an input text. You can ask a product identification or whatever you want to know what product is in news", "type": "string", "nullable": true }, "recipientMoreInformationLabel": { "description": "Display label for recipient who can answer to it in an input text. You can ask all information you want.", "type": "string", "nullable": true }, "recipientWelcomeMessage": { "description": "Display message for recipient in the deposit asking email.", "type": "string", "nullable": true }, "recipientConfirmMessage": { "description": "Display message for recipient in the deposit confirm email.", "type": "string", "nullable": true }, "recipientVigilancePoints": { "description": "List of vigilance point you want to display for recipient.", "type": "string", "nullable": true }, "settingDateOptional": { "description": "Active or not the date optional for the recipient. If you pass true, recipient can choose to not fill the date field.", "type": "boolean", "nullable": true }, "settingDepositAutomaticEmailRelaunch": { "description": "Active or not the automatic email relaunch for deposit. If the recipient have not completed the deposit, an email will be sent to him.", "type": "boolean", "nullable": true }, "settingMultipleCashOutOption": { "description": "Active or not the possibility to do multiple cashOut on the same request. (This is not disponible for all owner - contact us to know more)", "type": "boolean", "nullable": true }, "settingAuthorizeDepositSharing": { "description": "Setting to authorize deposit sharing, if set to false recipients can't split the deposit. We recommend leaving it set to `true` for large deposits.", "type": "boolean", "default": true, "nullable": true }, "identityVerificationType": { "description": "Type of identity verification to do on the recipient.", "type": "string", "enum": [ "simple", "advanced" ], "nullable": true }, "insurance": { "description": "If it's set to true, recipient can take an insurance during deposit to protect the deposit amount.", "type": "boolean", "nullable": true }, "insuranceMaximumAmount": { "description": "Maximum amount protected by the insurance.", "type": "number", "format": "float", "nullable": true }, "id": { "type": "string" }, "owner": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Organisation" } ] }, "publicLink": { "type": "string" }, "status": { "type": "string", "nullable": true }, "emailSendTiming": { "type": "string", "nullable": true }, "internalReference": { "type": "string", "nullable": true }, "dtype": { "description": "Type of the request.", "type": "string", "enum": [ "security_deposit", "payment" ] } }, "type": "object", "allOf": [ { "$ref": "#/components/schemas/ModelRequest" } ] }, "ModelRequestPayment2": { "required": [ "name", "description", "tvaType", "amount", "amountWithTax", "tvaValue", "id", "publicLink", "dtype" ], "properties": { "name": { "description": "Name of the payment request.", "type": "string" }, "description": { "description": "Description of the payment request.", "type": "string" }, "tvaType": { "description": "TVA type of the payment request.", "type": "string", "enum": [ "FR_09", "FR_21", "FR_40", "FR_55", "FR_60", "FR_65", "FR_85", "FR_92", "FR_100", "FR_130", "FR_196", "FR_200", "AT_100", "AT_130", "AT_200", "BE_60", "BE_120", "BE_210", "BG_90", "BG_200", "CH_25", "CH_37", "CH_77", "CH_26", "CH_38", "CH_81", "CY_50", "CY_90", "CY_190", "CZ_100", "CZ_150", "CZ_210", "DE_70", "DE_190", "DK_250", "EE_90", "EE_200", "ES_40", "ES_100", "ES_210", "FI_100", "FI_140", "FI_240", "GB_50", "GB_200", "GR_60", "GR_130", "GR_240", "HR_50", "HR_130", "HR_250", "HU_50", "HU_180", "HU_270", "IE_48", "IE_90", "IE_135", "IE_210", "IE_230", "IT_40", "IT_50", "IT_100", "IT_220", "LT_50", "LT_90", "LT_210", "LU_30", "LU_70", "LU_80", "LU_130", "LU_140", "LU_160", "LU_170", "LV_50", "LV_120", "LV_210", "MC_09", "MC_21", "MC_55", "MC_85", "MC_100", "MC_200", "MT_50", "MT_70", "MT_180", "NL_90", "NL_210", "PL_50", "PL_80", "PL_230", "PT_60", "PT_130", "PT_230", "RO_50", "RO_90", "RO_190", "SE_60", "SE_120", "SE_250", "SI_50", "SI_95", "SI_220", "SK_100", "SK_200", "exempt", "crossborder", "extracom", "FR_100_construction", "FR_200_construction" ] }, "amount": { "description": "Amount of the payment request.", "type": "number", "format": "float" }, "amountWithTax": { "description": "Amount of the payment request with taxes.", "type": "number", "format": "float" }, "tvaValue": { "description": "TVA value of the payment request.", "type": "number", "format": "float" }, "id": { "type": "string" }, "owner": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Organisation" } ] }, "publicLink": { "type": "string" }, "status": { "type": "string", "nullable": true }, "emailSendTiming": { "type": "string", "nullable": true }, "internalReference": { "type": "string", "nullable": true }, "dtype": { "description": "Type of the request.", "type": "string", "enum": [ "security_deposit", "payment" ] } }, "type": "object", "allOf": [ { "$ref": "#/components/schemas/ModelRequest" } ] }, "ModelRequest4": { "required": [ "id" ], "properties": { "deletedAt": { "type": "string", "format": "date-time", "nullable": true }, "id": { "type": "string" } }, "type": "object" }, "ModelRequestPaymentType": { "description": "Model Request Payment form data - Template for payment requests", "required": [ "name", "description", "amount", "tvaType", "name", "description", "amount", "tvaType" ], "properties": { "name": { "description": "Name of the model request template", "type": "string", "maxLength": 255, "example": "Service Payment" }, "description": { "description": "Description of the payment request", "type": "string", "maxLength": 255, "example": "Payment for professional services" }, "amount": { "description": "Amount of the payment (excluding VAT)", "type": "string", "maxLength": 255, "example": "100.00" }, "tvaType": { "description": "VAT rate type to apply", "type": "string", "enum": [ "FR_09", "FR_21", "FR_40", "FR_55", "FR_60", "FR_65", "FR_85", "FR_92", "FR_100", "FR_130", "FR_196", "FR_200", "AT_100", "AT_130", "AT_200", "BE_60", "BE_120", "BE_210", "BG_90", "BG_200", "CH_25", "CH_37", "CH_77", "CH_26", "CH_38", "CH_81", "CY_50", "CY_90", "CY_190", "CZ_100", "CZ_150", "CZ_210", "DE_70", "DE_190", "DK_250", "EE_90", "EE_200", "ES_40", "ES_100", "ES_210", "FI_100", "FI_140", "FI_240", "GB_50", "GB_200", "GR_60", "GR_130", "GR_240", "HR_50", "HR_130", "HR_250", "HU_50", "HU_180", "HU_270", "IE_48", "IE_90", "IE_135", "IE_210", "IE_230", "IT_40", "IT_50", "IT_100", "IT_220", "LT_50", "LT_90", "LT_210", "LU_30", "LU_70", "LU_80", "LU_130", "LU_140", "LU_160", "LU_170", "LV_50", "LV_120", "LV_210", "MC_09", "MC_21", "MC_55", "MC_85", "MC_100", "MC_200", "MT_50", "MT_70", "MT_180", "NL_90", "NL_210", "PL_50", "PL_80", "PL_230", "PT_60", "PT_130", "PT_230", "RO_50", "RO_90", "RO_190", "SE_60", "SE_120", "SE_250", "SI_50", "SI_95", "SI_220", "SK_100", "SK_200", "exempt", "crossborder", "extracom", "FR_100_construction", "FR_200_construction" ], "example": "FR_200" }, "status": { "description": "Status of the model", "type": "string", "default": "inline", "enum": [ "inline", "desactivate" ], "example": "inline", "nullable": true }, "internalReference": { "description": "Internal reference for the model", "type": "string", "maxLength": 255, "nullable": true } }, "type": "object" }, "ModelRequestSecurityDepositType": { "description": "Model Request Security Deposit form data - Template for security deposit requests", "required": [ "name", "description", "name", "description" ], "properties": { "name": { "description": "Name of the model request template", "type": "string", "maxLength": 255, "example": "Standard Security Deposit" }, "description": { "description": "Description of the model request", "type": "string", "maxLength": 255, "example": "Security deposit for vacation rental" }, "deposit": { "description": "Whether a security deposit is required", "type": "boolean", "example": true, "nullable": true }, "depositAmount": { "description": "Amount of the security deposit (required when deposit is true)", "type": "number", "format": "float", "example": 500, "nullable": true }, "depositType": { "description": "Type of deposit (required when deposit is true)", "type": "string", "enum": [ "verification", "blocked", "debit" ], "example": "blocked", "nullable": true }, "identityVerificationType": { "description": "Type of identity verification required", "type": "string", "enum": [ "simple", "advanced" ], "example": "simple", "nullable": true }, "remoteCheckInOut": { "description": "Whether remote check-in/check-out is enabled", "type": "boolean", "example": false, "nullable": true }, "remoteCheckInOutInformation": { "description": "Information about remote check-in/check-out process", "type": "string", "maxLength": 255, "nullable": true }, "recipientWelcomeMessage": { "description": "Welcome message displayed to the recipient", "type": "string", "maxLength": 255, "nullable": true }, "recipientConfirmMessage": { "description": "Confirmation message displayed to the recipient", "type": "string", "maxLength": 255, "nullable": true }, "recipientVigilancePoints": { "description": "Vigilance points to communicate to the recipient", "type": "string", "maxLength": 255, "nullable": true }, "recipientInformationDocuments": { "description": "List of document IDs to provide as information to recipient", "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "internalReference": { "description": "Internal reference for the model", "type": "string", "maxLength": 255, "nullable": true }, "settingMultipleProduct": { "description": "Whether multiple products can be specified", "type": "boolean", "example": false, "nullable": true }, "settingAuthorizeDepositSharing": { "description": "Whether deposit can be shared between multiple recipients", "type": "boolean", "example": false, "nullable": true }, "settingMultipleProductInformationLabel": { "description": "Label for multiple product information (required when settingMultipleProduct is true)", "type": "string", "maxLength": 255, "nullable": true }, "recipientMoreInformationLabel": { "description": "Label for additional information requested from recipient", "type": "string", "maxLength": 255, "nullable": true }, "insurance": { "description": "Whether insurance is offered", "type": "boolean", "example": false, "nullable": true }, "insuranceMaximumAmount": { "description": "Maximum insurance coverage amount", "type": "number", "format": "float", "nullable": true }, "settingDateOptional": { "description": "Whether dates are optional for the request", "type": "boolean", "example": false, "nullable": true }, "settingDepositAutomaticEmailRelaunch": { "description": "Whether automatic email reminders are enabled", "type": "boolean", "example": false, "nullable": true }, "settingMultipleCashOutOption": { "description": "Whether multiple cash-out operations are allowed", "type": "boolean", "example": false, "nullable": true }, "emailSendTiming": { "description": "When to send the request email", "type": "string", "default": "instant", "enum": [ "instant", "month_before", "week_before", "72_hours_before", "48_hours_before", "24_hours_before", "none" ], "example": "instant", "nullable": true }, "status": { "description": "Status of the model", "type": "string", "default": "inline", "enum": [ "inline", "desactivate" ], "example": "inline", "nullable": true } }, "type": "object" }, "AMCashInResponse": { "required": [ "id", "redirectUrl", "paymentUrl", "paymentToken" ], "properties": { "paymentAmount": { "type": "number", "format": "float", "nullable": true }, "id": { "type": "string" }, "redirectUrl": { "type": "string" }, "paymentUrl": { "type": "string" }, "paymentToken": { "type": "string" } }, "type": "object" }, "AMTRXCreditCardInfo": { "properties": { "id": { "type": "string", "default": null, "nullable": true }, "creationDate": { "default": null, "nullable": true, "oneOf": [ { "type": "string", "format": "date-time", "nullable": true }, { "type": "string", "nullable": true } ] }, "tag": { "type": "string", "default": null, "nullable": true }, "status": { "type": "string", "default": null, "nullable": true }, "number": { "type": "string", "default": null, "nullable": true }, "expiryDate": { "type": "string", "default": null, "nullable": true }, "brand": { "type": "string", "default": null, "nullable": true }, "holderName": { "type": "string", "default": null, "nullable": true }, "hash": { "type": "string", "nullable": true }, "pspErrorCode": { "type": "string", "default": null, "nullable": true }, "saveCardOption": { "type": "string", "default": null, "nullable": true }, "displayCards": { "type": "string", "default": null, "nullable": true }, "autoConfirm": { "type": "string", "default": null, "nullable": true }, "partnerReturnUrl": { "type": "string", "default": null, "nullable": true }, "partnerReturnUrlFail": { "type": "string", "default": null, "nullable": true } }, "type": "object" }, "AMBankTransfer": { "required": [ "bankTransferType", "lang", "country", "description", "pspTransactionId", "pspTransactionState", "pspBankId", "partnerReturnUrl", "partnerReturnUrlFail" ], "properties": { "bankTransferType": { "type": "string" }, "lang": { "type": "string" }, "country": { "type": "string" }, "description": { "type": "string" }, "payerLabel": { "type": "string", "default": null, "nullable": true }, "payerIban": { "type": "string", "default": null, "nullable": true }, "payerBic": { "type": "string", "default": null, "nullable": true }, "payerBankName": { "type": "string", "default": null, "nullable": true }, "pspTransactionId": { "type": "string" }, "pspTransactionState": { "type": "string" }, "pspBankId": { "type": "string" }, "pspErrorCode": { "type": "string", "default": null, "nullable": true }, "pspErrorDescription": { "type": "string", "default": null, "nullable": true }, "partnerReturnUrl": { "type": "string" }, "partnerReturnUrlFail": { "type": "string" } }, "type": "object" }, "AMBankWire": { "required": [ "iban", "paymentStatus", "overpaymentAllowed", "underpaymentAllowed" ], "properties": { "iban": { "type": "string" }, "bic": { "type": "string", "default": null, "nullable": true }, "paymentStatus": { "type": "string" }, "overpaymentAllowed": { "type": "boolean" }, "underpaymentAllowed": { "type": "boolean" } }, "type": "object" }, "AMTRXBankAccountInfo": { "required": [ "id", "creationDate", "tag", "status", "number", "holderName" ], "properties": { "id": { "type": "string" }, "creationDate": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "string" } ] }, "tag": { "type": "string" }, "status": { "type": "string" }, "number": { "type": "string" }, "bic": { "type": "string", "default": null, "nullable": true }, "bankName": { "type": "string", "default": null, "nullable": true }, "holderName": { "type": "string" } }, "type": "object" }, "AMTransaction": { "required": [ "id", "status", "type", "tag", "paymentMethod", "creationDate", "partnerRef", "amount", "currency" ], "properties": { "id": { "type": "string" }, "refunds": { "type": "array", "items": {}, "default": null, "nullable": true }, "initialTrxId": { "type": "string", "default": null, "nullable": true }, "status": { "type": "string" }, "type": { "type": "string" }, "tag": { "type": "string" }, "paymentMethod": { "type": "string" }, "creationDate": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "string" } ] }, "authorizationDate": { "default": null, "nullable": true, "oneOf": [ { "type": "string", "format": "date-time", "nullable": true }, { "type": "string", "nullable": true } ] }, "authorizationTimeoutDate": { "default": null, "nullable": true, "oneOf": [ { "type": "string", "format": "date-time", "nullable": true }, { "type": "string", "nullable": true } ] }, "executionDate": { "default": null, "nullable": true, "oneOf": [ { "type": "string", "format": "date-time", "nullable": true }, { "type": "string", "nullable": true } ] }, "partnerRef": { "type": "string" }, "payerAccountId": { "type": "string", "default": null, "nullable": true }, "senderWalletId": { "type": "string", "default": null, "nullable": true }, "receiverWalletId": { "type": "string", "default": null, "nullable": true }, "feesWalletId": { "type": "string", "default": null, "nullable": true }, "amount": { "type": "number", "format": "float" }, "authorizedAmount": { "type": "number", "format": "float", "nullable": true }, "fees": { "type": "number", "format": "float", "default": null, "nullable": true }, "currency": { "type": "string" }, "refundedAmount": { "type": "number", "format": "float", "default": null, "nullable": true }, "refundedFees": { "type": "number", "format": "float", "default": null, "nullable": true }, "creditCard": { "default": null, "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AMTRXCreditCardInfo" } ] }, "bankTransfer": { "default": null, "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AMBankTransfer" } ] }, "bankWire": { "default": null, "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AMBankWire" } ] }, "bankAccount": { "default": null, "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AMTRXBankAccountInfo" } ] }, "errorCode": { "type": "string", "default": null, "nullable": true }, "errorDetails": { "type": "string", "default": null, "nullable": true } }, "type": "object" }, "OrganisationPaymentMethod2": { "type": "object" }, "PhysicalPerson6": { "required": [ "id" ], "properties": { "auditAt": { "type": "string", "format": "date-time", "nullable": true }, "id": { "type": "string" }, "secondaryEmail": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "secondaryPhone": { "type": "string", "nullable": true }, "firstname": { "type": "string", "nullable": true }, "lastname": { "type": "string", "nullable": true }, "birthday": { "type": "string", "format": "date-time", "nullable": true }, "birthdayAddress": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Address2" } ] }, "address": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Address2" } ] }, "monthlyIncome": { "description": "Monthly income.", "type": "string", "enum": [ "LOWER_THAN_1200_EUROS", "BETWEEN_1200_2500_EUROS", "BETWEEN_2500_4000_EUROS", "GREATER_THAN_4000_EUROS" ], "nullable": true }, "profession": { "description": "Profession.", "type": "string", "enum": [ "FARMER", "CRAFTSMAN_MERCHANT_ENTREPRENEUR", "LIBERAL_PROFESSION", "EXECUTIVE", "RETIREE", "EMPLOYEE", "WORKER", "NO_ACTIVITY" ], "nullable": true }, "nationality": { "description": "Nationality in alpha3 country code.", "type": "string", "enum": [ "afg", "zaf", "alb", "dza", "deu", "and", "ago", "atg", "sau", "arg", "arm", "aus", "aut", "aze", "bhs", "bhr", "bgd", "brb", "blr", "bel", "blz", "ben", "btn", "bol", "bih", "bwa", "bra", "brn", "bgr", "bfa", "bdi", "khm", "cmr", "can", "cpv", "caf", "chl", "chn", "cyp", "col", "com", "cog", "cod", "kor", "prk", "cri", "civ", "hrv", "cub", "dnk", "dji", "dom", "dma", "egy", "slv", "are", "ecu", "eri", "esp", "est", "usa", "eth", "fji", "fin", "fra", "gab", "gmb", "geo", "gha", "grc", "grd", "gtm", "gin", "gnb", "gnq", "guy", "hti", "hnd", "hun", "ind", "idn", "irn", "irq", "irl", "isl", "isr", "ita", "jam", "jpn", "jor", "kaz", "ken", "kgz", "kir", "kwt", "lao", "lso", "lva", "lbn", "lbr", "lby", "lie", "ltu", "lux", "mkd", "mdg", "mys", "mwi", "mdv", "mli", "mlt", "mar", "mhl", "mus", "mrt", "mex", "fsm", "mda", "mco", "mng", "mne", "moz", "mmr", "nam", "nru", "npl", "nic", "ner", "nga", "nor", "nzl", "omn", "uga", "uzb", "pak", "plw", "pan", "png", "pry", "nld", "per", "phl", "pol", "prt", "qat", "rou", "gbr", "rus", "rwa", "kna", "smr", "vct", "lca", "slb", "wsm", "stp", "sen", "srb", "syc", "sle", "sgp", "svk", "svn", "som", "sdn", "ssd", "lka", "swe", "che", "sur", "swz", "syr", "tjk", "tza", "tcd", "cze", "tha", "tls", "tgo", "ton", "tto", "tun", "tkm", "tur", "tuv", "ukr", "ury", "vut", "ven", "vnm", "yem", "zmb", "zwe" ], "nullable": true }, "status": { "type": "string", "default": "waiting" }, "identityDocument": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Document2" } ] }, "mandatoryInfos": { "type": "array", "items": { "type": "string" }, "default": [] }, "uncompletedInfos": { "type": "array", "items": { "type": "string" }, "default": [] }, "createdAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true }, "email": { "type": "string", "nullable": true } }, "type": "object" }, "MoralPerson7": { "properties": { "companyName": { "type": "string", "nullable": true }, "companyEmail": { "type": "string", "nullable": true }, "companyType": { "type": "string", "nullable": true }, "companyRegistrationNumber": { "type": "string", "nullable": true }, "address": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Address2" } ] }, "status": { "type": "string", "default": "waiting" }, "headOfCompany": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PhysicalPerson6" } ] }, "proofOfAddressDocument": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Document2" } ] }, "kbisDocument": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Document2" } ] }, "financialInfoDocument": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Document2" } ] }, "statusDocument": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Document2" } ] }, "mandatoryInfos": { "type": "array", "items": { "type": "string" }, "default": [] }, "uncompletedInfos": { "type": "array", "items": { "type": "string" }, "default": [] }, "createdAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true } }, "type": "object" }, "Organisation17": { "required": [ "accountType", "organisationConnectors", "id", "walletFunctionalities", "invoiceFunctionalities" ], "properties": { "organisationName": { "type": "string", "nullable": true }, "accountType": { "type": "string" }, "legalType": { "type": "string", "nullable": true }, "kycLevel": { "type": "string", "default": "LEVEL_0", "nullable": true }, "amAccountId": { "type": "string", "nullable": true }, "amWalletId": { "type": "string", "nullable": true }, "amSequestrationWalletId": { "type": "string", "nullable": true }, "amAccountStatus": { "type": "string", "nullable": true }, "amAccountErrorCode": { "type": "integer", "nullable": true }, "amValidationAskAt": { "type": "string", "format": "date-time", "nullable": true }, "amValidationUpdateAt": { "type": "string", "format": "date-time", "nullable": true }, "amValidationStatus": { "type": "string", "nullable": true }, "amValidationError": { "type": "string", "nullable": true }, "amValidationErrorDescription": { "type": "string", "nullable": true }, "moralPerson": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MoralPerson7" } ] }, "physicalPerson": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PhysicalPerson6" } ] }, "creatorPhysicalPerson": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PhysicalPerson6" } ] }, "accountForWho": { "type": "string", "nullable": true }, "currentRelation": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OrganisationUserModel2" } ] }, "activity": { "type": "string", "nullable": true }, "displayEmail": { "description": "Public email.", "type": "string", "nullable": true }, "displayPhone": { "description": "Public phone.", "type": "string", "nullable": true }, "displayWebsite": { "description": "Public website.", "type": "string", "nullable": true }, "displayLogo": { "description": "Public logo.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Media2" } ] }, "receiverBankAccount": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ReceiverBankAccount3" } ] }, "activatedFunctionality": { "type": "string", "nullable": true }, "auditAt": { "type": "string", "format": "date-time", "nullable": true }, "settingClosingTime": { "type": "integer", "default": 10 }, "settingMaxDepositAmount": { "type": "integer", "default": 2500 }, "settingRequestEmailSendTiming": { "type": "string", "default": "instant", "nullable": true }, "settingForceIdentityDocument": { "type": "boolean", "default": false }, "settingMultipleCashOut": { "type": "boolean", "default": false }, "settingInsurance": { "type": "boolean", "default": true }, "organisationConnectors": { "type": "array", "items": { "$ref": "#/components/schemas/OrganisationConnector2" } }, "id": { "description": "Unique identifier of the organisation", "type": "string", "format": "uuid", "example": "550e8400-e29b-41d4-a716-446655440000" }, "parent": { "type": "string", "nullable": true }, "parentData": { "nullable": true, "oneOf": [ { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Organisation17" } ] }, { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Organisation10" } ] } ] }, "displayName": { "description": "Public name.", "type": "string", "nullable": true }, "displayCreatedAt": { "description": "Public created at date.", "type": "string", "format": "date-time", "nullable": true }, "displayAddress": { "description": "Public address.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Address2" } ] }, "effectiveFunctionality": { "type": "string", "nullable": true }, "walletFunctionalities": { "type": "boolean" }, "invoiceFunctionalities": { "type": "boolean" }, "littleBondSubscription": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Subscription3" } ] } }, "type": "object" }, "CheckInOut4": { "properties": { "recipient": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Organisation17" } ] }, "createdAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true } }, "type": "object" }, "OrganisationTransaction5": { "required": [ "id", "provider", "status" ], "properties": { "id": { "type": "string" }, "provider": { "description": "External provider of the transaction. Our payment partner.", "type": "string" }, "providerId": { "description": "External id of the transaction. Our payment partner transaction ID.", "type": "string", "nullable": true }, "payer": { "description": "Account who paid the transaction.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Organisation17" } ] }, "status": { "type": "string" }, "authorizedAmount": { "description": "3DS authorisation amount.", "type": "number", "format": "float", "nullable": true }, "amount": { "description": "Amount.", "type": "number", "format": "float", "nullable": true } }, "type": "object" }, "RequestSecurityDeposit4": { "required": [ "cashOuts", "recipientInformationDocuments", "name", "description", "insuranceActive", "canEdit", "id", "owner", "publicLink", "status", "emailSendTiming", "organisationTransactions", "requestEvents", "dtype" ], "properties": { "depositRecipientsNumber": { "description": "Number of participants for the deposit of the request. Recipients can choose if they want to pay all the security deposit or split it between multiple participants.", "type": "integer", "default": 1, "nullable": true }, "startAt": { "description": "Start date of the request.", "type": "string", "format": "date-time", "nullable": true }, "endAt": { "description": "End date of the request.", "type": "string", "format": "date-time", "nullable": true }, "recipientAllowToUpdateStartAt": { "description": "Know if recipient is allow to update start date.", "type": "boolean", "nullable": true }, "recipientAllowToUpdateEndAt": { "description": "Know if recipient is allow to update end date.", "type": "boolean", "nullable": true }, "settingMultipleProductInformationResponse": { "description": "Recipient response to the multiple product information label.", "type": "string", "nullable": true }, "recipientMoreInformationResponse": { "description": "Recipient response to the more information label.", "type": "string", "nullable": true }, "remoteCheckInStatus": { "description": "Status of the check in.", "type": "string", "default": "waiting", "enum": [ "waiting", "done" ], "nullable": true }, "remoteCheckOutStatus": { "description": "Status of the check out.", "type": "string", "default": "waiting", "enum": [ "waiting", "done" ], "nullable": true }, "depositStatus": { "description": "Status of the deposit.", "type": "string", "default": "waiting", "enum": [ "waiting", "done", "in_error" ], "nullable": true }, "identityVerificationStatus": { "description": "Status of the identity verification.", "type": "string", "default": "waiting", "enum": [ "waiting", "done" ], "nullable": true }, "remoteCheckIn": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CheckInOut4" } ] }, "remoteCheckOut": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CheckInOut4" } ] }, "cashOuts": { "type": "array", "items": { "$ref": "#/components/schemas/CashOut" } }, "createdAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true }, "recipientInformationDocuments": { "description": "Informations documents related to the recipient.", "type": "array", "items": { "$ref": "#/components/schemas/Media2" } }, "name": { "description": "Name of the request.", "type": "string" }, "description": { "description": "Description of the request.", "type": "string" }, "remoteCheckInOut": { "description": "Active or not the remote check in and check out section.", "type": "boolean", "nullable": true }, "remoteCheckInOutInformation": { "description": "Active or not the remote check in and check out.", "type": "string", "nullable": true }, "depositAmount": { "description": "Amount ask for the deposit.", "type": "number", "format": "float", "nullable": true }, "deposit": { "description": "Active or not the deposit section.", "type": "boolean", "nullable": true }, "depositType": { "description": "Deposit type.", "type": "string", "enum": [ "verification", "blocked", "debit" ], "nullable": true }, "settingMultipleProduct": { "description": "Active or not the multiple product section.", "type": "boolean", "nullable": true }, "settingMultipleProductInformationLabel": { "description": "Display label for recipient who can answer to it in an input text. You can ask a product identification or whatever you want to know what product is in news", "type": "string", "nullable": true }, "recipientMoreInformationLabel": { "description": "Display label for recipient who can answer to it in an input text. You can ask all information you want.", "type": "string", "nullable": true }, "recipientWelcomeMessage": { "description": "Display message for recipient in the deposit asking email.", "type": "string", "nullable": true }, "recipientConfirmMessage": { "description": "Display message for recipient in the deposit confirm email.", "type": "string", "nullable": true }, "recipientVigilancePoints": { "description": "List of vigilance point you want to display for recipient.", "type": "string", "nullable": true }, "settingDateOptional": { "description": "Active or not the date optional for the recipient. If you pass true, recipient can choose to not fill the date field.", "type": "boolean", "nullable": true }, "settingDepositAutomaticEmailRelaunch": { "description": "Active or not the automatic email relaunch for deposit. If the recipient have not completed the deposit, an email will be sent to him.", "type": "boolean", "nullable": true }, "settingMultipleCashOutOption": { "description": "Active or not the possibility to do multiple cashOut on the same request. (This is not disponible for all owner - contact us to know more)", "type": "boolean", "nullable": true }, "settingAuthorizeDepositSharing": { "description": "Setting to authorize deposit sharing, if set to false recipients can't split the deposit. We recommend leaving it set to `true` for large deposits.", "type": "boolean", "default": true, "nullable": true }, "identityVerificationType": { "description": "Type of identity verification to do on the recipient.", "type": "string", "enum": [ "simple", "advanced" ], "nullable": true }, "insurance": { "description": "If it's set to true, recipient can take an insurance during deposit to protect the deposit amount.", "type": "boolean", "nullable": true }, "insuranceMaximumAmount": { "description": "Maximum amount protected by the insurance.", "type": "number", "format": "float", "nullable": true }, "estimatedReleasedAt": { "description": "Estimated release date of the deposit. It's based on the end date of the request and the closing time of the owner.", "type": "string", "format": "date-time", "nullable": true }, "insuranceActive": { "description": "To know if one recipient take the insurance.", "type": "boolean" }, "depositRecipientsPayed": { "description": "Number of recipients that have paid their share.", "type": "integer", "nullable": true }, "depositRecipientsAmountPayed": { "description": "Amount payed by recipients that have paid their share.", "type": "number", "format": "float", "nullable": true }, "depositTransactionAmountPayedDetail": { "description": "Name and amount of the recipients that that have paid their share.", "type": "array", "items": {}, "nullable": true }, "cashOutAllow": { "description": "Property to know if a cashOut request is actually allow on the deposit.", "type": "boolean", "nullable": true }, "cashOutMaximumAmount": { "description": "Property to know the maximum amount that can be set to a cashOut request.", "type": "number", "format": "float", "nullable": true }, "canEdit": { "description": "Property to know if the request ca be edit or no.", "type": "boolean" }, "id": { "type": "string" }, "model": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ModelRequest3" } ] }, "owner": { "$ref": "#/components/schemas/Organisation17" }, "recipient": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Organisation17" } ] }, "recipientPreFill": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PhysicalPerson6" } ] }, "publicLink": { "type": "string" }, "source": { "type": "string", "nullable": true }, "locale": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "status": { "type": "string" }, "emailSendTiming": { "type": "string" }, "organisationTransactions": { "type": "array", "items": { "$ref": "#/components/schemas/OrganisationTransaction5" } }, "requestEvents": { "type": "array", "items": { "$ref": "#/components/schemas/RequestEvent2" } }, "partnerIntegrationType": { "type": "string", "nullable": true }, "partnerReturnSuccessUrl": { "type": "string", "nullable": true }, "partnerReturnFailedUrl": { "type": "string", "nullable": true }, "partnerName": { "type": "string", "nullable": true }, "partnerRef": { "type": "string", "nullable": true }, "internalReference": { "type": "string", "nullable": true }, "fullLink": { "type": "string", "nullable": true }, "recipientId": { "type": "string", "nullable": true }, "dtype": { "type": "string" } }, "type": "object", "allOf": [ { "$ref": "#/components/schemas/Request" } ] }, "RequestPayment3": { "required": [ "name", "description", "tvaType", "amount", "amountWithTax", "tvaValue", "canEdit", "id", "owner", "publicLink", "status", "emailSendTiming", "organisationTransactions", "requestEvents", "dtype" ], "properties": { "startAt": { "description": "Start date of the request. Use for the timing of the request email sending", "type": "string", "format": "date-time", "nullable": true }, "payedAt": { "description": "Date of the payment.", "type": "string", "format": "date-time", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true }, "name": { "description": "Name of the payment request.", "type": "string" }, "description": { "description": "Description of the payment request.", "type": "string" }, "tvaType": { "description": "TVA type of the payment request.", "type": "string", "enum": [ "FR_09", "FR_21", "FR_40", "FR_55", "FR_60", "FR_65", "FR_85", "FR_92", "FR_100", "FR_130", "FR_196", "FR_200", "AT_100", "AT_130", "AT_200", "BE_60", "BE_120", "BE_210", "BG_90", "BG_200", "CH_25", "CH_37", "CH_77", "CH_26", "CH_38", "CH_81", "CY_50", "CY_90", "CY_190", "CZ_100", "CZ_150", "CZ_210", "DE_70", "DE_190", "DK_250", "EE_90", "EE_200", "ES_40", "ES_100", "ES_210", "FI_100", "FI_140", "FI_240", "GB_50", "GB_200", "GR_60", "GR_130", "GR_240", "HR_50", "HR_130", "HR_250", "HU_50", "HU_180", "HU_270", "IE_48", "IE_90", "IE_135", "IE_210", "IE_230", "IT_40", "IT_50", "IT_100", "IT_220", "LT_50", "LT_90", "LT_210", "LU_30", "LU_70", "LU_80", "LU_130", "LU_140", "LU_160", "LU_170", "LV_50", "LV_120", "LV_210", "MC_09", "MC_21", "MC_55", "MC_85", "MC_100", "MC_200", "MT_50", "MT_70", "MT_180", "NL_90", "NL_210", "PL_50", "PL_80", "PL_230", "PT_60", "PT_130", "PT_230", "RO_50", "RO_90", "RO_190", "SE_60", "SE_120", "SE_250", "SI_50", "SI_95", "SI_220", "SK_100", "SK_200", "exempt", "crossborder", "extracom", "FR_100_construction", "FR_200_construction" ] }, "amount": { "description": "Amount of the payment request.", "type": "number", "format": "float" }, "amountWithTax": { "description": "Amount of the payment request with taxes.", "type": "number", "format": "float" }, "tvaValue": { "description": "TVA value of the payment request.", "type": "number", "format": "float" }, "canEdit": { "description": "Property to know if the request ca be edit or no.", "type": "boolean" }, "id": { "type": "string" }, "model": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ModelRequest3" } ] }, "owner": { "$ref": "#/components/schemas/Organisation17" }, "recipient": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Organisation17" } ] }, "recipientPreFill": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PhysicalPerson6" } ] }, "publicLink": { "type": "string" }, "source": { "type": "string", "nullable": true }, "locale": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "status": { "type": "string" }, "emailSendTiming": { "type": "string" }, "organisationTransactions": { "type": "array", "items": { "$ref": "#/components/schemas/OrganisationTransaction5" } }, "requestEvents": { "type": "array", "items": { "$ref": "#/components/schemas/RequestEvent2" } }, "partnerIntegrationType": { "type": "string", "nullable": true }, "partnerReturnSuccessUrl": { "type": "string", "nullable": true }, "partnerReturnFailedUrl": { "type": "string", "nullable": true }, "partnerName": { "type": "string", "nullable": true }, "partnerRef": { "type": "string", "nullable": true }, "internalReference": { "type": "string", "nullable": true }, "fullLink": { "type": "string", "nullable": true }, "recipientId": { "type": "string", "nullable": true }, "dtype": { "type": "string" } }, "type": "object", "allOf": [ { "$ref": "#/components/schemas/Request" } ] }, "Document3": { "required": [ "id", "type", "medias" ], "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "status": { "type": "string", "default": "provide" }, "medias": { "type": "array", "items": { "$ref": "#/components/schemas/Media" } } }, "type": "object" }, "PhysicalPerson7": { "required": [ "id" ], "properties": { "auditAt": { "type": "string", "format": "date-time", "nullable": true }, "id": { "type": "string" }, "secondaryEmail": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "secondaryPhone": { "type": "string", "nullable": true }, "firstname": { "type": "string", "nullable": true }, "lastname": { "type": "string", "nullable": true }, "birthday": { "type": "string", "format": "date-time", "nullable": true }, "birthdayAddress": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Address" } ] }, "address": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Address" } ] }, "monthlyIncome": { "description": "Monthly income.", "type": "string", "enum": [ "LOWER_THAN_1200_EUROS", "BETWEEN_1200_2500_EUROS", "BETWEEN_2500_4000_EUROS", "GREATER_THAN_4000_EUROS" ], "nullable": true }, "profession": { "description": "Profession.", "type": "string", "enum": [ "FARMER", "CRAFTSMAN_MERCHANT_ENTREPRENEUR", "LIBERAL_PROFESSION", "EXECUTIVE", "RETIREE", "EMPLOYEE", "WORKER", "NO_ACTIVITY" ], "nullable": true }, "nationality": { "description": "Nationality in alpha3 country code.", "type": "string", "enum": [ "afg", "zaf", "alb", "dza", "deu", "and", "ago", "atg", "sau", "arg", "arm", "aus", "aut", "aze", "bhs", "bhr", "bgd", "brb", "blr", "bel", "blz", "ben", "btn", "bol", "bih", "bwa", "bra", "brn", "bgr", "bfa", "bdi", "khm", "cmr", "can", "cpv", "caf", "chl", "chn", "cyp", "col", "com", "cog", "cod", "kor", "prk", "cri", "civ", "hrv", "cub", "dnk", "dji", "dom", "dma", "egy", "slv", "are", "ecu", "eri", "esp", "est", "usa", "eth", "fji", "fin", "fra", "gab", "gmb", "geo", "gha", "grc", "grd", "gtm", "gin", "gnb", "gnq", "guy", "hti", "hnd", "hun", "ind", "idn", "irn", "irq", "irl", "isl", "isr", "ita", "jam", "jpn", "jor", "kaz", "ken", "kgz", "kir", "kwt", "lao", "lso", "lva", "lbn", "lbr", "lby", "lie", "ltu", "lux", "mkd", "mdg", "mys", "mwi", "mdv", "mli", "mlt", "mar", "mhl", "mus", "mrt", "mex", "fsm", "mda", "mco", "mng", "mne", "moz", "mmr", "nam", "nru", "npl", "nic", "ner", "nga", "nor", "nzl", "omn", "uga", "uzb", "pak", "plw", "pan", "png", "pry", "nld", "per", "phl", "pol", "prt", "qat", "rou", "gbr", "rus", "rwa", "kna", "smr", "vct", "lca", "slb", "wsm", "stp", "sen", "srb", "syc", "sle", "sgp", "svk", "svn", "som", "sdn", "ssd", "lka", "swe", "che", "sur", "swz", "syr", "tjk", "tza", "tcd", "cze", "tha", "tls", "tgo", "ton", "tto", "tun", "tkm", "tur", "tuv", "ukr", "ury", "vut", "ven", "vnm", "yem", "zmb", "zwe" ], "nullable": true }, "status": { "type": "string", "default": "waiting" }, "identityDocument": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Document3" } ] }, "mandatoryInfos": { "type": "array", "items": { "type": "string" }, "default": [] }, "uncompletedInfos": { "type": "array", "items": { "type": "string" }, "default": [] }, "createdAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true }, "email": { "type": "string", "nullable": true } }, "type": "object" }, "MoralPerson8": { "properties": { "companyName": { "type": "string", "nullable": true }, "companyEmail": { "type": "string", "nullable": true }, "companyType": { "type": "string", "nullable": true }, "companyRegistrationNumber": { "type": "string", "nullable": true }, "address": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Address" } ] }, "status": { "type": "string", "default": "waiting" }, "headOfCompany": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PhysicalPerson7" } ] }, "proofOfAddressDocument": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Document3" } ] }, "kbisDocument": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Document3" } ] }, "financialInfoDocument": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Document3" } ] }, "statusDocument": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Document3" } ] }, "mandatoryInfos": { "type": "array", "items": { "type": "string" }, "default": [] }, "uncompletedInfos": { "type": "array", "items": { "type": "string" }, "default": [] }, "createdAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true } }, "type": "object" }, "ReceiverBankAccount4": { "required": [ "number", "holderName" ], "properties": { "number": { "type": "string" }, "bic": { "type": "string", "nullable": true }, "holderName": { "type": "string" }, "ibanDocument": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Document3" } ] }, "amBankAccountId": { "type": "string", "nullable": true } }, "type": "object" }, "Organisation18": { "required": [ "accountType", "organisationConnectors", "id", "createdAt", "updatedAt", "name", "walletFunctionalities", "invoiceFunctionalities" ], "properties": { "organisationName": { "type": "string", "nullable": true }, "accountType": { "type": "string" }, "legalType": { "type": "string", "nullable": true }, "kycLevel": { "type": "string", "default": "LEVEL_0", "nullable": true }, "amAccountId": { "type": "string", "nullable": true }, "amWalletId": { "type": "string", "nullable": true }, "amSequestrationWalletId": { "type": "string", "nullable": true }, "amAccountStatus": { "type": "string", "nullable": true }, "amAccountErrorCode": { "type": "integer", "nullable": true }, "amValidationAskAt": { "type": "string", "format": "date-time", "nullable": true }, "amValidationUpdateAt": { "type": "string", "format": "date-time", "nullable": true }, "amValidationStatus": { "type": "string", "nullable": true }, "amValidationError": { "type": "string", "nullable": true }, "amValidationErrorDescription": { "type": "string", "nullable": true }, "moralPerson": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MoralPerson8" } ] }, "physicalPerson": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PhysicalPerson7" } ] }, "creatorPhysicalPerson": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PhysicalPerson7" } ] }, "accountForWho": { "type": "string", "nullable": true }, "currentRelation": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OrganisationUserModel" } ] }, "activity": { "type": "string", "nullable": true }, "displayEmail": { "description": "Public email.", "type": "string", "nullable": true }, "displayPhone": { "description": "Public phone.", "type": "string", "nullable": true }, "displayWebsite": { "description": "Public website.", "type": "string", "nullable": true }, "displayLogo": { "description": "Public logo.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Media" } ] }, "receiverBankAccount": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ReceiverBankAccount4" } ] }, "activatedFunctionality": { "type": "string", "nullable": true }, "auditAt": { "type": "string", "format": "date-time", "nullable": true }, "settingClosingTime": { "type": "integer", "default": 10 }, "settingMaxDepositAmount": { "type": "integer", "default": 2500 }, "settingRequestEmailSendTiming": { "type": "string", "default": "instant", "nullable": true }, "settingForceIdentityDocument": { "type": "boolean", "default": false }, "settingMultipleCashOut": { "type": "boolean", "default": false }, "settingInsurance": { "type": "boolean", "default": true }, "mandatoryInfos": { "type": "array", "items": { "type": "string" }, "default": [] }, "uncompletedInfos": { "type": "array", "items": { "type": "string" }, "default": [] }, "accountMainAlert": { "type": "string", "nullable": true }, "accountAlerts": { "type": "array", "items": { "type": "string" }, "default": [] }, "organisationConnectors": { "type": "array", "items": { "$ref": "#/components/schemas/OrganisationConnector2" } }, "objectName": { "description": "Name of the object", "type": "string", "default": "organisation", "example": "organisation" }, "id": { "description": "Unique identifier of the organisation", "type": "string", "format": "uuid", "example": "550e8400-e29b-41d4-a716-446655440000" }, "createdAt": { "description": "Creation date of the organisation", "type": "string", "format": "date-time", "example": "2023-01-01T12:00:00+00:00" }, "updatedAt": { "description": "Last update date of the organisation", "type": "string", "format": "date-time", "example": "2023-01-01T15:30:00+00:00" }, "name": { "description": "Name of the organisation", "type": "string", "example": "Example Organisation" }, "parent": { "type": "string", "nullable": true }, "parentData": { "nullable": true, "oneOf": [ { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Organisation18" } ] }, { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Organisation3" } ] } ] }, "displayName": { "description": "Public name.", "type": "string", "nullable": true }, "displayIdentifier": { "type": "string", "nullable": true }, "displayCreatedAt": { "description": "Public created at date.", "type": "string", "format": "date-time", "nullable": true }, "displayAddress": { "description": "Public address.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Address" } ] }, "effectiveFunctionality": { "type": "string", "nullable": true }, "walletFunctionalities": { "type": "boolean" }, "invoiceFunctionalities": { "type": "boolean" }, "littleBondSubscription": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Subscription3" } ] }, "email": { "type": "string", "nullable": true } }, "type": "object" }, "CheckInOut5": { "required": [ "id", "type", "comment", "medias" ], "properties": { "id": { "type": "string" }, "type": { "description": "Type.", "type": "string", "enum": [ "check_in", "check_out" ] }, "comment": { "description": "Comment.", "type": "string" }, "medias": { "type": "array", "items": { "$ref": "#/components/schemas/Media" } }, "recipient": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Organisation18" } ] }, "createdAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true } }, "type": "object" }, "CashOutDiscussion3": { "required": [ "medias", "type" ], "properties": { "medias": { "type": "array", "items": { "$ref": "#/components/schemas/Media" } }, "amountProposed": { "description": "New amount proposed by the owner for the cashout.", "type": "number", "format": "float", "nullable": true }, "comment": { "description": "Message of the discussion put by the owner or the recipient.", "type": "string", "nullable": true }, "type": { "description": "Type of discussion.", "type": "string", "enum": [ "recipient_reclamation", "owner_new_offer", "recipient_accept", "owner_deny" ] }, "createdAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true } }, "type": "object" }, "CashOut3": { "required": [ "id", "amount", "reason", "medias", "cashOutDiscussions", "sequestrationAmount", "actualFinalAmount" ], "properties": { "id": { "type": "string" }, "amount": { "description": "Amount of the cashout.", "type": "number", "format": "float" }, "reason": { "description": "Reason of the cashout.", "type": "string" }, "medias": { "description": "Documents related to the cashout.", "type": "array", "items": { "$ref": "#/components/schemas/Media" } }, "status": { "description": "CashOut statut.", "type": "string", "default": "waiting", "enum": [ "waiting", "done", "reclamation", "failed", "cancel" ] }, "cashOutDiscussions": { "type": "array", "items": { "$ref": "#/components/schemas/CashOutDiscussion3" } }, "sequestrationSuccess": { "description": "Know if the sequestration of the cashout worked fine.", "type": "boolean", "default": false }, "sequestrationAmount": { "description": "Amount of the sequestrate amount.", "type": "number", "format": "float" }, "refundFailed": { "description": "Know if a refound failed.", "type": "boolean", "default": false }, "transferFailed": { "type": "boolean", "default": false, "nullable": true }, "transferProviderId": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true }, "actualFinalAmount": { "type": "number", "format": "float" } }, "type": "object" }, "OrganisationTransaction6": { "required": [ "id", "provider", "status" ], "properties": { "id": { "type": "string" }, "provider": { "description": "External provider of the transaction. Our payment partner.", "type": "string" }, "providerId": { "description": "External id of the transaction. Our payment partner transaction ID.", "type": "string", "nullable": true }, "payer": { "description": "Account who paid the transaction.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Organisation18" } ] }, "status": { "type": "string" }, "authorizedAmount": { "description": "3DS authorisation amount.", "type": "number", "format": "float", "nullable": true }, "amount": { "description": "Amount.", "type": "number", "format": "float", "nullable": true } }, "type": "object" }, "PennylaneDiscountModel": { "properties": { "type": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true } }, "type": "object" }, "PennylaneLineItemsSectionAttribute": { "properties": { "title": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "rank": { "type": "integer", "nullable": true } }, "type": "object" }, "PennylaneLineItem": { "properties": { "label": { "type": "string", "nullable": true }, "unit": { "type": "string", "nullable": true }, "quantity": { "type": "string", "nullable": true }, "productId": { "type": "string", "nullable": true }, "currencyAmountBeforeTax": { "type": "string", "nullable": true }, "rawCurrencyUnitPrice": { "type": "string", "nullable": true }, "sectionRank": { "type": "integer", "nullable": true } }, "type": "object" }, "Invoice2": { "required": [ "organisationTransactions", "id", "date", "deadline", "invoiceState" ], "properties": { "ttcPrice": { "type": "string", "nullable": true }, "type": { "type": "string", "default": "monthly", "nullable": true }, "freeBonds": { "type": "integer", "nullable": true }, "freeBondsPrice": { "type": "number", "format": "float", "nullable": true }, "paymentProviderId": { "type": "string", "nullable": true }, "paymentProviderType": { "type": "string", "nullable": true }, "organisationTransactions": { "type": "array", "items": { "$ref": "#/components/schemas/OrganisationTransaction6" } }, "id": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true }, "date": { "type": "string", "format": "date-time" }, "deadline": { "type": "string", "format": "date-time" }, "pdfInvoiceFreeText": { "type": "string", "nullable": true }, "pdfInvoiceSubject": { "type": "string", "nullable": true }, "pdfDescription": { "type": "string", "nullable": true }, "draft": { "type": "boolean", "default": false }, "currency": { "type": "string", "default": "EUR", "nullable": true }, "specialMention": { "type": "string", "nullable": true }, "discount": { "nullable": true, "oneOf": [ { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PennylaneDiscountModel" } ] }, { "type": "array", "items": {} } ] }, "language": { "type": "string", "nullable": true }, "invoiceNumber": { "type": "string", "nullable": true }, "lineItemsSectionsAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/PennylaneLineItemsSectionAttribute" }, "nullable": true }, "lineItems": { "type": "array", "items": { "$ref": "#/components/schemas/PennylaneLineItem" }, "nullable": true }, "mailSend": { "type": "boolean", "default": false, "nullable": true }, "payed": { "type": "boolean", "default": false, "nullable": true }, "customer": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Organisation18" } ] }, "lastSyncAt": { "type": "string", "format": "date-time", "nullable": true }, "status": { "type": "string", "nullable": true }, "currencyAmount": { "type": "string", "nullable": true }, "currencyAmountBeforeTax": { "type": "string", "nullable": true }, "currencyTax": { "type": "string", "nullable": true }, "invoiceState": { "type": "string" } }, "type": "object" }, "OrganisationRequestInsurance2": { "required": [ "externalDocuments" ], "properties": { "invoice": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Invoice2" } ] }, "externalState": { "description": "State of the insurance if the recipient take it. This state come from our insurance partner.", "type": "string", "nullable": true }, "externalClientCode": { "type": "string", "nullable": true }, "externalDocuments": { "type": "array", "items": {} }, "payed": { "description": "Know if the insurance has been payed by the recipient. This information is useful for the TYLLT administrator", "type": "boolean", "default": false }, "createdAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true } }, "type": "object" }, "RequestEvent4": { "required": [ "type", "medias" ], "properties": { "type": { "description": "Event type.", "type": "string", "enum": [ "email_send", "email_open", "email_processed", "email_delivered", "email_click", "email_bounce", "email_spamreport", "email_unsubscribe", "email_dropped", "email_deferred", "email_blocked", "email_invalid", "email_reply", "email_blacklisted", "ticket_admin_message", "new_transaction_manual_cancel", "ticket_owner_message" ] }, "subType": { "description": "Event subtype. For email event only.", "type": "string", "enum": [ "request_email", "cashout_email" ], "nullable": true }, "message": { "type": "string", "nullable": true }, "recipientMessage": { "type": "string", "nullable": true }, "ownerMessage": { "type": "string", "nullable": true }, "amount": { "type": "number", "format": "float", "nullable": true }, "visibility": { "type": "array", "items": { "type": "string" }, "nullable": true }, "cashOut": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CashOut3" } ] }, "checkIn": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CheckInOut5" } ] }, "checkOut": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CheckInOut5" } ] }, "organisationTransaction": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OrganisationTransaction6" } ] }, "medias": { "type": "array", "items": { "$ref": "#/components/schemas/Media" } }, "mail": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Mail" } ] }, "invoice": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Invoice2" } ] }, "organisationRequestInsurance": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OrganisationRequestInsurance2" } ] }, "createdAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true } }, "type": "object" }, "RequestSecurityDeposit5": { "required": [ "cashOuts", "organisationRequestInsurances", "personalRequestInsurances", "recipientInformationDocuments", "name", "description", "insuranceActive", "canEdit", "id", "owner", "publicLink", "status", "emailSendTiming", "organisationTransactions", "requestEvents", "dtype" ], "properties": { "depositRecipientsNumber": { "description": "Number of participants for the deposit of the request. Recipients can choose if they want to pay all the security deposit or split it between multiple participants.", "type": "integer", "default": 1, "nullable": true }, "startAt": { "description": "Start date of the request.", "type": "string", "format": "date-time", "nullable": true }, "endAt": { "description": "End date of the request.", "type": "string", "format": "date-time", "nullable": true }, "recipientAllowToUpdateStartAt": { "description": "Know if recipient is allow to update start date.", "type": "boolean", "nullable": true }, "recipientAllowToUpdateEndAt": { "description": "Know if recipient is allow to update end date.", "type": "boolean", "nullable": true }, "settingMultipleProductInformationResponse": { "description": "Recipient response to the multiple product information label.", "type": "string", "nullable": true }, "recipientMoreInformationResponse": { "description": "Recipient response to the more information label.", "type": "string", "nullable": true }, "remoteCheckInStatus": { "description": "Status of the check in.", "type": "string", "default": "waiting", "enum": [ "waiting", "done" ], "nullable": true }, "remoteCheckOutStatus": { "description": "Status of the check out.", "type": "string", "default": "waiting", "enum": [ "waiting", "done" ], "nullable": true }, "depositStatus": { "description": "Status of the deposit.", "type": "string", "default": "waiting", "enum": [ "waiting", "done", "in_error" ], "nullable": true }, "identityVerificationStatus": { "description": "Status of the identity verification.", "type": "string", "default": "waiting", "enum": [ "waiting", "done" ], "nullable": true }, "remoteCheckIn": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CheckInOut5" } ] }, "remoteCheckOut": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CheckInOut5" } ] }, "cashOuts": { "type": "array", "items": { "$ref": "#/components/schemas/CashOut3" } }, "organisationRequestInsurances": { "type": "array", "items": { "$ref": "#/components/schemas/OrganisationRequestInsurance2" } }, "personalRequestInsurances": { "type": "array", "items": { "$ref": "#/components/schemas/OrganisationRequestInsurance2" } }, "createdAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true }, "recipientInformationDocuments": { "description": "Informations documents related to the recipient.", "type": "array", "items": { "$ref": "#/components/schemas/Media" } }, "name": { "description": "Name of the request.", "type": "string" }, "description": { "description": "Description of the request.", "type": "string" }, "remoteCheckInOut": { "description": "Active or not the remote check in and check out section.", "type": "boolean", "nullable": true }, "remoteCheckInOutInformation": { "description": "Active or not the remote check in and check out.", "type": "string", "nullable": true }, "depositAmount": { "description": "Amount ask for the deposit.", "type": "number", "format": "float", "nullable": true }, "deposit": { "description": "Active or not the deposit section.", "type": "boolean", "nullable": true }, "depositType": { "description": "Deposit type.", "type": "string", "enum": [ "verification", "blocked", "debit" ], "nullable": true }, "settingMultipleProduct": { "description": "Active or not the multiple product section.", "type": "boolean", "nullable": true }, "settingMultipleProductInformationLabel": { "description": "Display label for recipient who can answer to it in an input text. You can ask a product identification or whatever you want to know what product is in news", "type": "string", "nullable": true }, "recipientMoreInformationLabel": { "description": "Display label for recipient who can answer to it in an input text. You can ask all information you want.", "type": "string", "nullable": true }, "recipientWelcomeMessage": { "description": "Display message for recipient in the deposit asking email.", "type": "string", "nullable": true }, "recipientConfirmMessage": { "description": "Display message for recipient in the deposit confirm email.", "type": "string", "nullable": true }, "recipientVigilancePoints": { "description": "List of vigilance point you want to display for recipient.", "type": "string", "nullable": true }, "settingDateOptional": { "description": "Active or not the date optional for the recipient. If you pass true, recipient can choose to not fill the date field.", "type": "boolean", "nullable": true }, "settingDepositAutomaticEmailRelaunch": { "description": "Active or not the automatic email relaunch for deposit. If the recipient have not completed the deposit, an email will be sent to him.", "type": "boolean", "nullable": true }, "settingMultipleCashOutOption": { "description": "Active or not the possibility to do multiple cashOut on the same request. (This is not disponible for all owner - contact us to know more)", "type": "boolean", "nullable": true }, "settingAuthorizeDepositSharing": { "description": "Setting to authorize deposit sharing, if set to false recipients can't split the deposit. We recommend leaving it set to `true` for large deposits.", "type": "boolean", "default": true, "nullable": true }, "identityVerificationType": { "description": "Type of identity verification to do on the recipient.", "type": "string", "enum": [ "simple", "advanced" ], "nullable": true }, "insurance": { "description": "If it's set to true, recipient can take an insurance during deposit to protect the deposit amount.", "type": "boolean", "nullable": true }, "insuranceMaximumAmount": { "description": "Maximum amount protected by the insurance.", "type": "number", "format": "float", "nullable": true }, "estimatedReleasedAt": { "description": "Estimated release date of the deposit. It's based on the end date of the request and the closing time of the owner.", "type": "string", "format": "date-time", "nullable": true }, "insuranceActive": { "description": "To know if one recipient take the insurance.", "type": "boolean" }, "depositRecipientsPayed": { "description": "Number of recipients that have paid their share.", "type": "integer", "nullable": true }, "depositRecipientsAmountPayed": { "description": "Amount payed by recipients that have paid their share.", "type": "number", "format": "float", "nullable": true }, "depositTransactionAmountPayedDetail": { "description": "Name and amount of the recipients that that have paid their share.", "type": "array", "items": {}, "nullable": true }, "cashOutAllow": { "description": "Property to know if a cashOut request is actually allow on the deposit.", "type": "boolean", "nullable": true }, "cashOutMaximumAmount": { "description": "Property to know the maximum amount that can be set to a cashOut request.", "type": "number", "format": "float", "nullable": true }, "canEdit": { "description": "Property to know if the request ca be edit or no.", "type": "boolean" }, "id": { "type": "string" }, "model": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ModelRequest3" } ] }, "owner": { "$ref": "#/components/schemas/Organisation18" }, "recipient": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Organisation18" } ] }, "recipientPreFill": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PhysicalPerson7" } ] }, "publicLink": { "type": "string" }, "source": { "type": "string", "nullable": true }, "locale": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "status": { "type": "string" }, "emailSendTiming": { "type": "string" }, "organisationTransactions": { "type": "array", "items": { "$ref": "#/components/schemas/OrganisationTransaction6" } }, "requestEvents": { "type": "array", "items": { "$ref": "#/components/schemas/RequestEvent4" } }, "partnerIntegrationType": { "type": "string", "nullable": true }, "partnerReturnSuccessUrl": { "type": "string", "nullable": true }, "partnerReturnFailedUrl": { "type": "string", "nullable": true }, "partnerName": { "type": "string", "nullable": true }, "partnerRef": { "type": "string", "nullable": true }, "internalReference": { "type": "string", "nullable": true }, "fullLink": { "type": "string", "nullable": true }, "recipientId": { "type": "string", "nullable": true }, "dtype": { "type": "string" } }, "type": "object", "allOf": [ { "$ref": "#/components/schemas/Request" } ] }, "RequestPayment4": { "required": [ "name", "description", "tvaType", "amount", "amountWithTax", "tvaValue", "canEdit", "id", "owner", "publicLink", "status", "emailSendTiming", "organisationTransactions", "requestEvents", "dtype" ], "properties": { "startAt": { "description": "Start date of the request. Use for the timing of the request email sending", "type": "string", "format": "date-time", "nullable": true }, "payedAt": { "description": "Date of the payment.", "type": "string", "format": "date-time", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true }, "name": { "description": "Name of the payment request.", "type": "string" }, "description": { "description": "Description of the payment request.", "type": "string" }, "tvaType": { "description": "TVA type of the payment request.", "type": "string", "enum": [ "FR_09", "FR_21", "FR_40", "FR_55", "FR_60", "FR_65", "FR_85", "FR_92", "FR_100", "FR_130", "FR_196", "FR_200", "AT_100", "AT_130", "AT_200", "BE_60", "BE_120", "BE_210", "BG_90", "BG_200", "CH_25", "CH_37", "CH_77", "CH_26", "CH_38", "CH_81", "CY_50", "CY_90", "CY_190", "CZ_100", "CZ_150", "CZ_210", "DE_70", "DE_190", "DK_250", "EE_90", "EE_200", "ES_40", "ES_100", "ES_210", "FI_100", "FI_140", "FI_240", "GB_50", "GB_200", "GR_60", "GR_130", "GR_240", "HR_50", "HR_130", "HR_250", "HU_50", "HU_180", "HU_270", "IE_48", "IE_90", "IE_135", "IE_210", "IE_230", "IT_40", "IT_50", "IT_100", "IT_220", "LT_50", "LT_90", "LT_210", "LU_30", "LU_70", "LU_80", "LU_130", "LU_140", "LU_160", "LU_170", "LV_50", "LV_120", "LV_210", "MC_09", "MC_21", "MC_55", "MC_85", "MC_100", "MC_200", "MT_50", "MT_70", "MT_180", "NL_90", "NL_210", "PL_50", "PL_80", "PL_230", "PT_60", "PT_130", "PT_230", "RO_50", "RO_90", "RO_190", "SE_60", "SE_120", "SE_250", "SI_50", "SI_95", "SI_220", "SK_100", "SK_200", "exempt", "crossborder", "extracom", "FR_100_construction", "FR_200_construction" ] }, "amount": { "description": "Amount of the payment request.", "type": "number", "format": "float" }, "amountWithTax": { "description": "Amount of the payment request with taxes.", "type": "number", "format": "float" }, "tvaValue": { "description": "TVA value of the payment request.", "type": "number", "format": "float" }, "canEdit": { "description": "Property to know if the request ca be edit or no.", "type": "boolean" }, "id": { "type": "string" }, "model": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ModelRequest3" } ] }, "owner": { "$ref": "#/components/schemas/Organisation18" }, "recipient": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Organisation18" } ] }, "recipientPreFill": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PhysicalPerson7" } ] }, "publicLink": { "type": "string" }, "source": { "type": "string", "nullable": true }, "locale": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "status": { "type": "string" }, "emailSendTiming": { "type": "string" }, "organisationTransactions": { "type": "array", "items": { "$ref": "#/components/schemas/OrganisationTransaction6" } }, "requestEvents": { "type": "array", "items": { "$ref": "#/components/schemas/RequestEvent4" } }, "partnerIntegrationType": { "type": "string", "nullable": true }, "partnerReturnSuccessUrl": { "type": "string", "nullable": true }, "partnerReturnFailedUrl": { "type": "string", "nullable": true }, "partnerName": { "type": "string", "nullable": true }, "partnerRef": { "type": "string", "nullable": true }, "internalReference": { "type": "string", "nullable": true }, "fullLink": { "type": "string", "nullable": true }, "recipientId": { "type": "string", "nullable": true }, "dtype": { "type": "string" } }, "type": "object", "allOf": [ { "$ref": "#/components/schemas/Request" } ] }, "Organisation19": { "required": [ "accountType", "organisationConnectors", "id", "createdAt", "updatedAt", "name", "walletFunctionalities", "invoiceFunctionalities" ], "properties": { "organisationName": { "type": "string", "nullable": true }, "accountType": { "type": "string" }, "legalType": { "type": "string", "nullable": true }, "kycLevel": { "type": "string", "default": "LEVEL_0", "nullable": true }, "amAccountId": { "type": "string", "nullable": true }, "amWalletId": { "type": "string", "nullable": true }, "amSequestrationWalletId": { "type": "string", "nullable": true }, "amAccountStatus": { "type": "string", "nullable": true }, "amAccountErrorCode": { "type": "integer", "nullable": true }, "amValidationAskAt": { "type": "string", "format": "date-time", "nullable": true }, "amValidationUpdateAt": { "type": "string", "format": "date-time", "nullable": true }, "amValidationStatus": { "type": "string", "nullable": true }, "amValidationError": { "type": "string", "nullable": true }, "amValidationErrorDescription": { "type": "string", "nullable": true }, "moralPerson": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MoralPerson8" } ] }, "physicalPerson": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PhysicalPerson7" } ] }, "creatorPhysicalPerson": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PhysicalPerson7" } ] }, "accountForWho": { "type": "string", "nullable": true }, "currentRelation": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OrganisationUserModel" } ] }, "activity": { "type": "string", "nullable": true }, "displayEmail": { "description": "Public email.", "type": "string", "nullable": true }, "displayPhone": { "description": "Public phone.", "type": "string", "nullable": true }, "displayWebsite": { "description": "Public website.", "type": "string", "nullable": true }, "displayLogo": { "description": "Public logo.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Media" } ] }, "receiverBankAccount": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ReceiverBankAccount4" } ] }, "activatedFunctionality": { "type": "string", "nullable": true }, "auditAt": { "type": "string", "format": "date-time", "nullable": true }, "settingClosingTime": { "type": "integer", "default": 10 }, "settingMaxDepositAmount": { "type": "integer", "default": 2500 }, "settingRequestEmailSendTiming": { "type": "string", "default": "instant", "nullable": true }, "settingForceIdentityDocument": { "type": "boolean", "default": false }, "settingMultipleCashOut": { "type": "boolean", "default": false }, "settingInsurance": { "type": "boolean", "default": true }, "mandatoryInfos": { "type": "array", "items": { "type": "string" }, "default": [] }, "uncompletedInfos": { "type": "array", "items": { "type": "string" }, "default": [] }, "accountMainAlert": { "type": "string", "nullable": true }, "accountAlerts": { "type": "array", "items": { "type": "string" }, "default": [] }, "organisationConnectors": { "type": "array", "items": { "$ref": "#/components/schemas/OrganisationConnector2" } }, "objectName": { "description": "Name of the object", "type": "string", "default": "organisation", "example": "organisation" }, "id": { "description": "Unique identifier of the organisation", "type": "string", "format": "uuid", "example": "550e8400-e29b-41d4-a716-446655440000" }, "createdAt": { "description": "Creation date of the organisation", "type": "string", "format": "date-time", "example": "2023-01-01T12:00:00+00:00" }, "updatedAt": { "description": "Last update date of the organisation", "type": "string", "format": "date-time", "example": "2023-01-01T15:30:00+00:00" }, "name": { "description": "Name of the organisation", "type": "string", "example": "Example Organisation" }, "parent": { "type": "string", "nullable": true }, "parentData": { "nullable": true, "oneOf": [ { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Organisation19" } ] }, { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Organisation3" } ] } ] }, "displayName": { "description": "Public name.", "type": "string", "nullable": true }, "displayIdentifier": { "type": "string", "nullable": true }, "displayCreatedAt": { "description": "Public created at date.", "type": "string", "format": "date-time", "nullable": true }, "displayAddress": { "description": "Public address.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Address" } ] }, "effectiveFunctionality": { "type": "string", "nullable": true }, "walletFunctionalities": { "type": "boolean" }, "invoiceFunctionalities": { "type": "boolean" }, "littleBondSubscription": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Subscription3" } ] }, "email": { "type": "string", "nullable": true } }, "type": "object" }, "CheckInOut6": { "required": [ "id", "type", "comment", "medias" ], "properties": { "id": { "type": "string" }, "type": { "description": "Type.", "type": "string", "enum": [ "check_in", "check_out" ] }, "comment": { "description": "Comment.", "type": "string" }, "medias": { "type": "array", "items": { "$ref": "#/components/schemas/Media" } }, "recipient": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Organisation19" } ] }, "createdAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true } }, "type": "object" }, "OrganisationRequestInsurance3": { "required": [ "externalDocuments" ], "properties": { "invoice": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Invoice" } ] }, "externalState": { "description": "State of the insurance if the recipient take it. This state come from our insurance partner.", "type": "string", "nullable": true }, "externalClientCode": { "type": "string", "nullable": true }, "externalDocuments": { "type": "array", "items": {} }, "payed": { "description": "Know if the insurance has been payed by the recipient. This information is useful for the TYLLT administrator", "type": "boolean", "default": false }, "createdAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true } }, "type": "object" }, "OrganisationTransaction7": { "required": [ "id", "provider", "status" ], "properties": { "id": { "type": "string" }, "provider": { "description": "External provider of the transaction. Our payment partner.", "type": "string" }, "providerId": { "description": "External id of the transaction. Our payment partner transaction ID.", "type": "string", "nullable": true }, "payer": { "description": "Account who paid the transaction.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Organisation19" } ] }, "status": { "type": "string" }, "authorizedAmount": { "description": "3DS authorisation amount.", "type": "number", "format": "float", "nullable": true }, "amount": { "description": "Amount.", "type": "number", "format": "float", "nullable": true } }, "type": "object" }, "RequestEvent5": { "required": [ "type", "medias" ], "properties": { "type": { "description": "Event type.", "type": "string", "enum": [ "email_send", "email_open", "email_processed", "email_delivered", "email_click", "email_bounce", "email_spamreport", "email_unsubscribe", "email_dropped", "email_deferred", "email_blocked", "email_invalid", "email_reply", "email_blacklisted", "ticket_admin_message", "new_transaction_manual_cancel", "ticket_owner_message" ] }, "subType": { "description": "Event subtype. For email event only.", "type": "string", "enum": [ "request_email", "cashout_email" ], "nullable": true }, "message": { "type": "string", "nullable": true }, "recipientMessage": { "type": "string", "nullable": true }, "ownerMessage": { "type": "string", "nullable": true }, "amount": { "type": "number", "format": "float", "nullable": true }, "visibility": { "type": "array", "items": { "type": "string" }, "nullable": true }, "cashOut": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CashOut3" } ] }, "checkIn": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CheckInOut6" } ] }, "checkOut": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CheckInOut6" } ] }, "organisationTransaction": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OrganisationTransaction7" } ] }, "medias": { "type": "array", "items": { "$ref": "#/components/schemas/Media" } }, "mail": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Mail" } ] }, "invoice": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Invoice" } ] }, "organisationRequestInsurance": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OrganisationRequestInsurance3" } ] }, "createdAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true } }, "type": "object" }, "RequestSecurityDeposit6": { "required": [ "cashOuts", "organisationRequestInsurances", "personalRequestInsurances", "recipientInformationDocuments", "name", "description", "insuranceActive", "canEdit", "id", "owner", "publicLink", "status", "emailSendTiming", "organisationTransactions", "requestEvents", "dtype" ], "properties": { "depositRecipientsNumber": { "description": "Number of participants for the deposit of the request. Recipients can choose if they want to pay all the security deposit or split it between multiple participants.", "type": "integer", "default": 1, "nullable": true }, "startAt": { "description": "Start date of the request.", "type": "string", "format": "date-time", "nullable": true }, "endAt": { "description": "End date of the request.", "type": "string", "format": "date-time", "nullable": true }, "recipientAllowToUpdateStartAt": { "description": "Know if recipient is allow to update start date.", "type": "boolean", "nullable": true }, "recipientAllowToUpdateEndAt": { "description": "Know if recipient is allow to update end date.", "type": "boolean", "nullable": true }, "settingMultipleProductInformationResponse": { "description": "Recipient response to the multiple product information label.", "type": "string", "nullable": true }, "recipientMoreInformationResponse": { "description": "Recipient response to the more information label.", "type": "string", "nullable": true }, "remoteCheckInStatus": { "description": "Status of the check in.", "type": "string", "default": "waiting", "enum": [ "waiting", "done" ], "nullable": true }, "remoteCheckOutStatus": { "description": "Status of the check out.", "type": "string", "default": "waiting", "enum": [ "waiting", "done" ], "nullable": true }, "depositStatus": { "description": "Status of the deposit.", "type": "string", "default": "waiting", "enum": [ "waiting", "done", "in_error" ], "nullable": true }, "identityVerificationStatus": { "description": "Status of the identity verification.", "type": "string", "default": "waiting", "enum": [ "waiting", "done" ], "nullable": true }, "remoteCheckIn": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CheckInOut6" } ] }, "remoteCheckOut": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CheckInOut6" } ] }, "cashOuts": { "type": "array", "items": { "$ref": "#/components/schemas/CashOut3" } }, "organisationRequestInsurances": { "type": "array", "items": { "$ref": "#/components/schemas/OrganisationRequestInsurance3" } }, "personalRequestInsurances": { "type": "array", "items": { "$ref": "#/components/schemas/OrganisationRequestInsurance3" } }, "createdAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true }, "recipientInformationDocuments": { "description": "Informations documents related to the recipient.", "type": "array", "items": { "$ref": "#/components/schemas/Media" } }, "name": { "description": "Name of the request.", "type": "string" }, "description": { "description": "Description of the request.", "type": "string" }, "remoteCheckInOut": { "description": "Active or not the remote check in and check out section.", "type": "boolean", "nullable": true }, "remoteCheckInOutInformation": { "description": "Active or not the remote check in and check out.", "type": "string", "nullable": true }, "depositAmount": { "description": "Amount ask for the deposit.", "type": "number", "format": "float", "nullable": true }, "deposit": { "description": "Active or not the deposit section.", "type": "boolean", "nullable": true }, "depositType": { "description": "Deposit type.", "type": "string", "enum": [ "verification", "blocked", "debit" ], "nullable": true }, "settingMultipleProduct": { "description": "Active or not the multiple product section.", "type": "boolean", "nullable": true }, "settingMultipleProductInformationLabel": { "description": "Display label for recipient who can answer to it in an input text. You can ask a product identification or whatever you want to know what product is in news", "type": "string", "nullable": true }, "recipientMoreInformationLabel": { "description": "Display label for recipient who can answer to it in an input text. You can ask all information you want.", "type": "string", "nullable": true }, "recipientWelcomeMessage": { "description": "Display message for recipient in the deposit asking email.", "type": "string", "nullable": true }, "recipientConfirmMessage": { "description": "Display message for recipient in the deposit confirm email.", "type": "string", "nullable": true }, "recipientVigilancePoints": { "description": "List of vigilance point you want to display for recipient.", "type": "string", "nullable": true }, "settingDateOptional": { "description": "Active or not the date optional for the recipient. If you pass true, recipient can choose to not fill the date field.", "type": "boolean", "nullable": true }, "settingDepositAutomaticEmailRelaunch": { "description": "Active or not the automatic email relaunch for deposit. If the recipient have not completed the deposit, an email will be sent to him.", "type": "boolean", "nullable": true }, "settingMultipleCashOutOption": { "description": "Active or not the possibility to do multiple cashOut on the same request. (This is not disponible for all owner - contact us to know more)", "type": "boolean", "nullable": true }, "settingAuthorizeDepositSharing": { "description": "Setting to authorize deposit sharing, if set to false recipients can't split the deposit. We recommend leaving it set to `true` for large deposits.", "type": "boolean", "default": true, "nullable": true }, "identityVerificationType": { "description": "Type of identity verification to do on the recipient.", "type": "string", "enum": [ "simple", "advanced" ], "nullable": true }, "insurance": { "description": "If it's set to true, recipient can take an insurance during deposit to protect the deposit amount.", "type": "boolean", "nullable": true }, "insuranceMaximumAmount": { "description": "Maximum amount protected by the insurance.", "type": "number", "format": "float", "nullable": true }, "estimatedReleasedAt": { "description": "Estimated release date of the deposit. It's based on the end date of the request and the closing time of the owner.", "type": "string", "format": "date-time", "nullable": true }, "insuranceActive": { "description": "To know if one recipient take the insurance.", "type": "boolean" }, "depositRecipientsPayed": { "description": "Number of recipients that have paid their share.", "type": "integer", "nullable": true }, "depositRecipientsAmountPayed": { "description": "Amount payed by recipients that have paid their share.", "type": "number", "format": "float", "nullable": true }, "depositTransactionAmountPayedDetail": { "description": "Name and amount of the recipients that that have paid their share.", "type": "array", "items": {}, "nullable": true }, "cashOutAllow": { "description": "Property to know if a cashOut request is actually allow on the deposit.", "type": "boolean", "nullable": true }, "cashOutMaximumAmount": { "description": "Property to know the maximum amount that can be set to a cashOut request.", "type": "number", "format": "float", "nullable": true }, "canEdit": { "description": "Property to know if the request ca be edit or no.", "type": "boolean" }, "id": { "type": "string" }, "model": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ModelRequest3" } ] }, "owner": { "$ref": "#/components/schemas/Organisation19" }, "recipient": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Organisation19" } ] }, "recipientPreFill": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PhysicalPerson7" } ] }, "publicLink": { "type": "string" }, "source": { "type": "string", "nullable": true }, "locale": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "status": { "type": "string" }, "emailSendTiming": { "type": "string" }, "organisationTransactions": { "type": "array", "items": { "$ref": "#/components/schemas/OrganisationTransaction7" } }, "requestEvents": { "type": "array", "items": { "$ref": "#/components/schemas/RequestEvent5" } }, "partnerIntegrationType": { "type": "string", "nullable": true }, "partnerReturnSuccessUrl": { "type": "string", "nullable": true }, "partnerReturnFailedUrl": { "type": "string", "nullable": true }, "partnerName": { "type": "string", "nullable": true }, "partnerRef": { "type": "string", "nullable": true }, "internalReference": { "type": "string", "nullable": true }, "fullLink": { "type": "string", "nullable": true }, "recipientId": { "type": "string", "nullable": true }, "dtype": { "type": "string" } }, "type": "object", "allOf": [ { "$ref": "#/components/schemas/Request" } ] }, "RequestPayment5": { "required": [ "name", "description", "tvaType", "amount", "amountWithTax", "tvaValue", "canEdit", "id", "owner", "publicLink", "status", "emailSendTiming", "organisationTransactions", "requestEvents", "dtype" ], "properties": { "startAt": { "description": "Start date of the request. Use for the timing of the request email sending", "type": "string", "format": "date-time", "nullable": true }, "payedAt": { "description": "Date of the payment.", "type": "string", "format": "date-time", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true }, "name": { "description": "Name of the payment request.", "type": "string" }, "description": { "description": "Description of the payment request.", "type": "string" }, "tvaType": { "description": "TVA type of the payment request.", "type": "string", "enum": [ "FR_09", "FR_21", "FR_40", "FR_55", "FR_60", "FR_65", "FR_85", "FR_92", "FR_100", "FR_130", "FR_196", "FR_200", "AT_100", "AT_130", "AT_200", "BE_60", "BE_120", "BE_210", "BG_90", "BG_200", "CH_25", "CH_37", "CH_77", "CH_26", "CH_38", "CH_81", "CY_50", "CY_90", "CY_190", "CZ_100", "CZ_150", "CZ_210", "DE_70", "DE_190", "DK_250", "EE_90", "EE_200", "ES_40", "ES_100", "ES_210", "FI_100", "FI_140", "FI_240", "GB_50", "GB_200", "GR_60", "GR_130", "GR_240", "HR_50", "HR_130", "HR_250", "HU_50", "HU_180", "HU_270", "IE_48", "IE_90", "IE_135", "IE_210", "IE_230", "IT_40", "IT_50", "IT_100", "IT_220", "LT_50", "LT_90", "LT_210", "LU_30", "LU_70", "LU_80", "LU_130", "LU_140", "LU_160", "LU_170", "LV_50", "LV_120", "LV_210", "MC_09", "MC_21", "MC_55", "MC_85", "MC_100", "MC_200", "MT_50", "MT_70", "MT_180", "NL_90", "NL_210", "PL_50", "PL_80", "PL_230", "PT_60", "PT_130", "PT_230", "RO_50", "RO_90", "RO_190", "SE_60", "SE_120", "SE_250", "SI_50", "SI_95", "SI_220", "SK_100", "SK_200", "exempt", "crossborder", "extracom", "FR_100_construction", "FR_200_construction" ] }, "amount": { "description": "Amount of the payment request.", "type": "number", "format": "float" }, "amountWithTax": { "description": "Amount of the payment request with taxes.", "type": "number", "format": "float" }, "tvaValue": { "description": "TVA value of the payment request.", "type": "number", "format": "float" }, "canEdit": { "description": "Property to know if the request ca be edit or no.", "type": "boolean" }, "id": { "type": "string" }, "model": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ModelRequest3" } ] }, "owner": { "$ref": "#/components/schemas/Organisation19" }, "recipient": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Organisation19" } ] }, "recipientPreFill": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PhysicalPerson7" } ] }, "publicLink": { "type": "string" }, "source": { "type": "string", "nullable": true }, "locale": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "status": { "type": "string" }, "emailSendTiming": { "type": "string" }, "organisationTransactions": { "type": "array", "items": { "$ref": "#/components/schemas/OrganisationTransaction7" } }, "requestEvents": { "type": "array", "items": { "$ref": "#/components/schemas/RequestEvent5" } }, "partnerIntegrationType": { "type": "string", "nullable": true }, "partnerReturnSuccessUrl": { "type": "string", "nullable": true }, "partnerReturnFailedUrl": { "type": "string", "nullable": true }, "partnerName": { "type": "string", "nullable": true }, "partnerRef": { "type": "string", "nullable": true }, "internalReference": { "type": "string", "nullable": true }, "fullLink": { "type": "string", "nullable": true }, "recipientId": { "type": "string", "nullable": true }, "dtype": { "type": "string" } }, "type": "object", "allOf": [ { "$ref": "#/components/schemas/Request" } ] }, "RecipientType": { "title": "RecipientType", "description": "Recipient organisation creation form with user details", "required": [ "legalType", "legalType" ], "properties": { "physicalPerson": { "oneOf": [ { "$ref": "#/components/schemas/PhysicalPersonType" } ], "nullable": true, "description": "Physical person details for the user account (required when legalType is \"particular\")" }, "moralPerson": { "oneOf": [ { "$ref": "#/components/schemas/MoralPersonType" } ], "nullable": true, "description": "Company details (required when legalType is \"company\")" }, "legalType": { "description": "Legal type of the organisation", "type": "string", "enum": [ "particular", "company" ], "example": "particular" } }, "type": "object" }, "RequestPaymentType": { "description": "Request Payment form data", "required": [ "name", "description", "amount", "tvaType" ], "properties": { "name": { "description": "Name of the model request template", "type": "string", "maxLength": 255, "example": "Service Payment" }, "description": { "description": "Description of the payment request", "type": "string", "maxLength": 255, "example": "Payment for professional services" }, "amount": { "description": "Amount of the payment (excluding VAT)", "type": "string", "maxLength": 255, "example": "100.00" }, "tvaType": { "description": "VAT rate type to apply", "type": "string", "enum": [ "FR_09", "FR_21", "FR_40", "FR_55", "FR_60", "FR_65", "FR_85", "FR_92", "FR_100", "FR_130", "FR_196", "FR_200", "AT_100", "AT_130", "AT_200", "BE_60", "BE_120", "BE_210", "BG_90", "BG_200", "CH_25", "CH_37", "CH_77", "CH_26", "CH_38", "CH_81", "CY_50", "CY_90", "CY_190", "CZ_100", "CZ_150", "CZ_210", "DE_70", "DE_190", "DK_250", "EE_90", "EE_200", "ES_40", "ES_100", "ES_210", "FI_100", "FI_140", "FI_240", "GB_50", "GB_200", "GR_60", "GR_130", "GR_240", "HR_50", "HR_130", "HR_250", "HU_50", "HU_180", "HU_270", "IE_48", "IE_90", "IE_135", "IE_210", "IE_230", "IT_40", "IT_50", "IT_100", "IT_220", "LT_50", "LT_90", "LT_210", "LU_30", "LU_70", "LU_80", "LU_130", "LU_140", "LU_160", "LU_170", "LV_50", "LV_120", "LV_210", "MC_09", "MC_21", "MC_55", "MC_85", "MC_100", "MC_200", "MT_50", "MT_70", "MT_180", "NL_90", "NL_210", "PL_50", "PL_80", "PL_230", "PT_60", "PT_130", "PT_230", "RO_50", "RO_90", "RO_190", "SE_60", "SE_120", "SE_250", "SI_50", "SI_95", "SI_220", "SK_100", "SK_200", "exempt", "crossborder", "extracom", "FR_100_construction", "FR_200_construction" ], "example": "FR_200" }, "status": { "description": "Status of the model", "type": "string", "default": "inline", "enum": [ "inline", "desactivate" ], "example": "inline", "nullable": true }, "internalReference": { "description": "Internal reference for the model", "type": "string", "maxLength": 255, "nullable": true }, "model": { "description": "ID of the model request to use as template", "type": "string", "format": "uuid", "example": "550e8400-e29b-41d4-a716-446655440000", "nullable": true }, "startAt": { "description": "Start date for the timing of the request email sending", "type": "string", "format": "date", "example": "2024-01-15", "nullable": true }, "email": { "description": "Recipient email address (required for fully integrated requests)", "type": "string", "format": "email", "example": "recipient@example.com", "nullable": true }, "recipientPreFill": { "oneOf": [ { "$ref": "#/components/schemas/PhysicalPersonType" } ], "nullable": true, "description": "Pre-filled recipient information" }, "emailSendTiming": { "description": "When to send the email to recipient", "type": "string", "default": "instant", "enum": [ "instant", "month_before", "week_before", "72_hours_before", "48_hours_before", "24_hours_before", "none" ], "nullable": true }, "partnerIntegrationType": { "description": "Integration type for partner API", "type": "string", "enum": [ "default", "integrated", "fully_integrated" ], "example": "default", "nullable": true }, "partnerReturnSuccessUrl": { "description": "URL to redirect on success (required for integrated/fully_integrated types)", "type": "string", "maxLength": 512, "example": "https://partner.com/success", "nullable": true }, "partnerReturnFailedUrl": { "description": "URL to redirect on failure (required for integrated/fully_integrated types)", "type": "string", "maxLength": 512, "example": "https://partner.com/failed", "nullable": true }, "partnerName": { "description": "Partner name identifier", "type": "string", "maxLength": 255, "nullable": true }, "partnerRef": { "description": "Partner reference", "type": "string", "maxLength": 255, "example": "PAYMENT-12345", "nullable": true }, "locale": { "description": "Recipient language preference", "type": "string", "default": "fr", "enum": [ "en", "fr", "de", "es" ], "example": "fr", "nullable": true }, "recipient": { "oneOf": [ { "$ref": "#/components/schemas/RecipientType" } ], "nullable": true, "description": "Full recipient creation (only for fully_integrated type)" } }, "type": "object" }, "RequestSecurityDepositType": { "description": "Request Security Deposit form data", "required": [ "partnerIntegrationType", "name", "description" ], "properties": { "name": { "description": "Name of the model request template", "type": "string", "maxLength": 255, "example": "Standard Security Deposit" }, "description": { "description": "Description of the model request", "type": "string", "maxLength": 255, "example": "Security deposit for vacation rental" }, "deposit": { "description": "Whether a security deposit is required", "type": "boolean", "example": true, "nullable": true }, "depositAmount": { "description": "Amount of the security deposit (required when deposit is true)", "type": "number", "format": "float", "example": 500, "nullable": true }, "depositType": { "description": "Type of deposit (required when deposit is true)", "type": "string", "enum": [ "verification", "blocked", "debit" ], "example": "blocked", "nullable": true }, "identityVerificationType": { "description": "Type of identity verification required", "type": "string", "enum": [ "simple", "advanced" ], "example": "simple", "nullable": true }, "remoteCheckInOut": { "description": "Whether remote check-in/check-out is enabled", "type": "boolean", "example": false, "nullable": true }, "remoteCheckInOutInformation": { "description": "Information about remote check-in/check-out process", "type": "string", "maxLength": 255, "nullable": true }, "recipientWelcomeMessage": { "description": "Welcome message displayed to the recipient", "type": "string", "maxLength": 255, "nullable": true }, "recipientConfirmMessage": { "description": "Confirmation message displayed to the recipient", "type": "string", "maxLength": 255, "nullable": true }, "recipientVigilancePoints": { "description": "Vigilance points to communicate to the recipient", "type": "string", "maxLength": 255, "nullable": true }, "recipientInformationDocuments": { "description": "List of document IDs to provide as information to recipient", "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "internalReference": { "description": "Internal reference for the model", "type": "string", "maxLength": 255, "nullable": true }, "settingMultipleProduct": { "description": "Whether multiple products can be specified", "type": "boolean", "example": false, "nullable": true }, "settingAuthorizeDepositSharing": { "description": "Whether deposit can be shared between multiple recipients", "type": "boolean", "example": false, "nullable": true }, "settingMultipleProductInformationLabel": { "description": "Label for multiple product information (required when settingMultipleProduct is true)", "type": "string", "maxLength": 255, "nullable": true }, "recipientMoreInformationLabel": { "description": "Label for additional information requested from recipient", "type": "string", "maxLength": 255, "nullable": true }, "insurance": { "description": "Whether insurance is offered", "type": "boolean", "example": false, "nullable": true }, "insuranceMaximumAmount": { "description": "Maximum insurance coverage amount", "type": "number", "format": "float", "nullable": true }, "settingDateOptional": { "description": "Whether dates are optional for the request", "type": "boolean", "example": false, "nullable": true }, "settingDepositAutomaticEmailRelaunch": { "description": "Whether automatic email reminders are enabled", "type": "boolean", "example": false, "nullable": true }, "settingMultipleCashOutOption": { "description": "Whether multiple cash-out operations are allowed", "type": "boolean", "example": false, "nullable": true }, "emailSendTiming": { "description": "When to send the request email", "type": "string", "default": "instant", "enum": [ "instant", "month_before", "week_before", "72_hours_before", "48_hours_before", "24_hours_before", "none" ], "example": "instant", "nullable": true }, "status": { "description": "Status of the model", "type": "string", "default": "inline", "enum": [ "inline", "desactivate" ], "example": "inline", "nullable": true }, "model": { "description": "ID of the model request to use as template", "type": "string", "format": "uuid", "example": "550e8400-e29b-41d4-a716-446655440000", "nullable": true }, "startAt": { "description": "Start date of the rental/service period", "type": "string", "format": "date", "example": "2024-01-15", "nullable": true }, "endAt": { "description": "End date of the rental/service period", "type": "string", "format": "date", "example": "2024-01-20", "nullable": true }, "recipientAllowToUpdateStartAt": { "description": "Whether recipient can modify the start date", "type": "boolean", "example": false, "nullable": true }, "recipientAllowToUpdateEndAt": { "description": "Whether recipient can modify the end date", "type": "boolean", "example": false, "nullable": true }, "email": { "description": "Recipient email address (required for fully integrated requests)", "type": "string", "format": "email", "example": "recipient@example.com", "nullable": true }, "recipientPreFill": { "oneOf": [ { "$ref": "#/components/schemas/PhysicalPersonType" } ], "nullable": true, "description": "Pre-filled recipient information", "required": [] }, "partnerIntegrationType": { "description": "Integration type for partner API (required for API/connector requests)", "type": "string", "enum": [ "default", "integrated", "fully_integrated" ], "example": "default" }, "partnerReturnSuccessUrl": { "description": "URL to redirect on success (required for integrated/fully_integrated types)", "type": "string", "maxLength": 255, "example": "https://partner.com/success", "nullable": true }, "partnerReturnFailedUrl": { "description": "URL to redirect on failure (required for integrated/fully_integrated types)", "type": "string", "maxLength": 255, "example": "https://partner.com/failed", "nullable": true }, "partnerName": { "description": "Partner name identifier", "type": "string", "maxLength": 255, "nullable": true }, "partnerRef": { "description": "Partner reference", "type": "string", "maxLength": 255, "example": "BOOK-12345", "nullable": true }, "locale": { "description": "Recipient language preference", "type": "string", "default": "fr", "enum": [ "en", "fr", "de", "es" ], "nullable": true }, "recipient": { "oneOf": [ { "$ref": "#/components/schemas/RecipientType" } ], "nullable": true, "description": "Full recipient creation (only for fully_integrated type)" } }, "type": "object" }, "PhysicalPerson8": { "required": [ "id" ], "properties": { "id": { "type": "string" }, "secondaryEmail": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "secondaryPhone": { "type": "string", "nullable": true }, "firstname": { "type": "string", "nullable": true }, "lastname": { "type": "string", "nullable": true }, "birthday": { "type": "string", "format": "date-time", "nullable": true }, "birthdayAddress": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Address" } ] }, "address": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Address" } ] }, "monthlyIncome": { "description": "Monthly income.", "type": "string", "enum": [ "LOWER_THAN_1200_EUROS", "BETWEEN_1200_2500_EUROS", "BETWEEN_2500_4000_EUROS", "GREATER_THAN_4000_EUROS" ], "nullable": true }, "profession": { "description": "Profession.", "type": "string", "enum": [ "FARMER", "CRAFTSMAN_MERCHANT_ENTREPRENEUR", "LIBERAL_PROFESSION", "EXECUTIVE", "RETIREE", "EMPLOYEE", "WORKER", "NO_ACTIVITY" ], "nullable": true }, "nationality": { "description": "Nationality in alpha3 country code.", "type": "string", "enum": [ "afg", "zaf", "alb", "dza", "deu", "and", "ago", "atg", "sau", "arg", "arm", "aus", "aut", "aze", "bhs", "bhr", "bgd", "brb", "blr", "bel", "blz", "ben", "btn", "bol", "bih", "bwa", "bra", "brn", "bgr", "bfa", "bdi", "khm", "cmr", "can", "cpv", "caf", "chl", "chn", "cyp", "col", "com", "cog", "cod", "kor", "prk", "cri", "civ", "hrv", "cub", "dnk", "dji", "dom", "dma", "egy", "slv", "are", "ecu", "eri", "esp", "est", "usa", "eth", "fji", "fin", "fra", "gab", "gmb", "geo", "gha", "grc", "grd", "gtm", "gin", "gnb", "gnq", "guy", "hti", "hnd", "hun", "ind", "idn", "irn", "irq", "irl", "isl", "isr", "ita", "jam", "jpn", "jor", "kaz", "ken", "kgz", "kir", "kwt", "lao", "lso", "lva", "lbn", "lbr", "lby", "lie", "ltu", "lux", "mkd", "mdg", "mys", "mwi", "mdv", "mli", "mlt", "mar", "mhl", "mus", "mrt", "mex", "fsm", "mda", "mco", "mng", "mne", "moz", "mmr", "nam", "nru", "npl", "nic", "ner", "nga", "nor", "nzl", "omn", "uga", "uzb", "pak", "plw", "pan", "png", "pry", "nld", "per", "phl", "pol", "prt", "qat", "rou", "gbr", "rus", "rwa", "kna", "smr", "vct", "lca", "slb", "wsm", "stp", "sen", "srb", "syc", "sle", "sgp", "svk", "svn", "som", "sdn", "ssd", "lka", "swe", "che", "sur", "swz", "syr", "tjk", "tza", "tcd", "cze", "tha", "tls", "tgo", "ton", "tto", "tun", "tkm", "tur", "tuv", "ukr", "ury", "vut", "ven", "vnm", "yem", "zmb", "zwe" ], "nullable": true }, "status": { "type": "string", "default": "waiting" }, "identityDocument": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Document2" } ] }, "mandatoryInfos": { "type": "array", "items": { "type": "string" }, "default": [] }, "uncompletedInfos": { "type": "array", "items": { "type": "string" }, "default": [] }, "email": { "type": "string", "nullable": true } }, "type": "object" }, "MoralPerson9": { "properties": { "companyName": { "type": "string", "nullable": true }, "companyEmail": { "type": "string", "nullable": true }, "companyType": { "type": "string", "nullable": true }, "companyRegistrationNumber": { "type": "string", "nullable": true }, "address": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Address" } ] }, "status": { "type": "string", "default": "waiting" }, "headOfCompany": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PhysicalPerson8" } ] }, "proofOfAddressDocument": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Document2" } ] }, "kbisDocument": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Document2" } ] }, "financialInfoDocument": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Document2" } ] }, "statusDocument": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Document2" } ] }, "mandatoryInfos": { "type": "array", "items": { "type": "string" }, "default": [] }, "uncompletedInfos": { "type": "array", "items": { "type": "string" }, "default": [] } }, "type": "object" }, "Organisation20": { "required": [ "accountType", "organisationConnectors", "id", "createdAt", "updatedAt", "name", "walletFunctionalities", "invoiceFunctionalities" ], "properties": { "organisationName": { "type": "string", "nullable": true }, "accountType": { "type": "string" }, "legalType": { "type": "string", "nullable": true }, "kycLevel": { "type": "string", "default": "LEVEL_0", "nullable": true }, "amAccountId": { "type": "string", "nullable": true }, "amWalletId": { "type": "string", "nullable": true }, "amSequestrationWalletId": { "type": "string", "nullable": true }, "amAccountStatus": { "type": "string", "nullable": true }, "amAccountErrorCode": { "type": "integer", "nullable": true }, "amValidationAskAt": { "type": "string", "format": "date-time", "nullable": true }, "amValidationUpdateAt": { "type": "string", "format": "date-time", "nullable": true }, "amValidationStatus": { "type": "string", "nullable": true }, "amValidationError": { "type": "string", "nullable": true }, "amValidationErrorDescription": { "type": "string", "nullable": true }, "moralPerson": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MoralPerson9" } ] }, "physicalPerson": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PhysicalPerson8" } ] }, "creatorPhysicalPerson": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PhysicalPerson8" } ] }, "accountForWho": { "type": "string", "nullable": true }, "currentRelation": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OrganisationUserModel" } ] }, "activity": { "type": "string", "nullable": true }, "displayEmail": { "description": "Public email.", "type": "string", "nullable": true }, "displayPhone": { "description": "Public phone.", "type": "string", "nullable": true }, "displayWebsite": { "description": "Public website.", "type": "string", "nullable": true }, "displayLogo": { "description": "Public logo.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Media2" } ] }, "receiverBankAccount": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ReceiverBankAccount3" } ] }, "activatedFunctionality": { "type": "string", "nullable": true }, "settingClosingTime": { "type": "integer", "default": 10 }, "settingMaxDepositAmount": { "type": "integer", "default": 2500 }, "settingRequestEmailSendTiming": { "type": "string", "default": "instant", "nullable": true }, "settingForceIdentityDocument": { "type": "boolean", "default": false }, "settingMultipleCashOut": { "type": "boolean", "default": false }, "settingInsurance": { "type": "boolean", "default": true }, "mandatoryInfos": { "type": "array", "items": { "type": "string" }, "default": [] }, "uncompletedInfos": { "type": "array", "items": { "type": "string" }, "default": [] }, "accountMainAlert": { "type": "string", "nullable": true }, "accountAlerts": { "type": "array", "items": { "type": "string" }, "default": [] }, "organisationConnectors": { "type": "array", "items": { "$ref": "#/components/schemas/OrganisationConnector" } }, "objectName": { "description": "Name of the object", "type": "string", "default": "organisation", "example": "organisation" }, "id": { "description": "Unique identifier of the organisation", "type": "string", "format": "uuid", "example": "550e8400-e29b-41d4-a716-446655440000" }, "createdAt": { "description": "Creation date of the organisation", "type": "string", "format": "date-time", "example": "2023-01-01T12:00:00+00:00" }, "updatedAt": { "description": "Last update date of the organisation", "type": "string", "format": "date-time", "example": "2023-01-01T15:30:00+00:00" }, "name": { "description": "Name of the organisation", "type": "string", "example": "Example Organisation" }, "parent": { "type": "string", "nullable": true }, "parentData": { "nullable": true, "oneOf": [ { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Organisation20" } ] }, { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Organisation3" } ] } ] }, "displayName": { "description": "Public name.", "type": "string", "nullable": true }, "displayIdentifier": { "type": "string", "nullable": true }, "displayCreatedAt": { "description": "Public created at date.", "type": "string", "format": "date-time", "nullable": true }, "displayAddress": { "description": "Public address.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Address" } ] }, "effectiveFunctionality": { "type": "string", "nullable": true }, "walletFunctionalities": { "type": "boolean" }, "invoiceFunctionalities": { "type": "boolean" }, "littleBondSubscription": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Subscription" } ] }, "email": { "type": "string", "nullable": true } }, "type": "object" }, "CheckInOut7": { "properties": { "recipient": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Organisation20" } ] } }, "type": "object" }, "CashOutDiscussion4": { "required": [ "medias", "type" ], "properties": { "medias": { "type": "array", "items": { "$ref": "#/components/schemas/Media2" } }, "amountProposed": { "description": "New amount proposed by the owner for the cashout.", "type": "number", "format": "float", "nullable": true }, "comment": { "description": "Message of the discussion put by the owner or the recipient.", "type": "string", "nullable": true }, "type": { "description": "Type of discussion.", "type": "string", "enum": [ "recipient_reclamation", "owner_new_offer", "recipient_accept", "owner_deny" ] } }, "type": "object" }, "CashOut4": { "required": [ "id", "amount", "reason", "medias", "cashOutDiscussions", "sequestrationAmount", "actualFinalAmount" ], "properties": { "id": { "type": "string" }, "amount": { "description": "Amount of the cashout.", "type": "number", "format": "float" }, "reason": { "description": "Reason of the cashout.", "type": "string" }, "medias": { "description": "Documents related to the cashout.", "type": "array", "items": { "$ref": "#/components/schemas/Media2" } }, "status": { "description": "CashOut statut.", "type": "string", "default": "waiting", "enum": [ "waiting", "done", "reclamation", "failed", "cancel" ] }, "cashOutDiscussions": { "type": "array", "items": { "$ref": "#/components/schemas/CashOutDiscussion4" } }, "sequestrationSuccess": { "description": "Know if the sequestration of the cashout worked fine.", "type": "boolean", "default": false }, "sequestrationAmount": { "description": "Amount of the sequestrate amount.", "type": "number", "format": "float" }, "refundFailed": { "description": "Know if a refound failed.", "type": "boolean", "default": false }, "transferFailed": { "type": "boolean", "default": false, "nullable": true }, "transferProviderId": { "type": "string", "nullable": true }, "actualFinalAmount": { "type": "number", "format": "float" } }, "type": "object" }, "OrganisationRequestInsurance4": { "required": [ "externalDocuments" ], "properties": { "invoice": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Invoice" } ] }, "externalState": { "description": "State of the insurance if the recipient take it. This state come from our insurance partner.", "type": "string", "nullable": true }, "externalClientCode": { "type": "string", "nullable": true }, "externalDocuments": { "type": "array", "items": {} }, "payed": { "description": "Know if the insurance has been payed by the recipient. This information is useful for the TYLLT administrator", "type": "boolean", "default": false } }, "type": "object" }, "OrganisationTransaction8": { "required": [ "id", "provider", "status" ], "properties": { "id": { "type": "string" }, "provider": { "description": "External provider of the transaction. Our payment partner.", "type": "string" }, "providerId": { "description": "External id of the transaction. Our payment partner transaction ID.", "type": "string", "nullable": true }, "payer": { "description": "Account who paid the transaction.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Organisation20" } ] }, "status": { "type": "string" }, "authorizedAmount": { "description": "3DS authorisation amount.", "type": "number", "format": "float", "nullable": true }, "amount": { "description": "Amount.", "type": "number", "format": "float", "nullable": true } }, "type": "object" }, "RequestEvent6": { "required": [ "type", "medias" ], "properties": { "type": { "description": "Event type.", "type": "string", "enum": [ "email_send", "email_open", "email_processed", "email_delivered", "email_click", "email_bounce", "email_spamreport", "email_unsubscribe", "email_dropped", "email_deferred", "email_blocked", "email_invalid", "email_reply", "email_blacklisted", "ticket_admin_message", "new_transaction_manual_cancel", "ticket_owner_message" ] }, "subType": { "description": "Event subtype. For email event only.", "type": "string", "enum": [ "request_email", "cashout_email" ], "nullable": true }, "message": { "type": "string", "nullable": true }, "recipientMessage": { "type": "string", "nullable": true }, "ownerMessage": { "type": "string", "nullable": true }, "amount": { "type": "number", "format": "float", "nullable": true }, "visibility": { "type": "array", "items": { "type": "string" }, "nullable": true }, "cashOut": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CashOut4" } ] }, "checkIn": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CheckInOut7" } ] }, "checkOut": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CheckInOut7" } ] }, "organisationTransaction": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OrganisationTransaction8" } ] }, "medias": { "type": "array", "items": { "$ref": "#/components/schemas/Media2" } }, "mail": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Mail" } ] }, "invoice": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Invoice" } ] }, "organisationRequestInsurance": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OrganisationRequestInsurance4" } ] } }, "type": "object" }, "RequestSecurityDeposit7": { "required": [ "cashOuts", "organisationRequestInsurances", "personalRequestInsurances", "recipientInformationDocuments", "name", "description", "insuranceActive", "canEdit", "id", "owner", "publicLink", "status", "emailSendTiming", "organisationTransactions", "requestEvents", "dtype" ], "properties": { "depositRecipientsNumber": { "description": "Number of participants for the deposit of the request. Recipients can choose if they want to pay all the security deposit or split it between multiple participants.", "type": "integer", "default": 1, "nullable": true }, "startAt": { "description": "Start date of the request.", "type": "string", "format": "date-time", "nullable": true }, "endAt": { "description": "End date of the request.", "type": "string", "format": "date-time", "nullable": true }, "recipientAllowToUpdateStartAt": { "description": "Know if recipient is allow to update start date.", "type": "boolean", "nullable": true }, "recipientAllowToUpdateEndAt": { "description": "Know if recipient is allow to update end date.", "type": "boolean", "nullable": true }, "settingMultipleProductInformationResponse": { "description": "Recipient response to the multiple product information label.", "type": "string", "nullable": true }, "recipientMoreInformationResponse": { "description": "Recipient response to the more information label.", "type": "string", "nullable": true }, "remoteCheckInStatus": { "description": "Status of the check in.", "type": "string", "default": "waiting", "enum": [ "waiting", "done" ], "nullable": true }, "remoteCheckOutStatus": { "description": "Status of the check out.", "type": "string", "default": "waiting", "enum": [ "waiting", "done" ], "nullable": true }, "depositStatus": { "description": "Status of the deposit.", "type": "string", "default": "waiting", "enum": [ "waiting", "done", "in_error" ], "nullable": true }, "identityVerificationStatus": { "description": "Status of the identity verification.", "type": "string", "default": "waiting", "enum": [ "waiting", "done" ], "nullable": true }, "remoteCheckIn": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CheckInOut7" } ] }, "remoteCheckOut": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CheckInOut7" } ] }, "cashOuts": { "type": "array", "items": { "$ref": "#/components/schemas/CashOut4" } }, "organisationRequestInsurances": { "type": "array", "items": { "$ref": "#/components/schemas/OrganisationRequestInsurance4" } }, "personalRequestInsurances": { "type": "array", "items": { "$ref": "#/components/schemas/OrganisationRequestInsurance4" } }, "recipientInformationDocuments": { "description": "Informations documents related to the recipient.", "type": "array", "items": { "$ref": "#/components/schemas/Media2" } }, "name": { "description": "Name of the request.", "type": "string" }, "description": { "description": "Description of the request.", "type": "string" }, "remoteCheckInOut": { "description": "Active or not the remote check in and check out section.", "type": "boolean", "nullable": true }, "remoteCheckInOutInformation": { "description": "Active or not the remote check in and check out.", "type": "string", "nullable": true }, "depositAmount": { "description": "Amount ask for the deposit.", "type": "number", "format": "float", "nullable": true }, "deposit": { "description": "Active or not the deposit section.", "type": "boolean", "nullable": true }, "depositType": { "description": "Deposit type.", "type": "string", "enum": [ "verification", "blocked", "debit" ], "nullable": true }, "settingMultipleProduct": { "description": "Active or not the multiple product section.", "type": "boolean", "nullable": true }, "settingMultipleProductInformationLabel": { "description": "Display label for recipient who can answer to it in an input text. You can ask a product identification or whatever you want to know what product is in news", "type": "string", "nullable": true }, "recipientMoreInformationLabel": { "description": "Display label for recipient who can answer to it in an input text. You can ask all information you want.", "type": "string", "nullable": true }, "recipientWelcomeMessage": { "description": "Display message for recipient in the deposit asking email.", "type": "string", "nullable": true }, "recipientConfirmMessage": { "description": "Display message for recipient in the deposit confirm email.", "type": "string", "nullable": true }, "recipientVigilancePoints": { "description": "List of vigilance point you want to display for recipient.", "type": "string", "nullable": true }, "settingDateOptional": { "description": "Active or not the date optional for the recipient. If you pass true, recipient can choose to not fill the date field.", "type": "boolean", "nullable": true }, "settingDepositAutomaticEmailRelaunch": { "description": "Active or not the automatic email relaunch for deposit. If the recipient have not completed the deposit, an email will be sent to him.", "type": "boolean", "nullable": true }, "settingMultipleCashOutOption": { "description": "Active or not the possibility to do multiple cashOut on the same request. (This is not disponible for all owner - contact us to know more)", "type": "boolean", "nullable": true }, "settingAuthorizeDepositSharing": { "description": "Setting to authorize deposit sharing, if set to false recipients can't split the deposit. We recommend leaving it set to `true` for large deposits.", "type": "boolean", "default": true, "nullable": true }, "identityVerificationType": { "description": "Type of identity verification to do on the recipient.", "type": "string", "enum": [ "simple", "advanced" ], "nullable": true }, "insurance": { "description": "If it's set to true, recipient can take an insurance during deposit to protect the deposit amount.", "type": "boolean", "nullable": true }, "insuranceMaximumAmount": { "description": "Maximum amount protected by the insurance.", "type": "number", "format": "float", "nullable": true }, "estimatedReleasedAt": { "description": "Estimated release date of the deposit. It's based on the end date of the request and the closing time of the owner.", "type": "string", "format": "date-time", "nullable": true }, "insuranceActive": { "description": "To know if one recipient take the insurance.", "type": "boolean" }, "depositRecipientsPayed": { "description": "Number of recipients that have paid their share.", "type": "integer", "nullable": true }, "depositRecipientsAmountPayed": { "description": "Amount payed by recipients that have paid their share.", "type": "number", "format": "float", "nullable": true }, "depositTransactionAmountPayedDetail": { "description": "Name and amount of the recipients that that have paid their share.", "type": "array", "items": {}, "nullable": true }, "cashOutAllow": { "description": "Property to know if a cashOut request is actually allow on the deposit.", "type": "boolean", "nullable": true }, "cashOutMaximumAmount": { "description": "Property to know the maximum amount that can be set to a cashOut request.", "type": "number", "format": "float", "nullable": true }, "canEdit": { "description": "Property to know if the request ca be edit or no.", "type": "boolean" }, "id": { "type": "string" }, "model": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ModelRequest" } ] }, "owner": { "$ref": "#/components/schemas/Organisation20" }, "recipient": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Organisation20" } ] }, "recipientPreFill": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PhysicalPerson8" } ] }, "publicLink": { "type": "string" }, "source": { "type": "string", "nullable": true }, "locale": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "status": { "type": "string" }, "emailSendTiming": { "type": "string" }, "organisationTransactions": { "type": "array", "items": { "$ref": "#/components/schemas/OrganisationTransaction8" } }, "requestEvents": { "type": "array", "items": { "$ref": "#/components/schemas/RequestEvent6" } }, "partnerIntegrationType": { "type": "string", "nullable": true }, "partnerReturnSuccessUrl": { "type": "string", "nullable": true }, "partnerReturnFailedUrl": { "type": "string", "nullable": true }, "partnerName": { "type": "string", "nullable": true }, "partnerRef": { "type": "string", "nullable": true }, "internalReference": { "type": "string", "nullable": true }, "fullLink": { "type": "string", "nullable": true }, "recipientId": { "type": "string", "nullable": true }, "dtype": { "type": "string" } }, "type": "object", "allOf": [ { "$ref": "#/components/schemas/Request" } ] }, "RequestPayment6": { "required": [ "name", "description", "tvaType", "amount", "amountWithTax", "tvaValue", "canEdit", "id", "owner", "publicLink", "status", "emailSendTiming", "organisationTransactions", "requestEvents", "dtype" ], "properties": { "startAt": { "description": "Start date of the request. Use for the timing of the request email sending", "type": "string", "format": "date-time", "nullable": true }, "payedAt": { "description": "Date of the payment.", "type": "string", "format": "date-time", "nullable": true }, "name": { "description": "Name of the payment request.", "type": "string" }, "description": { "description": "Description of the payment request.", "type": "string" }, "tvaType": { "description": "TVA type of the payment request.", "type": "string", "enum": [ "FR_09", "FR_21", "FR_40", "FR_55", "FR_60", "FR_65", "FR_85", "FR_92", "FR_100", "FR_130", "FR_196", "FR_200", "AT_100", "AT_130", "AT_200", "BE_60", "BE_120", "BE_210", "BG_90", "BG_200", "CH_25", "CH_37", "CH_77", "CH_26", "CH_38", "CH_81", "CY_50", "CY_90", "CY_190", "CZ_100", "CZ_150", "CZ_210", "DE_70", "DE_190", "DK_250", "EE_90", "EE_200", "ES_40", "ES_100", "ES_210", "FI_100", "FI_140", "FI_240", "GB_50", "GB_200", "GR_60", "GR_130", "GR_240", "HR_50", "HR_130", "HR_250", "HU_50", "HU_180", "HU_270", "IE_48", "IE_90", "IE_135", "IE_210", "IE_230", "IT_40", "IT_50", "IT_100", "IT_220", "LT_50", "LT_90", "LT_210", "LU_30", "LU_70", "LU_80", "LU_130", "LU_140", "LU_160", "LU_170", "LV_50", "LV_120", "LV_210", "MC_09", "MC_21", "MC_55", "MC_85", "MC_100", "MC_200", "MT_50", "MT_70", "MT_180", "NL_90", "NL_210", "PL_50", "PL_80", "PL_230", "PT_60", "PT_130", "PT_230", "RO_50", "RO_90", "RO_190", "SE_60", "SE_120", "SE_250", "SI_50", "SI_95", "SI_220", "SK_100", "SK_200", "exempt", "crossborder", "extracom", "FR_100_construction", "FR_200_construction" ] }, "amount": { "description": "Amount of the payment request.", "type": "number", "format": "float" }, "amountWithTax": { "description": "Amount of the payment request with taxes.", "type": "number", "format": "float" }, "tvaValue": { "description": "TVA value of the payment request.", "type": "number", "format": "float" }, "canEdit": { "description": "Property to know if the request ca be edit or no.", "type": "boolean" }, "id": { "type": "string" }, "model": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ModelRequest" } ] }, "owner": { "$ref": "#/components/schemas/Organisation20" }, "recipient": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Organisation20" } ] }, "recipientPreFill": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PhysicalPerson8" } ] }, "publicLink": { "type": "string" }, "source": { "type": "string", "nullable": true }, "locale": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "status": { "type": "string" }, "emailSendTiming": { "type": "string" }, "organisationTransactions": { "type": "array", "items": { "$ref": "#/components/schemas/OrganisationTransaction8" } }, "requestEvents": { "type": "array", "items": { "$ref": "#/components/schemas/RequestEvent6" } }, "partnerIntegrationType": { "type": "string", "nullable": true }, "partnerReturnSuccessUrl": { "type": "string", "nullable": true }, "partnerReturnFailedUrl": { "type": "string", "nullable": true }, "partnerName": { "type": "string", "nullable": true }, "partnerRef": { "type": "string", "nullable": true }, "internalReference": { "type": "string", "nullable": true }, "fullLink": { "type": "string", "nullable": true }, "recipientId": { "type": "string", "nullable": true }, "dtype": { "type": "string" } }, "type": "object", "allOf": [ { "$ref": "#/components/schemas/Request" } ] }, "OrganisationUserUpdateType": { "required": [ "notificationEmail", "notificationPush" ], "properties": { "notificationEmail": { "type": "boolean" }, "notificationPush": { "type": "boolean" } }, "type": "object" }, "Organisation21": { "required": [ "accountType", "organisationConnectors", "id", "createdAt", "updatedAt", "name", "walletFunctionalities", "invoiceFunctionalities" ], "properties": { "organisationName": { "type": "string", "nullable": true }, "accountType": { "type": "string" }, "legalType": { "type": "string", "nullable": true }, "kycLevel": { "type": "string", "default": "LEVEL_0", "nullable": true }, "amAccountId": { "type": "string", "nullable": true }, "amWalletId": { "type": "string", "nullable": true }, "amSequestrationWalletId": { "type": "string", "nullable": true }, "amAccountStatus": { "type": "string", "nullable": true }, "amAccountErrorCode": { "type": "integer", "nullable": true }, "amValidationAskAt": { "type": "string", "format": "date-time", "nullable": true }, "amValidationUpdateAt": { "type": "string", "format": "date-time", "nullable": true }, "amValidationStatus": { "type": "string", "nullable": true }, "amValidationError": { "type": "string", "nullable": true }, "amValidationErrorDescription": { "type": "string", "nullable": true }, "moralPerson": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MoralPerson5" } ] }, "physicalPerson": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PhysicalPerson" } ] }, "creatorPhysicalPerson": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PhysicalPerson" } ] }, "accountForWho": { "type": "string", "nullable": true }, "currentRelation": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OrganisationUserModel" } ] }, "activity": { "type": "string", "nullable": true }, "displayEmail": { "description": "Public email.", "type": "string", "nullable": true }, "displayPhone": { "description": "Public phone.", "type": "string", "nullable": true }, "displayWebsite": { "description": "Public website.", "type": "string", "nullable": true }, "displayLogo": { "description": "Public logo.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Media2" } ] }, "receiverBankAccount": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ReceiverBankAccount3" } ] }, "activatedFunctionality": { "type": "string", "nullable": true }, "settingClosingTime": { "type": "integer", "default": 10 }, "settingMaxDepositAmount": { "type": "integer", "default": 2500 }, "settingRequestEmailSendTiming": { "type": "string", "default": "instant", "nullable": true }, "settingForceIdentityDocument": { "type": "boolean", "default": false }, "settingMultipleCashOut": { "type": "boolean", "default": false }, "settingInsurance": { "type": "boolean", "default": true }, "mandatoryInfos": { "type": "array", "items": { "type": "string" }, "default": [] }, "uncompletedInfos": { "type": "array", "items": { "type": "string" }, "default": [] }, "accountMainAlert": { "type": "string", "nullable": true }, "accountAlerts": { "type": "array", "items": { "type": "string" }, "default": [] }, "organisationConnectors": { "type": "array", "items": { "$ref": "#/components/schemas/OrganisationConnector" } }, "objectName": { "description": "Name of the object", "type": "string", "default": "organisation", "example": "organisation" }, "id": { "description": "Unique identifier of the organisation", "type": "string", "format": "uuid", "example": "550e8400-e29b-41d4-a716-446655440000" }, "createdAt": { "description": "Creation date of the organisation", "type": "string", "format": "date-time", "example": "2023-01-01T12:00:00+00:00" }, "updatedAt": { "description": "Last update date of the organisation", "type": "string", "format": "date-time", "example": "2023-01-01T15:30:00+00:00" }, "name": { "description": "Name of the organisation", "type": "string", "example": "Example Organisation" }, "parent": { "type": "string", "nullable": true }, "parentData": { "nullable": true, "oneOf": [ { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Organisation21" } ] }, { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Organisation3" } ] } ] }, "displayName": { "description": "Public name.", "type": "string", "nullable": true }, "displayIdentifier": { "type": "string", "nullable": true }, "displayCreatedAt": { "description": "Public created at date.", "type": "string", "format": "date-time", "nullable": true }, "displayAddress": { "description": "Public address.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Address2" } ] }, "effectiveFunctionality": { "type": "string", "nullable": true }, "walletFunctionalities": { "type": "boolean" }, "invoiceFunctionalities": { "type": "boolean" }, "littleBondSubscription": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Subscription" } ] }, "email": { "type": "string", "nullable": true } }, "type": "object" }, "OrganisationUser7": { "required": [ "organisation", "rank", "createdAt", "updatedAt", "status" ], "properties": { "objectName": { "description": "Name of the object", "type": "string", "default": "organisation_user", "example": "organisation_user" }, "id": { "description": "Unique identifier of the organisation user", "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000", "nullable": true }, "organisation": { "$ref": "#/components/schemas/Organisation21" }, "rank": { "description": "Rank or role type of the user in the organisation. The ranks depend on the configuration.", "type": "string", "enum": [ "default", "..." ], "example": "default" }, "createdAt": { "description": "Creation date of the relationship between user and organisation", "type": "string", "format": "date-time", "example": "2023-05-15T14:30:00+00:00" }, "updatedAt": { "description": "Last update date of the relationship", "type": "string", "format": "date-time", "example": "2023-08-22T09:45:00+00:00" }, "requestAccessAt": { "description": "Date of the access request to the organisation", "type": "string", "format": "date-time", "example": "2023-07-10T11:20:00+00:00", "nullable": true }, "locks": { "description": "List of access locks applied to the user", "type": "array", "items": { "type": "string" }, "default": [], "example": [ "update", "delete" ] }, "status": { "description": "The status of the relation", "type": "string", "enum": [ "send", "accepted", "requested", "rejected", "expired" ], "example": "send" }, "email": { "description": "Email address of the invited user", "type": "string", "format": "email", "example": "john.doe@example.com", "nullable": true }, "inherited": { "description": "Indicates if the organisation is inherited from the current organisation", "type": "boolean", "default": false, "example": false, "nullable": true } }, "type": "object" }, "CashOutDiscussion5": { "type": "object" }, "CashOut5": { "required": [ "id", "amount", "reason", "medias", "cashOutDiscussions", "sequestrationAmount" ], "properties": { "id": { "type": "string" }, "amount": { "description": "Amount of the cashout.", "type": "number", "format": "float" }, "reason": { "description": "Reason of the cashout.", "type": "string" }, "medias": { "description": "Documents related to the cashout.", "type": "array", "items": { "$ref": "#/components/schemas/Media" } }, "status": { "description": "CashOut statut.", "type": "string", "default": "waiting", "enum": [ "waiting", "done", "reclamation", "failed", "cancel" ] }, "cashOutDiscussions": { "type": "array", "items": { "$ref": "#/components/schemas/CashOutDiscussion5" } }, "sequestrationSuccess": { "description": "Know if the sequestration of the cashout worked fine.", "type": "boolean", "default": false }, "sequestrationAmount": { "description": "Amount of the sequestrate amount.", "type": "number", "format": "float" } }, "type": "object" }, "Organisation22": { "properties": { "displayEmail": { "description": "Public email.", "type": "string", "nullable": true }, "displayPhone": { "description": "Public phone.", "type": "string", "nullable": true }, "displayWebsite": { "description": "Public website.", "type": "string", "nullable": true }, "displayLogo": { "description": "Public logo.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Media2" } ] }, "auditAt": { "type": "string", "format": "date-time", "nullable": true }, "displayName": { "description": "Public name.", "type": "string", "nullable": true }, "displayCreatedAt": { "description": "Public created at date.", "type": "string", "format": "date-time", "nullable": true }, "displayAddress": { "description": "Public address.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Address" } ] } }, "type": "object" }, "CheckInOut8": { "properties": { "recipient": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Organisation22" } ] }, "createdAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true } }, "type": "object" }, "CashOutDiscussion6": { "properties": { "createdAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true } }, "type": "object" }, "CashOut6": { "required": [ "id", "amount", "reason", "medias", "cashOutDiscussions", "sequestrationAmount" ], "properties": { "id": { "type": "string" }, "amount": { "description": "Amount of the cashout.", "type": "number", "format": "float" }, "reason": { "description": "Reason of the cashout.", "type": "string" }, "medias": { "description": "Documents related to the cashout.", "type": "array", "items": { "$ref": "#/components/schemas/Media2" } }, "status": { "description": "CashOut statut.", "type": "string", "default": "waiting", "enum": [ "waiting", "done", "reclamation", "failed", "cancel" ] }, "cashOutDiscussions": { "type": "array", "items": { "$ref": "#/components/schemas/CashOutDiscussion6" } }, "sequestrationSuccess": { "description": "Know if the sequestration of the cashout worked fine.", "type": "boolean", "default": false }, "sequestrationAmount": { "description": "Amount of the sequestrate amount.", "type": "number", "format": "float" }, "createdAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true } }, "type": "object" }, "OrganisationTransaction9": { "required": [ "id", "provider", "status" ], "properties": { "id": { "type": "string" }, "provider": { "description": "External provider of the transaction. Our payment partner.", "type": "string" }, "providerId": { "description": "External id of the transaction. Our payment partner transaction ID.", "type": "string", "nullable": true }, "payer": { "description": "Account who paid the transaction.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Organisation22" } ] }, "status": { "type": "string" }, "authorizedAmount": { "description": "3DS authorisation amount.", "type": "number", "format": "float", "nullable": true }, "amount": { "description": "Amount.", "type": "number", "format": "float", "nullable": true } }, "type": "object" }, "RequestSecurityDeposit8": { "required": [ "cashOuts", "recipientInformationDocuments", "name", "description", "insuranceActive", "canEdit", "id", "owner", "publicLink", "status", "emailSendTiming", "organisationTransactions", "requestEvents", "dtype" ], "properties": { "depositRecipientsNumber": { "description": "Number of participants for the deposit of the request. Recipients can choose if they want to pay all the security deposit or split it between multiple participants.", "type": "integer", "default": 1, "nullable": true }, "startAt": { "description": "Start date of the request.", "type": "string", "format": "date-time", "nullable": true }, "endAt": { "description": "End date of the request.", "type": "string", "format": "date-time", "nullable": true }, "recipientAllowToUpdateStartAt": { "description": "Know if recipient is allow to update start date.", "type": "boolean", "nullable": true }, "recipientAllowToUpdateEndAt": { "description": "Know if recipient is allow to update end date.", "type": "boolean", "nullable": true }, "settingMultipleProductInformationResponse": { "description": "Recipient response to the multiple product information label.", "type": "string", "nullable": true }, "recipientMoreInformationResponse": { "description": "Recipient response to the more information label.", "type": "string", "nullable": true }, "remoteCheckInStatus": { "description": "Status of the check in.", "type": "string", "default": "waiting", "enum": [ "waiting", "done" ], "nullable": true }, "remoteCheckOutStatus": { "description": "Status of the check out.", "type": "string", "default": "waiting", "enum": [ "waiting", "done" ], "nullable": true }, "depositStatus": { "description": "Status of the deposit.", "type": "string", "default": "waiting", "enum": [ "waiting", "done", "in_error" ], "nullable": true }, "identityVerificationStatus": { "description": "Status of the identity verification.", "type": "string", "default": "waiting", "enum": [ "waiting", "done" ], "nullable": true }, "remoteCheckIn": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CheckInOut8" } ] }, "remoteCheckOut": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CheckInOut8" } ] }, "cashOuts": { "type": "array", "items": { "$ref": "#/components/schemas/CashOut6" } }, "createdAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true }, "recipientInformationDocuments": { "description": "Informations documents related to the recipient.", "type": "array", "items": { "$ref": "#/components/schemas/Media2" } }, "name": { "description": "Name of the request.", "type": "string" }, "description": { "description": "Description of the request.", "type": "string" }, "remoteCheckInOut": { "description": "Active or not the remote check in and check out section.", "type": "boolean", "nullable": true }, "remoteCheckInOutInformation": { "description": "Active or not the remote check in and check out.", "type": "string", "nullable": true }, "depositAmount": { "description": "Amount ask for the deposit.", "type": "number", "format": "float", "nullable": true }, "deposit": { "description": "Active or not the deposit section.", "type": "boolean", "nullable": true }, "depositType": { "description": "Deposit type.", "type": "string", "enum": [ "verification", "blocked", "debit" ], "nullable": true }, "settingMultipleProduct": { "description": "Active or not the multiple product section.", "type": "boolean", "nullable": true }, "settingMultipleProductInformationLabel": { "description": "Display label for recipient who can answer to it in an input text. You can ask a product identification or whatever you want to know what product is in news", "type": "string", "nullable": true }, "recipientMoreInformationLabel": { "description": "Display label for recipient who can answer to it in an input text. You can ask all information you want.", "type": "string", "nullable": true }, "recipientWelcomeMessage": { "description": "Display message for recipient in the deposit asking email.", "type": "string", "nullable": true }, "recipientConfirmMessage": { "description": "Display message for recipient in the deposit confirm email.", "type": "string", "nullable": true }, "recipientVigilancePoints": { "description": "List of vigilance point you want to display for recipient.", "type": "string", "nullable": true }, "settingDateOptional": { "description": "Active or not the date optional for the recipient. If you pass true, recipient can choose to not fill the date field.", "type": "boolean", "nullable": true }, "settingDepositAutomaticEmailRelaunch": { "description": "Active or not the automatic email relaunch for deposit. If the recipient have not completed the deposit, an email will be sent to him.", "type": "boolean", "nullable": true }, "settingMultipleCashOutOption": { "description": "Active or not the possibility to do multiple cashOut on the same request. (This is not disponible for all owner - contact us to know more)", "type": "boolean", "nullable": true }, "settingAuthorizeDepositSharing": { "description": "Setting to authorize deposit sharing, if set to false recipients can't split the deposit. We recommend leaving it set to `true` for large deposits.", "type": "boolean", "default": true, "nullable": true }, "identityVerificationType": { "description": "Type of identity verification to do on the recipient.", "type": "string", "enum": [ "simple", "advanced" ], "nullable": true }, "insurance": { "description": "If it's set to true, recipient can take an insurance during deposit to protect the deposit amount.", "type": "boolean", "nullable": true }, "insuranceMaximumAmount": { "description": "Maximum amount protected by the insurance.", "type": "number", "format": "float", "nullable": true }, "estimatedReleasedAt": { "description": "Estimated release date of the deposit. It's based on the end date of the request and the closing time of the owner.", "type": "string", "format": "date-time", "nullable": true }, "insuranceActive": { "description": "To know if one recipient take the insurance.", "type": "boolean" }, "depositRecipientsPayed": { "description": "Number of recipients that have paid their share.", "type": "integer", "nullable": true }, "depositRecipientsAmountPayed": { "description": "Amount payed by recipients that have paid their share.", "type": "number", "format": "float", "nullable": true }, "depositTransactionAmountPayedDetail": { "description": "Name and amount of the recipients that that have paid their share.", "type": "array", "items": {}, "nullable": true }, "cashOutAllow": { "description": "Property to know if a cashOut request is actually allow on the deposit.", "type": "boolean", "nullable": true }, "cashOutMaximumAmount": { "description": "Property to know the maximum amount that can be set to a cashOut request.", "type": "number", "format": "float", "nullable": true }, "canEdit": { "description": "Property to know if the request ca be edit or no.", "type": "boolean" }, "id": { "type": "string" }, "model": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ModelRequest3" } ] }, "owner": { "$ref": "#/components/schemas/Organisation22" }, "recipient": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Organisation22" } ] }, "recipientPreFill": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PhysicalPerson4" } ] }, "publicLink": { "type": "string" }, "source": { "type": "string", "nullable": true }, "locale": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "status": { "type": "string" }, "emailSendTiming": { "type": "string" }, "organisationTransactions": { "type": "array", "items": { "$ref": "#/components/schemas/OrganisationTransaction9" } }, "requestEvents": { "type": "array", "items": { "$ref": "#/components/schemas/RequestEvent2" } }, "partnerIntegrationType": { "type": "string", "nullable": true }, "partnerReturnSuccessUrl": { "type": "string", "nullable": true }, "partnerReturnFailedUrl": { "type": "string", "nullable": true }, "partnerName": { "type": "string", "nullable": true }, "partnerRef": { "type": "string", "nullable": true }, "internalReference": { "type": "string", "nullable": true }, "fullLink": { "type": "string", "nullable": true }, "recipientId": { "type": "string", "nullable": true }, "dtype": { "type": "string" } }, "type": "object", "allOf": [ { "$ref": "#/components/schemas/Request" } ] }, "RequestPayment7": { "required": [ "name", "description", "tvaType", "amount", "amountWithTax", "tvaValue", "canEdit", "id", "owner", "publicLink", "status", "emailSendTiming", "organisationTransactions", "requestEvents", "dtype" ], "properties": { "startAt": { "description": "Start date of the request. Use for the timing of the request email sending", "type": "string", "format": "date-time", "nullable": true }, "payedAt": { "description": "Date of the payment.", "type": "string", "format": "date-time", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true }, "name": { "description": "Name of the payment request.", "type": "string" }, "description": { "description": "Description of the payment request.", "type": "string" }, "tvaType": { "description": "TVA type of the payment request.", "type": "string", "enum": [ "FR_09", "FR_21", "FR_40", "FR_55", "FR_60", "FR_65", "FR_85", "FR_92", "FR_100", "FR_130", "FR_196", "FR_200", "AT_100", "AT_130", "AT_200", "BE_60", "BE_120", "BE_210", "BG_90", "BG_200", "CH_25", "CH_37", "CH_77", "CH_26", "CH_38", "CH_81", "CY_50", "CY_90", "CY_190", "CZ_100", "CZ_150", "CZ_210", "DE_70", "DE_190", "DK_250", "EE_90", "EE_200", "ES_40", "ES_100", "ES_210", "FI_100", "FI_140", "FI_240", "GB_50", "GB_200", "GR_60", "GR_130", "GR_240", "HR_50", "HR_130", "HR_250", "HU_50", "HU_180", "HU_270", "IE_48", "IE_90", "IE_135", "IE_210", "IE_230", "IT_40", "IT_50", "IT_100", "IT_220", "LT_50", "LT_90", "LT_210", "LU_30", "LU_70", "LU_80", "LU_130", "LU_140", "LU_160", "LU_170", "LV_50", "LV_120", "LV_210", "MC_09", "MC_21", "MC_55", "MC_85", "MC_100", "MC_200", "MT_50", "MT_70", "MT_180", "NL_90", "NL_210", "PL_50", "PL_80", "PL_230", "PT_60", "PT_130", "PT_230", "RO_50", "RO_90", "RO_190", "SE_60", "SE_120", "SE_250", "SI_50", "SI_95", "SI_220", "SK_100", "SK_200", "exempt", "crossborder", "extracom", "FR_100_construction", "FR_200_construction" ] }, "amount": { "description": "Amount of the payment request.", "type": "number", "format": "float" }, "amountWithTax": { "description": "Amount of the payment request with taxes.", "type": "number", "format": "float" }, "tvaValue": { "description": "TVA value of the payment request.", "type": "number", "format": "float" }, "canEdit": { "description": "Property to know if the request ca be edit or no.", "type": "boolean" }, "id": { "type": "string" }, "model": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ModelRequest3" } ] }, "owner": { "$ref": "#/components/schemas/Organisation22" }, "recipient": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Organisation22" } ] }, "recipientPreFill": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PhysicalPerson4" } ] }, "publicLink": { "type": "string" }, "source": { "type": "string", "nullable": true }, "locale": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "status": { "type": "string" }, "emailSendTiming": { "type": "string" }, "organisationTransactions": { "type": "array", "items": { "$ref": "#/components/schemas/OrganisationTransaction9" } }, "requestEvents": { "type": "array", "items": { "$ref": "#/components/schemas/RequestEvent2" } }, "partnerIntegrationType": { "type": "string", "nullable": true }, "partnerReturnSuccessUrl": { "type": "string", "nullable": true }, "partnerReturnFailedUrl": { "type": "string", "nullable": true }, "partnerName": { "type": "string", "nullable": true }, "partnerRef": { "type": "string", "nullable": true }, "internalReference": { "type": "string", "nullable": true }, "fullLink": { "type": "string", "nullable": true }, "recipientId": { "type": "string", "nullable": true }, "dtype": { "type": "string" } }, "type": "object", "allOf": [ { "$ref": "#/components/schemas/Request" } ] }, "Organisation23": { "properties": { "displayEmail": { "description": "Public email.", "type": "string", "nullable": true }, "displayPhone": { "description": "Public phone.", "type": "string", "nullable": true }, "displayWebsite": { "description": "Public website.", "type": "string", "nullable": true }, "displayLogo": { "description": "Public logo.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Media" } ] }, "auditAt": { "type": "string", "format": "date-time", "nullable": true }, "displayName": { "description": "Public name.", "type": "string", "nullable": true }, "displayCreatedAt": { "description": "Public created at date.", "type": "string", "format": "date-time", "nullable": true }, "displayAddress": { "description": "Public address.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Address" } ] } }, "type": "object" }, "CheckInOut9": { "required": [ "id", "type", "comment", "medias" ], "properties": { "id": { "type": "string" }, "type": { "description": "Type.", "type": "string", "enum": [ "check_in", "check_out" ] }, "comment": { "description": "Comment.", "type": "string" }, "medias": { "type": "array", "items": { "$ref": "#/components/schemas/Media" } }, "recipient": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Organisation23" } ] }, "createdAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true } }, "type": "object" }, "CashOut7": { "required": [ "id", "amount", "reason", "medias", "cashOutDiscussions", "sequestrationAmount" ], "properties": { "id": { "type": "string" }, "amount": { "description": "Amount of the cashout.", "type": "number", "format": "float" }, "reason": { "description": "Reason of the cashout.", "type": "string" }, "medias": { "description": "Documents related to the cashout.", "type": "array", "items": { "$ref": "#/components/schemas/Media" } }, "status": { "description": "CashOut statut.", "type": "string", "default": "waiting", "enum": [ "waiting", "done", "reclamation", "failed", "cancel" ] }, "cashOutDiscussions": { "type": "array", "items": { "$ref": "#/components/schemas/CashOutDiscussion6" } }, "sequestrationSuccess": { "description": "Know if the sequestration of the cashout worked fine.", "type": "boolean", "default": false }, "sequestrationAmount": { "description": "Amount of the sequestrate amount.", "type": "number", "format": "float" }, "createdAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true } }, "type": "object" }, "PhysicalPerson9": { "properties": { "auditAt": { "type": "string", "format": "date-time", "nullable": true }, "secondaryEmail": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "secondaryPhone": { "type": "string", "nullable": true }, "firstname": { "type": "string", "nullable": true }, "lastname": { "type": "string", "nullable": true }, "birthday": { "type": "string", "format": "date-time", "nullable": true }, "birthdayAddress": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Address" } ] }, "address": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Address" } ] }, "monthlyIncome": { "description": "Monthly income.", "type": "string", "enum": [ "LOWER_THAN_1200_EUROS", "BETWEEN_1200_2500_EUROS", "BETWEEN_2500_4000_EUROS", "GREATER_THAN_4000_EUROS" ], "nullable": true }, "profession": { "description": "Profession.", "type": "string", "enum": [ "FARMER", "CRAFTSMAN_MERCHANT_ENTREPRENEUR", "LIBERAL_PROFESSION", "EXECUTIVE", "RETIREE", "EMPLOYEE", "WORKER", "NO_ACTIVITY" ], "nullable": true }, "nationality": { "description": "Nationality in alpha3 country code.", "type": "string", "enum": [ "afg", "zaf", "alb", "dza", "deu", "and", "ago", "atg", "sau", "arg", "arm", "aus", "aut", "aze", "bhs", "bhr", "bgd", "brb", "blr", "bel", "blz", "ben", "btn", "bol", "bih", "bwa", "bra", "brn", "bgr", "bfa", "bdi", "khm", "cmr", "can", "cpv", "caf", "chl", "chn", "cyp", "col", "com", "cog", "cod", "kor", "prk", "cri", "civ", "hrv", "cub", "dnk", "dji", "dom", "dma", "egy", "slv", "are", "ecu", "eri", "esp", "est", "usa", "eth", "fji", "fin", "fra", "gab", "gmb", "geo", "gha", "grc", "grd", "gtm", "gin", "gnb", "gnq", "guy", "hti", "hnd", "hun", "ind", "idn", "irn", "irq", "irl", "isl", "isr", "ita", "jam", "jpn", "jor", "kaz", "ken", "kgz", "kir", "kwt", "lao", "lso", "lva", "lbn", "lbr", "lby", "lie", "ltu", "lux", "mkd", "mdg", "mys", "mwi", "mdv", "mli", "mlt", "mar", "mhl", "mus", "mrt", "mex", "fsm", "mda", "mco", "mng", "mne", "moz", "mmr", "nam", "nru", "npl", "nic", "ner", "nga", "nor", "nzl", "omn", "uga", "uzb", "pak", "plw", "pan", "png", "pry", "nld", "per", "phl", "pol", "prt", "qat", "rou", "gbr", "rus", "rwa", "kna", "smr", "vct", "lca", "slb", "wsm", "stp", "sen", "srb", "syc", "sle", "sgp", "svk", "svn", "som", "sdn", "ssd", "lka", "swe", "che", "sur", "swz", "syr", "tjk", "tza", "tcd", "cze", "tha", "tls", "tgo", "ton", "tto", "tun", "tkm", "tur", "tuv", "ukr", "ury", "vut", "ven", "vnm", "yem", "zmb", "zwe" ], "nullable": true }, "identityDocument": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Document3" } ] }, "createdAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true } }, "type": "object" }, "OrganisationTransaction10": { "required": [ "id", "provider", "status" ], "properties": { "id": { "type": "string" }, "provider": { "description": "External provider of the transaction. Our payment partner.", "type": "string" }, "providerId": { "description": "External id of the transaction. Our payment partner transaction ID.", "type": "string", "nullable": true }, "payer": { "description": "Account who paid the transaction.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Organisation23" } ] }, "status": { "type": "string" }, "authorizedAmount": { "description": "3DS authorisation amount.", "type": "number", "format": "float", "nullable": true }, "amount": { "description": "Amount.", "type": "number", "format": "float", "nullable": true } }, "type": "object" }, "RequestEvent7": { "required": [ "type" ], "properties": { "type": { "description": "Event type.", "type": "string", "enum": [ "email_send", "email_open", "email_processed", "email_delivered", "email_click", "email_bounce", "email_spamreport", "email_unsubscribe", "email_dropped", "email_deferred", "email_blocked", "email_invalid", "email_reply", "email_blacklisted", "ticket_admin_message", "new_transaction_manual_cancel", "ticket_owner_message" ] }, "subType": { "description": "Event subtype. For email event only.", "type": "string", "enum": [ "request_email", "cashout_email" ], "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true } }, "type": "object" }, "RequestSecurityDeposit9": { "required": [ "cashOuts", "recipientInformationDocuments", "name", "description", "insuranceActive", "canEdit", "id", "owner", "publicLink", "status", "emailSendTiming", "organisationTransactions", "requestEvents", "dtype" ], "properties": { "depositRecipientsNumber": { "description": "Number of participants for the deposit of the request. Recipients can choose if they want to pay all the security deposit or split it between multiple participants.", "type": "integer", "default": 1, "nullable": true }, "startAt": { "description": "Start date of the request.", "type": "string", "format": "date-time", "nullable": true }, "endAt": { "description": "End date of the request.", "type": "string", "format": "date-time", "nullable": true }, "recipientAllowToUpdateStartAt": { "description": "Know if recipient is allow to update start date.", "type": "boolean", "nullable": true }, "recipientAllowToUpdateEndAt": { "description": "Know if recipient is allow to update end date.", "type": "boolean", "nullable": true }, "settingMultipleProductInformationResponse": { "description": "Recipient response to the multiple product information label.", "type": "string", "nullable": true }, "recipientMoreInformationResponse": { "description": "Recipient response to the more information label.", "type": "string", "nullable": true }, "remoteCheckInStatus": { "description": "Status of the check in.", "type": "string", "default": "waiting", "enum": [ "waiting", "done" ], "nullable": true }, "remoteCheckOutStatus": { "description": "Status of the check out.", "type": "string", "default": "waiting", "enum": [ "waiting", "done" ], "nullable": true }, "depositStatus": { "description": "Status of the deposit.", "type": "string", "default": "waiting", "enum": [ "waiting", "done", "in_error" ], "nullable": true }, "identityVerificationStatus": { "description": "Status of the identity verification.", "type": "string", "default": "waiting", "enum": [ "waiting", "done" ], "nullable": true }, "remoteCheckIn": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CheckInOut9" } ] }, "remoteCheckOut": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CheckInOut9" } ] }, "cashOuts": { "type": "array", "items": { "$ref": "#/components/schemas/CashOut7" } }, "createdAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true }, "recipientInformationDocuments": { "description": "Informations documents related to the recipient.", "type": "array", "items": { "$ref": "#/components/schemas/Media" } }, "name": { "description": "Name of the request.", "type": "string" }, "description": { "description": "Description of the request.", "type": "string" }, "remoteCheckInOut": { "description": "Active or not the remote check in and check out section.", "type": "boolean", "nullable": true }, "remoteCheckInOutInformation": { "description": "Active or not the remote check in and check out.", "type": "string", "nullable": true }, "depositAmount": { "description": "Amount ask for the deposit.", "type": "number", "format": "float", "nullable": true }, "deposit": { "description": "Active or not the deposit section.", "type": "boolean", "nullable": true }, "depositType": { "description": "Deposit type.", "type": "string", "enum": [ "verification", "blocked", "debit" ], "nullable": true }, "settingMultipleProduct": { "description": "Active or not the multiple product section.", "type": "boolean", "nullable": true }, "settingMultipleProductInformationLabel": { "description": "Display label for recipient who can answer to it in an input text. You can ask a product identification or whatever you want to know what product is in news", "type": "string", "nullable": true }, "recipientMoreInformationLabel": { "description": "Display label for recipient who can answer to it in an input text. You can ask all information you want.", "type": "string", "nullable": true }, "recipientWelcomeMessage": { "description": "Display message for recipient in the deposit asking email.", "type": "string", "nullable": true }, "recipientConfirmMessage": { "description": "Display message for recipient in the deposit confirm email.", "type": "string", "nullable": true }, "recipientVigilancePoints": { "description": "List of vigilance point you want to display for recipient.", "type": "string", "nullable": true }, "settingDateOptional": { "description": "Active or not the date optional for the recipient. If you pass true, recipient can choose to not fill the date field.", "type": "boolean", "nullable": true }, "settingDepositAutomaticEmailRelaunch": { "description": "Active or not the automatic email relaunch for deposit. If the recipient have not completed the deposit, an email will be sent to him.", "type": "boolean", "nullable": true }, "settingMultipleCashOutOption": { "description": "Active or not the possibility to do multiple cashOut on the same request. (This is not disponible for all owner - contact us to know more)", "type": "boolean", "nullable": true }, "settingAuthorizeDepositSharing": { "description": "Setting to authorize deposit sharing, if set to false recipients can't split the deposit. We recommend leaving it set to `true` for large deposits.", "type": "boolean", "default": true, "nullable": true }, "identityVerificationType": { "description": "Type of identity verification to do on the recipient.", "type": "string", "enum": [ "simple", "advanced" ], "nullable": true }, "insurance": { "description": "If it's set to true, recipient can take an insurance during deposit to protect the deposit amount.", "type": "boolean", "nullable": true }, "insuranceMaximumAmount": { "description": "Maximum amount protected by the insurance.", "type": "number", "format": "float", "nullable": true }, "estimatedReleasedAt": { "description": "Estimated release date of the deposit. It's based on the end date of the request and the closing time of the owner.", "type": "string", "format": "date-time", "nullable": true }, "insuranceActive": { "description": "To know if one recipient take the insurance.", "type": "boolean" }, "depositRecipientsPayed": { "description": "Number of recipients that have paid their share.", "type": "integer", "nullable": true }, "depositRecipientsAmountPayed": { "description": "Amount payed by recipients that have paid their share.", "type": "number", "format": "float", "nullable": true }, "depositTransactionAmountPayedDetail": { "description": "Name and amount of the recipients that that have paid their share.", "type": "array", "items": {}, "nullable": true }, "cashOutAllow": { "description": "Property to know if a cashOut request is actually allow on the deposit.", "type": "boolean", "nullable": true }, "cashOutMaximumAmount": { "description": "Property to know the maximum amount that can be set to a cashOut request.", "type": "number", "format": "float", "nullable": true }, "canEdit": { "description": "Property to know if the request ca be edit or no.", "type": "boolean" }, "id": { "type": "string" }, "model": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ModelRequest3" } ] }, "owner": { "$ref": "#/components/schemas/Organisation23" }, "recipient": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Organisation23" } ] }, "recipientPreFill": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PhysicalPerson9" } ] }, "publicLink": { "type": "string" }, "source": { "type": "string", "nullable": true }, "locale": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "status": { "type": "string" }, "emailSendTiming": { "type": "string" }, "organisationTransactions": { "type": "array", "items": { "$ref": "#/components/schemas/OrganisationTransaction10" } }, "requestEvents": { "type": "array", "items": { "$ref": "#/components/schemas/RequestEvent7" } }, "partnerIntegrationType": { "type": "string", "nullable": true }, "partnerReturnSuccessUrl": { "type": "string", "nullable": true }, "partnerReturnFailedUrl": { "type": "string", "nullable": true }, "partnerName": { "type": "string", "nullable": true }, "partnerRef": { "type": "string", "nullable": true }, "internalReference": { "type": "string", "nullable": true }, "fullLink": { "type": "string", "nullable": true }, "recipientId": { "type": "string", "nullable": true }, "dtype": { "type": "string" } }, "type": "object", "allOf": [ { "$ref": "#/components/schemas/Request" } ] }, "RequestPayment8": { "required": [ "name", "description", "tvaType", "amount", "amountWithTax", "tvaValue", "canEdit", "id", "owner", "publicLink", "status", "emailSendTiming", "organisationTransactions", "requestEvents", "dtype" ], "properties": { "startAt": { "description": "Start date of the request. Use for the timing of the request email sending", "type": "string", "format": "date-time", "nullable": true }, "payedAt": { "description": "Date of the payment.", "type": "string", "format": "date-time", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true }, "name": { "description": "Name of the payment request.", "type": "string" }, "description": { "description": "Description of the payment request.", "type": "string" }, "tvaType": { "description": "TVA type of the payment request.", "type": "string", "enum": [ "FR_09", "FR_21", "FR_40", "FR_55", "FR_60", "FR_65", "FR_85", "FR_92", "FR_100", "FR_130", "FR_196", "FR_200", "AT_100", "AT_130", "AT_200", "BE_60", "BE_120", "BE_210", "BG_90", "BG_200", "CH_25", "CH_37", "CH_77", "CH_26", "CH_38", "CH_81", "CY_50", "CY_90", "CY_190", "CZ_100", "CZ_150", "CZ_210", "DE_70", "DE_190", "DK_250", "EE_90", "EE_200", "ES_40", "ES_100", "ES_210", "FI_100", "FI_140", "FI_240", "GB_50", "GB_200", "GR_60", "GR_130", "GR_240", "HR_50", "HR_130", "HR_250", "HU_50", "HU_180", "HU_270", "IE_48", "IE_90", "IE_135", "IE_210", "IE_230", "IT_40", "IT_50", "IT_100", "IT_220", "LT_50", "LT_90", "LT_210", "LU_30", "LU_70", "LU_80", "LU_130", "LU_140", "LU_160", "LU_170", "LV_50", "LV_120", "LV_210", "MC_09", "MC_21", "MC_55", "MC_85", "MC_100", "MC_200", "MT_50", "MT_70", "MT_180", "NL_90", "NL_210", "PL_50", "PL_80", "PL_230", "PT_60", "PT_130", "PT_230", "RO_50", "RO_90", "RO_190", "SE_60", "SE_120", "SE_250", "SI_50", "SI_95", "SI_220", "SK_100", "SK_200", "exempt", "crossborder", "extracom", "FR_100_construction", "FR_200_construction" ] }, "amount": { "description": "Amount of the payment request.", "type": "number", "format": "float" }, "amountWithTax": { "description": "Amount of the payment request with taxes.", "type": "number", "format": "float" }, "tvaValue": { "description": "TVA value of the payment request.", "type": "number", "format": "float" }, "canEdit": { "description": "Property to know if the request ca be edit or no.", "type": "boolean" }, "id": { "type": "string" }, "model": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ModelRequest3" } ] }, "owner": { "$ref": "#/components/schemas/Organisation23" }, "recipient": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Organisation23" } ] }, "recipientPreFill": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PhysicalPerson9" } ] }, "publicLink": { "type": "string" }, "source": { "type": "string", "nullable": true }, "locale": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "status": { "type": "string" }, "emailSendTiming": { "type": "string" }, "organisationTransactions": { "type": "array", "items": { "$ref": "#/components/schemas/OrganisationTransaction10" } }, "requestEvents": { "type": "array", "items": { "$ref": "#/components/schemas/RequestEvent7" } }, "partnerIntegrationType": { "type": "string", "nullable": true }, "partnerReturnSuccessUrl": { "type": "string", "nullable": true }, "partnerReturnFailedUrl": { "type": "string", "nullable": true }, "partnerName": { "type": "string", "nullable": true }, "partnerRef": { "type": "string", "nullable": true }, "internalReference": { "type": "string", "nullable": true }, "fullLink": { "type": "string", "nullable": true }, "recipientId": { "type": "string", "nullable": true }, "dtype": { "type": "string" } }, "type": "object", "allOf": [ { "$ref": "#/components/schemas/Request" } ] }, "Media3": { "required": [ "id", "name", "extension" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "extension": { "type": "string" } }, "type": "object" }, "Organisation24": { "properties": { "displayEmail": { "description": "Public email.", "type": "string", "nullable": true }, "displayPhone": { "description": "Public phone.", "type": "string", "nullable": true }, "displayWebsite": { "description": "Public website.", "type": "string", "nullable": true }, "displayLogo": { "description": "Public logo.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Media3" } ] }, "displayName": { "description": "Public name.", "type": "string", "nullable": true }, "displayCreatedAt": { "description": "Public created at date.", "type": "string", "format": "date-time", "nullable": true }, "displayAddress": { "description": "Public address.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Address" } ] } }, "type": "object" }, "CheckInOut10": { "properties": { "recipient": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Organisation24" } ] } }, "type": "object" }, "CashOut8": { "required": [ "id", "amount", "reason", "medias", "cashOutDiscussions", "sequestrationAmount" ], "properties": { "id": { "type": "string" }, "amount": { "description": "Amount of the cashout.", "type": "number", "format": "float" }, "reason": { "description": "Reason of the cashout.", "type": "string" }, "medias": { "description": "Documents related to the cashout.", "type": "array", "items": { "$ref": "#/components/schemas/Media3" } }, "status": { "description": "CashOut statut.", "type": "string", "default": "waiting", "enum": [ "waiting", "done", "reclamation", "failed", "cancel" ] }, "cashOutDiscussions": { "type": "array", "items": { "$ref": "#/components/schemas/CashOutDiscussion5" } }, "sequestrationSuccess": { "description": "Know if the sequestration of the cashout worked fine.", "type": "boolean", "default": false }, "sequestrationAmount": { "description": "Amount of the sequestrate amount.", "type": "number", "format": "float" } }, "type": "object" }, "Document4": { "required": [ "id", "type", "medias" ], "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "status": { "type": "string", "default": "provide" }, "medias": { "type": "array", "items": { "$ref": "#/components/schemas/Media3" } } }, "type": "object" }, "PhysicalPerson10": { "properties": { "secondaryEmail": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "secondaryPhone": { "type": "string", "nullable": true }, "firstname": { "type": "string", "nullable": true }, "lastname": { "type": "string", "nullable": true }, "birthday": { "type": "string", "format": "date-time", "nullable": true }, "birthdayAddress": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Address" } ] }, "address": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Address" } ] }, "monthlyIncome": { "description": "Monthly income.", "type": "string", "enum": [ "LOWER_THAN_1200_EUROS", "BETWEEN_1200_2500_EUROS", "BETWEEN_2500_4000_EUROS", "GREATER_THAN_4000_EUROS" ], "nullable": true }, "profession": { "description": "Profession.", "type": "string", "enum": [ "FARMER", "CRAFTSMAN_MERCHANT_ENTREPRENEUR", "LIBERAL_PROFESSION", "EXECUTIVE", "RETIREE", "EMPLOYEE", "WORKER", "NO_ACTIVITY" ], "nullable": true }, "nationality": { "description": "Nationality in alpha3 country code.", "type": "string", "enum": [ "afg", "zaf", "alb", "dza", "deu", "and", "ago", "atg", "sau", "arg", "arm", "aus", "aut", "aze", "bhs", "bhr", "bgd", "brb", "blr", "bel", "blz", "ben", "btn", "bol", "bih", "bwa", "bra", "brn", "bgr", "bfa", "bdi", "khm", "cmr", "can", "cpv", "caf", "chl", "chn", "cyp", "col", "com", "cog", "cod", "kor", "prk", "cri", "civ", "hrv", "cub", "dnk", "dji", "dom", "dma", "egy", "slv", "are", "ecu", "eri", "esp", "est", "usa", "eth", "fji", "fin", "fra", "gab", "gmb", "geo", "gha", "grc", "grd", "gtm", "gin", "gnb", "gnq", "guy", "hti", "hnd", "hun", "ind", "idn", "irn", "irq", "irl", "isl", "isr", "ita", "jam", "jpn", "jor", "kaz", "ken", "kgz", "kir", "kwt", "lao", "lso", "lva", "lbn", "lbr", "lby", "lie", "ltu", "lux", "mkd", "mdg", "mys", "mwi", "mdv", "mli", "mlt", "mar", "mhl", "mus", "mrt", "mex", "fsm", "mda", "mco", "mng", "mne", "moz", "mmr", "nam", "nru", "npl", "nic", "ner", "nga", "nor", "nzl", "omn", "uga", "uzb", "pak", "plw", "pan", "png", "pry", "nld", "per", "phl", "pol", "prt", "qat", "rou", "gbr", "rus", "rwa", "kna", "smr", "vct", "lca", "slb", "wsm", "stp", "sen", "srb", "syc", "sle", "sgp", "svk", "svn", "som", "sdn", "ssd", "lka", "swe", "che", "sur", "swz", "syr", "tjk", "tza", "tcd", "cze", "tha", "tls", "tgo", "ton", "tto", "tun", "tkm", "tur", "tuv", "ukr", "ury", "vut", "ven", "vnm", "yem", "zmb", "zwe" ], "nullable": true }, "identityDocument": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Document4" } ] } }, "type": "object" }, "OrganisationTransaction11": { "required": [ "id", "provider", "status" ], "properties": { "id": { "type": "string" }, "provider": { "description": "External provider of the transaction. Our payment partner.", "type": "string" }, "providerId": { "description": "External id of the transaction. Our payment partner transaction ID.", "type": "string", "nullable": true }, "payer": { "description": "Account who paid the transaction.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Organisation24" } ] }, "status": { "type": "string" }, "authorizedAmount": { "description": "3DS authorisation amount.", "type": "number", "format": "float", "nullable": true }, "amount": { "description": "Amount.", "type": "number", "format": "float", "nullable": true } }, "type": "object" }, "RequestEvent8": { "required": [ "type" ], "properties": { "type": { "description": "Event type.", "type": "string", "enum": [ "email_send", "email_open", "email_processed", "email_delivered", "email_click", "email_bounce", "email_spamreport", "email_unsubscribe", "email_dropped", "email_deferred", "email_blocked", "email_invalid", "email_reply", "email_blacklisted", "ticket_admin_message", "new_transaction_manual_cancel", "ticket_owner_message" ] }, "subType": { "description": "Event subtype. For email event only.", "type": "string", "enum": [ "request_email", "cashout_email" ], "nullable": true } }, "type": "object" }, "RequestSecurityDeposit10": { "required": [ "cashOuts", "recipientInformationDocuments", "name", "description", "insuranceActive", "canEdit", "id", "owner", "publicLink", "status", "emailSendTiming", "organisationTransactions", "requestEvents", "dtype" ], "properties": { "depositRecipientsNumber": { "description": "Number of participants for the deposit of the request. Recipients can choose if they want to pay all the security deposit or split it between multiple participants.", "type": "integer", "default": 1, "nullable": true }, "startAt": { "description": "Start date of the request.", "type": "string", "format": "date-time", "nullable": true }, "endAt": { "description": "End date of the request.", "type": "string", "format": "date-time", "nullable": true }, "recipientAllowToUpdateStartAt": { "description": "Know if recipient is allow to update start date.", "type": "boolean", "nullable": true }, "recipientAllowToUpdateEndAt": { "description": "Know if recipient is allow to update end date.", "type": "boolean", "nullable": true }, "settingMultipleProductInformationResponse": { "description": "Recipient response to the multiple product information label.", "type": "string", "nullable": true }, "recipientMoreInformationResponse": { "description": "Recipient response to the more information label.", "type": "string", "nullable": true }, "remoteCheckInStatus": { "description": "Status of the check in.", "type": "string", "default": "waiting", "enum": [ "waiting", "done" ], "nullable": true }, "remoteCheckOutStatus": { "description": "Status of the check out.", "type": "string", "default": "waiting", "enum": [ "waiting", "done" ], "nullable": true }, "depositStatus": { "description": "Status of the deposit.", "type": "string", "default": "waiting", "enum": [ "waiting", "done", "in_error" ], "nullable": true }, "identityVerificationStatus": { "description": "Status of the identity verification.", "type": "string", "default": "waiting", "enum": [ "waiting", "done" ], "nullable": true }, "remoteCheckIn": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CheckInOut10" } ] }, "remoteCheckOut": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CheckInOut10" } ] }, "cashOuts": { "type": "array", "items": { "$ref": "#/components/schemas/CashOut8" } }, "recipientInformationDocuments": { "description": "Informations documents related to the recipient.", "type": "array", "items": { "$ref": "#/components/schemas/Media3" } }, "name": { "description": "Name of the request.", "type": "string" }, "description": { "description": "Description of the request.", "type": "string" }, "remoteCheckInOut": { "description": "Active or not the remote check in and check out section.", "type": "boolean", "nullable": true }, "remoteCheckInOutInformation": { "description": "Active or not the remote check in and check out.", "type": "string", "nullable": true }, "depositAmount": { "description": "Amount ask for the deposit.", "type": "number", "format": "float", "nullable": true }, "deposit": { "description": "Active or not the deposit section.", "type": "boolean", "nullable": true }, "depositType": { "description": "Deposit type.", "type": "string", "enum": [ "verification", "blocked", "debit" ], "nullable": true }, "settingMultipleProduct": { "description": "Active or not the multiple product section.", "type": "boolean", "nullable": true }, "settingMultipleProductInformationLabel": { "description": "Display label for recipient who can answer to it in an input text. You can ask a product identification or whatever you want to know what product is in news", "type": "string", "nullable": true }, "recipientMoreInformationLabel": { "description": "Display label for recipient who can answer to it in an input text. You can ask all information you want.", "type": "string", "nullable": true }, "recipientWelcomeMessage": { "description": "Display message for recipient in the deposit asking email.", "type": "string", "nullable": true }, "recipientConfirmMessage": { "description": "Display message for recipient in the deposit confirm email.", "type": "string", "nullable": true }, "recipientVigilancePoints": { "description": "List of vigilance point you want to display for recipient.", "type": "string", "nullable": true }, "settingDateOptional": { "description": "Active or not the date optional for the recipient. If you pass true, recipient can choose to not fill the date field.", "type": "boolean", "nullable": true }, "settingDepositAutomaticEmailRelaunch": { "description": "Active or not the automatic email relaunch for deposit. If the recipient have not completed the deposit, an email will be sent to him.", "type": "boolean", "nullable": true }, "settingMultipleCashOutOption": { "description": "Active or not the possibility to do multiple cashOut on the same request. (This is not disponible for all owner - contact us to know more)", "type": "boolean", "nullable": true }, "settingAuthorizeDepositSharing": { "description": "Setting to authorize deposit sharing, if set to false recipients can't split the deposit. We recommend leaving it set to `true` for large deposits.", "type": "boolean", "default": true, "nullable": true }, "identityVerificationType": { "description": "Type of identity verification to do on the recipient.", "type": "string", "enum": [ "simple", "advanced" ], "nullable": true }, "insurance": { "description": "If it's set to true, recipient can take an insurance during deposit to protect the deposit amount.", "type": "boolean", "nullable": true }, "insuranceMaximumAmount": { "description": "Maximum amount protected by the insurance.", "type": "number", "format": "float", "nullable": true }, "estimatedReleasedAt": { "description": "Estimated release date of the deposit. It's based on the end date of the request and the closing time of the owner.", "type": "string", "format": "date-time", "nullable": true }, "insuranceActive": { "description": "To know if one recipient take the insurance.", "type": "boolean" }, "depositRecipientsPayed": { "description": "Number of recipients that have paid their share.", "type": "integer", "nullable": true }, "depositRecipientsAmountPayed": { "description": "Amount payed by recipients that have paid their share.", "type": "number", "format": "float", "nullable": true }, "depositTransactionAmountPayedDetail": { "description": "Name and amount of the recipients that that have paid their share.", "type": "array", "items": {}, "nullable": true }, "cashOutAllow": { "description": "Property to know if a cashOut request is actually allow on the deposit.", "type": "boolean", "nullable": true }, "cashOutMaximumAmount": { "description": "Property to know the maximum amount that can be set to a cashOut request.", "type": "number", "format": "float", "nullable": true }, "canEdit": { "description": "Property to know if the request ca be edit or no.", "type": "boolean" }, "id": { "type": "string" }, "model": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ModelRequest" } ] }, "owner": { "$ref": "#/components/schemas/Organisation24" }, "recipient": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Organisation24" } ] }, "recipientPreFill": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PhysicalPerson10" } ] }, "publicLink": { "type": "string" }, "source": { "type": "string", "nullable": true }, "locale": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "status": { "type": "string" }, "emailSendTiming": { "type": "string" }, "organisationTransactions": { "type": "array", "items": { "$ref": "#/components/schemas/OrganisationTransaction11" } }, "requestEvents": { "type": "array", "items": { "$ref": "#/components/schemas/RequestEvent8" } }, "partnerIntegrationType": { "type": "string", "nullable": true }, "partnerReturnSuccessUrl": { "type": "string", "nullable": true }, "partnerReturnFailedUrl": { "type": "string", "nullable": true }, "partnerName": { "type": "string", "nullable": true }, "partnerRef": { "type": "string", "nullable": true }, "internalReference": { "type": "string", "nullable": true }, "fullLink": { "type": "string", "nullable": true }, "recipientId": { "type": "string", "nullable": true }, "dtype": { "type": "string" } }, "type": "object", "allOf": [ { "$ref": "#/components/schemas/Request" } ] }, "RequestPayment9": { "required": [ "name", "description", "tvaType", "amount", "amountWithTax", "tvaValue", "canEdit", "id", "owner", "publicLink", "status", "emailSendTiming", "organisationTransactions", "requestEvents", "dtype" ], "properties": { "startAt": { "description": "Start date of the request. Use for the timing of the request email sending", "type": "string", "format": "date-time", "nullable": true }, "payedAt": { "description": "Date of the payment.", "type": "string", "format": "date-time", "nullable": true }, "name": { "description": "Name of the payment request.", "type": "string" }, "description": { "description": "Description of the payment request.", "type": "string" }, "tvaType": { "description": "TVA type of the payment request.", "type": "string", "enum": [ "FR_09", "FR_21", "FR_40", "FR_55", "FR_60", "FR_65", "FR_85", "FR_92", "FR_100", "FR_130", "FR_196", "FR_200", "AT_100", "AT_130", "AT_200", "BE_60", "BE_120", "BE_210", "BG_90", "BG_200", "CH_25", "CH_37", "CH_77", "CH_26", "CH_38", "CH_81", "CY_50", "CY_90", "CY_190", "CZ_100", "CZ_150", "CZ_210", "DE_70", "DE_190", "DK_250", "EE_90", "EE_200", "ES_40", "ES_100", "ES_210", "FI_100", "FI_140", "FI_240", "GB_50", "GB_200", "GR_60", "GR_130", "GR_240", "HR_50", "HR_130", "HR_250", "HU_50", "HU_180", "HU_270", "IE_48", "IE_90", "IE_135", "IE_210", "IE_230", "IT_40", "IT_50", "IT_100", "IT_220", "LT_50", "LT_90", "LT_210", "LU_30", "LU_70", "LU_80", "LU_130", "LU_140", "LU_160", "LU_170", "LV_50", "LV_120", "LV_210", "MC_09", "MC_21", "MC_55", "MC_85", "MC_100", "MC_200", "MT_50", "MT_70", "MT_180", "NL_90", "NL_210", "PL_50", "PL_80", "PL_230", "PT_60", "PT_130", "PT_230", "RO_50", "RO_90", "RO_190", "SE_60", "SE_120", "SE_250", "SI_50", "SI_95", "SI_220", "SK_100", "SK_200", "exempt", "crossborder", "extracom", "FR_100_construction", "FR_200_construction" ] }, "amount": { "description": "Amount of the payment request.", "type": "number", "format": "float" }, "amountWithTax": { "description": "Amount of the payment request with taxes.", "type": "number", "format": "float" }, "tvaValue": { "description": "TVA value of the payment request.", "type": "number", "format": "float" }, "canEdit": { "description": "Property to know if the request ca be edit or no.", "type": "boolean" }, "id": { "type": "string" }, "model": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ModelRequest" } ] }, "owner": { "$ref": "#/components/schemas/Organisation24" }, "recipient": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Organisation24" } ] }, "recipientPreFill": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PhysicalPerson10" } ] }, "publicLink": { "type": "string" }, "source": { "type": "string", "nullable": true }, "locale": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "status": { "type": "string" }, "emailSendTiming": { "type": "string" }, "organisationTransactions": { "type": "array", "items": { "$ref": "#/components/schemas/OrganisationTransaction11" } }, "requestEvents": { "type": "array", "items": { "$ref": "#/components/schemas/RequestEvent8" } }, "partnerIntegrationType": { "type": "string", "nullable": true }, "partnerReturnSuccessUrl": { "type": "string", "nullable": true }, "partnerReturnFailedUrl": { "type": "string", "nullable": true }, "partnerName": { "type": "string", "nullable": true }, "partnerRef": { "type": "string", "nullable": true }, "internalReference": { "type": "string", "nullable": true }, "fullLink": { "type": "string", "nullable": true }, "recipientId": { "type": "string", "nullable": true }, "dtype": { "type": "string" } }, "type": "object", "allOf": [ { "$ref": "#/components/schemas/Request" } ] }, "Organisation25": { "properties": { "displayEmail": { "description": "Public email.", "type": "string", "nullable": true }, "displayPhone": { "description": "Public phone.", "type": "string", "nullable": true }, "displayWebsite": { "description": "Public website.", "type": "string", "nullable": true }, "displayLogo": { "description": "Public logo.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Media2" } ] }, "displayName": { "description": "Public name.", "type": "string", "nullable": true }, "displayCreatedAt": { "description": "Public created at date.", "type": "string", "format": "date-time", "nullable": true }, "displayAddress": { "description": "Public address.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Address" } ] } }, "type": "object" }, "CheckInOut11": { "properties": { "recipient": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Organisation25" } ] } }, "type": "object" }, "CashOut9": { "required": [ "id", "amount", "reason", "medias", "cashOutDiscussions", "sequestrationAmount" ], "properties": { "id": { "type": "string" }, "amount": { "description": "Amount of the cashout.", "type": "number", "format": "float" }, "reason": { "description": "Reason of the cashout.", "type": "string" }, "medias": { "description": "Documents related to the cashout.", "type": "array", "items": { "$ref": "#/components/schemas/Media2" } }, "status": { "description": "CashOut statut.", "type": "string", "default": "waiting", "enum": [ "waiting", "done", "reclamation", "failed", "cancel" ] }, "cashOutDiscussions": { "type": "array", "items": { "$ref": "#/components/schemas/CashOutDiscussion5" } }, "sequestrationSuccess": { "description": "Know if the sequestration of the cashout worked fine.", "type": "boolean", "default": false }, "sequestrationAmount": { "description": "Amount of the sequestrate amount.", "type": "number", "format": "float" } }, "type": "object" }, "OrganisationTransaction12": { "required": [ "id", "provider", "status" ], "properties": { "id": { "type": "string" }, "provider": { "description": "External provider of the transaction. Our payment partner.", "type": "string" }, "providerId": { "description": "External id of the transaction. Our payment partner transaction ID.", "type": "string", "nullable": true }, "payer": { "description": "Account who paid the transaction.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Organisation25" } ] }, "status": { "type": "string" }, "authorizedAmount": { "description": "3DS authorisation amount.", "type": "number", "format": "float", "nullable": true }, "amount": { "description": "Amount.", "type": "number", "format": "float", "nullable": true } }, "type": "object" }, "RequestSecurityDeposit11": { "required": [ "cashOuts", "recipientInformationDocuments", "name", "description", "insuranceActive", "canEdit", "id", "owner", "publicLink", "status", "emailSendTiming", "organisationTransactions", "requestEvents", "dtype" ], "properties": { "depositRecipientsNumber": { "description": "Number of participants for the deposit of the request. Recipients can choose if they want to pay all the security deposit or split it between multiple participants.", "type": "integer", "default": 1, "nullable": true }, "startAt": { "description": "Start date of the request.", "type": "string", "format": "date-time", "nullable": true }, "endAt": { "description": "End date of the request.", "type": "string", "format": "date-time", "nullable": true }, "recipientAllowToUpdateStartAt": { "description": "Know if recipient is allow to update start date.", "type": "boolean", "nullable": true }, "recipientAllowToUpdateEndAt": { "description": "Know if recipient is allow to update end date.", "type": "boolean", "nullable": true }, "settingMultipleProductInformationResponse": { "description": "Recipient response to the multiple product information label.", "type": "string", "nullable": true }, "recipientMoreInformationResponse": { "description": "Recipient response to the more information label.", "type": "string", "nullable": true }, "remoteCheckInStatus": { "description": "Status of the check in.", "type": "string", "default": "waiting", "enum": [ "waiting", "done" ], "nullable": true }, "remoteCheckOutStatus": { "description": "Status of the check out.", "type": "string", "default": "waiting", "enum": [ "waiting", "done" ], "nullable": true }, "depositStatus": { "description": "Status of the deposit.", "type": "string", "default": "waiting", "enum": [ "waiting", "done", "in_error" ], "nullable": true }, "identityVerificationStatus": { "description": "Status of the identity verification.", "type": "string", "default": "waiting", "enum": [ "waiting", "done" ], "nullable": true }, "remoteCheckIn": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CheckInOut11" } ] }, "remoteCheckOut": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CheckInOut11" } ] }, "cashOuts": { "type": "array", "items": { "$ref": "#/components/schemas/CashOut9" } }, "recipientInformationDocuments": { "description": "Informations documents related to the recipient.", "type": "array", "items": { "$ref": "#/components/schemas/Media2" } }, "name": { "description": "Name of the request.", "type": "string" }, "description": { "description": "Description of the request.", "type": "string" }, "remoteCheckInOut": { "description": "Active or not the remote check in and check out section.", "type": "boolean", "nullable": true }, "remoteCheckInOutInformation": { "description": "Active or not the remote check in and check out.", "type": "string", "nullable": true }, "depositAmount": { "description": "Amount ask for the deposit.", "type": "number", "format": "float", "nullable": true }, "deposit": { "description": "Active or not the deposit section.", "type": "boolean", "nullable": true }, "depositType": { "description": "Deposit type.", "type": "string", "enum": [ "verification", "blocked", "debit" ], "nullable": true }, "settingMultipleProduct": { "description": "Active or not the multiple product section.", "type": "boolean", "nullable": true }, "settingMultipleProductInformationLabel": { "description": "Display label for recipient who can answer to it in an input text. You can ask a product identification or whatever you want to know what product is in news", "type": "string", "nullable": true }, "recipientMoreInformationLabel": { "description": "Display label for recipient who can answer to it in an input text. You can ask all information you want.", "type": "string", "nullable": true }, "recipientWelcomeMessage": { "description": "Display message for recipient in the deposit asking email.", "type": "string", "nullable": true }, "recipientConfirmMessage": { "description": "Display message for recipient in the deposit confirm email.", "type": "string", "nullable": true }, "recipientVigilancePoints": { "description": "List of vigilance point you want to display for recipient.", "type": "string", "nullable": true }, "settingDateOptional": { "description": "Active or not the date optional for the recipient. If you pass true, recipient can choose to not fill the date field.", "type": "boolean", "nullable": true }, "settingDepositAutomaticEmailRelaunch": { "description": "Active or not the automatic email relaunch for deposit. If the recipient have not completed the deposit, an email will be sent to him.", "type": "boolean", "nullable": true }, "settingMultipleCashOutOption": { "description": "Active or not the possibility to do multiple cashOut on the same request. (This is not disponible for all owner - contact us to know more)", "type": "boolean", "nullable": true }, "settingAuthorizeDepositSharing": { "description": "Setting to authorize deposit sharing, if set to false recipients can't split the deposit. We recommend leaving it set to `true` for large deposits.", "type": "boolean", "default": true, "nullable": true }, "identityVerificationType": { "description": "Type of identity verification to do on the recipient.", "type": "string", "enum": [ "simple", "advanced" ], "nullable": true }, "insurance": { "description": "If it's set to true, recipient can take an insurance during deposit to protect the deposit amount.", "type": "boolean", "nullable": true }, "insuranceMaximumAmount": { "description": "Maximum amount protected by the insurance.", "type": "number", "format": "float", "nullable": true }, "estimatedReleasedAt": { "description": "Estimated release date of the deposit. It's based on the end date of the request and the closing time of the owner.", "type": "string", "format": "date-time", "nullable": true }, "insuranceActive": { "description": "To know if one recipient take the insurance.", "type": "boolean" }, "depositRecipientsPayed": { "description": "Number of recipients that have paid their share.", "type": "integer", "nullable": true }, "depositRecipientsAmountPayed": { "description": "Amount payed by recipients that have paid their share.", "type": "number", "format": "float", "nullable": true }, "depositTransactionAmountPayedDetail": { "description": "Name and amount of the recipients that that have paid their share.", "type": "array", "items": {}, "nullable": true }, "cashOutAllow": { "description": "Property to know if a cashOut request is actually allow on the deposit.", "type": "boolean", "nullable": true }, "cashOutMaximumAmount": { "description": "Property to know the maximum amount that can be set to a cashOut request.", "type": "number", "format": "float", "nullable": true }, "canEdit": { "description": "Property to know if the request ca be edit or no.", "type": "boolean" }, "id": { "type": "string" }, "model": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ModelRequest" } ] }, "owner": { "$ref": "#/components/schemas/Organisation25" }, "recipient": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Organisation25" } ] }, "recipientPreFill": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PhysicalPerson" } ] }, "publicLink": { "type": "string" }, "source": { "type": "string", "nullable": true }, "locale": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "status": { "type": "string" }, "emailSendTiming": { "type": "string" }, "organisationTransactions": { "type": "array", "items": { "$ref": "#/components/schemas/OrganisationTransaction12" } }, "requestEvents": { "type": "array", "items": { "$ref": "#/components/schemas/RequestEvent8" } }, "partnerIntegrationType": { "type": "string", "nullable": true }, "partnerReturnSuccessUrl": { "type": "string", "nullable": true }, "partnerReturnFailedUrl": { "type": "string", "nullable": true }, "partnerName": { "type": "string", "nullable": true }, "partnerRef": { "type": "string", "nullable": true }, "internalReference": { "type": "string", "nullable": true }, "fullLink": { "type": "string", "nullable": true }, "recipientId": { "type": "string", "nullable": true }, "dtype": { "type": "string" } }, "type": "object", "allOf": [ { "$ref": "#/components/schemas/Request" } ] }, "RequestPayment10": { "required": [ "name", "description", "tvaType", "amount", "amountWithTax", "tvaValue", "canEdit", "id", "owner", "publicLink", "status", "emailSendTiming", "organisationTransactions", "requestEvents", "dtype" ], "properties": { "startAt": { "description": "Start date of the request. Use for the timing of the request email sending", "type": "string", "format": "date-time", "nullable": true }, "payedAt": { "description": "Date of the payment.", "type": "string", "format": "date-time", "nullable": true }, "name": { "description": "Name of the payment request.", "type": "string" }, "description": { "description": "Description of the payment request.", "type": "string" }, "tvaType": { "description": "TVA type of the payment request.", "type": "string", "enum": [ "FR_09", "FR_21", "FR_40", "FR_55", "FR_60", "FR_65", "FR_85", "FR_92", "FR_100", "FR_130", "FR_196", "FR_200", "AT_100", "AT_130", "AT_200", "BE_60", "BE_120", "BE_210", "BG_90", "BG_200", "CH_25", "CH_37", "CH_77", "CH_26", "CH_38", "CH_81", "CY_50", "CY_90", "CY_190", "CZ_100", "CZ_150", "CZ_210", "DE_70", "DE_190", "DK_250", "EE_90", "EE_200", "ES_40", "ES_100", "ES_210", "FI_100", "FI_140", "FI_240", "GB_50", "GB_200", "GR_60", "GR_130", "GR_240", "HR_50", "HR_130", "HR_250", "HU_50", "HU_180", "HU_270", "IE_48", "IE_90", "IE_135", "IE_210", "IE_230", "IT_40", "IT_50", "IT_100", "IT_220", "LT_50", "LT_90", "LT_210", "LU_30", "LU_70", "LU_80", "LU_130", "LU_140", "LU_160", "LU_170", "LV_50", "LV_120", "LV_210", "MC_09", "MC_21", "MC_55", "MC_85", "MC_100", "MC_200", "MT_50", "MT_70", "MT_180", "NL_90", "NL_210", "PL_50", "PL_80", "PL_230", "PT_60", "PT_130", "PT_230", "RO_50", "RO_90", "RO_190", "SE_60", "SE_120", "SE_250", "SI_50", "SI_95", "SI_220", "SK_100", "SK_200", "exempt", "crossborder", "extracom", "FR_100_construction", "FR_200_construction" ] }, "amount": { "description": "Amount of the payment request.", "type": "number", "format": "float" }, "amountWithTax": { "description": "Amount of the payment request with taxes.", "type": "number", "format": "float" }, "tvaValue": { "description": "TVA value of the payment request.", "type": "number", "format": "float" }, "canEdit": { "description": "Property to know if the request ca be edit or no.", "type": "boolean" }, "id": { "type": "string" }, "model": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ModelRequest" } ] }, "owner": { "$ref": "#/components/schemas/Organisation25" }, "recipient": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Organisation25" } ] }, "recipientPreFill": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PhysicalPerson" } ] }, "publicLink": { "type": "string" }, "source": { "type": "string", "nullable": true }, "locale": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "status": { "type": "string" }, "emailSendTiming": { "type": "string" }, "organisationTransactions": { "type": "array", "items": { "$ref": "#/components/schemas/OrganisationTransaction12" } }, "requestEvents": { "type": "array", "items": { "$ref": "#/components/schemas/RequestEvent8" } }, "partnerIntegrationType": { "type": "string", "nullable": true }, "partnerReturnSuccessUrl": { "type": "string", "nullable": true }, "partnerReturnFailedUrl": { "type": "string", "nullable": true }, "partnerName": { "type": "string", "nullable": true }, "partnerRef": { "type": "string", "nullable": true }, "internalReference": { "type": "string", "nullable": true }, "fullLink": { "type": "string", "nullable": true }, "recipientId": { "type": "string", "nullable": true }, "dtype": { "type": "string" } }, "type": "object", "allOf": [ { "$ref": "#/components/schemas/Request" } ] }, "Organisation26": { "required": [ "id", "name" ], "properties": { "objectName": { "description": "Name of the object", "type": "string", "default": "organisation", "example": "organisation" }, "id": { "description": "Unique identifier of the organisation", "type": "string", "format": "uuid", "example": "550e8400-e29b-41d4-a716-446655440000" }, "name": { "description": "Name of the organisation", "type": "string", "example": "Example Organisation" }, "displayIdentifier": { "type": "string", "nullable": true } }, "type": "object" }, "OrganisationUser8": { "required": [ "organisation", "rank" ], "properties": { "notificationEmail": { "type": "boolean", "default": true, "nullable": true }, "notificationPush": { "type": "boolean", "default": true, "nullable": true }, "objectName": { "description": "Name of the object", "type": "string", "default": "organisation_user", "example": "organisation_user" }, "id": { "description": "Unique identifier of the organisation user", "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000", "nullable": true }, "organisation": { "$ref": "#/components/schemas/Organisation26" }, "rank": { "description": "Rank or role type of the user in the organisation. The ranks depend on the configuration.", "type": "string", "enum": [ "default", "..." ], "example": "default" } }, "type": "object" }, "PhysicalPerson11": { "required": [ "id" ], "properties": { "id": { "type": "string" }, "secondaryEmail": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "secondaryPhone": { "type": "string", "nullable": true }, "firstname": { "type": "string", "nullable": true }, "lastname": { "type": "string", "nullable": true }, "birthday": { "type": "string", "format": "date-time", "nullable": true }, "birthdayAddress": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Address2" } ] }, "address": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Address2" } ] }, "monthlyIncome": { "description": "Monthly income.", "type": "string", "enum": [ "LOWER_THAN_1200_EUROS", "BETWEEN_1200_2500_EUROS", "BETWEEN_2500_4000_EUROS", "GREATER_THAN_4000_EUROS" ], "nullable": true }, "profession": { "description": "Profession.", "type": "string", "enum": [ "FARMER", "CRAFTSMAN_MERCHANT_ENTREPRENEUR", "LIBERAL_PROFESSION", "EXECUTIVE", "RETIREE", "EMPLOYEE", "WORKER", "NO_ACTIVITY" ], "nullable": true }, "nationality": { "description": "Nationality in alpha3 country code.", "type": "string", "enum": [ "afg", "zaf", "alb", "dza", "deu", "and", "ago", "atg", "sau", "arg", "arm", "aus", "aut", "aze", "bhs", "bhr", "bgd", "brb", "blr", "bel", "blz", "ben", "btn", "bol", "bih", "bwa", "bra", "brn", "bgr", "bfa", "bdi", "khm", "cmr", "can", "cpv", "caf", "chl", "chn", "cyp", "col", "com", "cog", "cod", "kor", "prk", "cri", "civ", "hrv", "cub", "dnk", "dji", "dom", "dma", "egy", "slv", "are", "ecu", "eri", "esp", "est", "usa", "eth", "fji", "fin", "fra", "gab", "gmb", "geo", "gha", "grc", "grd", "gtm", "gin", "gnb", "gnq", "guy", "hti", "hnd", "hun", "ind", "idn", "irn", "irq", "irl", "isl", "isr", "ita", "jam", "jpn", "jor", "kaz", "ken", "kgz", "kir", "kwt", "lao", "lso", "lva", "lbn", "lbr", "lby", "lie", "ltu", "lux", "mkd", "mdg", "mys", "mwi", "mdv", "mli", "mlt", "mar", "mhl", "mus", "mrt", "mex", "fsm", "mda", "mco", "mng", "mne", "moz", "mmr", "nam", "nru", "npl", "nic", "ner", "nga", "nor", "nzl", "omn", "uga", "uzb", "pak", "plw", "pan", "png", "pry", "nld", "per", "phl", "pol", "prt", "qat", "rou", "gbr", "rus", "rwa", "kna", "smr", "vct", "lca", "slb", "wsm", "stp", "sen", "srb", "syc", "sle", "sgp", "svk", "svn", "som", "sdn", "ssd", "lka", "swe", "che", "sur", "swz", "syr", "tjk", "tza", "tcd", "cze", "tha", "tls", "tgo", "ton", "tto", "tun", "tkm", "tur", "tuv", "ukr", "ury", "vut", "ven", "vnm", "yem", "zmb", "zwe" ], "nullable": true }, "status": { "type": "string", "default": "waiting" }, "identityDocument": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Document2" } ] }, "mandatoryInfos": { "type": "array", "items": { "type": "string" }, "default": [] }, "uncompletedInfos": { "type": "array", "items": { "type": "string" }, "default": [] }, "email": { "type": "string", "nullable": true } }, "type": "object" }, "User7": { "required": [ "id", "email", "phone" ], "properties": { "emailValidated": { "type": "boolean", "default": false, "nullable": true }, "phoneValidated": { "type": "boolean", "default": false, "nullable": true }, "language": { "type": "string", "default": "fr", "nullable": true }, "lastSelectedOrganisation": { "type": "string", "nullable": true }, "cguAccepted": { "type": "boolean", "default": false }, "cguAcceptedAt": { "type": "string", "format": "date-time", "nullable": true }, "dataProtectionAccepted": { "type": "boolean", "default": false }, "viewableOrganisations": { "type": "array", "items": { "$ref": "#/components/schemas/OrganisationUser8" }, "nullable": true }, "dataProtectionAcceptedAt": { "type": "string", "format": "date-time", "nullable": true }, "disabled": { "type": "boolean", "default": false }, "lastLoginAt": { "type": "string", "format": "date-time", "nullable": true }, "notificationPush": { "type": "boolean", "default": true, "nullable": true }, "notificationEmail": { "type": "boolean", "default": true, "nullable": true }, "physicalPerson": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PhysicalPerson11" } ] }, "objectName": { "description": "Name of the object", "type": "string", "default": "user", "example": "organisation" }, "id": { "description": "Unique identifier of the user", "type": "string", "example": "550e8400-e29b-41d4-a716-446655440000" }, "email": { "description": "Email address of the user", "type": "string", "example": "user@example.com" }, "roles": { "description": "Roles assigned or inherited to the user", "type": "array", "items": { "type": "string" }, "default": [], "example": "[\"ROLE_USER\"]" }, "resetPasswordAt": { "description": "Date of the last password reset", "type": "string", "format": "date-time", "example": "2023-01-01T12:00:00+00:00", "nullable": true }, "needResetPassword": { "description": "Indicates if the user needs to reset their password", "type": "boolean", "default": false, "example": false, "nullable": true }, "validated": { "description": "Indicates if the user account is validated", "type": "boolean", "default": false, "example": false, "nullable": true }, "loginDate": { "description": "Date of the last login", "type": "string", "format": "date-time", "example": "2023-01-01T12:00:00+00:00", "nullable": true }, "createdAt": { "description": "Date when the account was created", "type": "string", "format": "date-time", "example": "2023-01-01T12:00:00+00:00", "nullable": true }, "updatedAt": { "description": "Date of the last account update", "type": "string", "format": "date-time", "example": "2023-01-01T12:00:00+00:00", "nullable": true }, "deletedAt": { "description": "Date when the account was deleted", "type": "string", "format": "date-time", "example": "2023-01-01T12:00:00+00:00", "nullable": true }, "crmContactListings": { "description": "Listing of cmr contact list ids", "type": "array", "items": { "type": "string" }, "default": [], "example": [ "1", "list_1" ], "nullable": true }, "phone": { "description": "Phone number of the user. It has to respect a phone number regex ^[+]{1}[0-9]*$", "type": "string", "example": "+33476210239" }, "completed": { "type": "boolean", "nullable": true }, "canCreateOwnerMeParticular": { "type": "boolean", "nullable": true }, "canCreateTenantMeParticular": { "type": "boolean", "nullable": true } }, "type": "object" }, "UserType": { "required": [ "physicalPerson", "email", "phone", "language", "roles", "notificationEmail", "notificationPush", "disabled", "cguAccepted", "dataProtectionAccepted", "redirectUri", "lastSelectedOrganisation" ], "properties": { "physicalPerson": { "$ref": "#/components/schemas/PhysicalPersonType" }, "email": { "type": "string" }, "phone": { "type": "string" }, "language": { "type": "string", "enum": [ "en", "fr", "de", "es" ] }, "roles": { "type": "array", "items": { "type": "string", "enum": [ "ROLE_ADMIN", "ROLE_USER" ] } }, "notificationEmail": { "type": "boolean" }, "notificationPush": { "type": "boolean" }, "disabled": { "type": "boolean" }, "cguAccepted": { "type": "boolean" }, "dataProtectionAccepted": { "type": "boolean" }, "redirectUri": { "type": "string" }, "lastSelectedOrganisation": { "type": "string" } }, "type": "object" }, "User8": { "required": [ "id", "deleted" ], "properties": { "objectName": { "description": "Name of the object", "type": "string", "default": "user", "example": "organisation" }, "id": { "description": "Unique identifier of the user", "type": "string", "example": "550e8400-e29b-41d4-a716-446655440000" }, "deleted": { "type": "boolean" } }, "type": "object" } } }, "tags": [ { "name": "Partner - Medias" }, { "name": "Partner - CashOut" }, { "name": "Partner - Me" }, { "name": "Partner - Login" }, { "name": "Partner - ModelRequest" }, { "name": "Partner - Request" } ] }