{ "info": { "name": "LinkProx API v1", "description": "API Collection for LinkProx Web Platform", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "variable": [ { "key": "baseUrl", "value": "localhost/linkprox_new", "type": "string" }, { "key": "jwt_token", "value": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6NCwiZW1haWwiOiJjdXN0b21lckBsaW5rcHJveC50ZXN0Iiwicm9sZSI6ImN1c3RvbWVyIiwidG9rZW5fdmVyc2lvbiI6MSwiZXhwIjoxNzc4MTk2NDQzfQ.E9OoVZ3ahIHpR5gAYF-DJBXD7jWDU008Du94-4QJizQ", "type": "string" }, { "key": "jwt_authorized_agent", "value": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MiwiZW1haWwiOiJjb21wYW55QGxpbmtwcm94LnRlc3QiLCJyb2xlIjoiY29tcGFueSIsInRva2VuX3ZlcnNpb24iOjMsImV4cCI6MTc3ODc2MjEwMX0.14yhiNEdVg8C0b2i0FZzpLA63-lftzI6gs8bCREY3xM", "type": "string", "description": "Bearer token from POST /auth/login for a company user (owner or staff) acting as signing rep / authorized agent. Paste the token value here." }, { "key": "jwt_site_engineer", "value": "", "type": "string", "description": "Bearer token from POST /auth/login for a user with JWT role site_engineer." }, { "key": "jwt_token", "value": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6NCwiZW1haWwiOiJjdXN0b21lckBsaW5rcHJveC50ZXN0Iiwicm9sZSI6ImN1c3RvbWVyIiwidG9rZW5fdmVyc2lvbiI6MSwiZXhwIjoxNzc4MTk2NDQzfQ.E9OoVZ3ahIHpR5gAYF-DJBXD7jWDU008Du94-4QJizQ", "type": "string", "description": "Bearer token from POST /auth/login for a user with role 'customer'." } ], "item": [ { "name": "01 Auth", "item": [ { "name": "Login", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/auth/login", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "auth", "login" ] }, "body": { "mode": "raw", "raw": "{\"email\":\"company@linkprox.test\",\"password\":\"pass123\"}" } } }, { "name": "Register", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/auth/register", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "auth", "register" ] }, "body": { "mode": "raw", "raw": "{\n \"full_name\": \"John Doe\",\n \"email\": \"john@example.com\",\n \"password\": \"pass123\",\n \"role\": \"company\",\n \"company_name\": \"John's Tech Solutions\"\n}" }, "description": "Create a new user account. Role can be 'customer' or 'company'. If 'company' is selected, `company_name` is required." } }, { "name": "Send OTP", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/auth/send-otp", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "auth", "send-otp" ] }, "body": { "mode": "raw", "raw": "{\"email\":\"company@linkprox.test\"}" } } }, { "name": "Login with OTP", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/auth/login-otp", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "auth", "login-otp" ] }, "body": { "mode": "raw", "raw": "{\"email\":\"company@linkprox.test\", \"otp\": \"123456\"}" } } }, { "name": "Forgot Password", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/auth/forgot-password", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "auth", "forgot-password" ] }, "body": { "mode": "raw", "raw": "{\"email\":\"company@linkprox.test\"}" } } }, { "name": "Reset Password", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/auth/reset-password", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "auth", "reset-password" ] }, "body": { "mode": "raw", "raw": "{\"token\":\"RESET_TOKEN_HERE\", \"password\": \"newpass123\"}" } } }, { "name": "Update Password", "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/auth/password", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "auth", "password" ] }, "body": { "mode": "raw", "raw": "{\"current_password\":\"pass123\", \"new_password\": \"newpass123\", \"confirm_password\": \"newpass123\"}" } } }, { "name": "Logout All Devices", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/auth/logout-all", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "auth", "logout-all" ] } } }, { "name": "Check Token / User Info", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/auth/me", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "auth", "me" ] }, "description": "Validate the current session token and retrieve the user's profile and role information." } }, { "name": "Get Business Types", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/auth/business-types", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "auth", "business-types" ] }, "description": "Retrieve the list of business types from the database." } }, { "name": "Get Preferred Language", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/auth/language", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "auth", "language" ] }, "description": "Retrieve the authenticated user's preferred language." } }, { "name": "Update Preferred Language", "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"language_code\": \"ar\"\n}" }, "url": { "raw": "{{baseUrl}}/api/v1/auth/language", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "auth", "language" ] }, "description": "Update the authenticated user's preferred language." } } ] }, { "name": "Car Wash", "item": [ { "name": "Settings", "item": [ { "name": "Get Global Settings", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/car-wash/settings", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "car-wash", "settings" ] }, "description": "Retrieve the global car wash service profile (title, price, description, etc.)." } } ] }, { "name": "Customer", "item": [ { "name": "Create Instant Request", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"service_type\": \"car_wash\",\n \"latitude\": 25.1234,\n \"longitude\": 55.4321,\n \"address_text\": \"Business Bay, Dubai\",\n \"car_details\": {\n \"type\": \"SUV\",\n \"plate\": \"A-12345\",\n \"notes\": \"Underground parking, pillar B12\"\n }\n}" }, "url": { "raw": "{{baseUrl}}/api/v1/instant-service/request", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "instant-service", "request" ] } } }, { "name": "Accept Offer", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"offer_id\": 1\n}" }, "url": { "raw": "{{baseUrl}}/api/v1/instant-service/accept", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "instant-service", "accept" ] } } }, { "name": "Get Tracking Info", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/instant-service/tracking?request_id=1", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "instant-service", "tracking" ], "query": [ { "key": "request_id", "value": "1" } ] } } }, { "name": "Get Request Offers", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/instant-service/offers?request_id=1", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "instant-service", "offers" ], "query": [ { "key": "request_id", "value": "1" } ] } } }, { "name": "Get Service History", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/instant-service/history?limit=20&offset=0", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "instant-service", "history" ], "query": [ { "key": "limit", "value": "20" }, { "key": "offset", "value": "0" } ] } } }, { "name": "Cancel Request", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"request_id\": 1,\n \"reason\": \"Changed my mind\"\n}" }, "url": { "raw": "{{baseUrl}}/api/v1/instant-service/cancel", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "instant-service", "cancel" ] } } }, { "name": "Get Marketplace Requests", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/instant-service/all", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "instant-service", "all" ] }, "description": "Get all available car wash requests in the system (Marketplace view for customers)." } } ] }, { "name": "Company", "item": [ { "name": "Toggle Car Wash Service", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_authorized_agent}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"enabled\": 1\n}" }, "url": { "raw": "{{baseUrl}}/api/v1/company/settings/car-wash-toggle", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "settings", "car-wash-toggle" ] } } }, { "name": "Get Company Settings", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_authorized_agent}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/car-wash/settings", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "car-wash", "settings" ] }, "description": "Retrieve the car wash service profile for the authenticated company." } }, { "name": "Update Company Settings", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_authorized_agent}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"title_en\": \"Premium Mobile Car Wash\",\n \"title_ar\": \"غسيل سيارات متنقل ممتاز\",\n \"description_en\": \"Professional detailing at your doorstep.\",\n \"base_price\": 35.00,\n \"estimated_duration\": \"60 Minutes\"\n}" }, "url": { "raw": "{{baseUrl}}/api/v1/company/car-wash/settings", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "car-wash", "settings" ] } } }, { "name": "Get Pending Requests (Offers Page)", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_authorized_agent}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/instant-service/pending?latitude=30.0444&longitude=31.2357&limit=20&offset=0", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "instant-service", "pending" ], "query": [ { "key": "latitude", "value": "30.0444" }, { "key": "longitude", "value": "31.2357" }, { "key": "limit", "value": "20" }, { "key": "offset", "value": "0" } ] } } }, { "name": "Get Pending Count (Sidebar)", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_authorized_agent}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/instant-service/pending-count", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "instant-service", "pending-count" ] } } }, { "name": "Submit Offer", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_authorized_agent}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"request_id\": 1,\n \"price\": 45,\n \"eta_minutes\": 20\n}" }, "url": { "raw": "{{baseUrl}}/api/v1/instant-service/offer", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "instant-service", "offer" ] } } }, { "name": "Update Tracking Stage", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_authorized_agent}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"request_id\": 1,\n \"stage_code\": \"arrived\",\n \"label_en\": \"Provider Arrived\",\n \"label_ar\": \"وصل المزود\",\n \"notes\": \"Technician has arrived at the location.\"\n}\n\n// Available Car Wash Stages:\n// - arrived: Provider Arrived\n// - washing_exterior: Washing Exterior\n// - interior_detailing: Interior Detailing\n// - final_inspection: Final Inspection\n// - completed: Service Finished" }, "url": { "raw": "{{baseUrl}}/api/v1/instant-service/stage-update", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "instant-service", "stage-update" ] }, "description": "Update the execution stage of a car wash service. Available `stage_code` types: \n- `arrived`: Provider Arrived\n- `washing_exterior`: Washing Exterior\n- `interior_detailing`: Interior Detailing\n- `final_inspection`: Final Inspection\n- `completed`: Service Finished" } }, { "name": "Update Staff Location", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_authorized_agent}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"request_id\": 1,\n \"latitude\": 25.1234,\n \"longitude\": 55.4321\n}" }, "url": { "raw": "{{baseUrl}}/api/v1/instant-service/location-update", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "instant-service", "location-update" ] } } }, { "name": "Get Service History", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_authorized_agent}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/instant-service/history?limit=50&offset=0", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "instant-service", "history" ], "query": [ { "key": "limit", "value": "50" }, { "key": "offset", "value": "0" } ] } } }, { "name": "Get Tracking Information", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_authorized_agent}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/instant-service/tracking?request_id=1", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "instant-service", "tracking" ], "query": [ { "key": "request_id", "value": "1", "description": "ID of the instant service request" } ] }, "description": "Retrieve real-time tracking data for a car wash service, including the current status, execution stages completed, and provider location." } }, { "name": "Get Ongoing Requests (Execution Page)", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_authorized_agent}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/instant-service/ongoing", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "instant-service", "ongoing" ] } } }, { "name": "Approve Payment", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_authorized_agent}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"request_id\": 1\n}" }, "url": { "raw": "{{baseUrl}}/api/v1/instant-service/approve-payment", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "instant-service", "approve-payment" ] }, "description": "Confirm that the customer has paid for the service. Moves status from `completed` to `paid`." } } ] } ] }, { "name": "02 Customer Support", "item": [ { "name": "Get FAQs", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/customer/faqs", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customer", "faqs" ] }, "description": "Retrieve the list of FAQ categories and questions." } } ] }, { "name": "Authorized Agent (company portal)", "description": "Endpoints typically used by a **company** JWT (owner or `company_staff` such as an **authorized signing agent**). Set `jwt_authorized_agent` from Login, then use it in the Authorization header. Staff may need `company_staff_permissions` (e.g. `payments.evidence`, `execution.manage`, `requests.respond`, quotation.*).", "item": [ { "name": "Login (company — save token to jwt_authorized_agent)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/auth/login", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "auth", "login" ] }, "body": { "mode": "raw", "raw": "{\"email\":\"your_agent@company.com\",\"password\":\"YOUR_PASSWORD\"}" }, "description": "Copy `data.token` from the response into the collection variable `jwt_authorized_agent` (and optionally `jwt_token`)." } }, { "name": "Get my staff permissions", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_authorized_agent}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/me/permissions", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "me", "permissions" ] } } }, { "name": "List company requests", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_authorized_agent}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/requests?limit=20&offset=0", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "requests" ], "query": [ { "key": "limit", "value": "20" }, { "key": "offset", "value": "0" } ] } } }, { "name": "Requests badge count", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_authorized_agent}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/requests/count", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "requests", "count" ] } } }, { "name": "List quotations", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_authorized_agent}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/quotations/list?limit=20&offset=0", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "quotations", "list" ], "query": [ { "key": "limit", "value": "20" }, { "key": "offset", "value": "0" } ] } } }, { "name": "List contracts", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_authorized_agent}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/contracts?limit=20&offset=0", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "contracts" ], "query": [ { "key": "limit", "value": "20" }, { "key": "offset", "value": "0" } ] } } }, { "name": "Get contract details (header/meta)", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_authorized_agent}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/contracts/details?contract_id=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "contracts", "details" ], "query": [ { "key": "contract_id", "value": "10" } ] } } }, { "name": "Get Revision Requests", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_authorized_agent}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/contracts/revision-requests?contract_id=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "contracts", "revision-requests" ], "query": [ { "key": "contract_id", "value": "10" } ] }, "description": "Get all customer revision requests (from contract_logs where action_code = customer_revision_requested) for a given contract. Requires company JWT. Returns reason, details JSON, and created_at for each request." } }, { "name": "Acknowledge Revision Request", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_authorized_agent}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/contracts/revision-requests/acknowledge", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "contracts", "revision-requests", "acknowledge" ] }, "body": { "mode": "raw", "raw": "{\"log_id\": 1}" } } }, { "name": "Mark Revision Request as Actioned", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_authorized_agent}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/contracts/revision-requests/actioned", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "contracts", "revision-requests", "actioned" ] }, "body": { "mode": "raw", "raw": "{\"log_id\": 1}" } } }, { "name": "Reject Revision Request", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_authorized_agent}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/contracts/revision-requests/reject", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "contracts", "revision-requests", "reject" ] }, "body": { "mode": "raw", "raw": "{\"log_id\": 1, \"reason\": \"The requested revision is outside the current project scope and requires a new quotation.\"}" } } }, { "name": "Get contract roles (signing rep / engineer assignment)", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_authorized_agent}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/contracts/roles?contract_id=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "contracts", "roles" ], "query": [ { "key": "contract_id", "value": "10" } ] } } }, { "name": "Save contract roles", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_authorized_agent}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/contracts/roles?contract_id=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "contracts", "roles" ], "query": [ { "key": "contract_id", "value": "10" } ] }, "body": { "mode": "raw", "raw": "{\"signing_representative_id\": 1, \"site_engineer_id\": 2, \"engineer_notifications_enabled\": true}" } } }, { "name": "List payment milestones (contract_details tab)", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_authorized_agent}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/contracts/milestones?contract_id=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "contracts", "milestones" ], "query": [ { "key": "contract_id", "value": "10" } ] } } }, { "name": "Milestone payment details", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_authorized_agent}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/contracts/milestones/details?milestone_id=7", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "contracts", "milestones", "details" ], "query": [ { "key": "milestone_id", "value": "7" } ] } } }, { "name": "Review milestone submission (approve / reject)", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_authorized_agent}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/contracts/milestones/review", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "contracts", "milestones", "review" ] }, "body": { "mode": "raw", "raw": "{\"submission_id\": 1, \"action\": \"approve\", \"note\": \"Approved\"}" }, "description": "Requires `payments.evidence` permission for gated staff." } }, { "name": "Request milestone payment", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_authorized_agent}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/contracts/milestones/request-payment", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "contracts", "milestones", "request-payment" ] }, "body": { "mode": "raw", "raw": "{\"milestone_id\": 7}" } } }, { "name": "Send contract to customer", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_authorized_agent}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/contracts/send?contract_id=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "contracts", "send" ], "query": [ { "key": "contract_id", "value": "10" } ] } } }, { "name": "Sign the contract (company — UAE PASS simulated)", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_authorized_agent}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/contracts/sign?contract_id=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "contracts", "sign" ], "query": [ { "key": "contract_id", "value": "10" } ] }, "description": "Company-side signature when the contract is in **pending_signature**. Same as portal **Sign with UAE PASS**; uses `POST /api/v1/company/contracts/sign?contract_id=`. Signing representative should use `jwt_authorized_agent` (company JWT)." } }, { "name": "Execution", "item": [ { "name": "Get Execution Overview", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_authorized_agent}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/contracts/execution?contract_id=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "contracts", "execution" ], "query": [ { "key": "contract_id", "value": "10" } ] }, "description": "Returns a list of all stages for a contract." } }, { "name": "Get Stage Details", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_authorized_agent}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/contracts/execution/stages/details?stage_id=1", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "contracts", "execution", "stages", "details" ], "query": [ { "key": "stage_id", "value": "1" } ] } } }, { "name": "Create Execution Stage", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_authorized_agent}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"contract_id\": 10,\n \"title\": \"Foundation Work\",\n \"description\": \"Excavation and base pouring\",\n \"sequence_no\": 1,\n \"planned_start_date\": \"2026-05-01\",\n \"planned_end_date\": \"2026-05-15\"\n}" }, "url": { "raw": "{{baseUrl}}/api/v1/contracts/execution/stages", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "contracts", "execution", "stages" ] } } }, { "name": "Update Execution Stage", "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_authorized_agent}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"stage_id\": 1,\n \"title\": \"Updated Foundation Title\"\n}" }, "url": { "raw": "{{baseUrl}}/api/v1/contracts/execution/stages", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "contracts", "execution", "stages" ] } } }, { "name": "Delete Execution Stage", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_authorized_agent}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/contracts/execution/stages?stage_id=1", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "contracts", "execution", "stages" ], "query": [ { "key": "stage_id", "value": "1" } ] } } }, { "name": "Reorder Stages", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_authorized_agent}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"contract_id\": 10,\n \"order\": [\n 2,\n 1,\n 3\n ]\n}" }, "url": { "raw": "{{baseUrl}}/api/v1/contracts/execution/stages/reorder", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "contracts", "execution", "stages", "reorder" ] } } }, { "name": "Review Stage Completion", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_authorized_agent}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"stage_id\": 1,\n \"action\": \"approve\",\n \"reason\": \"Looks good.\"\n}" }, "url": { "raw": "{{baseUrl}}/api/v1/contracts/execution/stages/review", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "contracts", "execution", "stages", "review" ] } } }, { "name": "Acknowledge/Resolve Delay", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_authorized_agent}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"delay_id\": 1,\n \"new_status\": \"acknowledged\"\n}" }, "url": { "raw": "{{baseUrl}}/api/v1/contracts/execution/delays/update-status", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "contracts", "execution", "delays", "update-status" ] } } }, { "name": "List Extension Requests", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_authorized_agent}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/contracts/execution/stages/extension-requests?contract_id=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "contracts", "execution", "stages", "extension-requests" ], "query": [ { "key": "contract_id", "value": "10" } ] } } }, { "name": "Review Extension Request", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_authorized_agent}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"request_id\": 1,\n \"action\": \"approve\",\n \"admin_note\": \"Extension granted due to weather.\"\n}" }, "url": { "raw": "{{baseUrl}}/api/v1/contracts/execution/stages/extension-request/review", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "contracts", "execution", "stages", "extension-request", "review" ] } } }, { "name": "Remind Customer about Stage", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_authorized_agent}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"stage_id\": 1\n}" }, "url": { "raw": "{{baseUrl}}/api/v1/contracts/execution/stages/remind", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "contracts", "execution", "stages", "remind" ] } } } ] } ] }, { "name": "Site Engineer (field execution)", "description": "Endpoints for JWT role **site_engineer** on assigned contracts/stages. Set `jwt_site_engineer` after login. Field work: progress uploads, mark complete for client review, deadline extension requests. Does **not** include contract generation, milestone payment review, or execution **remind** (company).", "item": [ { "name": "Login (site_engineer — save token to jwt_site_engineer)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/auth/login", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "auth", "login" ] }, "body": { "mode": "raw", "raw": "{\"email\":\"engineer@company.com\",\"password\":\"YOUR_PASSWORD\"}" }, "description": "User must have `roles.code` = site_engineer. Copy `data.token` into `jwt_site_engineer`." } }, { "name": "Get execution board (stages + progress)", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_site_engineer}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/contracts/execution?contract_id=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "contracts", "execution" ], "query": [ { "key": "contract_id", "value": "10" } ] } } }, { "name": "Get execution stage details", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_site_engineer}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/contracts/execution/stages/details?stage_id=1", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "contracts", "execution", "stages", "details" ], "query": [ { "key": "stage_id", "value": "1" } ] } } }, { "name": "Submit stage update for client review (multipart)", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_site_engineer}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/contracts/execution/stages/update", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "contracts", "execution", "stages", "update" ] }, "body": { "mode": "formdata", "formdata": [ { "key": "stage_id", "value": "1", "type": "text" }, { "key": "execution_notes", "value": "Progress notes for client.", "type": "text" }, { "key": "stage_notes", "value": "Visible stage notes.", "type": "text" }, { "key": "files[]", "type": "file", "src": [] } ] } } }, { "name": "Save stage progress (multipart)", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_site_engineer}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/contracts/execution/stages/save", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "contracts", "execution", "stages", "save" ] }, "body": { "mode": "formdata", "formdata": [ { "key": "stage_id", "value": "1", "type": "text" }, { "key": "stage_notes", "value": "Work completed this week.", "type": "text" }, { "key": "delay_type", "value": "", "type": "text" }, { "key": "delay_days", "value": "0", "type": "text" }, { "key": "media[]", "type": "file", "src": [] } ] } } }, { "name": "Mark stage complete (send to customer for approval)", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_site_engineer}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/contracts/execution/stages/mark-complete", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "contracts", "execution", "stages", "mark-complete" ] }, "body": { "mode": "raw", "raw": "{\"stage_id\": 1, \"stage_notes\": \"Ready for client review\"}" } } }, { "name": "Request deadline extension (multipart)", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_site_engineer}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/contracts/execution/stages/extension-request", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "contracts", "execution", "stages", "extension-request" ] }, "body": { "mode": "formdata", "formdata": [ { "key": "contract_id", "value": "10", "type": "text" }, { "key": "stage_id", "value": "1", "type": "text" }, { "key": "current_deadline", "value": "2024-11-15", "type": "text" }, { "key": "proposed_deadline", "value": "2024-11-28", "type": "text" }, { "key": "reason_code", "value": "client_instruction_change", "type": "text" }, { "key": "explanation", "value": "Client requested scope change; supplier lead time extended.", "type": "text" }, { "key": "files[]", "type": "file", "src": [] } ] } } }, { "name": "List extension requests for contract", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_site_engineer}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/contracts/execution/stages/extension-requests?contract_id=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "contracts", "execution", "stages", "extension-requests" ], "query": [ { "key": "contract_id", "value": "10" } ] } } }, { "name": "Update Engineer Location", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_site_engineer}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"latitude\": 24.4539,\n \"longitude\": 54.3773\n}" }, "url": { "raw": "{{baseUrl}}/api/v1/contracts/execution/location", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "contracts", "execution", "location" ] } } } ] }, { "name": "12 Admin - Migrations", "item": [ { "name": "Get Migrations Status (admin)", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/admin/migrations/status", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "admin", "migrations", "status" ] } } }, { "name": "Run Pending Migrations (admin)", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/admin/migrations/run", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "admin", "migrations", "run" ] }, "body": { "mode": "raw", "raw": "{\"dry_run\": false}" } } } ] }, { "name": "12b Admin - Contracts", "item": [ { "name": "List Contracts (admin)", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v2/admin/contracts?limit=20&offset=0", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "admin", "contracts" ], "query": [ { "key": "limit", "value": "20" }, { "key": "offset", "value": "0" }, { "key": "search", "value": "", "disabled": true }, { "key": "status", "value": "", "disabled": true }, { "key": "company_id", "value": "", "disabled": true } ] }, "description": "Retrieve all contracts across the platform. Admin only. Supports filtering by status, company_id, and search (contract_no, project_name, company name, customer name)." } }, { "name": "Get Contract Details (admin)", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v2/admin/contracts/details?id=1", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "admin", "contracts", "details" ], "query": [ { "key": "id", "value": "1" } ] }, "description": "Get full contract details including items, milestones, execution stages and financial summary. Admin only." } }, { "name": "Get Revision Requests (admin)", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v2/admin/contracts/revision-requests?contract_id=1", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "admin", "contracts", "revision-requests" ], "query": [ { "key": "contract_id", "value": "1" } ] }, "description": "Get all customer-submitted revision requests for a contract. Returns reason, details JSON, and created_at. Admin only." } } ] }, { "name": "13 Admin - Requests", "item": [ { "name": "List Requests (admin)", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/admin/requests?limit=50&offset=0", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "admin", "requests" ], "query": [ { "key": "limit", "value": "50" }, { "key": "offset", "value": "0" }, { "key": "search", "value": "", "disabled": true }, { "key": "status", "value": "pending", "disabled": true } ] }, "description": "Retrieve platform-wide requests with location data (latitude, longitude, area, emirate). Requires admin role." } }, { "name": "Request Details (admin)", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/admin/requests/details?id=1", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "admin", "requests", "details" ], "query": [ { "key": "id", "value": "1" } ] }, "description": "Retrieve full details of a specific request, including customer info, attachments, specifications, and map coordinates. Requires admin role." } } ] }, { "name": "08 Company Profile", "item": [ { "name": "Get Profile", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/profile", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "profile" ] } } }, { "name": "Get Team Dashboard", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/team-dashboard", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "team-dashboard" ] } } }, { "name": "List Staff for Agent Assignment", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/staff/for-agent-assignment?search=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "staff", "for-agent-assignment" ], "query": [ { "key": "search", "value": "" } ] } } }, { "name": "List Company Staff", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/staff?page=1&per_page=10&search=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "staff" ], "query": [ { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" }, { "key": "search", "value": "" } ] } } }, { "name": "Create Company Staff (owner only)", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/staff", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "staff" ] }, "body": { "mode": "raw", "raw": "{\"full_name\": \"Jane Doe\", \"email\": \"jane@example.com\", \"official_title\": \"Coordinator\", \"phone_country_code\": \"+971\", \"phone_number\": \"501234567\", \"permissions\": {\"quotation.create\": true, \"quotation.edit\": true, \"requests.respond\": false, \"execution.manage\": true, \"payments.evidence\": false}}" } }, "item": [ { "name": "Update Delay Status", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{company_token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"delay_id\": 1,\n \"status\": \"acknowledged\"\n}" }, "url": { "raw": "{{base_url}}/api/v1/contracts/execution/delays/update-status", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "contracts", "execution", "delays", "update-status" ] }, "description": "Updates the status of an execution delay. Valid statuses: `under_review`, `acknowledged`, `resolved`." } } ] }, { "name": "Backfill users for staff without user_id (owner only)", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/staff/backfill-users", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "staff", "backfill-users" ] }, "body": { "mode": "raw", "raw": "{}" }, "description": "For each company_staff with user_id NULL: links to users by matching email if found; otherwise creates users + user_roles (company). Sets company_staff.user_id and syncs site_engineers.user_id when linked." } }, { "name": "Backfill agents from signatory staff (owner only)", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/team/backfill-agents", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "team", "backfill-agents" ] }, "body": { "mode": "raw", "raw": "{}" }, "description": "Creates missing company_authorized_agents rows for company_staff.role_label='signatory' (active/pending)." } }, { "name": "Backfill engineers from engineer staff (owner only)", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/team/backfill-engineers", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "team", "backfill-engineers" ] }, "body": { "mode": "raw", "raw": "{}" }, "description": "Creates missing site_engineers rows for company_staff.role_label='engineer' (active/pending), linking user_id from company_staff." } }, { "name": "Update Staff App Access", "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/staff", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "staff" ] }, "body": { "mode": "raw", "raw": "{\"id\": 1, \"app_access_enabled\": true}" } } }, { "name": "Get Company Staff Details", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/staff/details?id=1", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "staff", "details" ], "query": [ { "key": "id", "value": "1" } ] } } }, { "name": "Update Staff Profile (owner only)", "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/staff/profile", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "staff", "profile" ] }, "body": { "mode": "raw", "raw": "{\"id\": 1, \"full_name\": \"Jane Doe\", \"email\": \"jane@example.com\", \"official_title\": \"Coordinator\", \"phone_country_code\": \"+971\", \"phone_number\": \"501234567\"}" } } }, { "name": "Update Staff Permissions (owner only)", "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/staff/permissions", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "staff", "permissions" ] }, "body": { "mode": "raw", "raw": "{\"id\": 1, \"permissions\": {\"quotation.create\": true, \"quotation.edit\": false, \"requests.respond\": false, \"execution.manage\": true, \"payments.evidence\": false}}" } } }, { "name": "Disable Staff (owner only)", "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/staff/disable", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "staff", "disable" ] }, "body": { "mode": "raw", "raw": "{\"id\": 1}" } } }, { "name": "Enable Staff (owner only)", "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/staff/enable", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "staff", "enable" ] }, "body": { "mode": "raw", "raw": "{\"id\": 1}" } } }, { "name": "List Authorized Agents", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/authorized-agents?page=1&per_page=10&search=&verification_status=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "authorized-agents" ], "query": [ { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" }, { "key": "search", "value": "" }, { "key": "verification_status", "value": "" } ] } } }, { "name": "Create Authorized Agent (owner only, external)", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/authorized-agents", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "authorized-agents" ] }, "body": { "mode": "raw", "raw": "{\"full_name\": \"Jane Agent\", \"email\": \"jane@example.com\", \"phone_country_code\": \"+971\", \"phone_number\": \"501234567\", \"company_position\": \"Legal Counsel\", \"uae_pass_linked\": false, \"corporate_binding_ack\": true, \"permissions\": {\"can_view_contract\": true, \"can_message\": true, \"can_upload_progress\": false, \"can_add_notes\": false, \"can_approve_milestones\": false, \"can_acknowledge_delivery\": true}}" }, "description": "External agent: omit company_staff_id. Requires full_name, email, phone_number, company_position." } }, { "name": "Get Authorized Agent Details", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/authorized-agents/details?id=1", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "authorized-agents", "details" ], "query": [ { "key": "id", "value": "1" } ] } } }, { "name": "Update Authorized Agent Profile (owner only)", "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/authorized-agents/profile", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "authorized-agents", "profile" ] }, "body": { "mode": "raw", "raw": "{\"id\": 1, \"full_name\": \"Jane Agent\", \"email\": \"jane@example.com\", \"phone_country_code\": \"+971\", \"phone_number\": \"501234567\", \"company_position\": \"Legal Counsel\", \"authority_level\": \"Tier 1 Signatory\", \"max_contract_value\": 0, \"permissions\": {\"can_view_contract\": true, \"can_message\": true, \"can_upload_progress\": false, \"can_add_notes\": false, \"can_approve_milestones\": false, \"can_acknowledge_delivery\": true}}" } } }, { "name": "List Site Engineers", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/site-engineers?page=1&per_page=10&search=&system_role=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "site-engineers" ], "query": [ { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" }, { "key": "search", "value": "" }, { "key": "system_role", "value": "" } ] }, "description": "system_role: empty | admin | staff | engineer. site_load counts execution_stages.assigned_site_engineer_id." } }, { "name": "Get Site Engineer Details (by company_staff_id)", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/site-engineers/details?company_staff_id=1", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "site-engineers", "details" ], "query": [ { "key": "company_staff_id", "value": "1" } ] } } }, { "name": "Update Site Engineer Profile (owner only)", "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/site-engineers/profile", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "site-engineers", "profile" ] }, "body": { "mode": "raw", "raw": "{\"company_staff_id\": 1, \"full_name\": \"Engineer Name\", \"email\": \"engineer@example.com\", \"official_title\": \"Site Engineer\", \"phone_country_code\": \"+971\", \"phone_number\": \"501234567\", \"system_role\": \"engineer\"}" } } }, { "name": "Create Site Engineer (owner only)", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/site-engineers", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "site-engineers" ] }, "body": { "mode": "raw", "raw": "{\"full_name\": \"Ahmed Engineer\", \"email\": \"ahmed.site@example.com\", \"phone_country_code\": \"+971\", \"phone_number\": \"501112233\", \"official_title\": \"Site Supervisor\", \"system_role\": \"engineer\"}" }, "description": "Creates users + user_roles, company_staff (engineer, pending), site_engineers (active). system_role: admin | staff | engineer (default engineer)." } }, { "name": "Update Authorized Agent Status (owner only)", "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/authorized-agents/status", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "authorized-agents", "status" ] }, "body": { "mode": "raw", "raw": "{\"id\": 1, \"status\": \"inactive\"}" } } }, { "name": "Get My Company Permissions", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/me/permissions", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "me", "permissions" ] }, "description": "Returns permissions map for the logged-in company user. Staff with role_label staff are gated per company_staff_permissions; owners have all true. 403 on gated actions use data.error=staff_permission_denied and data.permission_code." } }, { "name": "Update Profile", "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/profile", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "profile" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Inspired Tech\",\n \"description\": \"development softwares\",\n \"phone_number\": \"12481661854\",\n \"company_email\": \"info@inspired.test\",\n \"website\": \"test@test.com\",\n \"business_type_id\": 2,\n \"country_id\": 1,\n \"emirate_id\": 1,\n \"full_address\": \"ttttet, Abu Dhabi\",\n \"coverage_areas\": [\"Abu Dhabi\", \"Ajman\", \"Al Ain\"],\n \"business_hours\": [\n {\"weekday\": 1, \"opens_at\": \"08:00\", \"closes_at\": \"17:00\", \"is_closed\": 0},\n {\"weekday\": 2, \"opens_at\": \"08:00\", \"closes_at\": \"17:00\", \"is_closed\": 0}\n ],\n \"trade_license_number\": \"CN-1234567\",\n \"trade_license_expiry_date\": \"2025-12-31\",\n \"tax_registration_number\": \"100234567800003\",\n \"legal_representative_name\": \"John Doe\",\n \"registered_address\": \"Abu Dhabi, UAE\"\n}" } } }, { "name": "Update Legal Info", "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/profile/legal", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "profile", "legal" ] }, "body": { "mode": "raw", "raw": "{\"trade_license_number\":\"CN-12345\",\"trade_license_expiry_date\":\"2025-12-31\",\"tax_registration_number\":\"100000000000000\",\"legal_representative_name\":\"John Doe\",\"registered_address\":\"Abu Dhabi, UAE\"}" } } }, { "name": "Upload Logo", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/profile/upload_logo", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "profile", "upload_logo" ] }, "body": { "mode": "formdata", "formdata": [ { "key": "logo", "type": "file", "src": "" } ] } } }, { "name": "Upload Document", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/profile/upload_document", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "profile", "upload_document" ] }, "body": { "mode": "formdata", "formdata": [ { "key": "document[]", "type": "file", "src": "" }, { "key": "document_type", "type": "text", "value": "verification" }, { "key": "description", "type": "text", "value": "Trade license / VAT / company verification document" } ] } } } ] }, { "name": "09 Catalog & Services", "item": [ { "name": "Get Product Categories", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/categories?type=product", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "categories" ], "query": [ { "key": "type", "value": "product" } ] } } }, { "name": "Get Service Categories", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/categories?type=service", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "categories" ], "query": [ { "key": "type", "value": "service" } ] } } }, { "name": "Get Company Subcategories", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/catalog/custom-categories?parent_id=1", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "catalog", "custom-categories" ], "query": [ { "key": "parent_id", "value": "1" } ] }, "description": "Returns company-specific subcategories for a given parent global category." } }, { "name": "Add Company Subcategory", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/catalog/custom-categories", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "catalog", "custom-categories" ] }, "body": { "mode": "raw", "raw": "{\n \"parent_category_id\": 1,\n \"name\": \"New Subcategory\"\n}" } } }, { "name": "Update Company Subcategory", "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/catalog/custom-categories?id=1", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "catalog", "custom-categories" ], "query": [ { "key": "id", "value": "1" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Updated Subcategory Name\"\n}" } } }, { "name": "Delete Company Subcategory", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/catalog/custom-categories?id=1", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "catalog", "custom-categories" ], "query": [ { "key": "id", "value": "1" } ] } } }, { "name": "Get Products", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/catalog", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "catalog" ] } } }, { "name": "Add Product", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/catalog", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "catalog" ] }, "body": { "mode": "raw", "raw": "{\n \"category_id\": 1,\n \"company_category_id\": null,\n \"name_en\": \"Cement Bag\",\n \"name_ar\": \"كيس إسمنت\",\n \"description\": \"\",\n \"image_url\": null,\n \"unit\": \"Piece\",\n \"sku\": \"CEM-001\",\n \"unit_price\": 100.0,\n \"stock_quantity\": 10,\n \"stock_status\": \"in_stock\",\n \"visibility_status\": \"active\"\n}" } } }, { "name": "Get Product Details", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/catalog/details?id={{product_id}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "catalog", "details" ], "query": [ { "key": "id", "value": "{{product_id}}" } ] } } }, { "name": "Update Product", "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/catalog?id={{product_id}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "catalog" ], "query": [ { "key": "id", "value": "{{product_id}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"category_id\": 1,\n \"company_category_id\": null,\n \"name_en\": \"Cement Bag (Updated)\",\n \"name_ar\": \"كيس إسمنت (تحديث)\",\n \"description\": \"\",\n \"image_url\": null,\n \"unit\": \"Piece\",\n \"sku\": \"CEM-001\",\n \"unit_price\": 120.0,\n \"stock_quantity\": 8,\n \"stock_status\": \"in_stock\",\n \"visibility_status\": \"active\"\n}" } } }, { "name": "Delete Product", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/catalog?id={{product_id}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "catalog" ], "query": [ { "key": "id", "value": "{{product_id}}" } ] } } }, { "name": "Upload Product Image", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/catalog/upload", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "catalog", "upload" ] }, "body": { "mode": "formdata", "formdata": [ { "key": "image", "type": "file", "src": "" } ] } } }, { "name": "Get Services", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/services", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "services" ] } } }, { "name": "Add Service", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/services", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "services" ] }, "body": { "mode": "raw", "raw": "{\n \"category_id\": 2,\n \"company_category_id\": null,\n \"name_en\": \"Maintenance Visit\",\n \"name_ar\": \"زيارة صيانة\",\n \"description\": \"\",\n \"image_url\": null,\n \"media\": [],\n \"unit\": \"Session\",\n \"sku\": \"SRV-001\",\n \"base_price\": 500.0,\n \"pricing_model\": \"fixed\",\n \"skill_level\": null,\n \"execution_mode\": \"instant\",\n \"visibility_status\": \"active\",\n \"public_portal\": 0,\n \"specifications\": [],\n \"estimated_duration_value\": null,\n \"estimated_duration_unit\": null,\n \"crew_size\": null\n}" } } }, { "name": "Get Service Details", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/services/details?id={{service_id}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "services", "details" ], "query": [ { "key": "id", "value": "{{service_id}}" } ] } } }, { "name": "Update Service", "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/services?id={{service_id}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "services" ], "query": [ { "key": "id", "value": "{{service_id}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"category_id\": 2,\n \"company_category_id\": null,\n \"name_en\": \"Maintenance Visit (Updated)\",\n \"name_ar\": \"زيارة صيانة (تحديث)\",\n \"description\": \"\",\n \"image_url\": null,\n \"media\": [],\n \"unit\": \"Session\",\n \"sku\": \"SRV-001\",\n \"base_price\": 600.0,\n \"pricing_model\": \"fixed\",\n \"skill_level\": null,\n \"execution_mode\": \"instant\",\n \"visibility_status\": \"active\",\n \"public_portal\": 0,\n \"specifications\": [],\n \"estimated_duration_value\": null,\n \"estimated_duration_unit\": null,\n \"crew_size\": null\n}" } } }, { "name": "Delete Service", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/services?id={{service_id}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "services" ], "query": [ { "key": "id", "value": "{{service_id}}" } ] } } }, { "name": "Upload Service Media", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/services/upload", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "services", "upload" ] }, "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "src": "" } ] } } } ] }, { "name": "10 Settings & Notifications", "item": [ { "name": "Get Notification Settings", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/notifications/settings", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "notifications", "settings" ] } } }, { "name": "Update Notification Settings", "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/notifications/settings", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "notifications", "settings" ] }, "body": { "mode": "raw", "raw": "{\"receive_notifications\": true}" } } }, { "name": "Get General Settings", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/settings", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "settings" ] } } }, { "name": "Update General Settings", "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/settings", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "settings" ] }, "body": { "mode": "raw", "raw": "{\"preferred_language\": \"en\", \"timezone\": \"Asia/Dubai\"}" } } }, { "name": "Request Deactivation", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/deactivate-request", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "deactivate-request" ] }, "body": { "mode": "raw", "raw": "{\"reason\": \"Closing business\", \"notes\": \"Please archive all my data.\"}" } } }, { "name": "Deactivation Account Status", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/deactivation-status", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "deactivation-status" ] } } } ] }, { "name": "03 Requests", "item": [ { "name": "Get All Requests", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/requests?limit=50&offset=0&search=&type=&status=&date_range=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "requests" ], "query": [ { "key": "limit", "value": "50" }, { "key": "offset", "value": "0" }, { "key": "search", "value": "" }, { "key": "type", "value": "" }, { "key": "status", "value": "" }, { "key": "date_range", "value": "" } ] }, "description": "Retrieves all requests accessible to the logged-in company. Includes 'company_local_status' representing the company's specific interaction state." } }, { "name": "Get Requests (Paginated - Company Alias)", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/requests?limit=50&offset=0&search=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "requests" ], "query": [ { "key": "limit", "value": "50" }, { "key": "offset", "value": "0" }, { "key": "search", "value": "" } ] } } }, { "name": "Get Request Details", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/requests/1", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "requests", "1" ] } } }, { "name": "Get Request Count", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/requests/count", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "requests", "count" ] } } }, { "name": "Get Request Thread ID (Firestore)", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/requests/{{request_id}}/thread", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "requests", "{{request_id}}", "thread" ] }, "description": "Retrieve the conversation ID and Firestore thread ID for a specific request. This endpoint handles auto-creation of the conversation if it doesn't exist yet (for direct requests)." } }, { "name": "Update Request Status", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/requests/update-status", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "requests", "update-status" ] }, "body": { "mode": "raw", "raw": "{\n \"request_id\": 1,\n \"status\": \"rejected\",\n \"reason\": \"Outside service scope\",\n \"message\": \"Sorry, we don't cover this area.\"\n}" }, "description": "Updates the local status of a request for the logged-in company. \nAvailable statuses: 'viewed' (Under Review), 'accepted', 'rejected'.\n'reason' and 'message' are optional and primarily used for 'rejected' status." } }, { "name": "Get Chat History", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/chat/history?request_id=1", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "chat", "history" ], "query": [ { "key": "request_id", "value": "1" } ] } } }, { "name": "Send Chat Message", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/chat/send", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "chat", "send" ] }, "body": { "mode": "raw", "raw": "{\"request_id\": 1, \"message\": \"Hello, can you clarify the scope?\"}" } } } ] }, { "name": "04 Quotations", "item": [ { "name": "Get Company Quotations", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/quotations", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "quotations" ] } } }, { "name": "List Company Quotations (Filtered + Counts)", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/quotations/list?tab=all&status=&q=&limit=50&offset=0", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "quotations", "list" ], "query": [ { "key": "tab", "value": "all" }, { "key": "status", "value": "" }, { "key": "q", "value": "" }, { "key": "limit", "value": "50" }, { "key": "offset", "value": "0" } ] } } }, { "name": "List Pending Quotations", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/quotations/list?tab=pending&limit=50&offset=0", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "quotations", "list" ], "query": [ { "key": "tab", "value": "pending" }, { "key": "limit", "value": "50" }, { "key": "offset", "value": "0" } ] } } }, { "name": "List Accepted Quotations", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/quotations/list?tab=accepted&limit=50&offset=0", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "quotations", "list" ], "query": [ { "key": "tab", "value": "accepted" }, { "key": "limit", "value": "50" }, { "key": "offset", "value": "0" } ] } } }, { "name": "List Expired Quotations", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/quotations/list?tab=expired&limit=50&offset=0", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "quotations", "list" ], "query": [ { "key": "tab", "value": "expired" }, { "key": "limit", "value": "50" }, { "key": "offset", "value": "0" } ] } } }, { "name": "Get Company Quotation(s) By Request", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/quotations/request?request_id={{request_id}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "quotations", "request" ], "query": [ { "key": "request_id", "value": "{{request_id}}" } ] } } }, { "name": "Get Quotation Details", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/quotations/details?id=1", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "quotations", "details" ], "query": [ { "key": "id", "value": "1" } ] } } }, { "name": "Upload Attachment", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/quotations/upload", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "quotations", "upload" ] }, "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "src": "" } ] } } }, { "name": "Create Quotation", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/quotations", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "quotations" ] }, "body": { "mode": "raw", "raw": "{\n \"request_id\": {{request_id}},\n \"revision_id\": null,\n \"pricing_type\": \"unit_basis\",\n\n \"scope_description\": \"Scope of work...\",\n \"technical_specifications\": \"\",\n \"subtotal\": 1000.0,\n \"vat_percent\": 5.0,\n \"vat_amount\": 50.0,\n \"total_amount\": 1050.0,\n\n \"duration_value\": 30,\n \"duration_unit\": \"days\",\n \"validity_days\": 30,\n \"payment_terms\": \"full_completion\",\n \"payment_terms_details\": \"\",\n\n \"warranty_included\": false,\n \"warranty_value\": \"\",\n \"warranty_unit\": \"months\",\n\n \"special_conditions\": \"\",\n \"attachments\": [],\n \"items\": [\n {\n \"title\": \"Item 1\",\n \"pricing_type\": \"standard\",\n \"rate\": 1000.0,\n \"quantity\": 1,\n \"waste_allowance\": 0,\n \"line_total\": 1000.0,\n \"sub_items\": []\n }\n ]\n}\n" } } } ] }, { "name": "07 Execution Control", "item": [ { "name": "List Execution Stages + Context (company / customer / site_engineer / admin)", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/contracts/execution?contract_id=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "contracts", "execution" ], "query": [ { "key": "contract_id", "value": "10" } ] }, "description": "Returns can_manage_stages and assigned_contract_site_engineer (owner only) from contracts.site_engineer_id. No auto-seeding of default stages." } }, { "name": "Get Execution Stage Details", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/contracts/execution/stages/details?stage_id=1", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "contracts", "execution", "stages", "details" ], "query": [ { "key": "stage_id", "value": "1" } ] }, "description": "Company, customer, site_engineer, or admin. Customer response omits internal execution_notes and delay list." } }, { "name": "Create Execution Stage (company owner or admin)", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/contracts/execution/stages", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "contracts", "execution", "stages" ] }, "body": { "mode": "raw", "raw": "{\"contract_id\":10,\"title\":\"Foundation work\",\"description\":\"\",\"sequence_no\":0,\"assigned_site_engineer_id\":null}" } } }, { "name": "Update Execution Stage (company owner or admin)", "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/contracts/execution/stages", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "contracts", "execution", "stages" ] }, "body": { "mode": "raw", "raw": "{\"stage_id\":1,\"title\":\"Foundation work (updated)\",\"description\":\"\",\"assigned_site_engineer_id\":null}" } } }, { "name": "Delete Execution Stage (owner/admin; no updates yet)", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/contracts/execution/stages?stage_id=1", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "contracts", "execution", "stages" ], "query": [ { "key": "stage_id", "value": "1" } ] } } }, { "name": "Reorder Execution Stages (company owner or admin)", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/contracts/execution/stages/reorder", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "contracts", "execution", "stages", "reorder" ] }, "body": { "mode": "raw", "raw": "{\"contract_id\":10,\"stage_ids\":[2,1,3]}" } } }, { "name": "Request stage deadline extension (multipart; mobile)", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/contracts/execution/stages/extension-request", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "contracts", "execution", "stages", "extension-request" ] }, "body": { "mode": "formdata", "formdata": [ { "key": "contract_id", "value": "10", "type": "text" }, { "key": "stage_id", "value": "2", "type": "text" }, { "key": "current_deadline", "value": "2024-11-15", "type": "text" }, { "key": "proposed_deadline", "value": "2024-11-28", "type": "text" }, { "key": "reason_code", "value": "client_instruction_change", "type": "text", "description": "material_delay | client_instruction_change | force_majeure" }, { "key": "explanation", "value": "Client requested hardware upgrade; supplier lead time 10 business days.", "type": "text" }, { "key": "files[]", "type": "file", "src": [] } ] }, "description": "Maps to mobile **Request Extension** (execution stage). Requires migration `20260430_120000_execution_stage_extension_requests.sql`. Notifies customer. `reason_code` enum as shown." } }, { "name": "List extension requests for contract", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/contracts/execution/stages/extension-requests?contract_id=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "contracts", "execution", "stages", "extension-requests" ], "query": [ { "key": "contract_id", "value": "10" } ] }, "description": "Company, customer, site_engineer, or admin with contract access. Each row includes `attachments` when present." } }, { "name": "Customer review extension (approve / reject)", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/contracts/execution/stages/extension-request/review", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "contracts", "execution", "stages", "extension-request", "review" ] }, "body": { "mode": "raw", "raw": "{\"request_id\": 1, \"action\": \"approve\", \"customer_note\": \"Approved with note.\"}" }, "description": "Customer or admin. Body: `request_id`, `action` approve|reject, optional `customer_note`. On approve, inserts `execution_delays` with extension days. Use customer JWT from login." } }, { "name": "Submit Stage Update (multipart; company / site_engineer / admin)", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/contracts/execution/stages/update", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "contracts", "execution", "stages", "update" ] }, "body": { "mode": "formdata", "formdata": [ { "key": "stage_id", "value": "1", "type": "text" }, { "key": "execution_notes", "value": "Materials delivered and verified on-site.", "type": "text" }, { "key": "stage_notes", "value": "Pending client acknowledgement.", "type": "text" }, { "key": "files[]", "type": "file", "src": [] } ] } } }, { "name": "Save Stage Progress (multipart; company / site_engineer / admin)", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/contracts/execution/stages/save", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "contracts", "execution", "stages", "save" ] }, "body": { "mode": "formdata", "formdata": [ { "key": "stage_id", "value": "1", "type": "text" }, { "key": "stage_notes", "value": "Progress notes for the stage.", "type": "text" }, { "key": "internal_notes", "value": "Internal notes (not visible to client).", "type": "text" }, { "key": "client_notified", "value": "1", "type": "text" }, { "key": "delay_type", "value": "material_delay", "type": "text" }, { "key": "delay_days", "value": "2", "type": "text" }, { "key": "delay_note", "value": "Supplier delivery delay.", "type": "text" }, { "key": "media[]", "type": "file", "src": [] } ] } } }, { "name": "Mark Stage Complete / Submit for review", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/contracts/execution/stages/mark-complete", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "contracts", "execution", "stages", "mark-complete" ] }, "body": { "mode": "raw", "raw": "{\"stage_id\":1,\"stage_notes\":\"Ready for customer review\"}" }, "description": "Admin: sets stage completed immediately. Company/site_engineer: submits for customer review (same as submit update without files)." } }, { "name": "Review Stage (customer or admin JWT only)", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/contracts/execution/stages/review", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "contracts", "execution", "stages", "review" ] }, "body": { "mode": "raw", "raw": "{\"stage_id\":1,\"review_status\":\"approved\",\"review_note\":\"Approved.\"}" }, "description": "Stage must be awaiting_approval. review_note required when review_status is rejected." } }, { "name": "Send Stage Reminder", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/contracts/execution/stages/remind", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "contracts", "execution", "stages", "remind" ] }, "body": { "mode": "raw", "raw": "{\"stage_id\":1}" } } } ] }, { "name": "05 Contracts", "item": [ { "name": "Get Company Contracts", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/contracts?limit=50&offset=0&status=&q=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "contracts" ], "query": [ { "key": "limit", "value": "50" }, { "key": "offset", "value": "0" }, { "key": "status", "value": "" }, { "key": "q", "value": "" } ] } } }, { "name": "Init Contract", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/contracts/init?quotation_id=1", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "contracts", "init" ], "query": [ { "key": "quotation_id", "value": "1" } ] }, "description": "Loads accepted quotation data needed to generate a contract. Response includes `price_breakdown_type`: `unit_basis` (standard/measured items) or `lump_sum` (pricing_type=lump_sum)." } }, { "name": "Upload Contract Document", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/contracts/upload", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "contracts", "upload" ] }, "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "src": "" } ] }, "description": "Uploads a contract-related document (multipart/form-data). Use returned `path` in the contract `attachments` array when saving the draft." } }, { "name": "Get Contract Roles", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/contracts/roles?contract_id=1", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "contracts", "roles" ], "query": [ { "key": "contract_id", "value": "1" } ] }, "description": "Used by `contract_roles.php` to load contract info, company team list, and resolved assigned site engineer profile (if any)." } }, { "name": "Save Contract Roles", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/contracts/roles?contract_id=1", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "contracts", "roles" ], "query": [ { "key": "contract_id", "value": "1" } ] }, "body": { "mode": "raw", "raw": "{\"signing_representative_id\": 1, \"site_engineer_id\": 2, \"engineer_notifications_enabled\": true}" }, "description": "Assigns the signing representative (authorized agent) and optional site engineer to a contract, and sets `engineer_notifications_enabled`. `site_engineer_id` can be null." } }, { "name": "Get Contract Review Data", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/contracts/review?contract_id=1", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "contracts", "review" ], "query": [ { "key": "contract_id", "value": "1" } ] }, "description": "Full contract payload for review/details UIs. Includes embedded `timeline`. When status is `termination_pending`, `terminated`, or `cancelled`, timeline includes a `type: \"termination\"` event (see **Termination settlement** folder for dedicated termination APIs)." } }, { "name": "Get Contract Details Data (contract_details.php)", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/contracts/details?contract_id=1", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "contracts", "details" ], "query": [ { "key": "contract_id", "value": "1" } ] }, "description": "Loads the Details tab payload for `contract_details.php` (scope, financials, pricing breakdown, execution, penalties, warranty)." } }, { "name": "Get Contract Timeline (contract_details.php)", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/contracts/timeline?contract_id=1", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "contracts", "timeline" ], "query": [ { "key": "contract_id", "value": "1" } ] }, "description": "Returns `{ \"timeline\": [ ... ] }` for the Timeline tab in `contract_details.php`. Same event shape as embedded `timeline` on **Get Contract Review Data**. Appends a termination row when the contract is `termination_pending`, `terminated`, or `cancelled` (`type: \"termination\"`, `termination_kind`, `status`). Uses `terminated_at` and `updated_at` from `contracts`." } }, { "name": "Get Contract Messages (contract_details.php)", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/contracts/messages?contract_id=1", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "contracts", "messages" ], "query": [ { "key": "contract_id", "value": "1" } ] }, "description": "Loads messages for the contract by resolving contract -> request_id (same data as /chat/history but keyed by contract_id)." } }, { "name": "Termination settlement", "description": "Company: approve termination scenario (`termination_pending`), load reconciliation, finalize settlement (`terminated`). Routes: `/api/v2/company/contracts/termination/*`.", "item": [ { "name": "Get termination settlement", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v2/company/contracts/termination/settlement?contract_id=1", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "contracts", "termination", "settlement" ], "query": [ { "key": "contract_id", "value": "1" } ] }, "description": "Financial snapshot and `scenarios` (`work_based`, `refund_required`, `outstanding_payment`) for `contract_termination_settlement.php`." } }, { "name": "Approve termination settlement", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/company/contracts/termination/approve", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "contracts", "termination", "approve" ] }, "body": { "mode": "raw", "raw": "{\n \"contract_id\": 1,\n \"system_scenario\": \"work_based\",\n \"adjustment_amount\": null,\n \"adjustment_reason\": null,\n \"reason\": \"Termination settlement approved by company.\"\n}" }, "description": "`system_scenario` must be one of: `work_based`, `refund_required`, `outstanding_payment`. Sets contract to `termination_pending`; use reconciliation then **Confirm settlement**." } }, { "name": "Reject pending termination request", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/company/contracts/termination/reject", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "contracts", "termination", "reject" ] }, "body": { "mode": "raw", "raw": "{\n \"contract_id\": 1\n}" }, "description": "Rejects client `pending` termination request. If contract was `termination_pending`, reverts status to `active`." } }, { "name": "Get termination reconciliation", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v2/company/contracts/termination/reconciliation?contract_id=1", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "contracts", "termination", "reconciliation" ], "query": [ { "key": "contract_id", "value": "1" } ] }, "description": "Payload for `contract_settlement_reconciliation.php` while contract is `termination_pending` (approved settlement snapshot vs recalculated amounts)." } }, { "name": "Confirm settlement (finalize termination)", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/company/contracts/termination/confirm-settlement", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "contracts", "termination", "confirm-settlement" ] }, "body": { "mode": "raw", "raw": "{\n \"contract_id\": 1\n}" }, "description": "Requires contract `termination_pending` and an approved termination record. Sets contract to `terminated` and `terminated_at`." } } ] }, { "name": "Get Contract Edit Data", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/contracts/edit?contract_id=1&is_revision=true", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "contracts", "edit" ], "query": [ { "key": "contract_id", "value": "1" }, { "key": "is_revision", "value": "true" } ] } } }, { "name": "Send Contract", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/contracts/send?contract_id=1", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "contracts", "send" ], "query": [ { "key": "contract_id", "value": "1" } ] } } }, { "name": "Sign Contract (Company)", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/contracts/sign?contract_id=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "contracts", "sign" ], "query": [ { "key": "contract_id", "value": "10" } ] } } }, { "name": "Start Revision", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/contracts/start-revision?contract_id=1", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "contracts", "start-revision" ], "query": [ { "key": "contract_id", "value": "1" } ] } } }, { "name": "Cancel Revision", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/contracts/cancel-revision?contract_id=1", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "contracts", "cancel-revision" ], "query": [ { "key": "contract_id", "value": "1" } ] } } }, { "name": "Generate Contract (Full Completion)", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/contracts", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "contracts" ] }, "body": { "mode": "raw", "raw": "{\n \"quotation_id\": 1,\n \"contract_id\": null,\n \"action\": \"save_draft\",\n \"project_name\": \"Project Name\",\n\n \"scope_description\": \"Included scope...\",\n \"technical_specifications\": \"\",\n \"excluded_scope\": \"\",\n \"attachments\": [],\n\n \"subtotal\": 1000.0,\n \"vat_percent\": 5,\n \"vat_amount\": 50.0,\n \"grand_total\": 1050.0,\n\n \"payment_terms\": \"full_completion\",\n \"payment_terms_type\": \"full_completion\",\n \"milestones\": [\n { \"title\": \"Full Payment\", \"percentage\": 100, \"amount\": 1050.0, \"trigger_label\": \"Upon Project Handover\" }\n ],\n\n \"items\": [\n {\n \"title\": \"Item 1\",\n \"pricing_type\": \"standard\",\n \"rate\": 1000.0,\n \"quantity\": 1,\n \"waste_allowance\": 0,\n \"line_total\": 1000.0,\n \"sub_items\": []\n }\n ],\n\n \"execution_duration_value\": 30,\n \"execution_duration_unit\": \"days\",\n \"start_execution_trigger\": \"after_contract_signing\",\n \"specific_start_date\": \"\",\n\n \"delay_penalty_enabled\": false,\n \"delay_penalty_type\": \"percentage_per_day\",\n \"delay_penalty_value\": \"\",\n \"grace_period_days\": \"\",\n \"max_penalty_cap_percent\": \"\",\n\n \"warranty_included\": true,\n \"warranty_value\": 12,\n \"warranty_unit\": \"months\",\n\n \"is_revision\": false\n}" } } }, { "name": "Sign Contract (UAE PASS)", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/contracts/sign?contract_id=1", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "contracts", "sign" ], "query": [ { "key": "contract_id", "value": "1" } ] } } } ] }, { "name": "06 Payments (Company Milestones)", "item": [ { "name": "Portal: contract_details.php?id=10&tab=milestones (API)", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/contracts/milestones?contract_id=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "contracts", "milestones" ], "query": [ { "key": "contract_id", "value": "10", "description": "Same as `id` in contract_details.php?id=10&tab=milestones" } ] }, "description": "**Company portal:** `views/company/contract_details.php?id=10&tab=milestones`\n\nWhen the **Payment milestones** tab is selected, `loadPaymentMilestones()` calls `GET /api/v1/company/contracts/milestones?contract_id={id}` (see `resources/js/api.js` → `getContractMilestones`).\n\nRelated actions from that tab: `POST .../milestones/request-payment`, `POST .../milestones/send-reminder`, `POST .../milestones/review`." } }, { "name": "Portal: payment_details.php?contract_id=10&milestone_id=7 (API)", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/contracts/milestones/details?milestone_id=7", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "contracts", "milestones", "details" ], "query": [ { "key": "milestone_id", "value": "7", "description": "`contract_milestones.id` from the milestones list response; matches `milestone_id` in payment_details.php" } ] }, "description": "**Company portal:** `views/company/payment_details.php?contract_id=10&milestone_id=7`\n\nOn load, the page calls `GET /api/v1/company/contracts/milestones/details?milestone_id={milestone_id}` via `getMilestonePaymentDetails` (`milestone_id` only). Query param `contract_id` on the PHP page is for navigation/back-link to `contract_details.php?id=10&tab=milestones`.\n\nApprove/reject from this page: `POST .../milestones/review` with `submission_id`, `action`, optional `note` / `rejection_reason`." } }, { "name": "List Contract Milestones", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/contracts/milestones?contract_id=1", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "contracts", "milestones" ], "query": [ { "key": "contract_id", "value": "1" } ] }, "description": "Same endpoint used by **contract_details.php** when `tab=milestones` (`getContractMilestones`). Use `contract_id` equal to the contract `id` query parameter on that page." } }, { "name": "Get Milestone Payment Details", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/contracts/milestones/details?milestone_id=1", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "contracts", "milestones", "details" ], "query": [ { "key": "milestone_id", "value": "1" } ] }, "description": "Same endpoint used by **payment_details.php** (`getMilestonePaymentDetails`). `milestone_id` matches the page query param; `contract_id` on the PHP URL is not sent to this GET." } }, { "name": "Request Milestone Payment", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/contracts/milestones/request-payment", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "contracts", "milestones", "request-payment" ] }, "body": { "mode": "raw", "raw": "{\"milestone_id\":1}" } } }, { "name": "Send Milestone Reminder", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/contracts/milestones/send-reminder", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "contracts", "milestones", "send-reminder" ] }, "body": { "mode": "raw", "raw": "{\"milestone_id\":1}" } } }, { "name": "Review Milestone Submission", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/contracts/milestones/review", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "contracts", "milestones", "review" ] }, "body": { "mode": "raw", "raw": "{\"submission_id\":1,\"action\":\"approve\",\"note\":\"OK\"}" }, "description": "use approve or reject action" } } ] }, { "name": "02 Dashboard", "item": [ { "name": "Get Dashboard Stats", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/dashboard/stats", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "dashboard", "stats" ] }, "description": "Used by `views/company/dashboard.php` to load KPI + funnel + execution + payments overview stats." } }, { "name": "Get Dashboard Widgets (Requests/Contracts/Activity)", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/dashboard/widgets", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "dashboard", "widgets" ] }, "description": "Used by `views/company/dashboard.php` to load Active Contracts, Recent Requests, Requests Requiring Response, and System Activity in one call." } } ] }, { "name": "Activities", "item": [ { "name": "Get Activity Feed (activity.php)", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/dashboard/activity?limit=10&before=&types=request,quote,contract,payment,status,team&statuses=&date_from=&date_to=&q=&module_name=&action_code=&actor_user_id=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "dashboard", "activity" ], "query": [ { "key": "limit", "value": "10" }, { "key": "before", "value": "" }, { "key": "types", "value": "request,quote,contract,payment,status,team" }, { "key": "statuses", "value": "" }, { "key": "date_from", "value": "" }, { "key": "date_to", "value": "" }, { "key": "q", "value": "" }, { "key": "module_name", "value": "" }, { "key": "action_code", "value": "" }, { "key": "actor_user_id", "value": "" } ] }, "description": "Matches `views/company/activity.php` feed. Pagination: use `before` cursor (created_at). Filters: `types` csv, `statuses` csv, `date_from`, `date_to`, `q`, `module_name`, `action_code`, `actor_user_id`." } } ] }, { "name": "03 Customer Mobile App", "item": [ { "name": "Dashboard", "item": [ { "name": "Get Customer Dashboard", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/customer/dashboard", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customer", "dashboard" ] }, "description": "Returns a comprehensive dashboard for the mobile app including sliders, featured uploads, categories, and partners." } } ] }, { "name": "Browse", "item": [ { "name": "Browse Companies", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/customer/companies?search=construction&emirate_id=1&area_id=5&offering_type=services&verified_only=1", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customer", "companies" ], "query": [ { "key": "search", "value": "construction", "description": "Search by name, industry or description" }, { "key": "emirate_id", "value": "1", "description": "Filter by Emirate ID (Dubai=1, Abu Dhabi=2, etc.)" }, { "key": "area_id", "value": "5", "description": "Filter by Area ID (conditional based on Emirate)" }, { "key": "offering_type", "value": "services", "description": "Filter by offering (products, services)" }, { "key": "verified_only", "value": "1", "description": "Show only verified suppliers" } ] }, "description": "Browse companies with advanced filtering. Returns basic company info, product/service counts, and top 3 categories (tags) for card display." } }, { "name": "Company Details", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/customer/companies/details?id=1", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customer", "companies", "details" ], "query": [ { "key": "id", "value": "1" } ] }, "description": "Returns full company profile including industry, location, description, badges, and categorized product/service counts for the profile screen." } }, { "name": "Browse Services", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/customer/browse/services?company_id=1&category_id=5&search=repair", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customer", "browse", "services" ], "query": [ { "key": "company_id", "value": "1", "description": "Required for company-specific catalog view" }, { "key": "category_id", "value": "5", "description": "Optional category filter" }, { "key": "search", "value": "repair", "description": "Keyword search" } ] }, "description": "Browse all services or a specific company's service catalog." } }, { "name": "Browse Products", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/customer/browse/products?company_id=1&category_id=10&search=pipe", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customer", "browse", "products" ], "query": [ { "key": "company_id", "value": "1", "description": "Required for company-specific catalog view" }, { "key": "category_id", "value": "10", "description": "Optional category filter" }, { "key": "search", "value": "pipe", "description": "Keyword search" } ] }, "description": "Browse all products or a specific company's product catalog." } }, { "name": "Browse Categories", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/customer/browse/categories?company_id=1&type=service", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customer", "browse", "categories" ], "query": [ { "key": "company_id", "value": "1", "description": "Optional: Only return categories that have items for this company" }, { "key": "type", "value": "service", "description": "Optional: product or service" } ] }, "description": "Returns categories. If company_id is provided, only returns categories that are relevant to that company's catalog." } }, { "name": "Browse All (Catalog)", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/customer/browse/all?company_id=1&search=valve", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customer", "browse", "all" ], "query": [ { "key": "company_id", "value": "1", "description": "Optional: Filter by company" }, { "key": "category_id", "value": "5", "description": "Optional: Filter by category" }, { "key": "search", "value": "valve", "description": "Optional: Keyword search" } ] }, "description": "Returns both products and services in a single response. Useful for unified search results." } }, { "name": "Product Details", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/customer/browse/products/details?id=1", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customer", "browse", "products", "details" ], "query": [ { "key": "id", "value": "1" } ] }, "description": "Fetches full details for a product including its media gallery and technical specifications." } }, { "name": "Service Details", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/customer/browse/services/details?id=1", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customer", "browse", "services", "details" ], "query": [ { "key": "id", "value": "1" } ] }, "description": "Fetches full details for a service including its media gallery and characteristics." } } ] }, { "name": "Profile & Addresses", "item": [ { "name": "Get Locations", "request": { "method": "GET", "url": { "raw": "{{baseUrl}}/api/v1/customer/locations", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customer", "locations" ] }, "description": "Get all Emirates and their nested Areas" } }, { "name": "Get Profile", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/customer/profile", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customer", "profile" ] } } }, { "name": "Update Profile", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/customer/profile", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customer", "profile" ] }, "body": { "mode": "raw", "raw": "{\n \"full_name\": \"Updated Customer\",\n \"email\": \"customer@example.com\",\n \"phone_country_code\": \"+971\",\n \"phone_number\": \"501234567\",\n \"default_language_id\": 2,\n \"default_emirate_id\": 1\n}" } } }, { "name": "Get Addresses", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/customer/addresses", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customer", "addresses" ] } } }, { "name": "Add Address", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/customer/addresses", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customer", "addresses" ] }, "body": { "mode": "raw", "raw": "{\"label\":\"Home\",\"emirate_id\":1,\"full_address\":\"Building 5, Street 10, Al Nahda\",\"is_default\":1}" } } }, { "name": "Update Address", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/customer/addresses?id=1", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customer", "addresses" ], "query": [ { "key": "id", "value": "1" } ] }, "body": { "mode": "raw", "raw": "{\"label\":\"Office\",\"full_address\":\"Tower B, Floor 12\"}" } } }, { "name": "Delete Address", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/customer/addresses?id=1", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customer", "addresses" ], "query": [ { "key": "id", "value": "1" } ] } } }, { "name": "Get Settings", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/customer/settings", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customer", "settings" ] } } }, { "name": "Update Settings", "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/customer/settings", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customer", "settings" ] }, "body": { "mode": "raw", "raw": "{\n \"receive_notifications\": 1\n}" } } }, { "name": "Change Password", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/customer/profile/password", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customer", "profile", "password" ] }, "body": { "mode": "raw", "raw": "{\n \"current_password\": \"OldP@ssw0rd\",\n \"new_password\": \"NewP@ssw0rd!\"\n}" } } }, { "name": "Legal & Documents", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/customer/legal", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customer", "legal" ] } } }, { "name": "Verify Identity", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"provider\": \"uaepass\",\n \"status\": \"verified\"\n}" }, "url": { "raw": "{{baseUrl}}/api/v1/customer/legal", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customer", "legal" ] } } } ] }, { "name": "Requests", "item": [ { "name": "List My Requests", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/customer/requests", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customer", "requests" ] } } }, { "name": "Request Details", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/customer/requests/details?id=1", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customer", "requests", "details" ], "query": [ { "key": "id", "value": "1" } ] } } }, { "name": "Create Request (General Inquiry)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/customer/requests", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customer", "requests" ] }, "body": { "mode": "raw", "raw": "{\n \"title\": \"Need AC Installation\",\n \"request_type\": \"inquiry\",\n \"description\": \"Looking for AC installation service for 3 units\",\n \"budget\": 5000,\n \"emirate_id\": 1\n}" } } }, { "name": "Create Request with Attachments (Multipart)", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/customer/requests", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customer", "requests" ] }, "body": { "mode": "formdata", "formdata": [ { "key": "title", "value": "AC Installation for New Office", "type": "text" }, { "key": "request_type", "value": "direct_request", "type": "text", "description": "inquiry | direct_request | broadcast_request" }, { "key": "description", "value": "Need 5 split AC units installed. See attached floor plan.", "type": "text" }, { "key": "company_id", "value": "1", "type": "text" }, { "key": "category_id", "value": "1", "type": "text" }, { "key": "budget", "value": "5000", "type": "text" }, { "key": "budget_flexible", "value": "1", "type": "text" }, { "key": "urgency_level_id", "value": "2", "type": "text", "description": "1=Low, 2=Medium, 3=High" }, { "key": "emirate_id", "value": "1", "type": "text" }, { "key": "attachments[]", "type": "file", "src": [], "description": "Supports: jpg, png, webp, pdf, doc, docx, xls, xlsx. Max 10MB each." } ] }, "description": "Creates a new customer request with file attachments via multipart/form-data. Files saved to uploads/requests/{id}/ and recorded in request_attachments table." } }, { "name": "Update Draft Request", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/customer/requests?id=1", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customer", "requests" ], "query": [ { "key": "id", "value": "1" } ] }, "body": { "mode": "raw", "raw": "{\"title\":\"Updated Title\",\"budget\":6000,\"submit\":true}" } } }, { "name": "Cancel Request", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/customer/requests?id=1", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customer", "requests" ], "query": [ { "key": "id", "value": "1" } ] } } } ] }, { "name": "Quotations", "item": [ { "name": "List My Quotations", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/customer/quotations", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customer", "quotations" ] } } }, { "name": "Quotation Details", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/customer/quotations/details?id=1", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customer", "quotations", "details" ], "query": [ { "key": "id", "value": "1" } ] } } }, { "name": "Get Quotations by Request ID", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/customer/quotations/request?request_id=1", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customer", "quotations", "request" ], "query": [ { "key": "request_id", "value": "1" } ] }, "description": "Retrieves all quotations received for a specific request ID." } }, { "name": "Accept Quotation", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/customer/quotations/respond", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customer", "quotations", "respond" ] }, "body": { "mode": "raw", "raw": "{\"quotation_id\": 1, \"action\": \"accept\", \"notes\": \"Great offer, we accept.\"}" }, "description": "Accepts a quotation. This will: 1) Set this quotation to 'accepted', 2) Reject all other quotations for the same request, 3) Close the request so no new quotations can be sent. Use quotation_id or quotation_no to identify." } }, { "name": "Reject Quotation", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/customer/quotations/respond", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customer", "quotations", "respond" ] }, "body": { "mode": "raw", "raw": "{\"quotation_id\":1,\"action\":\"reject\",\"notes\":\"Price too high\"}" } } } ] }, { "name": "Authorized Agents", "item": [ { "name": "List Agents", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/customer/agents", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customer", "agents" ] } } }, { "name": "Agent Details", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/customer/agents/details?id=1", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customer", "agents", "details" ], "query": [ { "key": "id", "value": "1" } ] } } }, { "name": "Assign Agent to Contract", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/customer/contracts/assign_agent", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customer", "contracts", "assign_agent" ] }, "body": { "mode": "raw", "raw": "{\n \"contract_id\": 1,\n \"agent\": {\n \"full_name\": \"Maryam Mohamed\",\n \"email\": \"maryam@gmail.com\",\n \"phone_country_code\": \"+971\",\n \"phone_number\": \"1234567890\",\n \"company_position\": \"Project Manager\"\n },\n \"permissions\": {\n \"can_view_contract\": true,\n \"can_message\": true,\n \"can_upload_progress\": false,\n \"can_add_notes\": true,\n \"can_approve_milestones\": false,\n \"can_acknowledge_delivery\": true\n }\n}" } } }, { "name": "Create Agent", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/customer/agents", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customer", "agents" ] }, "body": { "mode": "raw", "raw": "{\n \"full_name\": \"Ahmed Kamal\",\n \"email\": \"ahmed@gmail.com\",\n \"phone_country_code\": \"+971\",\n \"phone_number\": \"555123456\",\n \"company_position\": \"Supervisor\"\n}" } } }, { "name": "Edit Agent", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/customer/agents?id=1", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customer", "agents" ], "query": [ { "key": "id", "value": "1" } ] }, "body": { "mode": "raw", "raw": "{\n \"full_name\": \"Ahmed Kamal Updated\",\n \"company_position\": \"Senior Supervisor\"\n}" } } }, { "name": "Update Agent Permissions", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/customer/contracts/agent_permissions", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customer", "contracts", "agent_permissions" ] }, "body": { "mode": "raw", "raw": "{\n \"contract_id\": 1,\n \"agent_id\": 1,\n \"permissions\": {\n \"can_view_contract\": true,\n \"can_message\": true,\n \"can_upload_progress\": true,\n \"can_add_notes\": false,\n \"can_approve_milestones\": false,\n \"can_acknowledge_delivery\": true\n }\n}" } } }, { "name": "Remove Agent", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/customer/agents?id=1", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customer", "agents" ], "query": [ { "key": "id", "value": "1" } ] } } } ] }, { "name": "Contracts", "item": [ { "name": "List My Contracts", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/customer/contracts", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customer", "contracts" ] } } }, { "name": "Contract Details", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/customer/contracts/details?id=1", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customer", "contracts", "details" ], "query": [ { "key": "id", "value": "1" } ] } }, "response": [ { "name": "Success Example (Matches Mobile Design)", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/customer/contracts/details?id=1", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customer", "contracts", "details" ], "query": [ { "key": "id", "value": "1" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"success\",\n \"message\": \"Contract details retrieved successfully\",\n \"data\": {\n \"id\": 1,\n \"contract_no\": \"CT-89732\",\n \"request_id\": 10,\n \"quotation_id\": 5,\n \"customer_id\": 2,\n \"company_id\": 3,\n \"current_version_no\": 1,\n \"status\": \"draft\",\n \"status_description\": \"This contract is in draft state and not yet active.\",\n \"project_name\": \"Custom Steel Beams for Warehouse Expansion\",\n \"total_amount\": \"245000.00\",\n \"expected_completion_date\": \"2026-03-30\",\n \"company_name\": \"Acme Corporation\",\n \"company_logo\": \"uploads/logos/acme.png\",\n \"company_industry\": \"HVAC maintenance\",\n \"is_verified_supplier\": 1,\n \"is_iso_certified\": 1,\n \"urgency_label\": \"Medium\",\n \"emirate_name\": \"Dubai\",\n \"country_name\": \"United Arab Emirates\",\n \"financials\": {\n \"total_amount\": 245000,\n \"paid_amount\": 0,\n \"remaining_amount\": 245000,\n \"payment_progress_percentage\": 0\n },\n \"current_version\": {\n \"id\": 1,\n \"version_no\": 1,\n \"items\": [\n { \"item_title\": \"Materials\", \"line_total\": \"145000.00\" },\n { \"item_title\": \"Fabrications\", \"line_total\": \"75000.00\" },\n { \"item_title\": \"Delivery & Installation\", \"line_total\": \"25000.00\" }\n ]\n },\n \"milestones\": [],\n \"attachments\": [\n { \"original_name\": \"SignedContractAgreement.pdf\", \"file_size\": 2306867, \"file_path\": \"uploads/contracts/SignedContractAgreement.pdf\" },\n { \"original_name\": \"ApprovedQuotation.doc\", \"file_size\": 2306867, \"file_path\": \"uploads/quotations/ApprovedQuotation.doc\" }\n ],\n \"pending_revision\": {\n \"id\": 1042,\n \"revision_details\": {\n \"change_types\": [\"pricing\", \"scope_of_work\", \"other\"],\n \"other_type_detail\": \"Custom delivery requirement\",\n \"details\": \"Requested changes to delivery timeline and payment schedule.\"\n },\n \"created_at\": \"2026-05-05 17:00:00\"\n },\n \"timeline\": []\n }\n}" } ] }, { "name": "Request Contract Revision", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/customer/contracts/request_revision", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customer", "contracts", "request_revision" ] }, "body": { "mode": "raw", "raw": "{\n \"contract_id\": 1,\n \"change_types\": [\"pricing\", \"scope_of_work\", \"other\"],\n \"other_type_detail\": \"Custom delivery requirement\",\n \"change_details\": \"I would like to adjust the pricing for materials and add a specific delivery time.\"\n}" } } }, { "name": "Accept Contract (Review Phase)", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/customer/contracts/accept", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customer", "contracts", "accept" ] }, "body": { "mode": "raw", "raw": "{\"contract_id\":1}" } } }, { "name": "Sign Contract", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}", "type": "text" } ], "body": { "mode": "formdata", "formdata": [ { "key": "contract_id", "value": "1", "type": "text" }, { "key": "signature_image", "type": "file", "src": [], "description": "The touch signature image file (png/jpg). If provided, provider is set to 'manual'." } ] }, "url": { "raw": "{{baseUrl}}/api/v1/customer/contracts/sign", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customer", "contracts", "sign" ] }, "description": "Signs the contract. Supports both digital (default) and manual (image upload) signatures. If 'signature_image' is uploaded, the system saves it and marks the signature as 'manual'." } }, { "name": "List Contracts", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/customer/contracts?limit=50&offset=0&status=&search=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customer", "contracts" ], "query": [ { "key": "limit", "value": "50" }, { "key": "offset", "value": "0" }, { "key": "status", "value": "" }, { "key": "search", "value": "" } ] } } }, { "name": "Get Contract Timeline", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/customer/contracts/timeline?id=1", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customer", "contracts", "timeline" ], "query": [ { "key": "id", "value": "1" } ] }, "description": "Returns a unified chronological timeline of the contract's lifecycle. Merges negotiation history (creation, revisions, signatures) with real-time execution stages (mobilization, progress, completion)." } }, { "name": "Termination", "item": [ { "name": "Init Termination (Financial Impact)", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{customer_token}}", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v2/customer/contracts/termination/init?contract_id=10", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "customer", "contracts", "termination", "init" ], "query": [ { "key": "contract_id", "value": "10" } ] } } }, { "name": "Submit Termination Request", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{customer_token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"contract_id\": 10,\n \"reason_category\": \"Work progress is delayed\",\n \"reason\": \"Quality concerns and delays in milestone 2.\"\n}" }, "url": { "raw": "{{base_url}}/api/v2/customer/contracts/termination/submit", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "customer", "contracts", "termination", "submit" ] } } }, { "name": "Get Termination Status", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{customer_token}}", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v2/customer/contracts/termination/status?contract_id=10", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "customer", "contracts", "termination", "status" ], "query": [ { "key": "contract_id", "value": "10" } ] } } }, { "name": "Respond to Settlement", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{customer_token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"contract_id\": 10,\n \"action\": \"dispute\",\n \"dispute_reason\": \"The proposed refund amount is too low based on the work progress.\"\n}" }, "url": { "raw": "{{base_url}}/api/v2/customer/contracts/termination/respond", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "customer", "contracts", "termination", "respond" ] }, "description": "Allows the customer to Accept or Dispute a settlement proposal from the company.\n\nPayload:\n- `contract_id`: The ID of the contract.\n- `action`: 'accept' to finalize termination, or 'dispute' to request administrative review.\n- `dispute_reason`: Required if action is 'dispute'. Briefly explains why the customer rejects the proposal." } }, { "name": "Withdraw Termination Request", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{customer_token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"contract_id\": 10\n}" }, "url": { "raw": "{{base_url}}/api/v2/customer/contracts/termination/withdraw", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "customer", "contracts", "termination", "withdraw" ] } } } ] }, { "name": "Milestones", "item": [ { "name": "List Milestones", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{customer_token}}", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/customer/contracts/milestones?contract_id=10", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "customer", "contracts", "milestones" ], "query": [ { "key": "contract_id", "value": "10" } ] }, "description": "Returns a timeline of payment milestones for a specific contract.\n\nStatus Definitions:\n- `locked`: Future milestone. Not yet actionable.\n- `requested`: Action required! The company has requested payment.\n- `pending_approval`: Proof submitted. Waiting for company verification.\n- `verified`: Payment confirmed by the company.\n- `rejected`: Proof rejected. Please re-submit with correct documents.\n- `paid`: Final state. Payment successfully processed." } }, { "name": "Get Milestone Details", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{customer_token}}", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/customer/contracts/milestones/details?milestone_id=1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "customer", "contracts", "milestones", "details" ], "query": [ { "key": "milestone_id", "value": "1" } ] }, "description": "Returns detailed information about a specific milestone, including current submission status and attachments." } }, { "name": "Submit Payment Proof", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{customer_token}}", "type": "text" } ], "body": { "mode": "formdata", "formdata": [ { "key": "milestone_id", "value": "1", "type": "text" }, { "key": "proof_documents", "type": "file", "src": [] } ] }, "url": { "raw": "{{base_url}}/api/v1/customer/contracts/milestones/submit_proof", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "customer", "contracts", "milestones", "submit_proof" ] }, "description": "Allows uploading documents as proof of payment for a milestone. Status will move to pending_approval." } } ] }, { "name": "Execution", "item": [ { "name": "List Execution Stages", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{customer_token}}", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/customer/contracts/execution?contract_id=10", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "customer", "contracts", "execution" ], "query": [ { "key": "contract_id", "value": "10" } ] }, "description": "Returns a timeline of execution stages for a specific contract. Use `is_locked` to determine if a stage can be interacted with." } }, { "name": "Get Stage Documentation", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{customer_token}}", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/customer/contracts/execution/details?stage_id=1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "customer", "contracts", "execution", "details" ], "query": [ { "key": "stage_id", "value": "1" } ] }, "description": "Returns detailed information about a specific execution stage, including key dates, execution media (attachments), and stage notes (including delays)." } }, { "name": "Submit Stage Review", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{customer_token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"stage_id\": 1,\n \"action\": \"reject\",\n \"reason\": \"Surface finishing is inconsistent on section C.\"\n}" }, "url": { "raw": "{{base_url}}/api/v1/customer/contracts/execution/review", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "customer", "contracts", "execution", "review" ] }, "description": "Allows the customer to approve or reject a stage that is awaiting review. `action` must be \"approve\" or \"reject\". If \"reject\", `reason` is required." } } ] } ] }, { "name": "Messaging", "item": [ { "name": "List Conversations", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/customer/conversations", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customer", "conversations" ] } } }, { "name": "Conversation Details", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/customer/conversations/details?id=1", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customer", "conversations", "details" ], "query": [ { "key": "id", "value": "1" } ] } } }, { "name": "Send Message", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/customer/messages", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customer", "messages" ] }, "body": { "mode": "raw", "raw": "{\"conversation_id\":1, \"body\":\"Hello, any update on my request?\"}" } } }, { "name": "Start Conversation", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/customer/conversations/start", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customer", "conversations", "start" ] }, "body": { "mode": "raw", "raw": "{\"type\":\"request\", \"request_id\":1, \"company_id\":1}" } } } ] }, { "name": "Notifications", "item": [ { "name": "List My Notifications", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/customer/notifications", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customer", "notifications" ] } } }, { "name": "Mark Single Notification as Read", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/customer/notifications/read", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customer", "notifications", "read" ] }, "body": { "mode": "raw", "raw": "{\"id\": 1}" } } }, { "name": "Get Customer Activity", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/customer/activity?types=requests,quotes,contracts,payments&statuses=pending,approved,completed&date_from=2024-01-01&date_to=2024-12-31&q=metal", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customer", "activity" ], "query": [ { "key": "types", "value": "requests,quotes,contracts,payments", "description": "Filter by type (requests, quotes, contracts, payments, status_updates)" }, { "key": "statuses", "value": "pending,approved,completed", "description": "Filter by status (pending, approved, completed, expired, rejected)" }, { "key": "date_from", "value": "2024-01-01", "description": "YYYY-MM-DD" }, { "key": "date_to", "value": "2024-12-31", "description": "YYYY-MM-DD" }, { "key": "q", "value": "metal", "description": "Free-text search" }, { "key": "limit", "value": "20" } ] }, "description": "Returns the customer's activity feed. Supports filtering as shown in the mobile activity screen." } } ] }, { "name": "Help & Support", "item": [ { "name": "Get Support Info", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}", "description": "Works for both customers and companies (use jwt_token or jwt_authorized_agent)" } ], "url": { "raw": "{{baseUrl}}/api/v1/customer/support/info", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customer", "support", "info" ] } } }, { "name": "Get FAQs", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}", "description": "Works for both customers and companies" } ], "url": { "raw": "{{baseUrl}}/api/v1/customer/faqs", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customer", "faqs" ] } } }, { "name": "List Help Requests", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}", "description": "Retrieves help requests for the authenticated user (filters by customer_id or company_id automatically)" } ], "url": { "raw": "{{baseUrl}}/api/v1/customer/help", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customer", "help" ] } } }, { "name": "Submit Help Request", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}", "description": "Works for both customers and companies. Identifies sender by role and ID automatically." } ], "url": { "raw": "{{baseUrl}}/api/v1/customer/help", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customer", "help" ] }, "body": { "mode": "formdata", "formdata": [ { "key": "category", "value": "Requests", "type": "text", "description": "High-level topic for routing (e.g., 'Billing', 'Technical', 'General'). Use 'Get Help Categories' for valid labels." }, { "key": "subject", "value": "Issue with my request", "type": "text" }, { "key": "description", "value": "I am unable to see the quotations.", "type": "text" }, { "key": "related_type", "value": "request", "type": "text", "description": "Direct link to a system object. Allowed: 'contract', 'request', 'payment', 'account', 'other'." }, { "key": "related_id", "value": "1", "type": "text", "description": "Primary ID of the object specified in related_type (e.g., contracts.id if related_type='contract')." }, { "key": "attachments[]", "type": "file", "src": [] } ] }, "description": "Submits a new help ticket. Use `related_type` and `related_id` for precise object linking. \n\nRelated Types:\n- **contract**: Issues with specific contracts.\n- **request**: Issues with inquiries or requests.\n- **payment**: Billing or milestone payment issues.\n- **account**: Profile, login, or general account issues.\n- **other**: Miscellaneous topics." } }, { "name": "Get Help Categories", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/customer/help/categories", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customer", "help", "categories" ] } } } ] }, { "name": "Inquiries", "item": [ { "name": "Customer: List Inquiries", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/customer/inqueries", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customer", "inqueries" ] } } }, { "name": "Customer: Get Inquiry Messages", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/customer/inqueries/messages?id=1", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customer", "inqueries", "messages" ], "query": [ { "key": "id", "value": "1" } ] } } }, { "name": "Customer: Start Inquiry", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/customer/inqueries/start", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customer", "inqueries", "start" ] }, "body": { "mode": "raw", "raw": "{\n \"company_id\": 1,\n \"service_id\": 1,\n \"product_id\": null\n}" } } }, { "name": "Customer: Send Message", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/customer/inqueries/send", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customer", "inqueries", "send" ] }, "body": { "mode": "raw", "raw": "{\n \"conversation_id\": 1,\n \"body\": \"Hello from Customer Mobile App!\"\n}" } } } ] }, { "name": "Milestones", "item": [ { "name": "List Milestones", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/customer/contracts/milestones?contract_id=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customer", "contracts", "milestones" ], "query": [ { "key": "contract_id", "value": "10" } ] } } }, { "name": "Get Milestone Details", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/customer/contracts/milestones/details?milestone_id=1", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customer", "contracts", "milestones", "details" ], "query": [ { "key": "milestone_id", "value": "1" } ] } } }, { "name": "Submit Payment Proof (Multipart)", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "body": { "mode": "formdata", "formdata": [ { "key": "milestone_id", "value": "1", "type": "text" }, { "key": "amount", "value": "5000", "type": "text" }, { "key": "documents[]", "type": "file", "src": [] } ] }, "url": { "raw": "{{baseUrl}}/api/v1/customer/contracts/milestones/submit_proof", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customer", "contracts", "milestones", "submit_proof" ] } } } ] } ] }, { "name": "12 Real-time (WebSockets)", "item": [ { "name": "Connect to LinkProx Real-time", "request": { "method": "GET", "header": [], "url": { "raw": "ws://localhost:8080", "protocol": "ws", "host": [ "localhost" ], "port": "8080" }, "description": "Establish a WebSocket connection to the real-time server. Once connected, send an 'auth' message." } }, { "name": "Sample: Auth Message", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"type\": \"auth\",\n \"token\": \"{{jwt_token}}\"\n}" }, "description": "Send this JSON as a message immediately after connecting to verify your session." } } ] }, { "name": "Company Inquiries", "description": "Endpoints for direct chat (inquiries) for the company portal.", "item": [ { "name": "Company: List Inquiries", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/inqueries", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "inqueries" ] } } }, { "name": "Company: Get Inquiry Messages", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/inqueries/messages?id=1", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "inqueries", "messages" ], "query": [ { "key": "id", "value": "1" } ] } } }, { "name": "Company: Send Message", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/inqueries/send", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "inqueries", "send" ] }, "body": { "mode": "raw", "raw": "{\n \"conversation_id\": 1,\n \"body\": \"Hello from Company!\"\n}" } } } ] }, { "name": "Admin - Subscription Plans", "item": [ { "name": "Get All Plans", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/admin/plans", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "admin", "plans" ] }, "description": "Returns all subscription plans with their active subscriber count. Requires admin role." } }, { "name": "Get Plan Details", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/admin/plans/details?id=1", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "admin", "plans", "details" ], "query": [ { "key": "id", "value": "1", "description": "Plan ID" } ] }, "description": "Returns the full details of a single subscription plan." } }, { "name": "Get Plan Subscribers", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/admin/plans/subscribers?id=1", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "admin", "plans", "subscribers" ], "query": [ { "key": "id", "value": "1", "description": "Plan ID" } ] }, "description": "Returns all companies subscribed to a given plan, including their subscription status, start/expiry dates, and the admin who assigned it." } }, { "name": "Create Plan", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/admin/plans", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "admin", "plans" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Professional\",\n \"price\": 299.00,\n \"validity_days\": 365,\n \"contract_availability_days\": null,\n \"description\": \"Best value for growing companies.\",\n \"is_active\": 1,\n \"sort_order\": 0\n}" }, "description": "Creates a new subscription plan. Set `contract_availability_days` to `null` for unlimited, or a number to restrict contract access." } }, { "name": "Update Plan", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/admin/plans/update", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "admin", "plans", "update" ] }, "body": { "mode": "raw", "raw": "{\n \"id\": 1,\n \"name\": \"Professional Updated\",\n \"price\": 349.00,\n \"validity_days\": 365,\n \"contract_availability_days\": 180,\n \"description\": \"Updated description.\",\n \"is_active\": 1,\n \"sort_order\": 1\n}" }, "description": "Updates an existing subscription plan by ID." } }, { "name": "Toggle Plan Status", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/admin/plans/toggle", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "admin", "plans", "toggle" ] }, "body": { "mode": "raw", "raw": "{\n \"id\": 1,\n \"is_active\": 0\n}" }, "description": "Activates or deactivates a plan. Set `is_active` to 1 to activate, 0 to deactivate." } }, { "name": "Delete Plan", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/admin/plans/delete", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "admin", "plans", "delete" ] }, "body": { "mode": "raw", "raw": "{\n \"id\": 1\n}" }, "description": "Deletes a plan. Will return 409 error if the plan has active subscribers." } }, { "name": "Assign Plan to Company", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/admin/subscriptions/assign", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "admin", "subscriptions", "assign" ] }, "body": { "mode": "raw", "raw": "{\n \"company_id\": 1,\n \"plan_id\": 1,\n \"notes\": \"Assigned by admin during onboarding.\"\n}" }, "description": "Manually assigns a subscription plan to a company. Cancels any existing active subscription first." } }, { "name": "Get Company Subscription", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/admin/subscriptions/company?company_id=1", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "admin", "subscriptions", "company" ], "query": [ { "key": "company_id", "value": "1", "description": "Company ID" } ] }, "description": "Returns the most recent active subscription for a given company." } } ] }, { "name": "Company - Subscription", "item": [ { "name": "Get Available Plans", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_authorized_agent}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/subscription/plans", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "subscription", "plans" ] }, "description": "Returns all active subscription plans available for a company to subscribe to. Requires company role." } }, { "name": "Get Current Subscription", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_authorized_agent}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/subscription/current", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "subscription", "current" ] }, "description": "Returns the company's current active subscription, including plan name, start date, expiry date, and contract availability days. Auto-expires overdue subscriptions. Returns null if no active subscription." } }, { "name": "Subscribe to Plan", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_authorized_agent}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/company/subscription/subscribe", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "company", "subscription", "subscribe" ] }, "body": { "mode": "raw", "raw": "{\n \"plan_id\": 1\n}" }, "description": "Subscribes the company to a plan. Any existing active subscription is cancelled first. Returns the new subscription's start and expiry dates." } } ] }, { "name": "Firebase & Notifications", "item": [ { "name": "Send to User (Test)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"title\": \"Direct Message\",\n \"body\": \"This is a test notification for a specific user\",\n \"user_id\": 4,\n \"data\": {\n \"type\": \"test\",\n \"click_action\": \"FLUTTER_NOTIFICATION_CLICK\"\n }\n}" }, "url": { "raw": "{{baseUrl}}/api/v1/test/send-notification", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "test", "send-notification" ] }, "description": "Send a push notification to a specific user using their LinkProx User ID." } }, { "name": "Send to Topic (Test)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"title\": \"Broadast Message\",\n \"body\": \"This is a test notification for a topic group\",\n \"topic\": \"all_users\",\n \"data\": {\n \"type\": \"test\",\n \"click_action\": \"FLUTTER_NOTIFICATION_CLICK\"\n }\n}" }, "url": { "raw": "{{baseUrl}}/api/v1/test/send-notification", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "test", "send-notification" ] }, "description": "Send a push notification to a topic group (e.g., `all_users`, `category_5`, `company_1`)." } }, { "name": "Get Firebase Auth Token", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/messaging/token", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "messaging", "token" ] }, "description": "Retrieve a Firebase Custom Token to sign in to Firestore on the mobile app." } } ] }, { "name": "Customer Mobile Application", "item": [ { "name": "Browse", "item": [ { "name": "Get Companies", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/customer/browse/companies?search=meta&emirate_id=1", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customer", "browse", "companies" ], "query": [ { "key": "search", "value": "meta" }, { "key": "emirate_id", "value": "1" } ] } } }, { "name": "Get Services", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/customer/browse/services", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customer", "browse", "services" ] } } }, { "name": "Get Products", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/customer/browse/products", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customer", "browse", "products" ] } } }, { "name": "Get All (Catalog)", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/customer/browse/all", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customer", "browse", "all" ] } } }, { "name": "Get Global Categories", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/customer/browse/categories", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customer", "browse", "categories" ] } } }, { "name": "Get Company Categories", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/customer/browse/company-categories?company_id=1", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customer", "browse", "company-categories" ], "query": [ { "key": "company_id", "value": "1" } ] } } } ] } ] }, { "name": "14 Messaging (Firestore Hybrid)", "item": [ { "name": "Get Conversations", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/messaging/conversations", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "messaging", "conversations" ] }, "description": "Retrieve list of conversations for the current user (Customer or Company)." } }, { "name": "Get Firestore Thread Metadata", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/messaging/thread?id=1", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "messaging", "thread" ], "query": [ { "key": "id", "value": "1" } ] }, "description": "Retrieve Firestore thread ID and permissions for a specific conversation ID." } }, { "name": "Get Firebase Token", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v1/messaging/token", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "messaging", "token" ] }, "description": "Get a Firebase custom token for authentication." } }, { "name": "Start Conversation", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"request\",\n \"request_id\": 1,\n \"company_id\": 1\n}" }, "url": { "raw": "{{baseUrl}}/api/v1/messaging/start", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "messaging", "start" ] } } }, { "name": "Upload Attachment", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "body": { "mode": "formdata", "formdata": [ { "key": "conversation_id", "value": "1", "type": "text" }, { "key": "file", "type": "file", "src": [] } ] }, "url": { "raw": "{{baseUrl}}/api/v1/messaging/upload", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "messaging", "upload" ] } } }, { "name": "Sync Metadata", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"conversation_id\": 1,\n \"last_message\": \"Hello!\"\n}" }, "url": { "raw": "{{baseUrl}}/api/v1/messaging/sync", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "messaging", "sync" ] } } } ] }, { "name": "V2 Contract Termination Flow", "item": [ { "name": "Customer Flow (V2)", "item": [ { "name": "Init Termination (Financial Impact)", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{customer_token}}", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v2/customer/contracts/termination/init?contract_id=10", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "customer", "contracts", "termination", "init" ], "query": [ { "key": "contract_id", "value": "10" } ] } } }, { "name": "Submit Termination Request", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{customer_token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"contract_id\": 10,\n \"reason_category\": \"Work progress is delayed\",\n \"reason\": \"Quality concerns and delays in milestone 2.\"\n}" }, "url": { "raw": "{{base_url}}/api/v2/customer/contracts/termination/submit", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "customer", "contracts", "termination", "submit" ] } } }, { "name": "Get Termination Status", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{customer_token}}", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v2/customer/contracts/termination/status?contract_id=10", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "customer", "contracts", "termination", "status" ], "query": [ { "key": "contract_id", "value": "10" } ] } } }, { "name": "Respond to Settlement", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{customer_token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"contract_id\": 10,\n \"action\": \"dispute\",\n \"dispute_reason\": \"The proposed refund amount is too low based on the work progress.\"\n}" }, "url": { "raw": "{{base_url}}/api/v2/customer/contracts/termination/respond", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "customer", "contracts", "termination", "respond" ] }, "description": "Allows the customer to Accept or Dispute a settlement proposal from the company.\n\nPayload:\n- `contract_id`: The ID of the contract.\n- `action`: 'accept' to finalize termination, or 'dispute' to request administrative review.\n- `dispute_reason`: Required if action is 'dispute'. Briefly explains why the customer rejects the proposal." } }, { "name": "Withdraw Termination Request", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{customer_token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"contract_id\": 10\n}" }, "url": { "raw": "{{base_url}}/api/v2/customer/contracts/termination/withdraw", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "customer", "contracts", "termination", "withdraw" ] } } } ] }, { "name": "Company Flow (V2)", "item": [ { "name": "Get termination settlement", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v2/company/contracts/termination/settlement?contract_id=1", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "company", "contracts", "termination", "settlement" ], "query": [ { "key": "contract_id", "value": "1" } ] }, "description": "Financial snapshot and `scenarios` (`work_based`, `refund_required`, `outstanding_payment`) for `contract_termination_settlement.php`." } }, { "name": "Approve termination settlement", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/company/contracts/termination/approve", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "company", "contracts", "termination", "approve" ] }, "body": { "mode": "raw", "raw": "{\n \"contract_id\": 1,\n \"system_scenario\": \"work_based\",\n \"adjustment_amount\": null,\n \"adjustment_reason\": null,\n \"reason\": \"Termination settlement approved by company.\"\n}" }, "description": "`system_scenario` must be one of: `work_based`, `refund_required`, `outstanding_payment`. Sets contract to `termination_pending`; use reconciliation then **Confirm settlement**." } }, { "name": "Reject pending termination request", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/company/contracts/termination/reject", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "company", "contracts", "termination", "reject" ] }, "body": { "mode": "raw", "raw": "{\n \"contract_id\": 1\n}" }, "description": "Rejects client `pending` termination request. If contract was `termination_pending`, reverts status to `active`." } }, { "name": "Get termination reconciliation", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v2/company/contracts/termination/reconciliation?contract_id=1", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "company", "contracts", "termination", "reconciliation" ], "query": [ { "key": "contract_id", "value": "1" } ] }, "description": "Payload for `contract_settlement_reconciliation.php` while contract is `termination_pending` (approved settlement snapshot vs recalculated amounts)." } }, { "name": "Confirm settlement (finalize termination)", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/company/contracts/termination/confirm-settlement", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "company", "contracts", "termination", "confirm-settlement" ] }, "body": { "mode": "raw", "raw": "{\n \"contract_id\": 1\n}" }, "description": "Requires contract `termination_pending` and an approved termination record. Sets contract to `terminated` and `terminated_at`." } }, { "name": "Propose/Initiate Company Termination (No Customer Request) V2", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/company/contracts/termination/approve", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "company", "contracts", "termination", "approve" ] }, "body": { "mode": "raw", "raw": "{\n \"contract_id\": 1,\n \"system_scenario\": \"work_based\",\n \"adjustment_amount\": 150,\n \"adjustment_reason\": \"Deduction for incomplete cleanup or access delays\",\n \"reason\": \"Company proposing unilateral contract termination settlement.\"\n}" }, "description": "Allows the company to unilaterally propose/initiate a contract termination settlement when there is NO prior request from the customer. The contract transitions to `'termination_pending'` status immediately, and awaits the customer's response (`accept` or `dispute`) via their mobile client." } } ] }, { "name": "Admin Views (V2)", "item": [ { "name": "List Contracts (admin)", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v2/admin/contracts?limit=20&offset=0", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "admin", "contracts" ], "query": [ { "key": "limit", "value": "20" }, { "key": "offset", "value": "0" }, { "key": "search", "value": "", "disabled": true }, { "key": "status", "value": "", "disabled": true }, { "key": "company_id", "value": "", "disabled": true } ] }, "description": "Retrieve all contracts across the platform. Admin only. Supports filtering by status, company_id, and search (contract_no, project_name, company name, customer name)." } }, { "name": "Get Contract Details (admin)", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt_token}}" } ], "url": { "raw": "{{baseUrl}}/api/v2/admin/contracts/details?id=1", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "admin", "contracts", "details" ], "query": [ { "key": "id", "value": "1" } ] }, "description": "Get full contract details including items, milestones, execution stages and financial summary. Admin only." } } ] } ] } ] }