{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "https:\/\/apiv2-sandbox.legalcity.fr" } ], "info": { "name": "LegalCity API Documentation", "_postman_id": "1a6bfb90-bcf1-4b03-9e54-3513028ea2be", "description": "Complete RESTful API for LegalCity debt recovery and legal services management", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "API System & Health", "description": "\nSystem status and API information endpoints.", "item": [ { "name": "Health Check", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/health", "query": [], "raw": "{{baseUrl}}\/api\/health" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns the current status of the API service and server timestamp.\nUse this endpoint to verify that the API is running and accessible.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"ok\",\n \"timestamp\": \"2025-10-31T14:30:00.000000Z\",\n \"version\": \"2.0\"\n}", "name": "" } ] }, { "name": "API Information", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/info", "query": [], "raw": "{{baseUrl}}\/api\/info" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Provides comprehensive information about the LegalCity API including\navailable endpoints, authentication details, and documentation links.\nThis endpoint is useful for API discovery and integration setup.\n\n**Features**:\n- API version and metadata\n- Documentation and collection URLs\n- Authentication endpoints\n- Main resource endpoints\n- OpenAPI specification access\n\n**Use Cases**:\n- API client initialization\n- Documentation discovery\n- Integration testing\n- Development environment setup", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"api_name\": \"LegalCity Recovery API\",\n \"version\": \"2.0\",\n \"description\": \"Comprehensive API for legal debt recovery management\",\n \"documentation\": \"https:\/\/apiv2-sandbox.legalcity.fr\/docs\",\n \"postman_collection\": \"https:\/\/apiv2-sandbox.legalcity.fr\/docs\/collection.json\",\n \"openapi_spec\": \"https:\/\/apiv2-sandbox.legalcity.fr\/docs\/openapi.yaml\",\n \"auth\": {\n \"type\": \"Bearer Token (OAuth2)\",\n \"login_endpoint\": \"https:\/\/apiv2-sandbox.legalcity.fr\/api\/auth\/login\",\n \"register_endpoint\": \"https:\/\/apiv2-sandbox.legalcity.fr\/api\/auth\/register\",\n \"logout_endpoint\": \"https:\/\/apiv2-sandbox.legalcity.fr\/api\/auth\/logout\",\n \"me_endpoint\": \"https:\/\/apiv2-sandbox.legalcity.fr\/api\/auth\/me\"\n },\n \"endpoints\": {\n \"auth\": \"https:\/\/apiv2-sandbox.legalcity.fr\/api\/auth\",\n \"recoveries\": \"https:\/\/apiv2-sandbox.legalcity.fr\/api\/recoveries\",\n \"companies\": \"https:\/\/apiv2-sandbox.legalcity.fr\/api\/recoveries\/{recoveryId}\/companies\",\n \"documents\": \"https:\/\/apiv2-sandbox.legalcity.fr\/api\/recoveries\/{recoveryId}\/docs\",\n \"invoices\": \"https:\/\/apiv2-sandbox.legalcity.fr\/api\/recoveries\/{recoveryId}\/invoices\",\n \"comments\": \"https:\/\/apiv2-sandbox.legalcity.fr\/api\/recoveries\/{recoveryId}\/comments\",\n \"protected_invoices\": \"https:\/\/apiv2-sandbox.legalcity.fr\/api\/protected-invoices\",\n \"scoring\": \"https:\/\/apiv2-sandbox.legalcity.fr\/api\/scoring\",\n \"health\": \"https:\/\/apiv2-sandbox.legalcity.fr\/api\/health\"\n },\n \"features\": {\n \"recovery_management\": \"Complete debt recovery case management\",\n \"company_tracking\": \"Customer and debtor information management\",\n \"document_upload\": \"Secure document storage and retrieval\",\n \"invoice_tracking\": \"Invoice management with payment status\",\n \"comment_system\": \"Internal and external communication tracking\",\n \"protected_invoices\": \"Secure invoice storage with tracking codes\",\n \"scoring_services\": \"Credit scoring and solvency reports\"\n },\n \"supported_formats\": {\n \"response_format\": \"JSON\",\n \"authentication\": \"Bearer Token (OAuth2)\",\n \"file_uploads\": \"PDF, DOC, DOCX, XLS, XLSX, JPG, PNG, GIF (max 10MB)\",\n \"date_format\": \"YYYY-MM-DD\",\n \"datetime_format\": \"ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ)\"\n },\n \"rate_limits\": {\n \"login_attempts\": \"5 per minute per IP\",\n \"api_requests\": \"1000 per hour per user\",\n \"file_uploads\": \"50 per hour per user\"\n },\n \"contact\": {\n \"support\": \"amine@legalcity.fr\",\n \"documentation\": \"https:\/\/apiv2-sandbox.legalcity.fr\/docs\",\n }\n}", "name": "" } ] }, { "name": "Not Found Handler", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/:fallbackPlaceholder", "query": [], "raw": "{{baseUrl}}\/api\/:fallbackPlaceholder", "variable": [ { "id": "fallbackPlaceholder", "key": "fallbackPlaceholder", "value": "%7C%7B%2B-0p", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Catches all undefined API routes and returns a standardized 404 error response.\nThis ensures consistent error formatting across the API.", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-ratelimit-limit", "value": "60" }, { "key": "x-ratelimit-remaining", "value": "59" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 404, "body": "{\"success\":false,\"message\":\"API endpoint not found\"}", "name": "" } ] } ] }, { "name": "Authentication & User Sessions", "description": "\nEndpoints for handling user authentication, registration, and session management.", "item": [ { "name": "Login", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/auth\/login", "query": [], "raw": "{{baseUrl}}\/api\/auth\/login" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"john@example.com\",\"key\":\"06572215-cb86-4ca2-b6b1-2ba6ceb1e8a5\"}" }, "description": "Authenticate a user using their email and API key credentials.\nReturns an access token (Bearer) required for authorized API requests.\n\nUse this endpoint to obtain a valid authentication token before accessing\nany protected routes within the LegalCity API.\n\n**Rate Limiting**: This endpoint is limited to 5 attempts per minute per IP address.\nAfter 5 failed attempts, wait 1 minute before trying again.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"data\": {\n \"user\": {\n \"id\": 1,\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john@example.com\",\n \"entreprise\": \"Company SARL\",\n \"can_register\": true,\n },\n \"token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9...\",\n \"token_type\": \"Bearer\"\n },\n \"message\": \"Login successful\"\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"success\": false,\n \"message\": \"Invalid credentials provided\"\n}", "name": "" }, { "header": [], "code": 403, "body": "{\n \"success\": false,\n \"message\": \"You do not have permission to access this resource.\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"success\": false,\n \"message\": \"Validation failed.\",\n \"errors\": {\n \"email\": [\"The email field is required.\"],\n \"key\": [\"The key field is required.\"]\n }\n}", "name": "" }, { "header": [], "code": 429, "body": "{\n \"success\": false,\n \"message\": \"Too Many Attempts. Please wait 60 seconds before trying again.\"\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"success\": false,\n \"message\": \"Authentication failed\"\n}", "name": "" } ] }, { "name": "User Registration", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/auth\/register", "query": [], "raw": "{{baseUrl}}\/api\/auth\/register" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"first_name\":\"John\",\"last_name\":\"Doe\",\"email\":\"john@example.com\",\"entreprise\":\"Company SARL\",\"siren\":\"123456789\",\"address\":\"123 Main St\",\"city\":\"Paris\",\"postal\":\"75001\",\"phone\":\"+33123456789\",\"metadata\":{\"custom_field\":\"value\",\"preferences\":{\"theme\":\"dark\"}}}" }, "description": "Create a new user account or update existing user with API access.\nRequires an authenticated user with \"can_register\" permission.\n\n**Important**: This endpoint returns API credentials (api_key and auth_secret)\nfor newly registered users. Store these securely as they won't be shown again." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"data\": {\n \"user\": {\n \"id\": 1,\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john@example.com\",\n \"entreprise\": \"Company SARL\",\n \"can_register\": false,\n \"api_key\": \"06572215-cb86-4ca2-b6b1-2ba6ceb1e8a5\",\n \"auth_secret\": \"uuid-secret-string\",\n }\n },\n \"message\": \"User already exists with API access\"\n}", "name": "" }, { "header": [], "code": 201, "body": "{\n \"success\": true,\n \"data\": {\n \"user\": {\n \"id\": 1,\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john@example.com\",\n \"entreprise\": \"Company SARL\",\n \"can_register\": false,\n \"api_key\": \"06572215-cb86-4ca2-b6b1-2ba6ceb1e8a5\",\n \"auth_secret\": \"uuid-secret-string\",\n }\n },\n \"message\": \"User registered successfully\"\n}", "name": "" }, { "header": [], "code": 403, "body": "{\n \"success\": false,\n \"message\": \"You do not have permission to access this resource.\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"success\": false,\n \"message\": \"Validation failed\",\n \"errors\": {\n \"email\": [\"The email field is required.\"],\n \"first_name\": [\"The first name field is required.\"]\n }\n}", "name": "" } ] }, { "name": "Logout", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/auth\/logout", "query": [], "raw": "{{baseUrl}}\/api\/auth\/logout" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Revoke the current user's access token and invalidate the session.\nAfter logout, the provided Bearer token will no longer be valid for API requests.\n\n**Note**: Once logged out, you'll need to call the login endpoint again\nto obtain a new access token." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Logout successful\"\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"success\": false,\n \"message\": \"User not authenticated\"\n}", "name": "" } ] }, { "name": "Refresh Token", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/auth\/refresh", "query": [], "raw": "{{baseUrl}}\/api\/auth\/refresh" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Refresh the current access token by revoking the old one and issuing a new one.\nUse this endpoint to obtain a fresh token without requiring the user to login again.\n\n**Important**: After calling this endpoint, use the new token for all subsequent requests.\nThe old token will be immediately revoked and no longer valid.\n\n**Rate Limiting**: Limited to 10 attempts per minute to prevent abuse." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"data\": {\n \"token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9...\",\n \"token_type\": \"Bearer\"\n },\n \"message\": \"Token refreshed successfully\"\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"success\": false,\n \"message\": \"User not authenticated\"\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"success\": false,\n \"message\": \"Token refresh failed\"\n}", "name": "" } ] }, { "name": "Get Authenticated User", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/auth\/me", "query": [], "raw": "{{baseUrl}}\/api\/auth\/me" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve the currently authenticated user's profile information including\nAPI access status and registration permissions.\n\nUse this endpoint to verify your authentication status and get current user details." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"data\": {\n \"id\": 1,\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john@example.com\",\n \"entreprise\": \"Company SARL\",\n \"can_register\": true,\n },\n \"message\": \"User retrieved successfully\"\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"success\": false,\n \"message\": \"Unauthenticated\"\n}", "name": "" } ] } ] }, { "name": "Recovery Management", "description": "\nComplete API for managing debt recovery cases with support for both amicable recovery\nand legal injunction procedures. Includes CRUD operations, statistics, and injunction transfers.\nAll business rules and validation are configurable through the system settings.", "item": [ { "name": "Create Complete Recovery Case", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/recoveries\/complete", "query": [], "raw": "{{baseUrl}}\/api\/recoveries\/complete" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"recovery\":{\"recovery_service_object\":\"Web development services\",\"recovery_due_date\":\"2025-12-31\",\"recovery_late_interest\":true,\"recovery_interest_rate\":\"yes\",\"recovery_interest_rate_percent\":\"5.50\",\"recovery_penalty\":true,\"recovery_penalty_type\":\"amount\",\"recovery_penalty_amount\":\"150.00\",\"recovery_penalty_percent\":\"10.00\",\"recovery_raison_notpaid\":1,\"recovery_observations\":\"Client experiencing financial difficulties\",\"type\":1,\"assign_to_me\":true},\"customer\":{\"company_type\":\"commercial\",\"company_legal_form\":\"SARL\",\"company_siren\":\"123456789\",\"company_name\":\"ABC Corp\",\"company_legalrep_firstname\":\"John\",\"company_legalrep_lastname\":\"Doe\",\"company_legalrep_gender\":\"M\",\"company_legalrep_quality\":1,\"company_address\":\"123 Main St\",\"company_city\":\"Paris\",\"company_postal\":\"75001\",\"company_country\":\"France\",\"company_email\":\"john@abc.com\",\"company_phone\":\"+33123456789\"},\"debtor\":{\"company_type\":\"commercial\",\"company_legal_form\":\"SAS\",\"company_siren\":\"987654321\",\"company_name\":\"XYZ Ltd\",\"company_legalrep_firstname\":\"Jane\",\"company_legalrep_lastname\":\"Smith\",\"company_legalrep_gender\":\"Mme\",\"company_address\":\"456 Oak Ave\",\"company_city\":\"Lyon\",\"company_postal\":\"69001\",\"company_country\":\"France\",\"company_email\":\"jane@xyz.com\",\"company_phone\":\"+33987654321\"},\"invoices\":[\"architecto\"]}" }, "description": "Create a complete recovery case with customer, debtor companies, and invoices in a single request.\nThis endpoint combines the functionality of creating a recovery case, customer company, debtor company,\nand multiple invoices in one atomic transaction.\n\n**Workflow:**\n1. Creates the recovery case with all financial parameters\n2. Creates customer company (creditor) and associates it with recovery\n3. Creates debtor company and associates it with recovery\n4. Creates all provided invoices and associates them with recovery\n5. Updates recovery totals based on invoice amounts\n\n**Important Notes:**\n- All operations are performed in a database transaction (atomic operation)\n- If any step fails, all changes are rolled back automatically\n- Customer and debtor companies are mandatory\n- Invoices are optional: you can send 0, 1, or multiple invoices in an array\n- Each invoice must have a unique invoice_number\n\n**Invoice Array Examples:**\n```json\n\/\/ No invoices\n\"invoices\": []\n\n\/\/ Single invoice\n\"invoices\": [\n {\"invoice_number\": \"INV-001\", \"invoice_date\": \"2025-10-20\", \"invoice_amount\": 1500.00}\n]\n\n\/\/ Multiple invoices\n\"invoices\": [\n {\"invoice_number\": \"INV-001\", \"invoice_date\": \"2025-10-20\", \"invoice_amount\": 1500.00},\n {\"invoice_number\": \"INV-002\", \"invoice_date\": \"2025-10-21\", \"invoice_amount\": 2000.00, \"invoice_part_paid\": true, \"invoice_part_paid_amount\": 500.00},\n {\"invoice_number\": \"INV-003\", \"invoice_date\": \"2025-10-22\", \"invoice_amount\": 800.00}\n]\n```" }, "response": [ { "header": [], "code": 201, "body": "{\n \"success\": true,\n \"data\": {\n \"recovery\": {\n \"id\": 25,\n \"recovery_reference\": \"REC-XYZ123\",\n \"recovery_service_object\": \"Web development services\",\n \"recovery_last_status\": 1,\n \"recovery_due_date\": \"2025-12-31\",\n \"amount\": \"3000.00\",\n \"amount_torecover\": \"3000.00\",\n \"user_id\": 1,\n \"created_at\": \"2025-12-07T10:30:00.000000Z\"\n },\n \"customer\": {\n \"id\": 15,\n \"company_name\": \"ABC Corp\",\n \"company_legalrep_firstname\": \"John\",\n \"company_legalrep_lastname\": \"Doe\",\n \"company_email\": \"john@abc.com\"\n },\n \"debtor\": {\n \"id\": 16,\n \"company_name\": \"XYZ Ltd\",\n \"company_legalrep_firstname\": \"Jane\",\n \"company_legalrep_lastname\": \"Smith\",\n \"company_email\": \"jane@xyz.com\"\n },\n \"invoices\": [\n {\n \"id\": 42,\n \"invoice_number\": \"INV-2025-001\",\n \"invoice_amount\": \"1500.00\",\n \"invoice_date\": \"2025-10-20\",\n \"remaining_amount\": \"1500.00\"\n },\n {\n \"id\": 43,\n \"invoice_number\": \"INV-2025-002\",\n \"invoice_amount\": \"1500.00\",\n \"invoice_date\": \"2025-10-21\",\n \"remaining_amount\": \"1500.00\"\n }\n ],\n \"summary\": {\n \"total_invoices\": 2,\n \"total_amount\": \"3000.00\",\n \"total_remaining\": \"3000.00\"\n }\n },\n \"message\": \"Complete recovery case created successfully\"\n}", "name": "" }, { "header": [], "code": 201, "body": "{\n \"success\": true,\n \"data\": {\n \"recovery\": {\n \"id\": 26,\n \"recovery_reference\": \"REC-ABC456\",\n \"amount\": \"0.00\",\n \"amount_torecover\": \"0.00\"\n },\n \"customer\": {...},\n \"debtor\": {...},\n \"invoices\": [],\n \"summary\": {\n \"total_invoices\": 0,\n \"total_amount\": \"0.00\",\n \"total_remaining\": \"0.00\"\n }\n },\n \"message\": \"Complete recovery case created successfully\"\n}", "name": "Without invoices" }, { "header": [], "code": 422, "body": "{\n \"success\": false,\n \"message\": \"Validation failed\",\n \"errors\": {\n \"recovery.recovery_service_object\": [\"The recovery service object must not exceed 255 characters.\"],\n \"customer.company_legalrep_firstname\": [\"The customer legal representative first name must not exceed 255 characters.\"],\n \"debtor.company_email\": [\"The debtor email must be a valid email address.\"],\n \"invoices.0.invoice_number\": [\"The invoice number field is required.\"]\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"success\": false,\n \"message\": \"Failed to create complete recovery case\"\n}", "name": "" } ] }, { "name": "List Recovery Cases", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/recoveries", "query": [ { "key": "status", "value": "1", "description": "optional Filter by recovery status group. Available groups:\n\u2022 **1** = Dossier Cr\u00e9\u00e9\n\u2022 **2** = Relance 1\n\u2022 **3** = Relance 2", "disabled": false }, { "key": "search", "value": "John", "description": "optional Search across multiple fields including reference, debtor name, debtor company name, and customer company name.", "disabled": false }, { "key": "sort_by", "value": "recovery_reference", "description": "optional Sort by recovery field. Available fields:\n\u2022 **id** - Recovery ID\n\u2022 **recovery_reference** - Recovery reference\n\u2022 **recovery_service_object** - Service description\n\u2022 **recovery_last_status** - Status ID\n\u2022 **recovery_due_date** - Due date\n\u2022 **amount** - Total amount\n\u2022 **amount_torecover** - Amount to recover\n\u2022 **user_id** - Assigned user ID\n\u2022 **created_at** - Creation date\n\u2022 **updated_at** - Last update date\n\u2022 **debtor_name** - Debtor name\n\u2022 **debtor_company** - Debtor company name\n\u2022 **customer_company** - Customer company name\nDefaults to created_at.", "disabled": false }, { "key": "sort_order", "value": "asc", "description": "optional Sort order (asc\/desc). Defaults to desc.", "disabled": false }, { "key": "per_page", "value": "20", "description": "optional Items per page (max configurable limit). Defaults to configured value.", "disabled": false }, { "key": "page", "value": "1", "description": "optional Page number for pagination. Defaults to 1.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/recoveries?status=1&search=John&sort_by=recovery_reference&sort_order=asc&per_page=20&page=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve a paginated list of debt recovery cases for the authenticated user with\nadvanced filtering, sorting, and search capabilities. Supports both amicable recovery\nand injunction procedures with comprehensive status tracking." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"data\": {\n \"recoveries\": [\n {\n \"id\": 1,\n \"recovery_reference\": \"REC-ABC123\",\n \"debtor_name\": \"John Doe\",\n \"debtor_company\": \"Example Corp\",\n \"customer_company\": \"LegalCity SARL\",\n \"amount\": \"1500.00\",\n \"amount_torecover\": \"1500.00\",\n \"recovery_last_status\": 1,\n \"recovery_due_date\": \"2025-11-20\",\n \"created_at\": \"2025-10-20T10:30:00.000000Z\",\n \"updated_at\": \"2025-10-20T10:30:00.000000Z\",\n \"status\": {\n \"id\": 1,\n \"name\": \"Dossier Cr\u00e9\u00e9\",\n \"description\": \"Recovery case created and awaiting processing\"\n },\n \"user\": {\n \"id\": 1,\n \"first_name\": \"John\",\n \"last_name\": \"Doe\"\n },\n \"invoices_count\": 2,\n \"comments_count\": 5\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"per_page\": 15,\n \"total\": 50,\n \"last_page\": 4,\n \"from\": 1,\n \"to\": 15,\n \"has_more_pages\": true\n },\n \"filters_applied\": {\n \"status\": 1,\n \"search\": null,\n \"sort_by\": \"created_at\",\n \"sort_order\": \"desc\"\n }\n },\n \"message\": \"Recoveries retrieved successfully. Total: 50 recoveries found.\"\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"success\": false,\n \"message\": \"Unauthenticated\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"success\": false,\n \"message\": \"Validation failed\",\n \"errors\": {\n \"status\": [\"The selected status filter is invalid.\"],\n \"sort_by\": [\"The selected sort field is invalid.\"],\n \"per_page\": [\"The per page field must be between 1 and 100.\"]\n }\n}", "name": "" } ] }, { "name": "POST api\/recoveries", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/recoveries", "query": [], "raw": "{{baseUrl}}\/api\/recoveries" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Get Recovery Case Details", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/recoveries\/:id", "query": [], "raw": "{{baseUrl}}\/api\/recoveries\/:id", "variable": [ { "id": "id", "key": "id", "value": "15", "description": "The ID of the recovery case." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve comprehensive details of a specific recovery case including all related entities:\ncompanies, invoices, documents, comments, status history, payments, and debts.\nIncludes ownership verification for security." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"data\": {\n \"id\": 15,\n \"recovery_reference\": \"REC-ABC123\",\n \"recovery_status\": 2,\n \"amount\": \"1500.00\",\n \"amount_torecover\": \"1500.00\",\n \"user\": {...},\n \"customer\": {...},\n \"debtor\": {...},\n \"status\": {\n \"id\": 2,\n \"name\": \"Paiement accept\u00e9 - en attente de traitement\",\n \"type\": 0,\n \"isaction\": false,\n \"last\": null\n },\n \"statusHistory\": [\n {\n \"id\": 1103,\n \"recovery_id\": 447,\n \"recovery_status_id\": 1,\n \"recovery_status_name\": \"Dossier Cr\u00e9\u00e9 - en attente de paiement\",\n \"recovery_admin_id\": 1,\n \"created_at\": \"2026-01-29T13:48:06.000000Z\",\n \"updated_at\": \"2026-01-29T13:48:06.000000Z\"\n },\n {\n \"id\": 1104,\n \"recovery_id\": 447,\n \"recovery_status_id\": 2,\n \"recovery_status_name\": \"Paiement accept\u00e9 - en attente de traitement\",\n \"recovery_admin_id\": 1,\n \"created_at\": \"2026-01-29T14:52:06.000000Z\",\n \"updated_at\": \"2026-01-29T14:52:06.000000Z\"\n },\n ],\n \"invoices\": [...],\n \"docs\": [...],\n \"comments\": [...],\n \"acomptes\": [...],\n \"dettes\": [...],\n \"all_docs\": [...]\n },\n \"message\": \"Recovery retrieved successfully\"\n}", "name": "" }, { "header": [], "code": 403, "body": "{\n \"success\": false,\n \"message\": \"Unauthorized access to this recovery\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"message\": \"Recovery not found\"\n}", "name": "" } ] }, { "name": "Update Recovery Case", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/recoveries\/:id", "query": [], "raw": "{{baseUrl}}\/api\/recoveries\/:id", "variable": [ { "id": "id", "key": "id", "value": "15", "description": "The ID of the recovery case to update." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"type\":1,\"recovery_service_object\":\"Updated web development services\",\"recovery_raison_notpaid\":3,\"recovery_observations\":\"Latest client communication\",\"recovery_due_date\":\"2026-01-31\",\"recovery_late_interest\":true,\"recovery_interest_rate\":\"yes\",\"recovery_interest_rate_percent\":\"6.0\",\"recovery_penalty\":false,\"recovery_penalty_type\":\"amount\",\"recovery_penalty_amount\":\"150.00\",\"recovery_penalty_percent\":\"12.0\"}" }, "description": "Update an existing recovery case with new information. Uses configurable validation rules\nfor updates and maintains data integrity. Only the recovery owner can modify the case." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"data\": {\n \"id\": 15,\n \"recovery_reference\": \"REC-ABC123\",\n \"recovery_service_object\": \"Updated web development services\",\n \"updated_at\": \"2025-10-23T15:30:00.000000Z\",\n \"user\": {...},\n \"customer\": {...},\n \"debtor\": {...},\n \"status\": {...}\n },\n \"message\": \"Recovery updated successfully\"\n}", "name": "" }, { "header": [], "code": 403, "body": "{\n \"success\": false,\n \"message\": \"Unauthorized access to this recovery\"\n}", "name": "" }, { "header": [], "code": 403, "body": "{\n \"success\": false,\n \"message\": \"Recovery cannot be modified. Only recoveries with status 1 or 2 can be updated.\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"message\": \"Recovery not found\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"success\": false,\n \"message\": \"Validation failed\",\n \"errors\": {\n \"recovery_interest_rate_percent\": [\"The interest rate must be between 0 and 100.\"]\n }\n}", "name": "" } ] }, { "name": "Delete Recovery Case", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/recoveries\/:id", "query": [], "raw": "{{baseUrl}}\/api\/recoveries\/:id", "variable": [ { "id": "id", "key": "id", "value": "15", "description": "The ID of the recovery case to delete." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Permanently delete a recovery case from the system. This action is irreversible and\nwill cascade delete all related entities including companies, invoices, comments,\nand status history. Only the recovery owner can delete the case." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Recovery deleted successfully\"\n}", "name": "" }, { "header": [], "code": 403, "body": "{\n \"success\": false,\n \"message\": \"Unauthorized access to this recovery\"\n}", "name": "" }, { "header": [], "code": 403, "body": "{\n \"success\": false,\n \"message\": \"Recovery cannot be modified. Only recoveries with status 1 or 2 can be updated.\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"message\": \"Recovery not found\"\n}", "name": "" } ] }, { "name": "Transfer Recovery to Injunction Procedure", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/recoveries\/:recovery\/injonction-transfer", "query": [], "raw": "{{baseUrl}}\/api\/recoveries\/:recovery\/injonction-transfer", "variable": [ { "id": "recovery", "key": "recovery", "value": "15", "description": "The ID of the recovery case to transfer to injunction." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Transform an amicable recovery case into a legal injunction procedure (\"injonction de payer\").\nThis endpoint validates eligibility requirements and handles the complete transfer process\nincluding entity duplication, specialized configuration, and legal procedure tracking.\nSupports both national and European injunction procedures based on debtor country and business rules.\n\n**Eligibility Requirements:**\n- Recovery must be owned by authenticated user\n- Recovery status must be between 3 and 908 (configured range)\n- No existing injunction link (injonction_id must be null)\n- Debtor must be in allowed countries (configurable list)\n- Must have eligible products\/services or proper access configuration\n- Validates order details and product eligibility\n\n**Process Flow:**\n1. Validates ownership (404 if not found, 403 if unauthorized)\n2. Validates eligibility requirements (status, debtor country, product eligibility)\n3. Creates new injunction recovery with specialized configuration\n4. Duplicates customer and debtor companies with data integrity\n5. Copies unpaid\/partially paid invoices only\n6. Duplicates all recovery comments with visibility settings\n7. Creates initial status history record\n8. Links original recovery to new injunction case\n9. Generates payment URLs and references" }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"data\": {\n \"id\": 45,\n \"reference\": \"REC-INJC1234\",\n \"type\": \"INJONCTION DE PAYER\",\n \"assign_to_me\": true,\n \"customer_ref\": \"CUST-ABC123\",\n \"debtor_ref\": \"DEBT-DEF456\",\n \"url_pay\": \"https:\/\/api.legalcity.fr\/injonction\/INJC1234KEY\"\n },\n \"message\": \"Recovery successfully transferred to injunction procedure\"\n}", "name": "" }, { "header": [], "code": 403, "body": "{\n \"success\": false,\n \"message\": \"Unauthorized access to this recovery\"\n}", "name": "" }, { "header": [], "code": 403, "body": "{\n \"success\": false,\n \"message\": \"This recovery is not eligible for injunction transfer\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"message\": \"Recovery not found\"\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"success\": false,\n \"message\": \"An error occurred during injunction transfer\"\n}", "name": "" } ] } ] }, { "name": "Company Management", "description": "\nAPIs for managing company information including customers and debtors", "item": [ { "name": "List Companies", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/recoveries\/:recoveryId\/companies", "query": [ { "key": "search", "value": "LegalCity", "description": "optional Search in company name, firstname, lastname, email, phone, or SIREN.", "disabled": false }, { "key": "relation_type", "value": "customer", "description": "optional Filter by relation type in recovery (customer, debtor).", "disabled": false }, { "key": "sort_by", "value": "company_name", "description": "optional Sort by field. Defaults to company_legalrep_lastname.", "disabled": false }, { "key": "sort_order", "value": "desc", "description": "optional Sort order (asc\/desc). Defaults to asc.", "disabled": false }, { "key": "per_page", "value": "20", "description": "optional Items per page (max 100). Defaults to 15.", "disabled": false }, { "key": "page", "value": "1", "description": "optional Page number. Defaults to 1.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/recoveries\/:recoveryId\/companies?search=LegalCity&relation_type=customer&sort_by=company_name&sort_order=desc&per_page=20&page=1", "variable": [ { "id": "recoveryId", "key": "recoveryId", "value": "5", "description": "ID of the recovery case." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get a paginated list of companies for a specific recovery case with optional filtering and search." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"data\": {\n \"companies\": [\n {\n \"id\": 1,\n \"company_type\": \"commercial\",\n \"company_legal_form\": \"SARL\",\n \"company_siren\": \"123456789\",\n \"company_name\": \"LegalCity SARL\",\n \"company_legalrep_gender\": \"M\",\n \"company_legalrep_firstname\": \"John\",\n \"company_legalrep_lastname\": \"Doe\",\n \"company_address\": \"123 Avenue des Champs\",\n \"company_city\": \"Paris\",\n \"company_postal\": \"75008\",\n \"company_country\": \"France\",\n \"company_email\": \"contact@legalcity.com\",\n \"company_phone\": \"+33123456789\",\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"per_page\": 15,\n \"total\": 25,\n \"last_page\": 2,\n \"from\": 1,\n \"to\": 15,\n \"has_more_pages\": true\n },\n \"filters_applied\": {\n \"search\": \"LegalCity\",\n \"relation_type\": \"customer\",\n \"sort_by\": \"company_legalrep_lastname\",\n \"sort_order\": \"asc\"\n }\n },\n \"message\": \"Companies retrieved successfully\"\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"success\": false,\n \"message\": \"Unauthenticated\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"message\": \"Recovery case not found\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"success\": false,\n \"message\": \"Validation failed\",\n \"errors\": {\n \"per_page\": [\"The per page field must be between 1 and 100.\"],\n \"relation_type\": [\"The relation type must be either customer or debtor.\"]\n }\n}", "name": "" } ] }, { "name": "Create Company for Recovery", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/recoveries\/:recoveryId\/companies", "query": [], "raw": "{{baseUrl}}\/api\/recoveries\/:recoveryId\/companies", "variable": [ { "id": "recoveryId", "key": "recoveryId", "value": "15", "description": "Recovery case ID to associate company with." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"relation_type\":\"customer\",\"company_type\":\"commercial\",\"company_legal_form\":\"SARL\",\"company_siren\":\"123456789\",\"company_name\":\"Example Corp\",\"company_legalrep_firstname\":\"John\",\"company_legalrep_lastname\":\"Doe\",\"company_legalrep_gender\":\"M\",\"company_legalrep_quality\":1,\"company_legalrep_quality_other\":\"Fondateur\",\"company_freelance_type\":\"trader\",\"company_address\":\"123 Main Street\",\"company_city\":\"Paris\",\"company_postal\":\"75001\",\"company_country\":\"France\",\"company_email\":\"john@example.com\",\"company_phone\":\"+33123456789\"}" }, "description": "Create a new company that MUST be associated with the specified recovery case.\nEach recovery can have exactly 2 companies: 1 customer (creditor) and 1 debtor." }, "response": [ { "header": [], "code": 201, "body": "{\n \"success\": true,\n \"data\": {\n \"id\": 10,\n \"company_type\": \"commercial\",\n \"company_legal_form\": \"SARL\",\n \"company_siren\": \"123456789\",\n \"company_name\": \"LegalCity SARL\",\n \"company_legalrep_gender\": \"M\",\n \"company_legalrep_firstname\": \"John\",\n \"company_legalrep_lastname\": \"Doe\",\n \"company_address\": \"123 Avenue des Champs\",\n \"company_city\": \"Paris\",\n \"company_postal\": \"75008\",\n \"company_country\": \"France\",\n \"company_email\": \"contact@legalcity.com\",\n \"company_phone\": \"+33123456789\",\n },\n \"message\": \"Company created and associated with recovery successfully\"\n}", "name": "" }, { "header": [], "code": 403, "body": "{\n \"success\": false,\n \"message\": \"Unauthorized access to this recovery\"\n}", "name": "" }, { "header": [], "code": 403, "body": "{\n \"success\": false,\n \"message\": \"Recovery cannot be modified. Only recoveries with status 1 or 2 can be updated.\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"message\": \"Recovery not found\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"success\": false,\n \"message\": \"Validation failed\",\n \"errors\": {\n \"relation_type\": [\"The relation type field is required.\"],\n \"company_legalrep_firstname\": [\"The company legalrep firstname field is required.\"],\n \"company_name\": [\"The company name field is required when company type is commercial.\"]\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"success\": false,\n \"message\": \"Failed to create company: This recovery case already has a customer. Each recovery can have only one customer and one debtor.\"\n}", "name": "" } ] }, { "name": "Display the specified company.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/recoveries\/:recoveryId\/companies\/:companyId", "query": [], "raw": "{{baseUrl}}\/api\/recoveries\/:recoveryId\/companies\/:companyId", "variable": [ { "id": "recoveryId", "key": "recoveryId", "value": "5", "description": "ID of the recovery case." }, { "id": "companyId", "key": "companyId", "value": "10", "description": "ID of the company." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"data\": {\n \"id\": 10,\n \"company_type\": \"commercial\",\n \"company_legal_form\": \"SARL\",\n \"company_siren\": \"123456789\",\n \"company_name\": \"Example Corp\",\n \"company_legalrep_gender\": \"M\",\n \"company_legalrep_firstname\": \"John\",\n \"company_legalrep_lastname\": \"Doe\",\n \"company_address\": \"123 Main Street\",\n \"company_city\": \"Paris\",\n \"company_postal\": \"75001\",\n \"company_country\": \"France\",\n \"company_email\": \"contact@example.com\",\n \"company_phone\": \"+33123456789\",\n },\n \"message\": \"Company retrieved successfully\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"message\": \"Company not found\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"message\": \"Recovery case not found\"\n}", "name": "" } ] }, { "name": "Update the specified company.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/recoveries\/:recoveryId\/companies\/:companyId", "query": [], "raw": "{{baseUrl}}\/api\/recoveries\/:recoveryId\/companies\/:companyId", "variable": [ { "id": "recoveryId", "key": "recoveryId", "value": "5", "description": "ID of the recovery case." }, { "id": "companyId", "key": "companyId", "value": "10", "description": "ID of the company to update." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"company_type\":\"commercial\",\"company_legal_form\":\"SARL\",\"company_siren\":\"123456789\",\"company_name\":\"Updated Corp Name\",\"company_legalrep_firstname\":\"John\",\"company_legalrep_lastname\":\"Doe\",\"company_legalrep_gender\":\"M\",\"company_legalrep_quality\":1,\"company_legalrep_quality_other\":\"Fondateur\",\"company_legalrep_birthday\":\"1980-05-15\",\"company_legalrep_birthday_city\":\"Paris\",\"company_legalrep_nationality\":\"French\",\"company_legalrep_profession\":\"Engineer\",\"company_freelance_type\":\"trader\",\"company_address\":\"123 Main Street\",\"company_city\":\"Paris\",\"company_postal\":\"75001\",\"company_country\":\"France\",\"company_state\":\"\u00cele-de-France\",\"company_email\":\"updated@example.com\",\"company_phone\":\"+33123456789\",\"company_activity\":\"Software Development\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"data\": {\n \"id\": 10,\n \"company_type\": \"commercial\",\n \"company_legal_form\": \"SARL\",\n \"company_siren\": \"123456789\",\n \"company_name\": \"Updated Corp Name\",\n \"company_legalrep_gender\": \"M\",\n \"company_legalrep_firstname\": \"John\",\n \"company_legalrep_lastname\": \"Doe\",\n \"company_address\": \"123 Main Street\",\n \"company_city\": \"Paris\",\n \"company_postal\": \"75001\",\n \"company_country\": \"France\",\n \"company_email\": \"updated@example.com\",\n \"company_phone\": \"+33123456789\",\n },\n \"message\": \"Company updated successfully\"\n}", "name": "" }, { "header": [], "code": 403, "body": "{\n \"success\": false,\n \"message\": \"Recovery cannot be modified. Only recoveries with status 1 or 2 can be updated.\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"message\": \"Company not found\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"message\": \"Recovery case not found\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"success\": false,\n \"message\": \"Validation failed\",\n \"errors\": {\n \"company_email\": [\"The company email must be a valid email address.\"]\n }\n}", "name": "" } ] }, { "name": "Remove the specified company.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/recoveries\/:recoveryId\/companies\/:companyId", "query": [], "raw": "{{baseUrl}}\/api\/recoveries\/:recoveryId\/companies\/:companyId", "variable": [ { "id": "recoveryId", "key": "recoveryId", "value": "5", "description": "ID of the recovery case." }, { "id": "companyId", "key": "companyId", "value": "10", "description": "ID of the company to delete." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Company removed from recovery successfully\"\n}", "name": "" }, { "header": [], "code": 403, "body": "{\n \"success\": false,\n \"message\": \"Recovery cannot be modified. Only recoveries with status 1 or 2 can be updated.\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"message\": \"Company not found\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"message\": \"Recovery case not found\"\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"success\": false,\n \"message\": \"Failed to delete company: Cannot delete this company - recovery would be incomplete\"\n}", "name": "" } ] }, { "name": "Get Companies by Type", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/companies\/type\/:type", "query": [], "raw": "{{baseUrl}}\/api\/companies\/type\/:type", "variable": [ { "id": "type", "key": "type", "value": "customer", "description": "The type of companies to filter (customer, debtor, or both)." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve companies filtered by their relationship type (customer, debtor, or both)\nfor the authenticated user." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"data\": [\n {\n \"id\": 10,\n \"company_type\": \"commercial\",\n \"company_legal_form\": \"SARL\",\n \"company_siren\": \"123456789\",\n \"company_name\": \"Example Corp\",\n \"company_legalrep_gender\": \"Mme\",\n \"company_legalrep_firstname\": \"Jane\",\n \"company_legalrep_lastname\": \"Smith\",\n \"company_address\": \"456 Rue de la Paix\",\n \"company_city\": \"Lyon\",\n \"company_postal\": \"69001\",\n \"company_country\": \"France\",\n \"company_email\": \"contact@example.com\",\n \"company_phone\": \"+33987654321\",\n }\n ],\n \"message\": \"Companies of type 'customer' retrieved successfully\"\n}", "name": "" }, { "header": [], "code": 400, "body": "{\n \"success\": false,\n \"message\": \"Invalid type. Must be customer, debtor, or both\"\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"success\": false,\n \"message\": \"Unauthenticated\"\n}", "name": "" } ] } ] }, { "name": "Invoice Management", "description": "\nAPIs for managing invoices related to debt recovery cases", "item": [ { "name": "List Invoices", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/recoveries\/:recoveryId\/invoices", "query": [ { "key": "is_part_paid", "value": "", "description": "optional Filter by partial payment status.", "disabled": true }, { "key": "search", "value": "INV-2025", "description": "optional Search in invoice number, reference, or description.", "disabled": false }, { "key": "date_from", "value": "2025-01-01", "description": "date optional Filter invoices from this date.", "disabled": false }, { "key": "date_to", "value": "2025-12-31", "description": "date optional Filter invoices until this date.", "disabled": false }, { "key": "sort_by", "value": "invoice_amount", "description": "optional Sort by field. Defaults to invoice_date.", "disabled": false }, { "key": "sort_order", "value": "asc", "description": "optional Sort order (asc\/desc). Defaults to desc.", "disabled": false }, { "key": "per_page", "value": "20", "description": "optional Items per page (max 100). Defaults to 15.", "disabled": false }, { "key": "page", "value": "1", "description": "optional Page number. Defaults to 1.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/recoveries\/:recoveryId\/invoices?is_part_paid=&search=INV-2025&date_from=2025-01-01&date_to=2025-12-31&sort_by=invoice_amount&sort_order=asc&per_page=20&page=1", "variable": [ { "id": "recoveryId", "key": "recoveryId", "value": "5", "description": "ID of the recovery case." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get a paginated list of invoices for the authenticated user with advanced filtering options." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"data\": {\n \"invoices\": [\n {\n \"id\": 1,\n \"recovery_id\": 5,\n \"invoice_amount\": \"1500.00\",\n \"invoice_number\": \"INV-2025-001\",\n \"invoice_date\": \"2025-10-20\",\n \"invoice_due_date\": \"2025-11-20\",\n \"invoice_part_paid\": false,\n \"invoice_part_paid_amount\": null,\n \"remaining_amount\": \"1500.00\",\n \"api_invoice_id\": \"CLIENT-REF-001\",\n \"is_paid\": false,\n \"days_overdue\": 5,\n \"recovery\": {\n \"id\": 5,\n \"recovery_reference\": \"REC-ABC123\",\n \"debtor_name\": \"John Doe\",\n \"recovery_last_status\": 1\n }\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"per_page\": 15,\n \"total\": 45,\n \"last_page\": 3,\n \"from\": 1,\n \"to\": 15,\n \"has_more_pages\": true\n },\n \"summary\": {\n \"total_amount\": \"67500.00\",\n \"total_paid\": \"15000.00\",\n \"total_remaining\": \"52500.00\",\n \"partially_paid_count\": 8,\n \"overdue_count\": 12\n },\n \"filters_applied\": {\n \"is_part_paid\": false,\n \"search\": \"INV-2025\",\n \"date_from\": \"2025-01-01\",\n \"date_to\": \"2025-12-31\",\n \"sort_by\": \"invoice_date\",\n \"sort_order\": \"desc\"\n }\n },\n \"message\": \"Invoices retrieved successfully. Total: 45 invoices found.\"\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"success\": false,\n \"message\": \"Unauthenticated\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"message\": \"Recovery case not found\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"success\": false,\n \"message\": \"Validation failed\",\n \"errors\": {\n \"date_from\": [\"The date from field must be a valid date.\"],\n \"date_to\": [\"The date to field must be a valid date after date from.\"],\n \"per_page\": [\"The per page field must be between 1 and 100.\"]\n }\n}", "name": "" } ] }, { "name": "Create Invoice", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/recoveries\/:recoveryId\/invoices", "query": [], "raw": "{{baseUrl}}\/api\/recoveries\/:recoveryId\/invoices", "variable": [ { "id": "recoveryId", "key": "recoveryId", "value": "5", "description": "ID of the recovery case (must exist and belong to authenticated user)." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"invoice_number\":\"INV-2025-001\",\"invoice_date\":\"2025-10-20\",\"invoice_due_date\":\"2025-11-20\",\"invoice_amount\":\"1500.00\",\"invoice_part_paid\":false,\"invoice_part_paid_amount\":\"500.00\",\"api_invoice_id\":\"CLIENT-REF-123\"}" }, "description": "Create a new invoice associated with a recovery case including all financial details." }, "response": [ { "header": [], "code": 201, "body": "{\n \"success\": true,\n \"data\": {\n \"id\": 15,\n \"recovery_id\": 5,\n \"invoice_amount\": \"1500.00\",\n \"invoice_number\": \"INV-2025-001\",\n \"invoice_date\": \"2025-10-20\",\n \"invoice_due_date\": \"2025-11-20\",\n \"invoice_part_paid\": false,\n \"invoice_part_paid_amount\": null,\n \"remaining_amount\": \"1500.00\",\n \"api_invoice_id\": \"CLIENT-REF-123\",\n \"is_paid\": false,\n \"days_overdue\": 0,\n \"recovery\": {\n \"id\": 5,\n \"recovery_reference\": \"REC-ABC123\",\n \"debtor_name\": \"John Doe\",\n \"debtor_company\": \"Example Corp\"\n }\n },\n \"message\": \"Invoice created successfully\"\n}", "name": "" }, { "header": [], "code": 403, "body": "{\n \"success\": false,\n \"message\": \"Recovery cannot be modified. Only recoveries with status 1 or 2 can be updated.\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"message\": \"Recovery case not found\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"success\": false,\n \"message\": \"Validation failed\",\n \"errors\": {\n \"recovery_id\": [\"The recovery id field is required.\"],\n \"invoice_number\": [\"The invoice number field is required.\"],\n \"invoice_amount\": [\"The invoice amount field is required.\"]\n }\n}", "name": "" } ] }, { "name": "Show Invoice", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/recoveries\/:recoveryId\/invoices\/:invoiceId", "query": [], "raw": "{{baseUrl}}\/api\/recoveries\/:recoveryId\/invoices\/:invoiceId", "variable": [ { "id": "recoveryId", "key": "recoveryId", "value": "5", "description": "ID of the recovery case." }, { "id": "invoiceId", "key": "invoiceId", "value": "5", "description": "ID of the invoice." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve detailed information about a specific invoice including recovery case details and financial breakdown." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"data\": {\n \"id\": 5,\n \"recovery_id\": 3,\n \"invoice_amount\": \"1500.00\",\n \"invoice_number\": \"INV-2025-001\",\n \"invoice_date\": \"2025-10-20\",\n \"invoice_due_date\": \"2025-11-20\",\n \"invoice_part_paid\": false,\n \"invoice_part_paid_amount\": null,\n \"remaining_amount\": \"1500.00\",\n \"api_invoice_id\": null,\n \"is_paid\": false,\n \"days_overdue\": 5,\n \"recovery\": {\n \"id\": 3,\n \"recovery_reference\": \"REC-ABC123\",\n \"debtor_name\": \"John Doe\",\n \"debtor_company\": \"Example Corp\",\n \"case_status\": \"active\"\n }\n },\n \"message\": \"Invoice retrieved successfully\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"message\": \"Invoice not found\"\n}", "name": "" } ] }, { "name": "Update Invoice", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/recoveries\/:recoveryId\/invoices\/:invoiceId", "query": [], "raw": "{{baseUrl}}\/api\/recoveries\/:recoveryId\/invoices\/:invoiceId", "variable": [ { "id": "recoveryId", "key": "recoveryId", "value": "5", "description": "ID of the recovery case." }, { "id": "invoiceId", "key": "invoiceId", "value": "5", "description": "ID of the invoice to update." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"invoice_number\":\"INV-2025-001-UPDATED\",\"invoice_date\":\"2025-10-20\",\"invoice_due_date\":\"2025-11-20\",\"invoice_amount\":\"1600.00\",\"invoice_part_paid\":true,\"invoice_part_paid_amount\":\"800.00\",\"api_invoice_id\":\"CLIENT-REF-123-UPD\"}" }, "description": "Update invoice details including financial information, payment status, and related recovery case data." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"data\": {\n \"id\": 5,\n \"recovery_id\": 5,\n \"invoice_amount\": \"1600.00\",\n \"invoice_number\": \"INV-2025-001-UPDATED\",\n \"invoice_date\": \"2025-10-20\",\n \"invoice_due_date\": \"2025-11-20\",\n \"invoice_part_paid\": true,\n \"invoice_part_paid_amount\": \"800.00\",\n \"remaining_amount\": \"800.00\",\n \"api_invoice_id\": \"CLIENT-REF-123-UPD\",\n \"is_paid\": false,\n \"days_overdue\": 0,\n \"recovery\": {\n \"id\": 5,\n \"recovery_reference\": \"REC-ABC123\",\n \"debtor_name\": \"John Doe\",\n \"debtor_company\": \"Example Corp\"\n }\n },\n \"message\": \"Invoice updated successfully\"\n}", "name": "" }, { "header": [], "code": 403, "body": "{\n \"success\": false,\n \"message\": \"Recovery cannot be modified. Only recoveries with status 1 or 2 can be updated.\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"message\": \"Invoice not found\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"message\": \"Recovery case not found\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"success\": false,\n \"message\": \"Validation failed\",\n \"errors\": {\n \"invoice_due_date\": [\"The invoice due date must be after the invoice date.\"],\n \"invoice_part_paid_amount\": [\"The partial payment amount cannot exceed the invoice amount.\"]\n }\n}", "name": "" } ] }, { "name": "Delete Invoice", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/recoveries\/:recoveryId\/invoices\/:invoiceId", "query": [], "raw": "{{baseUrl}}\/api\/recoveries\/:recoveryId\/invoices\/:invoiceId", "variable": [ { "id": "recoveryId", "key": "recoveryId", "value": "5", "description": "ID of the recovery case." }, { "id": "invoiceId", "key": "invoiceId", "value": "5", "description": "ID of the invoice to delete." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Permanently delete an invoice from the system. This action cannot be undone." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Invoice deleted successfully\"\n}", "name": "" }, { "header": [], "code": 403, "body": "{\n \"success\": false,\n \"message\": \"Recovery cannot be modified. Only recoveries with status 1 or 2 can be updated.\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"message\": \"Invoice not found\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"message\": \"Recovery case not found\"\n}", "name": "" } ] } ] }, { "name": "Document Management", "description": "\nAPIs for managing documents related to recovery cases including correspondence,\nlegal documents, invoices, and file attachments. Use GET \/api\/docs\/file-types\nto retrieve available document types before creating or filtering documents.", "item": [ { "name": "Get File Types", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/docs\/file-types", "query": [], "raw": "{{baseUrl}}\/api\/docs\/file-types" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve all active file types available for documents.\nUse this endpoint before creating documents to ensure you're using valid file type IDs.\n\n**Supported File Types**: PDF, DOC, DOCX, XLS, XLSX, JPG, PNG, GIF\n**Maximum File Size**: 10MB per file\n**Security**: All files are scanned for malware and validated for content type" }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"data\": [\n {\n \"id\": 1,\n \"type\": \"Facture\",\n \"position\": 1,\n \"active\": true,\n \"description\": \"Invoice or billing document\"\n },\n {\n \"id\": 2,\n \"type\": \"Courrier\",\n \"position\": 2,\n \"active\": true,\n \"description\": \"General correspondence\"\n },\n {\n \"id\": 3,\n \"type\": \"LRAR\",\n \"position\": 3,\n \"active\": true,\n \"description\": \"Registered mail with acknowledgment of receipt\"\n }\n ],\n \"message\": \"Active file types retrieved successfully\"\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"success\": false,\n \"message\": \"Unauthenticated\"\n}", "name": "" } ] }, { "name": "List Documents", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/recoveries\/:recoveryId\/docs", "query": [ { "key": "search", "value": "contrat", "description": "Search in document filename.", "disabled": false }, { "key": "invoice_id", "value": "3", "description": "Filter documents by invoice ID.", "disabled": false }, { "key": "file_type", "value": "1", "description": "Filter by file type ID (use GET \/api\/docs\/file-types to get available types).", "disabled": false }, { "key": "sort_by", "value": "file_created_at", "description": "Sort field (recovery_id, file_type, invoice_id, file_created_at).", "disabled": false }, { "key": "sort_order", "value": "desc", "description": "Sort direction (asc, desc).", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max 100).", "disabled": false }, { "key": "page", "value": "1", "description": "Page number for pagination.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/recoveries\/:recoveryId\/docs?search=contrat&invoice_id=3&file_type=1&sort_by=file_created_at&sort_order=desc&per_page=15&page=1", "variable": [ { "id": "recoveryId", "key": "recoveryId", "value": "5", "description": "ID of the recovery case." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get all documents for a specific recovery case with filtering and pagination." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"data\": {\n \"documents\": [\n {\n \"id\": 1,\n \"recovery_id\": 5,\n \"invoice_id\": 3,\n \"adminUserId\": 1,\n \"fileId\": 10,\n \"fileTypeId\": 1,\n \"visibleToUser\": true,\n \"visibleToDebtor\": false,\n \"visibleToBailiff\": false,\n \"visibleToOIP\": false,\n \"isSigned\": false,\n \"created_at\": \"2025-10-19T15:30:00.000000Z\",\n \"updated_at\": \"2025-10-20T10:30:00.000000Z\",\n \"recovery\": {\n \"id\": 5,\n \"recovery_reference\": \"REC-ABC123\",\n \"debtor_name\": \"John Doe\",\n \"debtor_company\": \"Example Corp\"\n },\n \"invoice\": {\n \"id\": 3,\n \"invoice_number\": \"INV-2025-001\",\n \"amount_ttc\": \"1500.00\"\n },\n \"file\": {\n \"id\": 10,\n \"filename\": \"document.pdf\",\n \"mime\": \"application\/pdf\"\n },\n \"file_type_info\": {\n \"id\": 1,\n \"type\": \"Mise en demeure\"\n }\n }\n ]\n },\n \"pagination\": {\n \"current_page\": 1,\n \"per_page\": 15,\n \"total\": 42,\n \"last_page\": 3,\n \"from\": 1,\n \"to\": 15,\n \"has_more_pages\": true\n },\n \"message\": \"Documents retrieved successfully\"\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"success\": false,\n \"message\": \"Unauthenticated\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"message\": \"Recovery case not found\"\n}", "name": "" } ] }, { "name": "Create Document", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/recoveries\/:recoveryId\/docs", "query": [], "raw": "{{baseUrl}}\/api\/recoveries\/:recoveryId\/docs", "variable": [ { "id": "recoveryId", "key": "recoveryId", "value": "5", "description": "ID of the recovery case (must exist and belong to authenticated user)." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Mise en demeure #1\",\"pathinfo\":\"https:\\\/\\\/example.com\\\/document.pdf\",\"invoice_id\":3,\"file_type\":1}" }, "description": "Store a new document with file upload for a specific recovery case." }, "response": [ { "header": [], "code": 201, "body": "{\n \"success\": true,\n \"data\": {\n \"id\": 1,\n \"recovery_id\": 5,\n \"invoice_id\": 3,\n \"adminUserId\": 1,\n \"fileId\": 10,\n \"fileTypeId\": 1,\n \"visibleToUser\": true,\n \"visibleToDebtor\": false,\n \"visibleToBailiff\": false,\n \"visibleToOIP\": false,\n \"isSigned\": false,\n \"created_at\": \"2025-10-19T15:30:00.000000Z\",\n \"updated_at\": \"2025-10-20T10:30:00.000000Z\",\n \"recovery\": {\n \"id\": 5,\n \"recovery_reference\": \"REC-ABC123\",\n \"debtor_name\": \"John Doe\",\n \"debtor_company\": \"Example Corp\"\n },\n \"invoice\": {\n \"id\": 3,\n \"invoice_number\": \"INV-2025-001\",\n \"amount_ttc\": \"1500.00\"\n },\n \"file\": {\n \"id\": 10,\n \"filename\": \"document.pdf\",\n \"mime\": \"application\/pdf\"\n },\n \"file_type_info\": {\n \"id\": 1,\n \"type\": \"Mise en demeure\"\n }\n },\n \"message\": \"Document uploaded successfully\"\n}", "name": "" }, { "header": [], "code": 400, "body": "{\n \"success\": false,\n \"message\": \"Failed to process file\"\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"success\": false,\n \"message\": \"Unauthenticated\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"message\": \"Recovery case not found\"\n}", "name": "Recovery not found" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"message\": \"Invoice not found or does not belong to this recovery\"\n}", "name": "Invoice not found" }, { "header": [], "code": 422, "body": "{\n \"success\": false,\n \"message\": \"Validation failed\",\n \"errors\": {\n \"name\": [\"The name field is required.\"],\n \"pathinfo\": [\"The pathinfo field is required when file is not present.\"]\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"success\": false,\n \"message\": \"Failed to upload document\"\n}", "name": "" } ] }, { "name": "Show Document", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/recoveries\/:recoveryId\/docs\/:docId", "query": [], "raw": "{{baseUrl}}\/api\/recoveries\/:recoveryId\/docs\/:docId", "variable": [ { "id": "recoveryId", "key": "recoveryId", "value": "5", "description": "ID of the recovery case." }, { "id": "docId", "key": "docId", "value": "123", "description": "ID of the document." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get detailed document information for a specific recovery case." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"data\": {\n \"id\": 1,\n \"recovery_id\": 5,\n \"invoice_id\": 3,\n \"adminUserId\": 1,\n \"fileId\": 10,\n \"fileTypeId\": 1,\n \"visibleToUser\": true,\n \"visibleToDebtor\": false,\n \"visibleToBailiff\": false,\n \"visibleToOIP\": false,\n \"isSigned\": false,\n \"created_at\": \"2025-10-19T15:30:00.000000Z\",\n \"updated_at\": \"2025-10-20T10:30:00.000000Z\",\n \"recovery\": {\n \"id\": 5,\n \"recovery_reference\": \"REC-ABC123\",\n \"debtor_name\": \"John Doe\",\n \"debtor_company\": \"Example Corp\"\n },\n \"invoice\": {\n \"id\": 3,\n \"invoice_number\": \"INV-2025-001\",\n \"amount_ttc\": \"1500.00\"\n },\n \"file\": {\n \"id\": 10,\n \"filename\": \"document.pdf\",\n \"mime\": \"application\/pdf\"\n },\n \"file_type_info\": {\n \"id\": 1,\n \"type\": \"Mise en demeure\"\n }\n },\n \"message\": \"Document retrieved successfully\"\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"success\": false,\n \"message\": \"Unauthenticated\"\n}", "name": "" }, { "header": [], "code": 403, "body": "{\n \"success\": false,\n \"message\": \"Unauthorized access to this document\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"message\": \"Recovery case not found\"\n}", "name": "Recovery not found" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"message\": \"Document not found\"\n}", "name": "Document not found" } ] }, { "name": "Download Document File", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/recoveries\/:recoveryId\/docs\/:docId\/download", "query": [], "raw": "{{baseUrl}}\/api\/recoveries\/:recoveryId\/docs\/:docId\/download", "variable": [ { "id": "recoveryId", "key": "recoveryId", "value": "5", "description": "ID of the recovery case." }, { "id": "docId", "key": "docId", "value": "123", "description": "ID of the document." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Download the actual file for a specific document with secure access control.\nFiles are served with proper security headers and content type validation.\n\n**Security Features**:\n- User ownership verification\n- Document access permissions check\n- File existence validation\n- Secure file serving with proper headers\n- Content-Type header protection\n\n**File Serving**:\n- Files are served with secure file response handling\n- Original filename is preserved\n- Proper MIME type detection\n- Download logging for audit purposes" }, "response": [ { "header": [], "code": 200, "body": "\"File download with proper headers and content-disposition\"", "name": "" }, { "header": [], "code": 401, "body": "{\n \"success\": false,\n \"message\": \"Unauthenticated\"\n}", "name": "" }, { "header": [], "code": 403, "body": "{\n \"success\": false,\n \"message\": \"Unauthorized access to this document\"\n}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\n \"success\": false,\n \"message\": \"This endpoint is not yet implemented. Feature under development.\"\n}", "name": "Not implemented" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"message\": \"Recovery case not found\"\n}", "name": "Recovery not found" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"message\": \"Document not found\"\n}", "name": "Document not found" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"message\": \"File not found\"\n}", "name": "File not found" }, { "header": [], "code": 500, "body": "{\n \"success\": false,\n \"message\": \"File could not be accessed\"\n}", "name": "" } ] }, { "name": "Delete Document", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/recoveries\/:recoveryId\/docs\/:docId", "query": [], "raw": "{{baseUrl}}\/api\/recoveries\/:recoveryId\/docs\/:docId", "variable": [ { "id": "recoveryId", "key": "recoveryId", "value": "5", "description": "ID of the recovery case." }, { "id": "docId", "key": "docId", "value": "123", "description": "ID of the document to delete." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Remove document from a specific recovery case." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Document deleted successfully\"\n}", "name": "" }, { "header": [], "code": 400, "body": "{\n \"success\": false,\n \"message\": \"Cannot delete document with pending signature requests\"\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"success\": false,\n \"message\": \"Unauthenticated\"\n}", "name": "" }, { "header": [], "code": 403, "body": "{\n \"success\": false,\n \"message\": \"Unauthorized access to this document\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"message\": \"Recovery case not found\"\n}", "name": "Recovery not found" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"message\": \"Document not found\"\n}", "name": "Document not found" } ] } ] }, { "name": "Comment Management", "description": "\nAPIs for managing comments on recovery cases including internal notes,\ncommunications, and case updates with advanced visibility controls.\n\n**Visibility System**:\n- `visibleToUser`: Internal team visibility\n- `visibleToDebtor`: Debtor can see this comment\n- `visibleToBailiff`: Bailiff\/legal representative access\n- `isRead`: Read\/validation status tracking\n\n**Use Cases**:\n- Internal case notes and updates\n- Client communications log\n- Legal procedure documentation\n- Status change notifications", "item": [ { "name": "List Comments", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/recoveries\/:recoveryId\/comments", "query": [ { "key": "per_page", "value": "20", "description": "optional Items per page (max 100). Defaults to 15.", "disabled": false }, { "key": "page", "value": "1", "description": "optional Page number. Defaults to 1.", "disabled": false }, { "key": "visibility", "value": "user", "description": "enum optional Filter by visibility level (user, debtor, bailiff, all).", "disabled": false }, { "key": "unread_only", "value": "1", "description": "optional Show only unread comments.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/recoveries\/:recoveryId\/comments?per_page=20&page=1&visibility=user&unread_only=1", "variable": [ { "id": "recoveryId", "key": "recoveryId", "value": "1", "description": "The recovery case ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get all comments for a specific recovery case with visibility filtering and access control.\nComments are automatically filtered based on user permissions and visibility settings.\n\n**Visibility Rules**:\n- All users see comments where `visibleToUser = true`\n- Debtors only see comments where `visibleToDebtor = true`\n- Bailiffs see comments where `visibleToBailiff = true`\n- Admin users can see all comments regardless of visibility" }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"data\": {\n \"comments\": [\n {\n \"id\": 1,\n \"recovery_id\": 1,\n \"user_id\": 1,\n \"comment\": \"Client contacted by phone - no response received\",\n \"visibleToUser\": true,\n \"visibleToDebtor\": false,\n \"visibleToBailiff\": true,\n \"isRead\": false,\n \"created_at\": \"2025-10-20T10:30:00.000000Z\",\n \"updated_at\": \"2025-10-20T10:30:00.000000Z\"\n },\n {\n \"id\": 2,\n \"recovery_id\": 1,\n \"user_id\": 1,\n \"comment\": \"Payment plan proposal sent to debtor\",\n \"visibleToUser\": true,\n \"visibleToDebtor\": true,\n \"visibleToBailiff\": false,\n \"isRead\": true,\n \"created_at\": \"2025-10-21T14:15:00.000000Z\",\n \"updated_at\": \"2025-10-21T14:15:00.000000Z\"\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"per_page\": 20,\n \"total\": 189,\n \"last_page\": 10,\n \"from\": 1,\n \"to\": 20,\n \"has_more_pages\": true\n },\n \"summary\": {\n \"total_comments\": 189,\n \"unread_count\": 45,\n \"visible_to_debtor\": 23,\n \"visible_to_bailiff\": 67\n }\n },\n \"message\": \"Comments retrieved successfully. Total: 189 comments found.\"\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"success\": false,\n \"message\": \"Unauthenticated\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"message\": \"Recovery case not found\"\n}", "name": "" } ] }, { "name": "Create Comment", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/recoveries\/:recoveryId\/comments", "query": [], "raw": "{{baseUrl}}\/api\/recoveries\/:recoveryId\/comments", "variable": [ { "id": "recoveryId", "key": "recoveryId", "value": "1", "description": "The recovery case ID." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"comment\":\"

Client contacted by phone - no response<\\\/strong><\\\/p>\"}" }, "description": "Add a new comment to a recovery case with specified visibility settings." }, "response": [ { "header": [], "code": 201, "body": "{\n \"success\": true,\n \"data\": {\n \"id\": 1,\n \"recovery_id\": 1,\n \"user_id\": 1,\n \"comment\": \"Client contacted by phone - no response\",\n \"visibleToUser\": true,\n \"visibleToDebtor\": false,\n \"visibleToBailiff\": true,\n \"isRead\": false,\n \"created_at\": \"2025-10-20T10:30:00.000000Z\",\n \"updated_at\": \"2025-10-20T10:30:00.000000Z\"\n },\n \"message\": \"Comment created successfully\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"message\": \"Recovery case not found\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"success\": false,\n \"message\": \"Validation failed\",\n \"errors\": {\n \"comment\": [\"The comment field is required.\", \"The comment contains potentially dangerous HTML tags.\", \"The comment contains too much HTML markup.\"]\n }\n}", "name": "" } ] }, { "name": "Show Comment", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/recoveries\/:recoveryId\/comments\/:commentId", "query": [], "raw": "{{baseUrl}}\/api\/recoveries\/:recoveryId\/comments\/:commentId", "variable": [ { "id": "recoveryId", "key": "recoveryId", "value": "1", "description": "The recovery case ID." }, { "id": "commentId", "key": "commentId", "value": "1", "description": "The comment ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get details of a specific comment." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"data\": {\n \"id\": 1,\n \"recovery_id\": 1,\n \"user_id\": 1,\n \"comment\": \"Client contacted by phone - no response\",\n \"visibleToUser\": true,\n \"visibleToDebtor\": false,\n \"visibleToBailiff\": true,\n \"isRead\": false,\n \"created_at\": \"2025-10-20T10:30:00.000000Z\",\n \"updated_at\": \"2025-10-20T10:30:00.000000Z\"\n },\n \"message\": \"Comment retrieved successfully\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"message\": \"Recovery case not found\"\n}", "name": "Recovery not found" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"message\": \"Comment not found\"\n}", "name": "Comment not found" } ] }, { "name": "Update Comment", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/recoveries\/:recoveryId\/comments\/:commentId", "query": [], "raw": "{{baseUrl}}\/api\/recoveries\/:recoveryId\/comments\/:commentId", "variable": [ { "id": "recoveryId", "key": "recoveryId", "value": "1", "description": "The recovery case ID." }, { "id": "commentId", "key": "commentId", "value": "1", "description": "The comment ID." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"comment\":\"

Client contacted by phone - answered this time<\\\/em><\\\/p>\"}" }, "description": "Update an existing comment with new content or visibility settings." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"data\": {\n \"id\": 1,\n \"recovery_id\": 1,\n \"user_id\": 1,\n \"comment\": \"Client contacted by phone - answered this time\",\n \"visibleToUser\": true,\n \"visibleToDebtor\": false,\n \"visibleToBailiff\": true,\n \"isRead\": false,\n \"created_at\": \"2025-10-20T10:30:00.000000Z\",\n \"updated_at\": \"2025-10-20T10:30:00.000000Z\"\n },\n \"message\": \"Comment updated successfully\"\n}", "name": "" }, { "header": [], "code": 403, "body": "{\n \"success\": false,\n \"message\": \"Cannot update comment that is visible to debtor\/bailiff or has been read\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"message\": \"Comment not found\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"success\": false,\n \"message\": \"Validation failed\",\n \"errors\": {\n \"comment\": [\"The comment must not be greater than 2000 characters.\", \"The comment contains potentially dangerous HTML tags.\", \"The comment contains too much HTML markup.\"]\n }\n}", "name": "" } ] }, { "name": "Delete Comment", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/recoveries\/:recoveryId\/comments\/:commentId", "query": [], "raw": "{{baseUrl}}\/api\/recoveries\/:recoveryId\/comments\/:commentId", "variable": [ { "id": "recoveryId", "key": "recoveryId", "value": "1", "description": "The recovery case ID." }, { "id": "commentId", "key": "commentId", "value": "1", "description": "The comment ID." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Remove a comment from the recovery case." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Comment deleted successfully\"\n}", "name": "" }, { "header": [], "code": 403, "body": "{\n \"success\": false,\n \"message\": \"Cannot delete comment that is visible to debtor\/bailiff or has been read\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"message\": \"Recovery case not found\"\n}", "name": "Recovery not found" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"message\": \"Comment not found\"\n}", "name": "Comment not found" } ] } ] }, { "name": "Protected Invoice Management", "description": "\nEndpoints for managing protected invoices. These endpoints handle\nsecure invoice information storage and retrieval for client billing.", "item": [ { "name": "List Protected Invoices", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/protected-invoices", "query": [ { "key": "search", "value": "INV-2024", "description": "optional Search in invoice numbers and descriptions.", "disabled": false }, { "key": "status", "value": "pending", "description": "optional Filter by invoice status (pending, paid, cancelled).", "disabled": false }, { "key": "siren", "value": "123456789", "description": "optional Filter by client SIREN.", "disabled": false }, { "key": "sort_by", "value": "invoice_number", "description": "optional Sort by field. Defaults to due_date.", "disabled": false }, { "key": "sort_order", "value": "asc", "description": "optional Sort order (asc\/desc). Defaults to desc.", "disabled": false }, { "key": "per_page", "value": "20", "description": "optional Items per page (max 100). Defaults to 15.", "disabled": false }, { "key": "page", "value": "1", "description": "optional Page number. Defaults to 1.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/protected-invoices?search=INV-2024&status=pending&siren=123456789&sort_by=invoice_number&sort_order=asc&per_page=20&page=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieves a paginated list of protected invoices with optional filters." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"data\": {\n \"protected_invoices\": [\n {\n \"id\": 1,\n \"api_invoice_id\": \"INV-202405252001\",\n \"tracking_code\": \"fyn_INV-202405252001\",\n \"siren\": \"123456789\",\n \"invoice_number\": \"INV-2024-001\",\n \"due_date\": \"2024-12-31\",\n \"amount\": \"1500.50\",\n \"currency\": \"EUR\",\n \"status\": \"pending\",\n \"status_label\": \"\u00c0 payer\",\n \"formatted_amount\": \"1500.50 EUR\",\n \"is_overdue\": false,\n \"is_paid\": false,\n \"created_at\": \"2024-10-31T21:15:00.000000Z\",\n \"updated_at\": \"2024-10-31T21:15:00.000000Z\"\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"per_page\": 15,\n \"total\": 1,\n \"last_page\": 1,\n \"from\": 1,\n \"to\": 1,\n \"has_more_pages\": false\n }\n },\n \"message\": \"Protected invoices retrieved successfully\"\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"success\": false,\n \"message\": \"Unauthenticated\"\n}", "name": "" } ] }, { "name": "Store Protected Invoice", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/protected-invoices", "query": [], "raw": "{{baseUrl}}\/api\/protected-invoices" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"api_invoice_id\":\"INV-202405252001\",\"siren\":\"123456789\",\"invoice_number\":\"INV-2024-001\",\"due_date\":\"2024-12-31\",\"amount\":\"1500.50\",\"currency\":\"EUR\",\"status\":\"pending\",\"description\":\"Services rendered for January 2024\"}" }, "description": "Creates a new protected invoice with automatic tracking code generation.\nThe tracking code is automatically generated with the prefix \"fyn_\" followed by a unique identifier." }, "response": [ { "header": [], "code": 201, "body": "{\n \"success\": true,\n \"data\": {\n \"id\": 1,\n \"api_invoice_id\": \"INV-202405252001\",\n \"tracking_code\": \"fyn_INV-202405252001\",\n \"siren\": \"123456789\",\n \"invoice_number\": \"INV-2024-001\",\n \"due_date\": \"2024-12-31\",\n \"amount\": \"1500.50\",\n \"currency\": \"EUR\",\n \"status\": \"pending\",\n \"status_label\": \"\u00c0 payer\",\n \"description\": \"Services rendered for January 2024\",\n \"formatted_amount\": \"1500.50 EUR\",\n \"is_overdue\": false,\n \"is_paid\": false,\n \"created_at\": \"2024-10-31T21:15:00.000000Z\",\n \"updated_at\": \"2024-10-31T21:15:00.000000Z\"\n },\n \"message\": \"Protected invoice created successfully\"\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"success\": false,\n \"message\": \"Unauthenticated\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"success\": false,\n \"message\": \"Validation failed\",\n \"errors\": {\n \"api_invoice_id\": [\"An invoice with this API ID already exists for your account.\"],\n \"siren\": [\"The siren must be exactly 9 characters.\"]\n }\n}", "name": "" } ] }, { "name": "Show Protected Invoice", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/protected-invoices\/:id", "query": [], "raw": "{{baseUrl}}\/api\/protected-invoices\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The protected invoice ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieves details of a specific protected invoice by its ID." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"data\": {\n \"id\": 1,\n \"api_invoice_id\": \"INV-202405252001\",\n \"tracking_code\": \"fyn_INV-202405252001\",\n \"siren\": \"123456789\",\n \"invoice_number\": \"INV-2024-001\",\n \"due_date\": \"2024-12-31\",\n \"amount\": \"1500.50\",\n \"currency\": \"EUR\",\n \"status\": \"pending\",\n \"status_label\": \"\u00c0 payer\",\n \"description\": \"Services rendered for January 2024\",\n \"formatted_amount\": \"1500.50 EUR\",\n \"is_overdue\": false,\n \"is_paid\": false,\n \"created_at\": \"2024-10-31T21:15:00.000000Z\",\n \"updated_at\": \"2024-10-31T21:15:00.000000Z\"\n },\n \"message\": \"Protected invoice retrieved successfully\"\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"success\": false,\n \"message\": \"Unauthenticated\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"message\": \"Protected invoice not found\"\n}", "name": "" } ] }, { "name": "Update Protected Invoice Status", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/protected-invoices\/:id", "query": [], "raw": "{{baseUrl}}\/api\/protected-invoices\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The protected invoice ID." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"status\":\"\\\"paid\\\"\"}" }, "description": "Updates the status of a protected invoice. This automatically updates the timestamp.\nOnly the status can be modified after creation." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"data\": {\n \"id\": 1,\n \"api_invoice_id\": \"INV-202405252001\",\n \"tracking_code\": \"fyn_INV-202405252001\",\n \"siren\": \"123456789\",\n \"invoice_number\": \"INV-2024-001\",\n \"due_date\": \"2024-12-31\",\n \"amount\": \"1500.50\",\n \"currency\": \"EUR\",\n \"status\": \"paid\",\n \"status_label\": \"Pay\u00e9e\",\n \"formatted_amount\": \"1500.50 EUR\",\n \"is_overdue\": false,\n \"is_paid\": true,\n \"created_at\": \"2024-10-31T21:15:00.000000Z\",\n \"updated_at\": \"2024-10-31T21:30:00.000000Z\"\n },\n \"message\": \"Protected invoice status updated successfully\"\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"success\": false,\n \"message\": \"Unauthenticated\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"message\": \"Protected invoice not found\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"success\": false,\n \"message\": \"Validation failed\",\n \"errors\": {\n \"status\": [\"Status must be one of: pending, paid, cancelled.\"]\n }\n}", "name": "" } ] }, { "name": "Get Protected Invoice by API Invoice ID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/protected-invoices\/api\/:apiInvoiceId", "query": [], "raw": "{{baseUrl}}\/api\/protected-invoices\/api\/:apiInvoiceId", "variable": [ { "id": "apiInvoiceId", "key": "apiInvoiceId", "value": "INV-202405252001", "description": "The API invoice ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieves a protected invoice using its unique API invoice ID." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"data\": {\n \"id\": 1,\n \"api_invoice_id\": \"INV-202405252001\",\n \"tracking_code\": \"fyn_INV-202405252001\",\n \"siren\": \"123456789\",\n \"invoice_number\": \"INV-2024-001\",\n \"due_date\": \"2024-12-31\",\n \"amount\": \"1500.50\",\n \"currency\": \"EUR\",\n \"status\": \"pending\",\n \"status_label\": \"\u00c0 payer\",\n \"description\": \"Services rendered for January 2024\",\n \"formatted_amount\": \"1500.50 EUR\",\n \"is_overdue\": false,\n \"is_paid\": false,\n \"created_at\": \"2024-10-31T21:15:00.000000Z\",\n \"updated_at\": \"2024-10-31T21:15:00.000000Z\"\n },\n \"message\": \"Protected invoice found\"\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"success\": false,\n \"message\": \"Unauthenticated\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"message\": \"Protected invoice not found with this API invoice ID\"\n}", "name": "" } ] } ] }, { "name": "Scoring Management", "description": "\nEndpoints for managing credit scoring, solvency reports, and company surveillance.\nThese endpoints handle ordering and monitoring of financial assessments.", "item": [ { "name": "Order Scoring Report", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/scoring\/order", "query": [], "raw": "{{baseUrl}}\/api\/scoring\/order" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"company_id\":123,\"company_name\":\"\\\"ACME Corporation\\\"\",\"company_siret\":\"\\\"12345678901234\\\"\",\"services\":[\"solvency_report\",\"surveillance\"],\"report_type\":\"\\\"standard\\\"\",\"surveillance_duration\":12,\"priority\":\"\\\"standard\\\"\"}" }, "description": "Orders a solvency report and\/or surveillance for a company.\nThis endpoint allows ordering both services simultaneously or individually." }, "response": [ { "header": [], "code": 201, "body": "{\n \"success\": true,\n \"data\": {\n \"order_id\": \"SCR-2024-001\",\n \"services\": [\"solvency_report\", \"surveillance\"],\n \"status\": \"pending\",\n \"estimated_delivery\": \"2024-01-17T10:00:00.000000Z\"\n },\n \"message\": \"Scoring order placed successfully\"\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"success\": false,\n \"message\": \"Unauthenticated\"\n}", "name": "" }, { "header": [], "code": 403, "body": "{\n \"success\": false,\n \"message\": \"This endpoint is not yet implemented. Feature under development.\"\n}", "name": "" } ] }, { "name": "Check Available Tokens", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/scoring\/tokens", "query": [], "raw": "{{baseUrl}}\/api\/scoring\/tokens" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns the number of remaining tokens available for ordering reports and surveillance.\nThis endpoint helps users monitor their consumption and remaining credits." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"data\": {\n \"remaining_tokens\": 75\n },\n \"message\": \"Token information retrieved successfully\"\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"data\": {\n \"remaining_tokens\": 0\n },\n \"message\": \"No tokens available\"\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"success\": false,\n \"message\": \"Unauthenticated\"\n}", "name": "" } ] }, { "name": "List Scoring Orders", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/scoring\/orders", "query": [ { "key": "status", "value": "completed", "description": "Filter by order status.", "disabled": false }, { "key": "service_type", "value": "solvency_report", "description": "Filter by service type.", "disabled": false }, { "key": "per_page", "value": "15", "description": "Number of items per page.", "disabled": false }, { "key": "page", "value": "1", "description": "The page number for pagination.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/scoring\/orders?status=completed&service_type=solvency_report&per_page=15&page=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieves a list of scoring orders for the authenticated user." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"data\": {\n \"scoring_orders\": []\n },\n \"pagination\": {\n \"current_page\": 1,\n \"per_page\": 15,\n \"total\": 0,\n \"last_page\": 1,\n \"from\": null,\n \"to\": null\n },\n \"message\": \"Scoring orders retrieved successfully\"\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"success\": false,\n \"message\": \"Unauthenticated\"\n}", "name": "" }, { "header": [], "code": 403, "body": "{\n \"success\": false,\n \"message\": \"This endpoint is not yet implemented. Feature under development.\"\n}", "name": "" } ] }, { "name": "Show Scoring Order", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/scoring\/orders\/:orderId", "query": [], "raw": "{{baseUrl}}\/api\/scoring\/orders\/:orderId", "variable": [ { "id": "orderId", "key": "orderId", "value": "SCR-2024-001", "description": "The scoring order ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieves details of a specific scoring order including results if available." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"data\": {\n \"order_id\": \"SCR-2024-001\",\n \"company_name\": \"ACME Corporation\",\n \"services\": [\"solvency_report\"],\n \"status\": \"completed\",\n \"results\": {\n \"solvency_score\": 85,\n \"risk_level\": \"low\"\n }\n },\n \"message\": \"Scoring order retrieved successfully\"\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"success\": false,\n \"message\": \"Unauthenticated\"\n}", "name": "" }, { "header": [], "code": 403, "body": "{\n \"success\": false,\n \"message\": \"This endpoint is not yet implemented. Feature under development.\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"message\": \"Scoring order not found\"\n}", "name": "" } ] } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "Authorization", "type": "string" } ] } }