{ "info": { "_postman_id": "46ab9f7c-f8d4-4d81-8597-a59de9d81fca", "name": "PAY ROLL AI", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "_exporter_id": "36581263", "_collection_link": "https://kkk888-1459.postman.co/workspace/kamal~79353cb5-1f5b-414f-997c-84d181dd020a/collection/36581263-46ab9f7c-f8d4-4d81-8597-a59de9d81fca?action=share&source=collection_link&creator=36581263" }, "item": [ { "name": "updated2026", "item": [ { "name": "Dashboard Analytics", "item": [ { "name": "Global Payroll Analytics", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}api/admin/dashboard/analytics/payroll?from=2023-01-01&to=2024-12-31", "host": [ "{{base_url}}api" ], "path": [ "admin", "dashboard", "analytics", "payroll" ], "query": [ { "key": "from", "value": "2023-01-01", "description": "Start date (YYYY-MM-DD) - optional" }, { "key": "to", "value": "2024-12-31", "description": "End date (YYYY-MM-DD) - optional" }, { "key": "per_page", "value": "50", "description": "Pagination limit" }, { "key": "page", "value": "1", "description": "Page number" } ] }, "description": "Retrieves the total net pay, company-wise breakdowns, and status summaries for all payrolls.\n\n### Query Parameters\n- `from`: Start date for the analysis period (YYYY-MM-DD)\n- `to`: End date for the analysis period (YYYY-MM-DD)\n- `per_page`: Pagination limit for the raw list\n- `page`: Page number\n\n### Response Structure\nIncludes `global_totals` (status & net pay), `company_breakdown`, and `all_payrolls` (paginated list)." } } ] }, { "name": "Payroll Columns", "description": "Endpoints for managing default system columns and custom company columns.", "item": [ { "name": "Get All Columns (System/Company)", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{base_url}}api/companies/2/columns", "host": [ "{{base_url}}api" ], "path": [ "companies", "2", "columns" ] }, "description": "Retrieves the full schema of payroll columns available for a specific company.\n\n### Logic\nThe response combines two data sources:\n1. **System Default Columns:** Computed statically from `Default Columns Configuration.json` (ID: `default_xxx`).\n2. **Company Custom Columns:** Fetched directly from `payroll_columns` (ID: `cust_xxx`)." } }, { "name": "Create Company Column", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Night Shift Allowance\",\n \"type\": \"payment\",\n \"created_by\": 1\n}" }, "url": { "raw": "{{base_url}}api/companies/2/columns", "host": [ "{{base_url}}api" ], "path": [ "companies", "2", "columns" ] }, "description": "Allows an admin or HR supervisor to define a new payroll column specific to a company, used when a specific deduction/payment type isn't covered by defaults.\n\n### Validation Rules\n- **Name:** Unique for this specific `company_id`. Cannot conflict with existing system default keys/aliases.\n- **Type:** enum: `payment`, `deduction`, `info`, `other`." } }, { "name": "Manage Columns direct (CRUD)", "item": [ { "name": "Get All direct", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{base_url}}api/payroll-columns?company_id=2", "host": [ "{{base_url}}api" ], "path": [ "payroll-columns" ], "query": [ { "key": "company_id", "value": "2", "description": "Company ID to filter" } ] } } }, { "name": "Create List Column", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Housing Allowance\",\n \"type\": \"payment\",\n \"company_id\": 2,\n \"aliases\": [\"housing\", \"بدل السكن\"]\n}" }, "url": { "raw": "{{base_url}}api/payroll-columns", "host": [ "{{base_url}}api" ], "path": [ "payroll-columns" ] } } }, { "name": "Update Column", "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"New Housing Allowance\",\n \"type\": \"payment\",\n \"company_id\": 2,\n \"aliases\": [\"housing\", \"housing_allowance\", \"بدل مسكن\"]\n}" }, "url": { "raw": "{{base_url}}api/payroll-columns/1", "host": [ "{{base_url}}api" ], "path": [ "payroll-columns", "1" ] } } }, { "name": "Delete Column", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{base_url}}api/payroll-columns/1", "host": [ "{{base_url}}api" ], "path": [ "payroll-columns", "1" ] } } }, { "name": "Initialize Defaults", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"company_id\": 2\n}" }, "url": { "raw": "{{base_url}}api/payroll-columns/init-defaults", "host": [ "{{base_url}}api" ], "path": [ "payroll-columns", "init-defaults" ] }, "description": "Seeds the 28 default payload columns from your `Default Columns Configuration.json` directly into the `payroll_columns` table for the specified `company_id`. Uses `updateOrCreate` to ensure idempotency. The columns will have `is_default=true`." } } ] } ] }, { "name": "Payroll Imports (Updated Strict Logic)", "item": [ { "name": "Import Payroll File", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "body": { "mode": "formdata", "formdata": [ { "key": "company_id", "value": "2", "type": "text" }, { "key": "file", "type": "file", "src": "" } ] }, "url": { "raw": "{{base_url}}api/payrolls/importFile/execute", "host": [ "{{base_url}}api" ], "path": [ "payrolls", "importFile", "execute" ] }, "description": "Imports a payroll CSV/XLSX into the system.\n\n### Updated Logic (Strict Column Validation):\n1. Parses the first row to determine column exact match/aliases using English/Arabic arrays (via unified list).\n2. If unknown columns exist in the file, or if mandatory core columns (like `EmployeeId`, `NetPay`, `PayPeriod`) are missing, it immediately throws `400 Bad Request` with structured properties: `missing_columns` and `unknown_columns`." } } ] } ] }, { "name": "AUTH", "item": [ { "name": "Profile", "item": [ { "name": "chnagePassword", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"current_password\": \"password123\",\r\n \"new_password\": \"password1234\",\r\n \"new_password_confirmation\": \"password1234\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "api/myProfile/changePassword", "host": [ "api" ], "path": [ "myProfile", "changePassword" ] } }, "response": [ { "name": "changePassword", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"current_password\": \"password1234\",\r\n \"new_password\": \"password123\",\r\n \"new_password_confirmation\": \"password123\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "api/myProfile/changePassword", "host": [ "api" ], "path": [ "myProfile", "changePassword" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "127.0.0.1:8000" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.3.14" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Date", "value": "Sat, 10 May 2025 04:36:56 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "57" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [ { "expires": "Invalid Date", "domain": "", "path": "" } ], "body": "{\n \"status\": true,\n \"data\": null,\n \"messages\": null,\n \"code\": 200\n}" } ] }, { "name": "myProfile", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "42|CQlPQv6xNj8Jg75dVz2BemS7GWSLkX8uMepDVkp2fa469c0d", "type": "string" } ] }, "method": "GET", "header": [], "url": { "raw": "api/myProfile", "host": [ "api" ], "path": [ "myProfile" ] } }, "response": [ { "name": "myProfile", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "api/myProfile", "host": [ "api" ], "path": [ "myProfile" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "127.0.0.1:8000" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.3.14" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Date", "value": "Tue, 06 May 2025 22:18:23 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "{\n \"status\": true,\n \"data\": {\n \"user\": {\n \"id\": 31,\n \"custom_id\": \"EM00000001\",\n \"name\": \"Erwin Monte Mosciski\",\n \"first_name\": \"Erwin\",\n \"middle_name\": \"Monte\",\n \"last_name\": \"Mosciski\",\n \"email\": \"employee3@payrollai.com\",\n \"phone\": \"966550973643\",\n \"email_verified_at\": \"2025-05-07T01:08:30.000000Z\",\n \"account_type\": \"employee\",\n \"verified\": 1,\n \"status\": \"active\",\n \"national_insurance_number\": \"000000273488\",\n \"created_at\": \"2025-05-07T01:08:33.000000Z\",\n \"updated_at\": \"2025-05-07T01:08:33.000000Z\"\n },\n \"permissions\": [\n \"*\"\n ]\n },\n \"messages\": null,\n \"code\": 200\n}" } ] }, { "name": "SwitchCompnay", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "company_id", "value": "2", "type": "text" } ] }, "url": { "raw": "api/switchCompnay", "host": [ "api" ], "path": [ "switchCompnay" ] } }, "response": [ { "name": "New Request", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "company_id", "value": "2", "type": "text" } ] }, "url": { "raw": "api/switchCompnay", "host": [ "api" ], "path": [ "switchCompnay" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Connection", "value": "Keep-Alive" }, { "key": "Keep-Alive", "value": "timeout=5, max=100" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "57" }, { "key": "Access-Control-Allow-Origin", "value": "*" }, { "key": "Content-Length", "value": "623" }, { "key": "Date", "value": "Thu, 03 Jul 2025 00:13:16 GMT" }, { "key": "Server", "value": "LiteSpeed" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "alt-svc", "value": "h3=\":443\"; ma=2592000, h3-29=\":443\"; ma=2592000, h3-Q050=\":443\"; ma=2592000, h3-Q046=\":443\"; ma=2592000, h3-Q043=\":443\"; ma=2592000, quic=\":443\"; ma=2592000; v=\"43,46\"" } ], "cookie": [], "body": "{\n \"status\": true,\n \"data\": {\n \"id\": 57,\n \"custom_id\": \"EM00000012\",\n \"name\": \"Nora Nader\",\n \"first_name\": \"Nora\",\n \"middle_name\": null,\n \"last_name\": \"Nader\",\n \"email\": \"employee16@company.com\",\n \"phone\": \"966517346506\",\n \"email_verified_at\": \"2025-05-14T17:08:34.000000Z\",\n \"account_type\": \"employee\",\n \"verified\": 1,\n \"status\": \"active\",\n \"national_insurance_number\": \"000000798097\",\n \"created_at\": \"2025-05-14T17:08:35.000000Z\",\n \"is_leaver\": 1,\n \"leaving_date\": \"2025-06-28T00:00:00.000000Z\",\n \"updated_at\": \"2025-07-03T00:13:10.000000Z\",\n \"leave_date_status\": \"pending\",\n \"leave_date_requested_at\": \"2025-06-18T00:00:00.000000Z\",\n \"selected_company\": \"2\"\n },\n \"messages\": null,\n \"code\": 200\n}" } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{EM00000016}}", "type": "string" } ] }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "packages": [], "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "packages": [], "exec": [ "" ] } } ] }, { "name": "Notification", "item": [ { "name": "read", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{EM00000016}}", "type": "string" } ] }, "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "ids[]", "value": "1", "type": "text" } ] }, "url": { "raw": "api/myProfile/notifications/read", "host": [ "api" ], "path": [ "myProfile", "notifications", "read" ] } }, "response": [ { "name": "read", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "ids[]", "value": "1", "type": "text" } ] }, "url": { "raw": "api/myProfile/notifications/read", "host": [ "api" ], "path": [ "myProfile", "notifications", "read" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Connection", "value": "Keep-Alive" }, { "key": "Keep-Alive", "value": "timeout=5, max=100" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "58" }, { "key": "Access-Control-Allow-Origin", "value": "*" }, { "key": "Content-Length", "value": "68" }, { "key": "Date", "value": "Sat, 26 Jul 2025 11:28:41 GMT" }, { "key": "Server", "value": "LiteSpeed" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "alt-svc", "value": "h3=\":443\"; ma=2592000, h3-29=\":443\"; ma=2592000, h3-Q050=\":443\"; ma=2592000, h3-Q046=\":443\"; ma=2592000, h3-Q043=\":443\"; ma=2592000, quic=\":443\"; ma=2592000; v=\"43,46\"" } ], "cookie": [], "body": "{\n \"status\": true,\n \"data\": {\n \"unread_count\": 0\n },\n \"messages\": null,\n \"code\": 200\n}" } ] }, { "name": "notifications", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{EM00000016}}", "type": "string" } ] }, "method": "GET", "header": [], "url": { "raw": "api/myProfile/notifications?sort_by=id&sort=desc&per_page=20", "host": [ "api" ], "path": [ "myProfile", "notifications" ], "query": [ { "key": "sort_by", "value": "id" }, { "key": "sort", "value": "desc" }, { "key": "per_page", "value": "20" } ] } }, "response": [ { "name": "New Request", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "api/myProfile/notifications?sort_by=id&sort=desc&per_page=20", "host": [ "api" ], "path": [ "myProfile", "notifications" ], "query": [ { "key": "sort_by", "value": "id" }, { "key": "sort", "value": "desc" }, { "key": "per_page", "value": "20" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Connection", "value": "Keep-Alive" }, { "key": "Keep-Alive", "value": "timeout=5, max=100" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" }, { "key": "Content-Length", "value": "1059" }, { "key": "Date", "value": "Thu, 03 Jul 2025 15:02:21 GMT" }, { "key": "Server", "value": "LiteSpeed" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "alt-svc", "value": "h3=\":443\"; ma=2592000, h3-29=\":443\"; ma=2592000, h3-Q050=\":443\"; ma=2592000, h3-Q046=\":443\"; ma=2592000, h3-Q043=\":443\"; ma=2592000, quic=\":443\"; ma=2592000; v=\"43,46\"" } ], "cookie": [], "body": "{\n \"status\": true,\n \"data\": {\n \"notifications\": {\n \"current_page\": 1,\n \"data\": [\n {\n \"notifiable_id\": \"107\",\n \"notifiable_type\": \"users\",\n \"type\": \"salary_uploaded\",\n \"message\": \"Your monthly salary for 2024-05-31 has been uploaded.\",\n \"channel\": \"FIREBASE\",\n \"action_url\": \"https://endpoint.ngm4ido3.a2hosted.com/api/showPayrolls/515\",\n \"read\": false,\n \"read_at\": null,\n \"company_id\": 2,\n \"created_at\": \"2025-07-03T14:51:30.000000Z\"\n }\n ],\n \"first_page_url\": \"https://endpoint.ngm4ido3.a2hosted.com/api/myProfile/notifications?page=1\",\n \"from\": 1,\n \"last_page\": 1,\n \"last_page_url\": \"https://endpoint.ngm4ido3.a2hosted.com/api/myProfile/notifications?page=1\",\n \"links\": [\n {\n \"url\": null,\n \"label\": \"« Previous\",\n \"active\": false\n },\n {\n \"url\": \"https://endpoint.ngm4ido3.a2hosted.com/api/myProfile/notifications?page=1\",\n \"label\": \"1\",\n \"active\": true\n },\n {\n \"url\": null,\n \"label\": \"Next »\",\n \"active\": false\n }\n ],\n \"next_page_url\": null,\n \"path\": \"https://endpoint.ngm4ido3.a2hosted.com/api/myProfile/notifications\",\n \"per_page\": 20,\n \"prev_page_url\": null,\n \"to\": 1,\n \"total\": 1\n },\n \"unread_count\": 1,\n \"total_count\": 1\n },\n \"messages\": null,\n \"code\": 200\n}" } ] } ] }, { "name": "reset password", "item": [ { "name": "resetPasswordViaEmail", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "email", "value": "hr@company.com", "type": "text" }, { "key": "custom_id", "value": "", "type": "text" } ] }, "url": { "raw": "api/resetPasswordViaEmail", "host": [ "api" ], "path": [ "resetPasswordViaEmail" ] } }, "response": [ { "name": "resetPasswordViaEmail", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "email", "value": "kamalmusto67@gmail.com", "type": "text" } ] }, "url": { "raw": "api/resetPasswordViaEmail", "host": [ "api" ], "path": [ "resetPasswordViaEmail" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.3.14" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Date", "value": "Sat, 03 May 2025 00:23:56 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "{\n \"status\": true,\n \"data\": \"470608\",\n \"messages\": null,\n \"code\": 200\n}" } ] }, { "name": "changePasswordViaCode", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "identifier", "value": "employee3@payrollai.com", "description": "emai || Phone", "type": "text" }, { "key": "code", "value": "411210", "type": "text" }, { "key": "password", "value": "password123", "description": "min:8", "type": "text" }, { "key": "confirm_password", "value": "password123", "description": "min:8", "type": "text" } ] }, "url": { "raw": "api/changePasswordViaCode", "host": [ "api" ], "path": [ "changePasswordViaCode" ] } }, "response": [ { "name": "changePasswordViaCode", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "identifier", "value": "kamalmusto67@gmail.com", "description": "emai || Phone", "type": "text" }, { "key": "code", "value": "470608", "type": "text" }, { "key": "password", "value": "password1234", "description": "min:8", "type": "text" }, { "key": "confirm_password", "value": "password1234", "description": "min:8", "type": "text" } ] }, "url": { "raw": "api/changePasswordViaCode", "host": [ "api" ], "path": [ "changePasswordViaCode" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.3.14" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Date", "value": "Sat, 03 May 2025 00:48:19 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "56" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "{\n \"status\": true,\n \"data\": {\n \"success\": true\n },\n \"messages\": null,\n \"code\": 200\n}" }, { "name": "changePasswordViaCode error", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "identifier", "value": "kamalmusto67@gmail.com", "description": "emai || Phone", "type": "text" }, { "key": "code", "value": "470608", "type": "text" }, { "key": "password", "value": "password1234", "description": "min:8", "type": "text" }, { "key": "confirm_password", "value": "password1234", "description": "min:8", "type": "text" } ] }, "url": { "raw": "api/changePasswordViaCode", "host": [ "api" ], "path": [ "changePasswordViaCode" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.3.14" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Date", "value": "Sat, 03 May 2025 00:49:02 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "58" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "{\n \"status\": false,\n \"data\": null,\n \"messages\": \"The selected code is invalid.\",\n \"code\": 400\n}" } ] }, { "name": "checkCode", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "identifier", "value": "employee3@payrollai.com", "description": "emai || Phone", "type": "text" }, { "key": "code", "value": "411210", "type": "text" } ] }, "url": { "raw": "api/checkCode", "host": [ "api" ], "path": [ "checkCode" ] } }, "response": [ { "name": "checkCode success", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "identifier", "value": "kamalmusto67@gmail.com", "description": "emai || Phone", "type": "text" }, { "key": "code", "value": "470608", "type": "text" } ] }, "url": { "raw": "api/checkCode", "host": [ "api" ], "path": [ "checkCode" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.3.14" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Date", "value": "Sat, 03 May 2025 00:33:10 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "57" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "{\n \"status\": true,\n \"data\": {\n \"success\": true\n },\n \"messages\": null,\n \"code\": 200\n}" } ] } ] }, { "name": "Resgister", "item": [ { "name": "check_company_user", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "emp_id", "value": "2", "type": "text" }, { "key": "company_id", "value": "2", "type": "text" } ] }, "url": { "raw": "api/check_company_user", "host": [ "api" ], "path": [ "check_company_user" ] } }, "response": [ { "name": "\"is_available\": true", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "emp_id", "value": "1", "type": "text" }, { "key": "company_id", "value": "1", "type": "text" } ] }, "url": { "raw": "api/check_company_user", "host": [ "api" ], "path": [ "check_company_user" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Connection", "value": "Keep-Alive" }, { "key": "Keep-Alive", "value": "timeout=5, max=100" }, { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application/json" }, { "key": "x-ratelimit-limit", "value": "60" }, { "key": "x-ratelimit-remaining", "value": "54" }, { "key": "access-control-allow-origin", "value": "*" }, { "key": "content-length", "value": "71" }, { "key": "date", "value": "Thu, 15 May 2025 00:54:12 GMT" }, { "key": "server", "value": "LiteSpeed" }, { "key": "strict-transport-security", "value": "max-age=63072000; includeSubDomains" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "alt-svc", "value": "h3=\":443\"; ma=2592000, h3-29=\":443\"; ma=2592000, h3-Q050=\":443\"; ma=2592000, h3-Q046=\":443\"; ma=2592000, h3-Q043=\":443\"; ma=2592000, quic=\":443\"; ma=2592000; v=\"43,46\"" } ], "cookie": [], "body": "{\n \"status\": true,\n \"data\": {\n \"is_available\": true\n },\n \"messages\": null,\n \"code\": 200\n}" }, { "name": "\"is_available\": false", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "emp_id", "value": "2", "type": "text" }, { "key": "company_id", "value": "2", "type": "text" } ] }, "url": { "raw": "api/check_company_user", "host": [ "api" ], "path": [ "check_company_user" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Connection", "value": "Keep-Alive" }, { "key": "Keep-Alive", "value": "timeout=5, max=100" }, { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application/json" }, { "key": "x-ratelimit-limit", "value": "60" }, { "key": "x-ratelimit-remaining", "value": "59" }, { "key": "access-control-allow-origin", "value": "*" }, { "key": "content-length", "value": "72" }, { "key": "date", "value": "Thu, 15 May 2025 00:55:20 GMT" }, { "key": "server", "value": "LiteSpeed" }, { "key": "strict-transport-security", "value": "max-age=63072000; includeSubDomains" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "alt-svc", "value": "h3=\":443\"; ma=2592000, h3-29=\":443\"; ma=2592000, h3-Q050=\":443\"; ma=2592000, h3-Q046=\":443\"; ma=2592000, h3-Q043=\":443\"; ma=2592000, quic=\":443\"; ma=2592000; v=\"43,46\"" } ], "cookie": [], "body": "{\n \"status\": true,\n \"data\": {\n \"is_available\": false\n },\n \"messages\": null,\n \"code\": 200\n}" } ] }, { "name": "register", "event": [ { "listen": "test", "script": { "exec": [ "const response = pm.response.json();\r", "pm.collectionVariables.set(\"token\", response.data.token);\r", "" ], "type": "text/javascript", "packages": [] } } ], "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "email", "value": "exampl111e@example.com", "type": "text" }, { "key": "phone", "value": "123167891", "type": "text" }, { "key": "national_insurance_number", "value": "12345671891", "type": "text" }, { "key": "password", "value": "StrongPass123", "type": "text" }, { "key": "password_confirmation", "value": "StrongPass123", "type": "text" }, { "key": "first_name", "value": "Ali", "type": "text" }, { "key": "middle_name", "value": "Hassan", "type": "text" }, { "key": "last_name", "value": "Khaled", "type": "text" }, { "key": "emp_id", "value": "111", "type": "text" }, { "key": "company_id", "value": "602", "type": "text" } ] }, "url": { "raw": "api/register", "host": [ "api" ], "path": [ "register" ] }, "description": "**User Registration**\n\nRegister a new user account.\n\n**Required Fields:**\n- `email`: Valid email address\n- `phone`: Phone number\n- `national_insurance_number`: National insurance number\n- `password`: Minimum 8 characters\n- `password_confirmation`: Must match password\n- `first_name`: User's first name\n- `last_name`: User's last name\n\n**Optional Fields:**\n- `middle_name`: Middle name\n- `emp_id`: Employee ID\n- `company_id`: Company to join\n\n**Response:**\n- `token`: Bearer token for authentication\n- `custom_id`: Generated user custom ID" }, "response": [ { "name": "login Copy", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "email", "value": "exampl11e@example.com", "type": "text" }, { "key": "phone", "value": "1234567891", "type": "text" }, { "key": "national_insurance_number", "value": "1234567891", "type": "text" }, { "key": "password", "value": "StrongPass123", "type": "text" }, { "key": "password_confirmation", "value": "StrongPass123", "type": "text" }, { "key": "first_name", "value": "Ali", "type": "text" }, { "key": "middle_name", "value": "Hassan", "type": "text" }, { "key": "last_name", "value": "Khaled", "type": "text" }, { "key": "emp_id", "value": "789", "type": "text" }, { "key": "company_id", "value": "1", "type": "text" } ] }, "url": { "raw": "api/register", "host": [ "api" ], "path": [ "register" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Connection", "value": "Keep-Alive" }, { "key": "Keep-Alive", "value": "timeout=5, max=100" }, { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application/json" }, { "key": "x-ratelimit-limit", "value": "60" }, { "key": "x-ratelimit-remaining", "value": "59" }, { "key": "access-control-allow-origin", "value": "*" }, { "key": "content-length", "value": "137" }, { "key": "date", "value": "Thu, 15 May 2025 01:05:06 GMT" }, { "key": "server", "value": "LiteSpeed" }, { "key": "strict-transport-security", "value": "max-age=63072000; includeSubDomains" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "alt-svc", "value": "h3=\":443\"; ma=2592000, h3-29=\":443\"; ma=2592000, h3-Q050=\":443\"; ma=2592000, h3-Q046=\":443\"; ma=2592000, h3-Q043=\":443\"; ma=2592000, quic=\":443\"; ma=2592000; v=\"43,46\"" } ], "cookie": [], "body": "{\n \"status\": true,\n \"data\": {\n \"token\": \"2|SRoWQMZRLsgQw6GBh3ONckTJUuT8WDMEUrdXpoExff055b92\",\n \"custom_id\": \"EM00000017\"\n },\n \"messages\": null,\n \"code\": 200\n}" }, { "name": "register", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "email", "value": "exampl111e@example.com", "type": "text" }, { "key": "phone", "value": "123167891", "type": "text" }, { "key": "national_insurance_number", "value": "12345671891", "type": "text" }, { "key": "password", "value": "StrongPass123", "type": "text" }, { "key": "password_confirmation", "value": "StrongPass123", "type": "text" }, { "key": "first_name", "value": "Ali", "type": "text" }, { "key": "middle_name", "value": "Hassan", "type": "text" }, { "key": "last_name", "value": "Khaled", "type": "text" }, { "key": "emp_id", "value": "111", "type": "text" }, { "key": "company_id", "value": "602", "type": "text" } ] }, "url": { "raw": "api/register", "host": [ "api" ], "path": [ "register" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Connection", "value": "Keep-Alive" }, { "key": "Keep-Alive", "value": "timeout=5, max=100" }, { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application/json" }, { "key": "x-ratelimit-limit", "value": "60" }, { "key": "x-ratelimit-remaining", "value": "58" }, { "key": "access-control-allow-origin", "value": "*" }, { "key": "content-length", "value": "137" }, { "key": "date", "value": "Fri, 16 May 2025 08:39:54 GMT" }, { "key": "server", "value": "LiteSpeed" }, { "key": "strict-transport-security", "value": "max-age=63072000; includeSubDomains" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "alt-svc", "value": "h3=\":443\"; ma=2592000, h3-29=\":443\"; ma=2592000, h3-Q050=\":443\"; ma=2592000, h3-Q046=\":443\"; ma=2592000, h3-Q043=\":443\"; ma=2592000, quic=\":443\"; ma=2592000; v=\"43,46\"" } ], "cookie": [], "body": "{\n \"status\": true,\n \"data\": {\n \"token\": \"9|h9nI5YiOtcqlDQPaff2i4doplH231eBnYW3v88RN40039376\",\n \"custom_id\": \"EM00000018\"\n },\n \"messages\": null,\n \"code\": 200\n}" } ] }, { "name": "newCode", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "identifier", "value": "hr@company.com", "type": "text" } ] }, "url": { "raw": "api/newCode", "host": [ "api" ], "path": [ "newCode" ] } }, "response": [ { "name": "newCode", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "identifier", "value": "hr@company.com", "type": "text" } ] }, "url": { "raw": "api/newCode", "host": [ "api" ], "path": [ "newCode" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Connection", "value": "Keep-Alive" }, { "key": "Keep-Alive", "value": "timeout=5, max=100" }, { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application/json" }, { "key": "x-ratelimit-limit", "value": "60" }, { "key": "x-ratelimit-remaining", "value": "59" }, { "key": "access-control-allow-origin", "value": "*" }, { "key": "content-length", "value": "69" }, { "key": "date", "value": "Thu, 15 May 2025 00:47:14 GMT" }, { "key": "server", "value": "LiteSpeed" }, { "key": "strict-transport-security", "value": "max-age=63072000; includeSubDomains" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "alt-svc", "value": "h3=\":443\"; ma=2592000, h3-29=\":443\"; ma=2592000, h3-Q050=\":443\"; ma=2592000, h3-Q046=\":443\"; ma=2592000, h3-Q043=\":443\"; ma=2592000, quic=\":443\"; ma=2592000; v=\"43,46\"" } ], "cookie": [], "body": "{\n \"status\": true,\n \"data\": {\n \"dev_code\": \"6723\"\n },\n \"messages\": null,\n \"code\": 200\n}" } ] } ] }, { "name": "sign out", "item": [ { "name": "logoutFromCurrentToken", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "GET", "header": [], "url": { "raw": "api/logoutFromCurrentToken", "host": [ "api" ], "path": [ "logoutFromCurrentToken" ] }, "description": "**Logout from Current Device**\n\nInvalidates the current authentication token. User will be logged out from this device only.\n\n**Authentication:** Required (Bearer token)\n\n**Note:** Other active sessions on different devices will remain active." }, "response": [ { "name": "logoutFromCurrentToken", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "api/logoutFromCurrentToken", "host": [ "api" ], "path": [ "logoutFromCurrentToken" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.3.14" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Date", "value": "Fri, 02 May 2025 18:00:56 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "58" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "{\n \"status\": true,\n \"data\": null,\n \"messages\": null,\n \"code\": 200\n}" } ] }, { "name": "logoutFromAllTokens", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "GET", "header": [], "url": { "raw": "api/logoutFromAllTokens", "host": [ "api" ], "path": [ "logoutFromAllTokens" ] }, "description": "**Logout from All Devices**\n\nInvalidates all authentication tokens for the user. User will be logged out from all devices.\n\n**Authentication:** Required (Bearer token)\n\n**Use Case:** Security measure when user suspects unauthorized access." }, "response": [ { "name": "logoutFromAllTokens", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "api/logoutFromAllTokens", "host": [ "api" ], "path": [ "logoutFromAllTokens" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.3.14" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Date", "value": "Fri, 02 May 2025 18:01:37 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "{\n \"status\": true,\n \"data\": null,\n \"messages\": null,\n \"code\": 200\n}" } ] } ] }, { "name": "EXAMPLES", "item": [ { "name": "login manager", "event": [ { "listen": "test", "script": { "exec": [ "const response = pm.response.json();\r", "pm.collectionVariables.set(\"token_manager\", response.data.token);\r", "" ], "type": "text/javascript", "packages": [] } } ], "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "identifier", "value": "manager20@company.com", "type": "text" }, { "key": "password", "value": "password123", "type": "text" }, { "key": "custom_id", "value": "MG00000013", "type": "text" } ] }, "url": { "raw": "api/login", "host": [ "api" ], "path": [ "login" ] } }, "response": [ { "name": "login manager", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "identifier", "value": "manager20@company.com", "type": "text" }, { "key": "password", "value": "password123", "type": "text" }, { "key": "custom_id", "value": "MG00000013", "type": "text" } ] }, "url": { "raw": "api/login", "host": [ "api" ], "path": [ "login" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Connection", "value": "Keep-Alive" }, { "key": "Keep-Alive", "value": "timeout=5, max=100" }, { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application/json" }, { "key": "x-ratelimit-limit", "value": "60" }, { "key": "x-ratelimit-remaining", "value": "59" }, { "key": "access-control-allow-origin", "value": "*" }, { "key": "content-length", "value": "596" }, { "key": "date", "value": "Fri, 23 May 2025 11:32:47 GMT" }, { "key": "server", "value": "LiteSpeed" }, { "key": "strict-transport-security", "value": "max-age=63072000; includeSubDomains" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "alt-svc", "value": "h3=\":443\"; ma=2592000, h3-29=\":443\"; ma=2592000, h3-Q050=\":443\"; ma=2592000, h3-Q046=\":443\"; ma=2592000, h3-Q043=\":443\"; ma=2592000, quic=\":443\"; ma=2592000; v=\"43,46\"" } ], "cookie": [], "body": "{\n \"status\": true,\n \"data\": {\n \"success\": true,\n \"token\": \"28|cVLvfrDmdUCrnrfZ6YGhgeUuybsU9KDlDF5cjVpna1b85c90\",\n \"user\": {\n \"id\": 43,\n \"custom_id\": \"MG00000013\",\n \"name\": \"Jennie Casimer Mitchell\",\n \"first_name\": \"Jennie\",\n \"middle_name\": \"Casimer\",\n \"last_name\": \"Mitchell\",\n \"email\": \"manager20@company.com\",\n \"phone\": \"966542067492\",\n \"email_verified_at\": \"2025-05-14T17:08:32.000000Z\",\n \"account_type\": \"manager\",\n \"verified\": 1,\n \"status\": \"active\",\n \"national_insurance_number\": \"000000857105\",\n \"created_at\": \"2025-05-14T17:08:33.000000Z\",\n \"is_leaver\": 0,\n \"leaving_date\": null,\n \"updated_at\": \"2025-05-14T17:08:33.000000Z\"\n }\n },\n \"messages\": null,\n \"code\": 200\n}" } ] }, { "name": "EM00000016", "event": [ { "listen": "test", "script": { "exec": [ "const response = pm.response.json();\r", "pm.collectionVariables.set(\"EM00000016\", response.data.token);\r", "" ], "type": "text/javascript", "packages": [] } } ], "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "identifier", "value": "exampl1e@example.com", "type": "text" }, { "key": "password", "value": "password123", "type": "text" }, { "key": "custom_id", "value": "EM00000016", "type": "text" } ] }, "url": { "raw": "api/login", "host": [ "api" ], "path": [ "login" ] } }, "response": [] }, { "name": "login HR", "event": [ { "listen": "test", "script": { "exec": [ "const response = pm.response.json();\r", "pm.collectionVariables.set(\"token_hr\", response.data.token);\r", "" ], "type": "text/javascript", "packages": [] } } ], "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "identifier", "value": "hr17@company.com", "type": "text" }, { "key": "password", "value": "password123", "type": "text" }, { "key": "custom_id", "value": "HR00000015", "type": "text" } ] }, "url": { "raw": "api/login", "host": [ "api" ], "path": [ "login" ] } }, "response": [ { "name": "login HR", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "identifier", "value": "hr17@company.com", "type": "text" }, { "key": "password", "value": "password123", "type": "text" }, { "key": "custom_id", "value": "HR00000015", "type": "text" } ] }, "url": { "raw": "api/login", "host": [ "api" ], "path": [ "login" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Connection", "value": "Keep-Alive" }, { "key": "Keep-Alive", "value": "timeout=5, max=100" }, { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application/json" }, { "key": "x-ratelimit-limit", "value": "60" }, { "key": "x-ratelimit-remaining", "value": "58" }, { "key": "access-control-allow-origin", "value": "*" }, { "key": "content-length", "value": "578" }, { "key": "date", "value": "Fri, 23 May 2025 11:32:50 GMT" }, { "key": "server", "value": "LiteSpeed" }, { "key": "strict-transport-security", "value": "max-age=63072000; includeSubDomains" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "x-content-type-options", "value": "nosniff" } ], "cookie": [], "body": "{\n \"status\": true,\n \"data\": {\n \"success\": true,\n \"token\": \"29|2RVcmO2PGvi2LA0KJaT8WQgK6r0LG9vUs53h60jG2992a23d\",\n \"user\": {\n \"id\": 15,\n \"custom_id\": \"HR00000015\",\n \"name\": \"Lenora Clara Durgan\",\n \"first_name\": \"Lenora\",\n \"middle_name\": \"Clara\",\n \"last_name\": \"Durgan\",\n \"email\": \"hr17@company.com\",\n \"phone\": \"966513301977\",\n \"email_verified_at\": \"2025-05-14T17:08:28.000000Z\",\n \"account_type\": \"hr\",\n \"verified\": 1,\n \"status\": \"active\",\n \"national_insurance_number\": \"000000474280\",\n \"created_at\": \"2025-05-14T17:08:28.000000Z\",\n \"is_leaver\": 0,\n \"leaving_date\": null,\n \"updated_at\": \"2025-05-14T17:08:28.000000Z\"\n }\n },\n \"messages\": null,\n \"code\": 200\n}" } ] }, { "name": "company owner", "event": [ { "listen": "test", "script": { "exec": [ "const response = pm.response.json();\r", "pm.collectionVariables.set(\"token_company\", response.data.token);\r", "" ], "type": "text/javascript", "packages": [] } } ], "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "identifier", "value": "company18@gmail.com", "type": "text" }, { "key": "password", "value": "password123", "type": "text" }, { "key": "custom_id", "value": "CO00000015", "type": "text" } ] }, "url": { "raw": "api/login", "host": [ "api" ], "path": [ "login" ] } }, "response": [ { "name": "company owner", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "identifier", "value": "company18@gmail.com", "type": "text" }, { "key": "password", "value": "password123", "type": "text" }, { "key": "custom_id", "value": "CO00000015", "type": "text" } ] }, "url": { "raw": "api/login", "host": [ "api" ], "path": [ "login" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Connection", "value": "Keep-Alive" }, { "key": "Keep-Alive", "value": "timeout=5, max=100" }, { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application/json" }, { "key": "x-ratelimit-limit", "value": "60" }, { "key": "x-ratelimit-remaining", "value": "57" }, { "key": "access-control-allow-origin", "value": "*" }, { "key": "content-length", "value": "594" }, { "key": "date", "value": "Fri, 23 May 2025 11:32:53 GMT" }, { "key": "server", "value": "LiteSpeed" }, { "key": "strict-transport-security", "value": "max-age=63072000; includeSubDomains" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "x-content-type-options", "value": "nosniff" } ], "cookie": [], "body": "{\n \"status\": true,\n \"data\": {\n \"success\": true,\n \"token\": \"30|O9JnKygdI5rLK9TWIPsUkrrmgcNMlan038kNHy9Ffc607c22\",\n \"user\": {\n \"id\": 30,\n \"custom_id\": \"CO00000015\",\n \"name\": \"Dustin Lloyd Cartwright\",\n \"first_name\": \"Dustin\",\n \"middle_name\": \"Lloyd\",\n \"last_name\": \"Cartwright\",\n \"email\": \"company18@gmail.com\",\n \"phone\": \"966540552719\",\n \"email_verified_at\": \"2025-05-14T17:08:30.000000Z\",\n \"account_type\": \"company\",\n \"verified\": 1,\n \"status\": \"active\",\n \"national_insurance_number\": \"000000908445\",\n \"created_at\": \"2025-05-14T17:08:31.000000Z\",\n \"is_leaver\": 0,\n \"leaving_date\": null,\n \"updated_at\": \"2025-05-14T17:08:31.000000Z\"\n }\n },\n \"messages\": null,\n \"code\": 200\n}" } ] } ] }, { "name": "FCM", "item": [ { "name": "saveToken", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"firebase_token\": \"abcd1234efgh5678ijkl9012mnop34562\",\r\n \"device_type\": \"android\",\r\n \"device_name\": \"Galaxy S22\",\r\n \"device_id\": \"A1B2C3D4E5F6G7H8\",\r\n \"device_model\": \"SM-S901B\",\r\n \"device_manufacturer\": \"Samsung\",\r\n \"app_version\": \"1.2.3\",\r\n \"build_number\": \"123\",\r\n \"app_language\": \"en\",\r\n \"platform_version\": \"Android 13\"\r\n }", "options": { "raw": { "language": "json" } } }, "url": { "raw": "api/saveToken", "host": [ "api" ], "path": [ "saveToken" ] } }, "response": [] } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "packages": [], "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "packages": [], "exec": [ "" ] } } ] }, { "name": "login", "event": [ { "listen": "test", "script": { "exec": [ "const response = pm.response.json();\r", "pm.collectionVariables.set(\"token\", response.data.token);\r", "" ], "type": "text/javascript", "packages": [], "requests": [] } } ], "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "identifier", "value": "manager11@example.com", "type": "text", "description": "Email or phone number" }, { "key": "password", "value": "password", "type": "text", "description": "User password" }, { "key": "custom_id", "value": "PAIM00001", "type": "text", "description": "Employee/Manager/HR custom ID (e.g., EM00000001, MG00000001, HR00000001)" } ] }, "url": { "raw": "api/login", "host": [ "api" ], "path": [ "login" ] }, "description": "**User Login**\n\nAuthenticate user and receive access token.\n\n**Required Fields:**\n- `identifier`: Email or phone number\n- `password`: User password\n- `custom_id`: Employee custom ID\n\n**Response:**\n- `token`: Bearer token for authentication\n- `custom_id`: User's custom ID\n\n**Note:** Token is automatically saved to collection variables for subsequent requests." }, "response": [ { "name": "login", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "identifier", "value": "employee3@payrollai.com", "type": "text" }, { "key": "password", "value": "password123", "type": "text" }, { "key": "custom id", "value": "EM00000001", "type": "text" } ] }, "url": { "raw": "api/login", "host": [ "api" ], "path": [ "login" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "127.0.0.1:8000" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.3.14" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Date", "value": "Tue, 06 May 2025 22:18:10 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "{\n \"status\": true,\n \"data\": {\n \"success\": true,\n \"token\": \"2|Hnt83jIJMInJ4oPat6Hgrb1emnaBmzkB3wE5anuJeb0f05ac\",\n \"user\": {\n \"id\": 31,\n \"custom_id\": \"EM00000001\",\n \"name\": \"Erwin Monte Mosciski\",\n \"first_name\": \"Erwin\",\n \"middle_name\": \"Monte\",\n \"last_name\": \"Mosciski\",\n \"email\": \"employee3@payrollai.com\",\n \"phone\": \"966550973643\",\n \"email_verified_at\": \"2025-05-07T01:08:30.000000Z\",\n \"account_type\": \"employee\",\n \"verified\": 1,\n \"status\": \"active\",\n \"national_insurance_number\": \"000000273488\",\n \"created_at\": \"2025-05-07T01:08:33.000000Z\",\n \"updated_at\": \"2025-05-07T01:08:33.000000Z\"\n }\n },\n \"messages\": null,\n \"code\": 200\n}" }, { "name": "login", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "identifier", "value": "employee9@company.com", "type": "text" }, { "key": "password", "value": "password123", "type": "text" }, { "key": "custom id", "value": "EM00000001", "type": "text" } ] }, "url": { "raw": "api/login", "host": [ "api" ], "path": [ "login" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Connection", "value": "Keep-Alive" }, { "key": "Keep-Alive", "value": "timeout=5, max=100" }, { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application/json" }, { "key": "x-ratelimit-limit", "value": "60" }, { "key": "x-ratelimit-remaining", "value": "57" }, { "key": "access-control-allow-origin", "value": "*" }, { "key": "content-length", "value": "550" }, { "key": "date", "value": "Tue, 06 May 2025 23:28:45 GMT" }, { "key": "server", "value": "LiteSpeed" }, { "key": "strict-transport-security", "value": "max-age=63072000; includeSubDomains" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "alt-svc", "value": "h3=\":443\"; ma=2592000, h3-29=\":443\"; ma=2592000, h3-Q050=\":443\"; ma=2592000, h3-Q046=\":443\"; ma=2592000, h3-Q043=\":443\"; ma=2592000, quic=\":443\"; ma=2592000; v=\"43,46\"" } ], "cookie": [], "body": "{\n \"status\": true,\n \"data\": {\n \"success\": true,\n \"token\": \"1|m26tbBkRIx8H3xgch0BTptoKArgUO7kRYW2TPlvzc8ff53ce\",\n \"user\": {\n \"id\": 46,\n \"custom_id\": \"EM00000001\",\n \"name\": \"Jake Aliya Hammes\",\n \"first_name\": \"Jake\",\n \"middle_name\": \"Aliya\",\n \"last_name\": \"Hammes\",\n \"email\": \"employee9@company.com\",\n \"phone\": \"966562459630\",\n \"email_verified_at\": \"2025-05-06T19:24:09.000000Z\",\n \"account_type\": \"employee\",\n \"verified\": 1,\n \"status\": \"active\",\n \"national_insurance_number\": \"000000410680\",\n \"created_at\": \"2025-05-06T19:24:11.000000Z\",\n \"updated_at\": \"2025-05-06T19:24:11.000000Z\"\n }\n },\n \"messages\": null,\n \"code\": 200\n}" }, { "name": "login", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "identifier", "value": "hr@company.com", "type": "text" }, { "key": "password", "value": "password123", "type": "text" }, { "key": "custom_id", "value": "HR00000002", "type": "text" } ] }, "url": { "raw": "api/login", "host": [ "api" ], "path": [ "login" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Connection", "value": "Keep-Alive" }, { "key": "Keep-Alive", "value": "timeout=5, max=100" }, { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application/json" }, { "key": "x-ratelimit-limit", "value": "60" }, { "key": "x-ratelimit-remaining", "value": "59" }, { "key": "access-control-allow-origin", "value": "*" }, { "key": "content-length", "value": "538" }, { "key": "date", "value": "Sat, 10 May 2025 05:33:05 GMT" }, { "key": "server", "value": "LiteSpeed" }, { "key": "strict-transport-security", "value": "max-age=63072000; includeSubDomains" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "alt-svc", "value": "h3=\":443\"; ma=2592000, h3-29=\":443\"; ma=2592000, h3-Q050=\":443\"; ma=2592000, h3-Q046=\":443\"; ma=2592000, h3-Q043=\":443\"; ma=2592000, quic=\":443\"; ma=2592000; v=\"43,46\"" } ], "cookie": [], "body": "{\n \"status\": true,\n \"data\": {\n \"success\": true,\n \"token\": \"3|gCKy2AqI5Pc1ECO9pRpPeTC2Gs3G3QomdY9I8dCj57233375\",\n \"user\": {\n \"id\": 1,\n \"custom_id\": \"HR00000001\",\n \"name\": \"Robbie Abby Bednar\",\n \"first_name\": \"Robbie\",\n \"middle_name\": \"Abby\",\n \"last_name\": \"Bednar\",\n \"email\": \"hr@company.com\",\n \"phone\": \"966529908602\",\n \"email_verified_at\": \"2025-05-06T19:24:02.000000Z\",\n \"account_type\": \"hr\",\n \"verified\": 1,\n \"status\": \"active\",\n \"national_insurance_number\": \"000000193682\",\n \"created_at\": \"2025-05-06T19:24:04.000000Z\",\n \"updated_at\": \"2025-05-06T19:24:04.000000Z\"\n }\n },\n \"messages\": null,\n \"code\": 200\n}" }, { "name": "login", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "identifier", "value": "employee16@company.com", "type": "text" }, { "key": "password", "value": "password123", "type": "text" }, { "key": "custom_id", "value": "EM00000012", "type": "text" } ] }, "url": { "raw": "api/login", "host": [ "api" ], "path": [ "login" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Connection", "value": "Keep-Alive" }, { "key": "Keep-Alive", "value": "timeout=5, max=100" }, { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application/json" }, { "key": "x-ratelimit-limit", "value": "60" }, { "key": "x-ratelimit-remaining", "value": "59" }, { "key": "access-control-allow-origin", "value": "*" }, { "key": "content-length", "value": "541" }, { "key": "date", "value": "Sat, 17 May 2025 22:02:04 GMT" }, { "key": "server", "value": "LiteSpeed" }, { "key": "strict-transport-security", "value": "max-age=63072000; includeSubDomains" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "alt-svc", "value": "h3=\":443\"; ma=2592000, h3-29=\":443\"; ma=2592000, h3-Q050=\":443\"; ma=2592000, h3-Q046=\":443\"; ma=2592000, h3-Q043=\":443\"; ma=2592000, quic=\":443\"; ma=2592000; v=\"43,46\"" } ], "cookie": [], "body": "{\n \"status\": true,\n \"data\": {\n \"success\": true,\n \"token\": \"13|b0c5T48KsNH8wBFwJdssIDWVhwwIsm3aIhUAc38u55993e75\",\n \"user\": {\n \"id\": 57,\n \"custom_id\": \"EM00000012\",\n \"name\": \"Nora Nader\",\n \"first_name\": \"Nora\",\n \"middle_name\": null,\n \"last_name\": \"Nader\",\n \"email\": \"employee16@company.com\",\n \"phone\": \"966517346506\",\n \"email_verified_at\": \"2025-05-14T17:08:34.000000Z\",\n \"account_type\": \"employee\",\n \"verified\": 1,\n \"status\": \"active\",\n \"national_insurance_number\": \"000000798097\",\n \"created_at\": \"2025-05-14T17:08:35.000000Z\",\n \"updated_at\": \"2025-05-14T17:08:35.000000Z\"\n }\n },\n \"messages\": null,\n \"code\": 200\n}" } ] }, { "name": "checkIfExistsIn", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "check_from", "value": "phone", "type": "text" }, { "key": "value", "value": "966500500500", "type": "text" }, { "key": "in", "value": "users", "description": "users", "type": "text", "disabled": true } ] }, "url": { "raw": "api/is_available", "host": [ "api" ], "path": [ "is_available" ] }, "description": "users : phone email" }, "response": [ { "name": "checkIfExistsInCustomers", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "check_from", "value": "phone", "type": "text" }, { "key": "value", "value": "966500500500", "type": "text" }, { "key": "in", "value": "users", "type": "text" } ] }, "url": { "raw": "api/is_available", "host": [ "api" ], "path": [ "is_available" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "127.0.0.1:8000" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.3.14" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Date", "value": "Fri, 09 May 2025 18:16:42 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "58" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "{\n \"status\": true,\n \"data\": {\n \"is_available\": true\n },\n \"messages\": null,\n \"code\": 200\n}" } ] } ] }, { "name": "TEXT", "item": [ { "name": "privacyPolicy", "request": { "method": "GET", "header": [], "url": { "raw": "/api/globalText/privacy_policy", "path": [ "api", "globalText", "privacy_policy" ] } }, "response": [ { "name": "privacy_policy", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "/api/globalText/privacy_policy", "path": [ "api", "globalText", "privacy_policy" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "127.0.0.1:8000" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.3.14" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Date", "value": "Fri, 09 May 2025 18:36:18 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "{\n \"status\": true,\n \"data\": {\n \"id\": 1,\n \"key\": \"privacy_policy\",\n \"hyper_text\": \"

Privacy Policy

\\n

We are committed to protecting your personal information and your right to privacy. This Privacy Policy describes how we collect, use, and safeguard your information when you visit our website.

\\n\\\"Privacy\\n

We may collect personal data such as your name, email address, and other information you provide directly to us. We use this information to provide and improve our services.

\\n

For more details, please read the full document or contact our support team.

\",\n \"data\": [],\n \"created_at\": \"2025-05-09T18:36:03.000000Z\",\n \"updated_at\": \"2025-05-09T18:36:03.000000Z\"\n },\n \"messages\": null,\n \"code\": 200\n}" } ] }, { "name": "contact us", "request": { "method": "GET", "header": [], "url": { "raw": "/api/globalText/contact_us", "path": [ "api", "globalText", "contact_us" ] } }, "response": [ { "name": "contact us", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "/api/globalText/contact_us", "path": [ "api", "globalText", "contact_us" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "127.0.0.1:8000" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.3.14" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Date", "value": "Fri, 09 May 2025 18:36:39 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "58" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "{\n \"status\": true,\n \"data\": {\n \"id\": 2,\n \"key\": \"contact_us\",\n \"hyper_text\": \"

Contact Us

\\n

We would love to hear from you! Please feel free to reach out using any of the following methods:

\\n\\\"Contact\\n\\n

Stay connected with us on social media for the latest updates and announcements.

\",\n \"data\": {\n \"email\": \"support@example.com\",\n \"phone\": \"+966123456789\",\n \"address\": \"King Fahad Street, Riyadh, Saudi Arabia\",\n \"twitter\": \"https://twitter.com/example\",\n \"facebook\": \"https://facebook.com/example\",\n \"whatsapp\": \"https://wa.me/966123456789\",\n \"instagram\": \"https://instagram.com/example\"\n },\n \"created_at\": \"2025-05-09T18:36:03.000000Z\",\n \"updated_at\": \"2025-05-09T18:36:03.000000Z\"\n },\n \"messages\": null,\n \"code\": 200\n}" } ] }, { "name": "about_us", "request": { "method": "GET", "header": [], "url": { "raw": "/api/globalText/about_us", "path": [ "api", "globalText", "about_us" ] } }, "response": [ { "name": "about_us", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "/api/globalText/about_us", "path": [ "api", "globalText", "about_us" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "127.0.0.1:8000" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.3.14" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Date", "value": "Fri, 09 May 2025 18:40:07 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "{\n \"status\": true,\n \"data\": {\n \"id\": 4,\n \"key\": \"about_us\",\n \"hyper_text\": \"

About Us

\\n\\n
\\n

Our Mission

\\n \\\"Mission\\\"\\n

Our mission is to empower individuals and businesses through cutting-edge technology and outstanding customer service. We strive to build long-term value and trust with every client we serve.

\\n
\\n\\n
\\n

Our Vision

\\n \\\"Vision\\\"\\n

We envision a connected world where technology bridges gaps and accelerates progress. Our goal is to be a global leader in delivering innovative and scalable digital solutions.

\\n
\\n\\n
\\n

Our Values

\\n \\\"Values\\\"\\n

Integrity, innovation, excellence, and customer focus are the core values that define our culture and guide our actions every day.

\\n
\\n\\n
\\n

Our Services

\\n \\\"Services\\\"\\n

We offer a wide range of services including software development, mobile and web applications, cloud solutions, digital marketing, and IT consulting.

\\n
\\n\\n
\\n

Our Story

\\n \\\"Story\\\"\\n

Founded in 2010, our journey began with a small team and a big dream. Today, we’ve grown into a multinational company serving clients across various industries worldwide.

\\n
\\n\\n
\\n

Meet Our Team

\\n \\\"Team\\\"\\n

Our team consists of passionate professionals from diverse backgrounds, united by a shared vision to deliver the highest quality solutions and support to our clients.

\\n
\\n\\n
\\n

Contact and Location

\\n \\\"Contact\\\"\\n

You can find us at our headquarters or reach us online. Visit our contact page for more details on how to get in touch with us or schedule a consultation.

\\n
\",\n \"data\": [],\n \"created_at\": \"2025-05-09T18:39:46.000000Z\",\n \"updated_at\": \"2025-05-09T18:39:46.000000Z\"\n },\n \"messages\": null,\n \"code\": 200\n}" } ] } ] }, { "name": "Company", "item": [ { "name": "Checkout & Payment", "item": [ { "name": "Company - Subscription & Privacy", "item": [ { "name": "Get Current Subscription", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "/api/company/subscription/current", "path": [ "api", "company", "subscription", "current" ] }, "description": "Get active subscription details for selected company. Role: authenticated company user" }, "response": [] }, { "name": "Get Subscription History", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "/api/company/subscription/history", "path": [ "api", "company", "subscription", "history" ] }, "description": "Get all past and current subscriptions with change history for selected company. Role: authenticated company user" }, "response": [] }, { "name": "Get Available Plans", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "/api/company/plans/available", "path": [ "api", "company", "plans", "available" ] }, "description": "Get all available plans with current subscription status. Role: authenticated company user" }, "response": [] }, { "name": "List Privacy Policies", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "/api/company/privacy-policies?search=&is_active=&sort_by=effective_date&sort=desc&per_page=15", "path": [ "api", "company", "privacy-policies" ], "query": [ { "key": "search", "value": "", "description": "Search in title or version" }, { "key": "is_active", "value": "", "description": "Filter by active status. Options: true, false" }, { "key": "sort_by", "value": "effective_date", "description": "Sort field. Options: id, effective_date, created_at" }, { "key": "sort", "value": "desc", "description": "Sort direction. Options: asc, desc" }, { "key": "per_page", "value": "15", "description": "Records per page" } ] }, "description": "List all privacy policies for your company. Role: authenticated company user" }, "response": [] }, { "name": "Create Privacy Policy", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"title\": \"Privacy Policy\",\n \"content\": \"Full policy content here...\",\n \"version\": \"1.0\",\n \"effective_date\": \"2025-01-01\",\n \"change_summary\": \"Initial policy version\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "/api/company/privacy-policies", "path": [ "api", "company", "privacy-policies" ] }, "description": "Create privacy policy for your company. ⚠️ IMPORTANT: Creating a new policy will DELETE all old policies for your company. Only ONE policy per company is allowed. Role: authenticated company user\n\nParameters:\n- title (required, string, max 255): Policy title\n- content (required, string): Full policy content\n- version (required, string, max 50): Version number\n- effective_date (required, date): When policy becomes effective (YYYY-MM-DD)\n- change_summary (optional, string): Summary of changes from previous version\n\nNote: company_id is automatically taken from your selected company" }, "response": [] }, { "name": "Get Active Privacy Policy", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "/api/company/privacy-policies/active", "path": [ "api", "company", "privacy-policies", "active" ] }, "description": "Get active privacy policy for your company. Role: authenticated company user" }, "response": [] }, { "name": "Get Privacy Policy History", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "/api/company/privacy-policies/history", "path": [ "api", "company", "privacy-policies", "history" ] }, "description": "Get all privacy policy versions for your company ordered by effective date. Role: authenticated company user" }, "response": [] }, { "name": "Get Policy Details", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "/api/company/privacy-policies/1", "path": [ "api", "company", "privacy-policies", "1" ] }, "description": "Get full policy details. Role: authenticated company user" }, "response": [] }, { "name": "Update Privacy Policy", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"title\": \"Updated Privacy Policy\",\n \"is_active\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "/api/company/privacy-policies/1", "path": [ "api", "company", "privacy-policies", "1" ] }, "description": "Update privacy policy. All fields optional. Role: authenticated company user\n\nParameters:\n- title (optional, string, max 255): Policy title\n- content (optional, string): Policy content\n- version (optional, string, max 50): Version\n- is_active (optional, boolean): Active status\n- effective_date (optional, date): Effective date\n- change_summary (optional, string): Change summary" }, "response": [] }, { "name": "Delete Privacy Policy", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "/api/company/privacy-policies/1", "path": [ "api", "company", "privacy-policies", "1" ] }, "description": "Delete privacy policy. Cannot delete active policies. Role: authenticated company user" }, "response": [] }, { "name": "Get Payment Transactions", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "/api/company/payment-transactions?per_page=15", "path": [ "api", "company", "payment-transactions" ], "query": [ { "key": "per_page", "value": "15", "description": "Records per page" } ] }, "description": "Get payment transaction history for selected company. Role: authenticated company user" }, "response": [] } ], "description": "Company users manage their subscription, payment history, and privacy policies. Full CRUD operations for privacy policies. Requires authentication and company selection." }, { "name": "Initiate Checkout", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "multipart/form-data" } ], "body": { "mode": "formdata", "formdata": [ { "key": "company_id", "value": "1", "description": "Required. Company ID (exists:companies,id)", "type": "text" }, { "key": "plan_id", "value": "1", "description": "Required. Plan ID (exists:plans,id)", "type": "text" }, { "key": "payment_method", "value": "bank_transfer", "description": "Required. Payment method. Options: stripe, paypal, bank_transfer, cash", "type": "text" }, { "key": "receipt_file", "description": "Required if payment_method=bank_transfer. Upload receipt file. Max 5MB. Types: jpg, jpeg, png, pdf", "type": "file", "src": [] } ] }, "url": { "raw": "/api/checkout/initiate", "path": [ "api", "checkout", "initiate" ] }, "description": "Start checkout process. Creates subscription and transaction. Returns payment URL for online methods or pending status for manual methods. Role: authenticated\n\nResponse types:\n- Online (stripe/paypal): {type: 'redirect', payment_url: '...', transaction_id: X}\n- Bank Transfer: {type: 'pending_approval', transaction_id: X, status: 'pending'}\n- Cash: {type: 'pending_approval', transaction_id: X, status: 'pending'}" }, "response": [] }, { "name": "Payment Callback (GET)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "/api/payment/callback?transaction_id=1&status=success&gateway_transaction_id=TXN_123&signature=abc123", "path": [ "api", "payment", "callback" ], "query": [ { "key": "transaction_id", "value": "1", "description": "Transaction ID" }, { "key": "status", "value": "success", "description": "Payment status. Options: success, completed, failure, failed" }, { "key": "gateway_transaction_id", "value": "TXN_123", "description": "External gateway transaction ID" }, { "key": "signature", "value": "abc123", "description": "HMAC signature for verification" } ] }, "description": "Handle payment gateway callback. Verifies payment, updates transaction and subscription status, redirects to frontend. No authentication required (called by payment gateway)" }, "response": [] }, { "name": "Payment Callback (POST)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"transaction_id\": 1,\n \"status\": \"success\",\n \"gateway_transaction_id\": \"TXN_123\",\n \"signature\": \"abc123\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "/api/payment/callback", "path": [ "api", "payment", "callback" ] }, "description": "Handle payment gateway callback via POST. Same functionality as GET callback. No authentication required" }, "response": [] }, { "name": "Mock Payment Gateway", "request": { "method": "GET", "header": [], "url": { "raw": "/api/payment/mock?transaction_id=1&amount=99.99¤cy=USD&callback_url=http://localhost:8000/api/payment/callback", "path": [ "api", "payment", "mock" ], "query": [ { "key": "transaction_id", "value": "1", "description": "Transaction ID" }, { "key": "amount", "value": "99.99", "description": "Payment amount" }, { "key": "currency", "value": "USD", "description": "Currency code" }, { "key": "callback_url", "value": "http://localhost:8000/api/payment/callback", "description": "Callback URL to return to" } ] }, "description": "Mock payment gateway UI for testing. Shows payment details with Confirm/Cancel buttons. No authentication required" }, "response": [] }, { "name": "Process Mock Payment", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"transaction_id\": 1,\n \"status\": \"success\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "/api/payment/mock/process", "path": [ "api", "payment", "mock", "process" ] }, "description": "Process mock payment. Simulates gateway callback. No authentication required\n\nParameters:\n- transaction_id (required, exists:payment_transactions,id): Transaction to process\n- status (required, string): Payment result. Options: success, failure" }, "response": [] } ], "description": "Initiate checkout process, handle payment callbacks, and mock payment gateway. Public/authenticated access." }, { "name": "getActiveCompanies", "request": { "method": "GET", "header": [], "url": { "raw": "/api/getActiveCompanies?dropDown=1", "path": [ "api", "getActiveCompanies" ], "query": [ { "key": "dropDown", "value": "1" }, { "key": "per_page", "value": "12", "disabled": true }, { "key": "sort_by", "value": "", "disabled": true }, { "key": "per_page", "value": "", "disabled": true }, { "key": "search", "value": "and Rogahn", "disabled": true } ] } }, "response": [ { "name": "getActiveCompanies", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "/api/getActiveCompanies?dropDown=1", "path": [ "api", "getActiveCompanies" ], "query": [ { "key": "dropDown", "value": "1" }, { "key": "per_page", "value": "12", "disabled": true }, { "key": "sort_by", "value": "", "disabled": true }, { "key": "per_page", "value": "", "disabled": true }, { "key": "search", "value": "and Rogahn", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Connection", "value": "Keep-Alive" }, { "key": "Keep-Alive", "value": "timeout=5, max=100" }, { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application/json" }, { "key": "x-ratelimit-limit", "value": "60" }, { "key": "x-ratelimit-remaining", "value": "59" }, { "key": "access-control-allow-origin", "value": "*" }, { "key": "content-length", "value": "3890" }, { "key": "date", "value": "Fri, 16 May 2025 11:38:07 GMT" }, { "key": "server", "value": "LiteSpeed" }, { "key": "strict-transport-security", "value": "max-age=63072000; includeSubDomains" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "alt-svc", "value": "h3=\":443\"; ma=2592000, h3-29=\":443\"; ma=2592000, h3-Q050=\":443\"; ma=2592000, h3-Q046=\":443\"; ma=2592000, h3-Q043=\":443\"; ma=2592000, quic=\":443\"; ma=2592000; v=\"43,46\"" } ], "cookie": [], "body": "{\n \"status\": true,\n \"data\": [\n {\n \"id\": 602,\n \"name\": \"Trantow PLC\"\n },\n {\n \"id\": 601,\n \"name\": \"Fisher, Bauch and Senger\"\n },\n {\n \"id\": 599,\n \"name\": \"Kris, Medhurst and Carroll\"\n },\n {\n \"id\": 598,\n \"name\": \"Barrows, Parisian and Bode\"\n },\n {\n \"id\": 597,\n \"name\": \"Medhurst PLC\"\n },\n {\n \"id\": 596,\n \"name\": \"Skiles PLC\"\n },\n {\n \"id\": 594,\n \"name\": \"Bernier PLC\"\n },\n {\n \"id\": 593,\n \"name\": \"Corwin, Bogisich and Kilback\"\n },\n {\n \"id\": 592,\n \"name\": \"Gaylord-Hoppe\"\n },\n {\n \"id\": 590,\n \"name\": \"Jacobs, Russel and Rodriguez\"\n },\n {\n \"id\": 589,\n \"name\": \"Jenkins Ltd\"\n },\n {\n \"id\": 588,\n \"name\": \"McCullough, Rowe and Swaniawski\"\n },\n {\n \"id\": 587,\n \"name\": \"Spinka, Ortiz and Welch\"\n },\n {\n \"id\": 586,\n \"name\": \"Gusikowski-Dickens\"\n },\n {\n \"id\": 585,\n \"name\": \"Satterfield, Pfeffer and Fadel\"\n },\n {\n \"id\": 584,\n \"name\": \"Fadel Ltd\"\n },\n {\n \"id\": 583,\n \"name\": \"Goldner Inc\"\n },\n {\n \"id\": 582,\n \"name\": \"Collier, Moen and Schneider\"\n },\n {\n \"id\": 581,\n \"name\": \"Willms and Sons\"\n },\n {\n \"id\": 580,\n \"name\": \"Witting, Reynolds and Mayert\"\n },\n {\n \"id\": 579,\n \"name\": \"Dach PLC\"\n },\n {\n \"id\": 578,\n \"name\": \"Runolfsdottir-Goldner\"\n },\n {\n \"id\": 577,\n \"name\": \"Streich-Treutel\"\n },\n {\n \"id\": 576,\n \"name\": \"McLaughlin, Marvin and Pagac\"\n },\n {\n \"id\": 575,\n \"name\": \"Spinka PLC\"\n },\n {\n \"id\": 574,\n \"name\": \"Fritsch Inc\"\n },\n {\n \"id\": 573,\n \"name\": \"Schowalter, Bruen and Shanahan\"\n },\n {\n \"id\": 572,\n \"name\": \"Towne, Anderson and Sauer\"\n },\n {\n \"id\": 571,\n \"name\": \"Beahan-Halvorson\"\n },\n {\n \"id\": 570,\n \"name\": \"Klocko-Emmerich\"\n },\n {\n \"id\": 569,\n \"name\": \"Lindgren-Kozey\"\n },\n {\n \"id\": 568,\n \"name\": \"Leuschke, Wolf and Wunsch\"\n },\n {\n \"id\": 566,\n \"name\": \"Lueilwitz PLC\"\n },\n {\n \"id\": 565,\n \"name\": \"Maggio, Jaskolski and Turner\"\n },\n {\n \"id\": 564,\n \"name\": \"Mohr and Sons\"\n },\n {\n \"id\": 563,\n \"name\": \"Tromp, Bailey and Mosciski\"\n },\n {\n \"id\": 561,\n \"name\": \"Hirthe, Wehner and Weber\"\n },\n {\n \"id\": 560,\n \"name\": \"Bode-Wisoky\"\n },\n {\n \"id\": 559,\n \"name\": \"Heidenreich PLC\"\n },\n {\n \"id\": 558,\n \"name\": \"Rath-Lowe\"\n },\n {\n \"id\": 557,\n \"name\": \"Ledner Ltd\"\n },\n {\n \"id\": 556,\n \"name\": \"Mraz, O'Keefe and Rippin\"\n },\n {\n \"id\": 555,\n \"name\": \"Haley-Bergnaum\"\n },\n {\n \"id\": 553,\n \"name\": \"Lueilwitz Inc\"\n },\n {\n \"id\": 552,\n \"name\": \"Dickens LLC\"\n },\n {\n \"id\": 551,\n \"name\": \"Durgan and Sons\"\n },\n {\n \"id\": 550,\n \"name\": \"Carter Inc\"\n },\n {\n \"id\": 549,\n \"name\": \"Hartmann Group\"\n },\n {\n \"id\": 548,\n \"name\": \"Dare PLC\"\n },\n {\n \"id\": 547,\n \"name\": \"Pollich PLC\"\n },\n {\n \"id\": 546,\n \"name\": \"Orn, Mante and Bradtke\"\n },\n {\n \"id\": 545,\n \"name\": \"Weimann, Herzog and Wuckert\"\n },\n {\n \"id\": 544,\n \"name\": \"Hickle, Boyle and Hamill\"\n },\n {\n \"id\": 543,\n \"name\": \"Mayer, Konopelski and Carter\"\n },\n {\n \"id\": 542,\n \"name\": \"Ledner PLC\"\n },\n {\n \"id\": 541,\n \"name\": \"Yundt Inc\"\n },\n {\n \"id\": 540,\n \"name\": \"Emmerich-Kessler\"\n },\n {\n \"id\": 539,\n \"name\": \"O'Reilly-Yost\"\n },\n {\n \"id\": 538,\n \"name\": \"Orn-Zulauf\"\n },\n {\n \"id\": 537,\n \"name\": \"Keeling, Terry and Donnelly\"\n },\n {\n \"id\": 536,\n \"name\": \"Heidenreich-Hauck\"\n },\n {\n \"id\": 535,\n \"name\": \"Weissnat-Heaney\"\n },\n {\n \"id\": 533,\n \"name\": \"Volkman, Fadel and Muller\"\n },\n {\n \"id\": 531,\n \"name\": \"Torp-Hudson\"\n },\n {\n \"id\": 530,\n \"name\": \"Turner Ltd\"\n },\n {\n \"id\": 529,\n \"name\": \"Brown Group\"\n },\n {\n \"id\": 528,\n \"name\": \"Bartell-Wunsch\"\n },\n {\n \"id\": 527,\n \"name\": \"Friesen-Welch\"\n },\n {\n \"id\": 526,\n \"name\": \"Kunze, Price and Klein\"\n },\n {\n \"id\": 525,\n \"name\": \"Dach PLC\"\n },\n {\n \"id\": 524,\n \"name\": \"Jones and Sons\"\n },\n {\n \"id\": 523,\n \"name\": \"Gislason, Collins and Wiza\"\n },\n {\n \"id\": 522,\n \"name\": \"Auer, Koss and Murray\"\n },\n {\n \"id\": 521,\n \"name\": \"Medhurst-Kris\"\n },\n {\n \"id\": 520,\n \"name\": \"Schulist Inc\"\n },\n {\n \"id\": 519,\n \"name\": \"Kemmer LLC\"\n },\n {\n \"id\": 518,\n \"name\": \"Weimann and Sons\"\n },\n {\n \"id\": 517,\n \"name\": \"Abshire PLC\"\n },\n {\n \"id\": 516,\n \"name\": \"Lind and Sons\"\n },\n {\n \"id\": 515,\n \"name\": \"Smitham-Witting\"\n },\n {\n \"id\": 514,\n \"name\": \"Langworth-Ward\"\n },\n {\n \"id\": 513,\n \"name\": \"Eichmann, Larkin and Zieme\"\n },\n {\n \"id\": 512,\n \"name\": \"Keebler-Bartell\"\n },\n {\n \"id\": 511,\n \"name\": \"Larson-Langosh\"\n },\n {\n \"id\": 510,\n \"name\": \"Yost, Dicki and Osinski\"\n },\n {\n \"id\": 509,\n \"name\": \"Blick, Hammes and Sawayn\"\n },\n {\n \"id\": 508,\n \"name\": \"Kohler Ltd\"\n },\n {\n \"id\": 507,\n \"name\": \"Rath-Oberbrunner\"\n },\n {\n \"id\": 505,\n \"name\": \"Murazik Ltd\"\n },\n {\n \"id\": 504,\n \"name\": \"O'Kon Group\"\n },\n {\n \"id\": 503,\n \"name\": \"Swaniawski, Rowe and Rath\"\n },\n {\n \"id\": 501,\n \"name\": \"Smitham-Price\"\n },\n {\n \"id\": 500,\n \"name\": \"Boyle-Koch\"\n },\n {\n \"id\": 499,\n \"name\": \"Lehner Group\"\n },\n {\n \"id\": 498,\n \"name\": \"Romaguera-Rowe\"\n },\n {\n \"id\": 497,\n \"name\": \"Medhurst, Stanton and Wintheiser\"\n },\n {\n \"id\": 496,\n \"name\": \"Kuvalis, Schamberger and Mertz\"\n },\n {\n \"id\": 495,\n \"name\": \"Kuvalis, Paucek and Kohler\"\n },\n {\n \"id\": 494,\n \"name\": \"Beer, Gleason and Keebler\"\n },\n {\n \"id\": 493,\n \"name\": \"Emard, Schinner and Gibson\"\n }\n ],\n \"messages\": null,\n \"code\": 200\n}" } ] }, { "name": "getCompaniesWithMembershipStatus", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "GET", "header": [], "url": { "raw": "/api/getCompaniesWithMembershipStatus?dropDown=1&membership=0", "path": [ "api", "getCompaniesWithMembershipStatus" ], "query": [ { "key": "dropDown", "value": "1" }, { "key": "per_page", "value": "12", "disabled": true }, { "key": "sort_by", "value": "", "disabled": true }, { "key": "per_page", "value": "", "disabled": true }, { "key": "search", "value": "and Rogahn", "disabled": true }, { "key": "membership", "value": "0", "description": "1,0" } ] } }, "response": [ { "name": "getActiveCompanies Copy", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "/api/getCompaniesWithMembershipStatus?dropDown=1&membership=0", "path": [ "api", "getCompaniesWithMembershipStatus" ], "query": [ { "key": "dropDown", "value": "1" }, { "key": "per_page", "value": "12", "disabled": true }, { "key": "sort_by", "value": "", "disabled": true }, { "key": "per_page", "value": "", "disabled": true }, { "key": "search", "value": "and Rogahn", "disabled": true }, { "key": "membership", "value": "0", "description": "1,0" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Connection", "value": "Keep-Alive" }, { "key": "Keep-Alive", "value": "timeout=5, max=100" }, { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application/json" }, { "key": "x-ratelimit-limit", "value": "60" }, { "key": "x-ratelimit-remaining", "value": "58" }, { "key": "access-control-allow-origin", "value": "*" }, { "key": "content-length", "value": "29451" }, { "key": "date", "value": "Fri, 16 May 2025 11:38:01 GMT" }, { "key": "server", "value": "LiteSpeed" }, { "key": "strict-transport-security", "value": "max-age=63072000; includeSubDomains" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "x-content-type-options", "value": "nosniff" } ], "cookie": [], "body": "{\n \"status\": true,\n \"data\": [\n {\n \"id\": 601,\n \"name\": \"Fisher, Bauch and Senger\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 599,\n \"name\": \"Kris, Medhurst and Carroll\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 598,\n \"name\": \"Barrows, Parisian and Bode\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 597,\n \"name\": \"Medhurst PLC\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 596,\n \"name\": \"Skiles PLC\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 594,\n \"name\": \"Bernier PLC\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 593,\n \"name\": \"Corwin, Bogisich and Kilback\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 592,\n \"name\": \"Gaylord-Hoppe\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 590,\n \"name\": \"Jacobs, Russel and Rodriguez\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 589,\n \"name\": \"Jenkins Ltd\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 588,\n \"name\": \"McCullough, Rowe and Swaniawski\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 587,\n \"name\": \"Spinka, Ortiz and Welch\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 586,\n \"name\": \"Gusikowski-Dickens\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 585,\n \"name\": \"Satterfield, Pfeffer and Fadel\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 584,\n \"name\": \"Fadel Ltd\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 583,\n \"name\": \"Goldner Inc\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 582,\n \"name\": \"Collier, Moen and Schneider\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 581,\n \"name\": \"Willms and Sons\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 580,\n \"name\": \"Witting, Reynolds and Mayert\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 579,\n \"name\": \"Dach PLC\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 578,\n \"name\": \"Runolfsdottir-Goldner\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 577,\n \"name\": \"Streich-Treutel\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 576,\n \"name\": \"McLaughlin, Marvin and Pagac\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 575,\n \"name\": \"Spinka PLC\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 574,\n \"name\": \"Fritsch Inc\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 573,\n \"name\": \"Schowalter, Bruen and Shanahan\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 572,\n \"name\": \"Towne, Anderson and Sauer\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 571,\n \"name\": \"Beahan-Halvorson\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 570,\n \"name\": \"Klocko-Emmerich\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 569,\n \"name\": \"Lindgren-Kozey\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 568,\n \"name\": \"Leuschke, Wolf and Wunsch\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 566,\n \"name\": \"Lueilwitz PLC\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 565,\n \"name\": \"Maggio, Jaskolski and Turner\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 564,\n \"name\": \"Mohr and Sons\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 563,\n \"name\": \"Tromp, Bailey and Mosciski\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 561,\n \"name\": \"Hirthe, Wehner and Weber\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 560,\n \"name\": \"Bode-Wisoky\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 559,\n \"name\": \"Heidenreich PLC\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 558,\n \"name\": \"Rath-Lowe\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 557,\n \"name\": \"Ledner Ltd\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 556,\n \"name\": \"Mraz, O'Keefe and Rippin\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 555,\n \"name\": \"Haley-Bergnaum\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 553,\n \"name\": \"Lueilwitz Inc\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 552,\n \"name\": \"Dickens LLC\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 551,\n \"name\": \"Durgan and Sons\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 550,\n \"name\": \"Carter Inc\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 549,\n \"name\": \"Hartmann Group\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 548,\n \"name\": \"Dare PLC\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 547,\n \"name\": \"Pollich PLC\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 546,\n \"name\": \"Orn, Mante and Bradtke\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 545,\n \"name\": \"Weimann, Herzog and Wuckert\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 544,\n \"name\": \"Hickle, Boyle and Hamill\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 543,\n \"name\": \"Mayer, Konopelski and Carter\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 542,\n \"name\": \"Ledner PLC\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 541,\n \"name\": \"Yundt Inc\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 540,\n \"name\": \"Emmerich-Kessler\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 539,\n \"name\": \"O'Reilly-Yost\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 538,\n \"name\": \"Orn-Zulauf\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 537,\n \"name\": \"Keeling, Terry and Donnelly\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 536,\n \"name\": \"Heidenreich-Hauck\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 535,\n \"name\": \"Weissnat-Heaney\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 533,\n \"name\": \"Volkman, Fadel and Muller\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 531,\n \"name\": \"Torp-Hudson\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 530,\n \"name\": \"Turner Ltd\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 529,\n \"name\": \"Brown Group\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 528,\n \"name\": \"Bartell-Wunsch\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 527,\n \"name\": \"Friesen-Welch\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 526,\n \"name\": \"Kunze, Price and Klein\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 525,\n \"name\": \"Dach PLC\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 524,\n \"name\": \"Jones and Sons\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 523,\n \"name\": \"Gislason, Collins and Wiza\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 522,\n \"name\": \"Auer, Koss and Murray\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 521,\n \"name\": \"Medhurst-Kris\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 520,\n \"name\": \"Schulist Inc\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 519,\n \"name\": \"Kemmer LLC\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 518,\n \"name\": \"Weimann and Sons\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 517,\n \"name\": \"Abshire PLC\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 516,\n \"name\": \"Lind and Sons\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 515,\n \"name\": \"Smitham-Witting\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 514,\n \"name\": \"Langworth-Ward\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 513,\n \"name\": \"Eichmann, Larkin and Zieme\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 512,\n \"name\": \"Keebler-Bartell\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 511,\n \"name\": \"Larson-Langosh\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 510,\n \"name\": \"Yost, Dicki and Osinski\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 509,\n \"name\": \"Blick, Hammes and Sawayn\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 508,\n \"name\": \"Kohler Ltd\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 507,\n \"name\": \"Rath-Oberbrunner\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 505,\n \"name\": \"Murazik Ltd\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 504,\n \"name\": \"O'Kon Group\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 503,\n \"name\": \"Swaniawski, Rowe and Rath\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 501,\n \"name\": \"Smitham-Price\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 500,\n \"name\": \"Boyle-Koch\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 499,\n \"name\": \"Lehner Group\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 498,\n \"name\": \"Romaguera-Rowe\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 497,\n \"name\": \"Medhurst, Stanton and Wintheiser\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 496,\n \"name\": \"Kuvalis, Schamberger and Mertz\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 495,\n \"name\": \"Kuvalis, Paucek and Kohler\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 494,\n \"name\": \"Beer, Gleason and Keebler\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 493,\n \"name\": \"Emard, Schinner and Gibson\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 492,\n \"name\": \"Deckow-Turner\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 491,\n \"name\": \"Marvin, Tromp and Pacocha\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 490,\n \"name\": \"Howell, Gibson and Stark\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 489,\n \"name\": \"Krajcik, Cummerata and Koch\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 488,\n \"name\": \"Considine, Ankunding and Rath\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 487,\n \"name\": \"Beer LLC\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 486,\n \"name\": \"Daniel LLC\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 485,\n \"name\": \"Lynch, Frami and Daniel\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 483,\n \"name\": \"Leffler-Fahey\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 481,\n \"name\": \"Reichert PLC\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 480,\n \"name\": \"Wintheiser, Bogisich and Powlowski\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 479,\n \"name\": \"Walter and Sons\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 477,\n \"name\": \"Cummings LLC\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 476,\n \"name\": \"Morar, Keeling and Franecki\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 474,\n \"name\": \"O'Conner-Jenkins\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 472,\n \"name\": \"Hickle-Kunze\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 471,\n \"name\": \"Murazik Inc\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 470,\n \"name\": \"Reynolds LLC\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 468,\n \"name\": \"Wuckert Inc\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 467,\n \"name\": \"Strosin-Fritsch\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 465,\n \"name\": \"Cummerata-Thompson\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 464,\n \"name\": \"Wolf, Turner and Balistreri\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 463,\n \"name\": \"Reilly-Vandervort\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 462,\n \"name\": \"Sauer, Bergnaum and Sanford\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 460,\n \"name\": \"Wiegand Ltd\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 459,\n \"name\": \"Grady, Harber and Becker\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 458,\n \"name\": \"Mosciski-Brown\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 456,\n \"name\": \"Rohan, Schiller and Gaylord\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 455,\n \"name\": \"Altenwerth Inc\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 454,\n \"name\": \"Hand-Bins\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 452,\n \"name\": \"Hintz-Christiansen\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 451,\n \"name\": \"Oberbrunner, Bailey and Ullrich\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 450,\n \"name\": \"Corkery, Schoen and Schulist\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 449,\n \"name\": \"Tillman, Schuster and Watsica\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 448,\n \"name\": \"Ondricka, Waters and Veum\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 447,\n \"name\": \"Franecki LLC\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 446,\n \"name\": \"Osinski, Brekke and Kerluke\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 445,\n \"name\": \"McLaughlin, Lindgren and Hegmann\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 443,\n \"name\": \"Stracke, Shanahan and Schuster\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 442,\n \"name\": \"Monahan-Bartell\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 441,\n \"name\": \"Hand-Wilderman\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 440,\n \"name\": \"Schuppe, Kovacek and Bernier\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 437,\n \"name\": \"Corwin PLC\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 436,\n \"name\": \"Lockman, Dickens and Vandervort\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 435,\n \"name\": \"Hegmann-Parker\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 434,\n \"name\": \"Cruickshank-Kemmer\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 433,\n \"name\": \"Swift-Gerhold\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 432,\n \"name\": \"Pfeffer PLC\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 431,\n \"name\": \"Balistreri and Sons\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 430,\n \"name\": \"O'Conner, McClure and Nolan\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 428,\n \"name\": \"Feil Inc\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 427,\n \"name\": \"Schaden LLC\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 426,\n \"name\": \"Lehner and Sons\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 425,\n \"name\": \"Ward, Friesen and Wilderman\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 424,\n \"name\": \"Ziemann LLC\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 423,\n \"name\": \"Johnson Ltd\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 422,\n \"name\": \"Kilback and Sons\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 421,\n \"name\": \"Rippin, Simonis and Bailey\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 420,\n \"name\": \"Jenkins, Wilderman and Waters\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 419,\n \"name\": \"Feeney PLC\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 418,\n \"name\": \"Frami-McGlynn\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 417,\n \"name\": \"Schaefer-Gerlach\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 416,\n \"name\": \"Hermann PLC\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 415,\n \"name\": \"Crist-Hills\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 414,\n \"name\": \"Kutch, Predovic and Ullrich\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 413,\n \"name\": \"Hauck-Tillman\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 412,\n \"name\": \"Johnson-Bahringer\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 411,\n \"name\": \"Ryan Ltd\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 410,\n \"name\": \"Yundt, Mertz and Tillman\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 409,\n \"name\": \"Abbott, Schamberger and Boyle\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 408,\n \"name\": \"Roob, Streich and Hackett\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 407,\n \"name\": \"Schoen-Feil\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 406,\n \"name\": \"Dickens Group\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 405,\n \"name\": \"Pagac, Boehm and Hahn\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 404,\n \"name\": \"Swaniawski PLC\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 403,\n \"name\": \"Crist-Schinner\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 402,\n \"name\": \"Balistreri, Lemke and Kunze\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 401,\n \"name\": \"Skiles, Bednar and Rau\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 400,\n \"name\": \"Predovic LLC\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 399,\n \"name\": \"Rau Group\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 398,\n \"name\": \"King, Kshlerin and Goyette\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 397,\n \"name\": \"Greenfelder-Hirthe\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 396,\n \"name\": \"Johns, Swaniawski and Watsica\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 395,\n \"name\": \"Robel-Swift\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 394,\n \"name\": \"Gleichner-Donnelly\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 393,\n \"name\": \"Von, Veum and Beer\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 392,\n \"name\": \"Cartwright-Dach\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 391,\n \"name\": \"Maggio, Jaskolski and Walsh\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 390,\n \"name\": \"Nolan, Trantow and Maggio\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 389,\n \"name\": \"Pacocha, Shields and Hickle\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 388,\n \"name\": \"Kohler, Koelpin and Hyatt\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 387,\n \"name\": \"Legros Group\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 386,\n \"name\": \"Schulist LLC\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 385,\n \"name\": \"Pfeffer, Daniel and Langosh\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 384,\n \"name\": \"Lowe-Becker\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 383,\n \"name\": \"Reynolds, Bashirian and Bahringer\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 382,\n \"name\": \"Murray-Tillman\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 381,\n \"name\": \"Friesen-Hoeger\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 380,\n \"name\": \"Fay, Rodriguez and Ledner\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 379,\n \"name\": \"Bednar Group\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 378,\n \"name\": \"Paucek-Schimmel\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 377,\n \"name\": \"Wisozk, Flatley and Parisian\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 376,\n \"name\": \"Bayer-Emmerich\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 375,\n \"name\": \"Sporer LLC\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 374,\n \"name\": \"Dooley, Windler and Kunde\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 373,\n \"name\": \"Roob, Corkery and Reinger\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 371,\n \"name\": \"Witting, Metz and Bahringer\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 368,\n \"name\": \"Zemlak-Hirthe\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 367,\n \"name\": \"Lockman Ltd\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 366,\n \"name\": \"Murray-Heidenreich\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 365,\n \"name\": \"Wuckert and Sons\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 364,\n \"name\": \"Halvorson, Robel and Emard\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 363,\n \"name\": \"Feil Ltd\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 361,\n \"name\": \"Sporer-Ward\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 360,\n \"name\": \"Vandervort, Reilly and Brakus\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 359,\n \"name\": \"Muller, Botsford and Hartmann\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 358,\n \"name\": \"Rodriguez, Hills and Kulas\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 357,\n \"name\": \"Fritsch, Jast and Halvorson\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 356,\n \"name\": \"Gerlach, Jacobi and Davis\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 355,\n \"name\": \"Quigley, Schimmel and Jerde\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 354,\n \"name\": \"Upton, Feeney and Medhurst\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 353,\n \"name\": \"Jones Inc\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 352,\n \"name\": \"Will, Kunze and Terry\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 350,\n \"name\": \"Strosin-Corkery\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 349,\n \"name\": \"Keeling, Hills and Miller\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 348,\n \"name\": \"Herman, McClure and Rodriguez\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 347,\n \"name\": \"Goyette, Gislason and Bradtke\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 346,\n \"name\": \"Langosh-O'Conner\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 345,\n \"name\": \"Ankunding-Emard\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 344,\n \"name\": \"Windler PLC\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 343,\n \"name\": \"Streich-Orn\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 342,\n \"name\": \"Stanton-Stamm\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 341,\n \"name\": \"Thiel, Gerhold and Bode\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 340,\n \"name\": \"Windler Inc\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 339,\n \"name\": \"Skiles, Blanda and Pagac\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 338,\n \"name\": \"Hoppe, Douglas and Bednar\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 337,\n \"name\": \"Hackett-Hagenes\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 336,\n \"name\": \"Rodriguez-Hoeger\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 335,\n \"name\": \"Hahn, Sanford and Green\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 334,\n \"name\": \"Von, Corkery and Maggio\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 333,\n \"name\": \"Ritchie and Sons\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 332,\n \"name\": \"Schinner, Ondricka and Hartmann\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 331,\n \"name\": \"Yundt-Bechtelar\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 330,\n \"name\": \"Pfannerstill Group\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 329,\n \"name\": \"Halvorson PLC\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 327,\n \"name\": \"Fadel-West\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 326,\n \"name\": \"Nolan-Spinka\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 325,\n \"name\": \"Kovacek-Bauch\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 324,\n \"name\": \"Quitzon-Fadel\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 323,\n \"name\": \"Hammes, Walsh and Stracke\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 322,\n \"name\": \"Pouros Inc\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 321,\n \"name\": \"Streich-Ondricka\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 320,\n \"name\": \"Hartmann-Farrell\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 319,\n \"name\": \"Bauch, Abshire and Kozey\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 318,\n \"name\": \"Reichert Inc\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 317,\n \"name\": \"Boehm-Goodwin\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 316,\n \"name\": \"O'Reilly, Hermann and Windler\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 315,\n \"name\": \"Green Inc\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 314,\n \"name\": \"Romaguera-Herman\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 313,\n \"name\": \"Gottlieb Ltd\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 311,\n \"name\": \"Koelpin Group\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 310,\n \"name\": \"Lang, D'Amore and Jacobs\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 309,\n \"name\": \"Boyle-Reilly\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 308,\n \"name\": \"Johnston Inc\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 306,\n \"name\": \"Okuneva-Batz\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 305,\n \"name\": \"Gerlach-Reichel\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 304,\n \"name\": \"Stokes-Donnelly\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 303,\n \"name\": \"Kerluke, Cummerata and Weimann\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 302,\n \"name\": \"Collins-Halvorson\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 301,\n \"name\": \"Schultz PLC\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 300,\n \"name\": \"Von-Osinski\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 299,\n \"name\": \"Sauer Inc\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 298,\n \"name\": \"Koelpin-Zieme\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 297,\n \"name\": \"Baumbach-Runolfsdottir\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 296,\n \"name\": \"Kris PLC\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 295,\n \"name\": \"Parisian, McLaughlin and Koss\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 294,\n \"name\": \"Kris, Schamberger and Hammes\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 293,\n \"name\": \"Bergnaum, Champlin and Boyle\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 292,\n \"name\": \"Wiegand, Ernser and Johnson\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 291,\n \"name\": \"Terry, Barton and Dicki\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 290,\n \"name\": \"Kuvalis, Klein and Sanford\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 289,\n \"name\": \"Bahringer-Cassin\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 288,\n \"name\": \"Collins, Wiegand and Monahan\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 287,\n \"name\": \"Windler-Thiel\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 286,\n \"name\": \"Reichert-Johnson\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 285,\n \"name\": \"Stanton PLC\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 284,\n \"name\": \"Schuster, Balistreri and Sipes\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 283,\n \"name\": \"Dooley-Schaefer\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 281,\n \"name\": \"Kertzmann-Shields\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 280,\n \"name\": \"Hayes-Muller\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 279,\n \"name\": \"Stokes Ltd\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 278,\n \"name\": \"Heathcote LLC\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 277,\n \"name\": \"Bosco Inc\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 275,\n \"name\": \"Turner PLC\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 274,\n \"name\": \"Rempel, Deckow and Romaguera\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 272,\n \"name\": \"Jenkins Ltd\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 269,\n \"name\": \"Deckow, Larson and Cronin\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 268,\n \"name\": \"Murray LLC\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 267,\n \"name\": \"Kilback PLC\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 266,\n \"name\": \"Skiles, Erdman and Weimann\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 264,\n \"name\": \"Murphy, West and Stracke\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 263,\n \"name\": \"Kemmer, McDermott and Jast\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 262,\n \"name\": \"Lueilwitz-Ryan\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 261,\n \"name\": \"Ullrich Group\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 260,\n \"name\": \"Fisher, Welch and Hill\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 259,\n \"name\": \"Schmeler-Sauer\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 258,\n \"name\": \"Cormier-Conn\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 257,\n \"name\": \"Rau Ltd\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 256,\n \"name\": \"Langosh-Wisoky\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 255,\n \"name\": \"Koelpin and Sons\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 254,\n \"name\": \"Schultz-Rempel\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 252,\n \"name\": \"Cremin-Will\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 251,\n \"name\": \"Thiel and Sons\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 250,\n \"name\": \"Emmerich-Effertz\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 249,\n \"name\": \"Collins, Ziemann and Fahey\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 248,\n \"name\": \"Flatley, Lakin and Walter\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 247,\n \"name\": \"Homenick and Sons\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 246,\n \"name\": \"Hahn-Zemlak\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 245,\n \"name\": \"Stoltenberg LLC\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 244,\n \"name\": \"Luettgen-Bradtke\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 243,\n \"name\": \"Kuvalis and Sons\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 242,\n \"name\": \"Lindgren PLC\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 240,\n \"name\": \"Shanahan Group\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 239,\n \"name\": \"Brekke-Farrell\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 238,\n \"name\": \"Pfeffer, Vandervort and Kunze\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 235,\n \"name\": \"Kuhlman-Sanford\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 234,\n \"name\": \"Keebler PLC\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 233,\n \"name\": \"Marks, Walker and Veum\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 232,\n \"name\": \"Graham and Sons\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 231,\n \"name\": \"Bernier, Haley and Hoppe\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 230,\n \"name\": \"Hessel-Hayes\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 229,\n \"name\": \"Hackett-Hammes\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 228,\n \"name\": \"Deckow-Stracke\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 227,\n \"name\": \"Langosh, Nitzsche and Rodriguez\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 226,\n \"name\": \"Gibson, Torp and DuBuque\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 225,\n \"name\": \"Prohaska, Haley and Hirthe\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 224,\n \"name\": \"Marquardt, Stehr and Heller\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 223,\n \"name\": \"Quigley-Botsford\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 222,\n \"name\": \"Schultz-Auer\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 221,\n \"name\": \"Kertzmann, Armstrong and Goodwin\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 220,\n \"name\": \"Jast LLC\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 219,\n \"name\": \"Will, Durgan and Runte\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 218,\n \"name\": \"Medhurst Inc\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 217,\n \"name\": \"Deckow, Brakus and Lind\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 214,\n \"name\": \"Mitchell-Anderson\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 213,\n \"name\": \"Pouros-Yundt\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 212,\n \"name\": \"Runolfsdottir, Bahringer and Hahn\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 211,\n \"name\": \"Grant Inc\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 210,\n \"name\": \"Kertzmann-Cassin\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 209,\n \"name\": \"Altenwerth, Medhurst and Gorczany\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 207,\n \"name\": \"Dooley, Schmitt and Pouros\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 205,\n \"name\": \"Trantow, Gibson and Tillman\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 203,\n \"name\": \"Waelchi, Kuphal and Corwin\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 201,\n \"name\": \"Shields PLC\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 200,\n \"name\": \"Berge-Feest\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 199,\n \"name\": \"Davis, Ward and Armstrong\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 198,\n \"name\": \"Doyle, Harber and Beer\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 197,\n \"name\": \"VonRueden-Jenkins\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 196,\n \"name\": \"Block, Becker and Kuhlman\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 195,\n \"name\": \"Willms-Blanda\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 194,\n \"name\": \"Kunze, Kulas and Bechtelar\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 193,\n \"name\": \"Marvin-Jacobson\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 191,\n \"name\": \"Reilly-Abernathy\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 190,\n \"name\": \"Wisoky-Daugherty\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 189,\n \"name\": \"Ryan, Walker and Spinka\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 188,\n \"name\": \"Barrows, Boyer and Dietrich\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 187,\n \"name\": \"Wilderman, Mann and Jakubowski\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 186,\n \"name\": \"Conn and Sons\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 185,\n \"name\": \"Ritchie and Sons\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 184,\n \"name\": \"Bradtke and Sons\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 183,\n \"name\": \"Keebler, Reichert and Kunde\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 182,\n \"name\": \"Erdman and Sons\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 181,\n \"name\": \"Moore-Block\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 180,\n \"name\": \"Crona Inc\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 178,\n \"name\": \"Gleason, Gorczany and Cremin\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 177,\n \"name\": \"Ward, Reinger and Walter\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 176,\n \"name\": \"Hill-Green\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 175,\n \"name\": \"Hills, Hansen and Leannon\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 174,\n \"name\": \"Ward-Weissnat\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 173,\n \"name\": \"Rippin, Nikolaus and Kreiger\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 172,\n \"name\": \"VonRueden, Hammes and Lowe\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 171,\n \"name\": \"Friesen-Mraz\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 170,\n \"name\": \"Nitzsche, Towne and Will\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 169,\n \"name\": \"Fritsch Group\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 168,\n \"name\": \"Aufderhar, Lindgren and Mueller\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 167,\n \"name\": \"Walter, Larson and Ziemann\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 166,\n \"name\": \"Douglas Group\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 165,\n \"name\": \"Heller-Doyle\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 164,\n \"name\": \"Blanda Ltd\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 163,\n \"name\": \"Walsh and Sons\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 162,\n \"name\": \"Raynor, Boyer and Feeney\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 159,\n \"name\": \"Swift-Fahey\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 158,\n \"name\": \"Stoltenberg, Padberg and Morissette\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 157,\n \"name\": \"Littel PLC\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 156,\n \"name\": \"Bode, Buckridge and Roberts\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 154,\n \"name\": \"McCullough-Grimes\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 153,\n \"name\": \"Welch-Schuster\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 152,\n \"name\": \"Heaney-Funk\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 151,\n \"name\": \"Durgan-Rutherford\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 150,\n \"name\": \"Wunsch Inc\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 149,\n \"name\": \"Lemke and Sons\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 148,\n \"name\": \"Boyle, Rogahn and Yost\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 147,\n \"name\": \"Harber-Reilly\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 145,\n \"name\": \"Graham Ltd\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 144,\n \"name\": \"Predovic-Ortiz\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 143,\n \"name\": \"Baumbach and Sons\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 142,\n \"name\": \"Casper Ltd\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 141,\n \"name\": \"Bernier Inc\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 140,\n \"name\": \"Roob LLC\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 139,\n \"name\": \"Kilback-Kassulke\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 138,\n \"name\": \"Jerde LLC\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 137,\n \"name\": \"Waters-Fadel\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 135,\n \"name\": \"Borer-Dicki\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 134,\n \"name\": \"Wyman, Lockman and McGlynn\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 133,\n \"name\": \"Koelpin-Batz\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 132,\n \"name\": \"Mann Group\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 131,\n \"name\": \"Wilkinson, Zieme and Kreiger\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 130,\n \"name\": \"Cronin and Sons\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 129,\n \"name\": \"Kertzmann-Feeney\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 128,\n \"name\": \"Larkin-Heaney\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 127,\n \"name\": \"Lockman and Sons\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 126,\n \"name\": \"Dickens-Yost\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 125,\n \"name\": \"Schumm, Schmeler and Lynch\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 124,\n \"name\": \"Sipes, Cartwright and Gleason\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 122,\n \"name\": \"Torp PLC\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 121,\n \"name\": \"Kris LLC\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 120,\n \"name\": \"Powlowski PLC\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 119,\n \"name\": \"Deckow, Effertz and Wunsch\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 117,\n \"name\": \"Borer-Lindgren\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 116,\n \"name\": \"Lowe-Feest\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 115,\n \"name\": \"Tromp and Sons\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 114,\n \"name\": \"Lebsack Ltd\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 113,\n \"name\": \"Runolfsson, Wolf and Cruickshank\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 112,\n \"name\": \"Larson-Abernathy\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 111,\n \"name\": \"Johnston LLC\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 110,\n \"name\": \"Feil, Monahan and Batz\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 108,\n \"name\": \"Thompson Group\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 107,\n \"name\": \"Mosciski-Stamm\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 106,\n \"name\": \"O'Kon, Ullrich and Cassin\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 105,\n \"name\": \"Hyatt PLC\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 104,\n \"name\": \"Crona, Funk and Zieme\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 103,\n \"name\": \"Weber Ltd\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 102,\n \"name\": \"Bartoletti and Sons\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 101,\n \"name\": \"Roberts, Schneider and Nicolas\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 100,\n \"name\": \"Adams and Sons\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 99,\n \"name\": \"Ullrich, Rohan and Turcotte\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 98,\n \"name\": \"Abshire, Osinski and Stehr\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 97,\n \"name\": \"Marvin Group\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 96,\n \"name\": \"Yost-Koelpin\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 95,\n \"name\": \"Pagac, Labadie and Lebsack\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 94,\n \"name\": \"Schuster-Weber\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 93,\n \"name\": \"Kihn-Schaden\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 92,\n \"name\": \"Brakus-Orn\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 91,\n \"name\": \"Dietrich, Jacobson and Altenwerth\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 88,\n \"name\": \"Zulauf Group\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 87,\n \"name\": \"Kiehn-Reilly\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 86,\n \"name\": \"Brown-Dietrich\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 85,\n \"name\": \"Zulauf Inc\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 84,\n \"name\": \"Kihn, Wiza and Casper\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 83,\n \"name\": \"Mayert-Wilkinson\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 82,\n \"name\": \"Zboncak PLC\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 81,\n \"name\": \"Champlin-O'Conner\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 80,\n \"name\": \"Hessel and Sons\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 79,\n \"name\": \"Witting Inc\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 78,\n \"name\": \"Pacocha-Collins\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 77,\n \"name\": \"Cormier LLC\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 76,\n \"name\": \"Schneider, Stokes and Monahan\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 75,\n \"name\": \"Howell-O'Conner\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 74,\n \"name\": \"Fritsch LLC\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 73,\n \"name\": \"Satterfield-Balistreri\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 72,\n \"name\": \"Upton PLC\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 71,\n \"name\": \"Sporer Ltd\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 69,\n \"name\": \"Welch LLC\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 68,\n \"name\": \"Schroeder-Hauck\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 67,\n \"name\": \"Gleichner, Kuhn and Schuppe\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 66,\n \"name\": \"Tremblay, Bosco and Lang\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 65,\n \"name\": \"Aufderhar Ltd\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 64,\n \"name\": \"Lind, Kuhic and Runte\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 63,\n \"name\": \"Gorczany Group\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 62,\n \"name\": \"Dietrich-Prosacco\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 61,\n \"name\": \"Cormier-Bosco\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 60,\n \"name\": \"Schmidt, Homenick and Conroy\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 59,\n \"name\": \"Kutch, Cole and Von\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 58,\n \"name\": \"Heller, Bergstrom and Lynch\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 57,\n \"name\": \"Roob-Kub\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 56,\n \"name\": \"Howe, Olson and Towne\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 55,\n \"name\": \"Powlowski, Herzog and Skiles\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 54,\n \"name\": \"Lehner-Aufderhar\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 53,\n \"name\": \"Parisian and Sons\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 52,\n \"name\": \"Jacobson Group\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 51,\n \"name\": \"Purdy LLC\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 50,\n \"name\": \"Kreiger-Hamill\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 49,\n \"name\": \"Quigley-Upton\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 48,\n \"name\": \"Stark-Parisian\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 47,\n \"name\": \"Muller, Bartoletti and Breitenberg\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 46,\n \"name\": \"Haag, Homenick and Kshlerin\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 45,\n \"name\": \"Padberg, Gerlach and Lindgren\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 44,\n \"name\": \"Kris PLC\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 43,\n \"name\": \"Gislason, Huels and Veum\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 42,\n \"name\": \"Nicolas, Ratke and Deckow\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 41,\n \"name\": \"Raynor-Ratke\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 40,\n \"name\": \"Marvin LLC\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 39,\n \"name\": \"Yost, Metz and Schaden\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 38,\n \"name\": \"Wunsch Ltd\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 37,\n \"name\": \"Borer Ltd\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 36,\n \"name\": \"Senger Group\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 35,\n \"name\": \"Toy Inc\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 34,\n \"name\": \"Kutch, Wehner and Pfannerstill\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 33,\n \"name\": \"Quitzon-Daniel\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 32,\n \"name\": \"Hegmann Ltd\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 30,\n \"name\": \"Bradtke, Padberg and Bogan\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 29,\n \"name\": \"Frami-Heller\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 28,\n \"name\": \"Berge, Lemke and Dibbert\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 27,\n \"name\": \"Fahey Group\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 26,\n \"name\": \"Zboncak Ltd\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 25,\n \"name\": \"Kshlerin PLC\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 24,\n \"name\": \"Goodwin, Hamill and Feeney\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 23,\n \"name\": \"Herman-Prosacco\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 22,\n \"name\": \"Hayes-Bahringer\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 21,\n \"name\": \"Becker Group\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 20,\n \"name\": \"Kreiger Inc\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 19,\n \"name\": \"Jerde-Kreiger\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 18,\n \"name\": \"Nolan, Torphy and Gaylord\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 17,\n \"name\": \"Leffler, Friesen and Douglas\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 16,\n \"name\": \"Corwin, Reichel and Weber\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 15,\n \"name\": \"Marvin Inc\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 14,\n \"name\": \"Runolfsdottir, Cummings and Reichel\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 12,\n \"name\": \"Schultz and Sons\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 11,\n \"name\": \"Heaney, Moen and Hill\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 10,\n \"name\": \"Fisher, Skiles and Leannon\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 9,\n \"name\": \"Ullrich-Reinger\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 8,\n \"name\": \"Quigley LLC\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 7,\n \"name\": \"Fahey PLC\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 6,\n \"name\": \"Padberg, Quitzon and Tromp\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 5,\n \"name\": \"Zulauf, Conroy and Padberg\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 4,\n \"name\": \"McCullough PLC\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 3,\n \"name\": \"Walsh-Crist\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 2,\n \"name\": \"Mosciski, Franecki and Howell\",\n \"is_member\": \"0\"\n },\n {\n \"id\": 1,\n \"name\": \"Jenkins, Walker and McClure\",\n \"is_member\": \"0\"\n }\n ],\n \"messages\": null,\n \"code\": 200\n}" } ] }, { "name": "getCompaniesMembershipAndJoinability", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "GET", "header": [], "url": { "raw": "/api/getCompaniesMembershipAndJoinability?dropDown=1&membership=0&can_join=1", "path": [ "api", "getCompaniesMembershipAndJoinability" ], "query": [ { "key": "dropDown", "value": "1" }, { "key": "per_page", "value": "1", "disabled": true }, { "key": "sort_by", "value": "", "disabled": true }, { "key": "per_page", "value": "", "disabled": true }, { "key": "search", "value": "Emmerich", "disabled": true }, { "key": "membership", "value": "0", "description": "1,0" }, { "key": "can_join", "value": "1", "description": "1" } ] } }, "response": [ { "name": "getCompaniesMembershipAndJoinability", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "/api/getCompaniesMembershipAndJoinability?dropDown=1&search=Emmerich", "path": [ "api", "getCompaniesMembershipAndJoinability" ], "query": [ { "key": "dropDown", "value": "1" }, { "key": "per_page", "value": "12", "disabled": true }, { "key": "sort_by", "value": "", "disabled": true }, { "key": "per_page", "value": "", "disabled": true }, { "key": "search", "value": "Emmerich" }, { "key": "membership", "value": "0", "description": "1,0", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Connection", "value": "Keep-Alive" }, { "key": "Keep-Alive", "value": "timeout=5, max=100" }, { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application/json" }, { "key": "x-ratelimit-limit", "value": "60" }, { "key": "x-ratelimit-remaining", "value": "50" }, { "key": "access-control-allow-origin", "value": "*" }, { "key": "content-length", "value": "1051" }, { "key": "date", "value": "Fri, 16 May 2025 11:31:04 GMT" }, { "key": "server", "value": "LiteSpeed" }, { "key": "strict-transport-security", "value": "max-age=63072000; includeSubDomains" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "alt-svc", "value": "h3=\":443\"; ma=2592000, h3-29=\":443\"; ma=2592000, h3-Q050=\":443\"; ma=2592000, h3-Q046=\":443\"; ma=2592000, h3-Q043=\":443\"; ma=2592000, quic=\":443\"; ma=2592000; v=\"43,46\"" } ], "cookie": [], "body": "{\n \"status\": true,\n \"data\": [\n {\n \"id\": 570,\n \"name\": \"Klocko-Emmerich\",\n \"is_member\": \"0\",\n \"can_join\": \"1\"\n },\n {\n \"id\": 540,\n \"name\": \"Emmerich-Kessler\",\n \"is_member\": \"0\",\n \"can_join\": \"1\"\n },\n {\n \"id\": 509,\n \"name\": \"Blick, Hammes and Sawayn\",\n \"is_member\": \"0\",\n \"can_join\": \"1\"\n },\n {\n \"id\": 457,\n \"name\": \"Emmerich and Sons\",\n \"is_member\": \"0\",\n \"can_join\": \"1\"\n },\n {\n \"id\": 376,\n \"name\": \"Bayer-Emmerich\",\n \"is_member\": \"0\",\n \"can_join\": \"1\"\n },\n {\n \"id\": 361,\n \"name\": \"Sporer-Ward\",\n \"is_member\": \"0\",\n \"can_join\": \"1\"\n },\n {\n \"id\": 260,\n \"name\": \"Fisher, Welch and Hill\",\n \"is_member\": \"0\",\n \"can_join\": \"1\"\n },\n {\n \"id\": 250,\n \"name\": \"Emmerich-Effertz\",\n \"is_member\": \"0\",\n \"can_join\": \"1\"\n },\n {\n \"id\": 234,\n \"name\": \"Keebler PLC\",\n \"is_member\": \"0\",\n \"can_join\": \"1\"\n },\n {\n \"id\": 212,\n \"name\": \"Runolfsdottir, Bahringer and Hahn\",\n \"is_member\": \"0\",\n \"can_join\": \"1\"\n },\n {\n \"id\": 202,\n \"name\": \"Gislason, Schoen and Emmerich\",\n \"is_member\": \"0\",\n \"can_join\": \"1\"\n },\n {\n \"id\": 131,\n \"name\": \"Wilkinson, Zieme and Kreiger\",\n \"is_member\": \"0\",\n \"can_join\": \"1\"\n },\n {\n \"id\": 127,\n \"name\": \"Lockman and Sons\",\n \"is_member\": \"0\",\n \"can_join\": \"1\"\n },\n {\n \"id\": 84,\n \"name\": \"Kihn, Wiza and Casper\",\n \"is_member\": \"0\",\n \"can_join\": \"1\"\n }\n ],\n \"messages\": null,\n \"code\": 200\n}" } ] }, { "name": "listRequestJoinCompany", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "GET", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "company_id", "value": "500", "type": "text" } ] }, "url": { "raw": "api/listRequestJoinCompany/:companyId", "host": [ "api" ], "path": [ "listRequestJoinCompany", ":companyId" ], "query": [ { "key": "dropDown", "value": "1", "disabled": true }, { "key": "search", "value": "john", "disabled": true }, { "key": "account_type", "value": "hr", "disabled": true }, { "key": "status", "value": "approved", "disabled": true }, { "key": "approved_start_date", "value": "2025-01-01", "disabled": true }, { "key": "approved_end_date", "value": "2025-12-31", "disabled": true }, { "key": "sort_by", "value": "requested_at", "disabled": true }, { "key": "sort", "value": "asc", "disabled": true }, { "key": "per_page", "value": "20", "disabled": true } ], "variable": [ { "key": "companyId", "value": "501" } ] } }, "response": [] }, { "name": "update status of request Join Company", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token_manager}}", "type": "string" } ] }, "method": "PATCH", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"status\": \"approved_manager\",\r\n \"message\": \"تمت الموافقة بعد مراجعة كافة التفاصيل.\",\r\n \"department_id\":2254,\r\n \"cost_center_id\":363,\r\n \"emp_id\" : \"22344\",\r\n \"account_type\" : \"\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "api/requestJoinCompany/:joinRequest/status", "host": [ "api" ], "path": [ "requestJoinCompany", ":joinRequest", "status" ], "variable": [ { "key": "joinRequest", "value": "3" } ] } }, "response": [] }, { "name": "update status of request Join Company Copy", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token_manager}}", "type": "string" } ] }, "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"status\": \"approved_manager\",\r\n \"message\": \"تمت الموافقة بعد مراجعة كافة التفاصيل.\",\r\n \"department_id\":2254,\r\n \"cost_center_id\":363,\r\n \"emp_id\" : \"22344\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "api/requestJoinCompany/:joinRequest/status", "host": [ "api" ], "path": [ "requestJoinCompany", ":joinRequest", "status" ], "variable": [ { "key": "joinRequest", "value": "3" } ] } }, "response": [] }, { "name": "showCompanyWithCostCentersAndDepartments", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "42|CQlPQv6xNj8Jg75dVz2BemS7GWSLkX8uMepDVkp2fa469c0d", "type": "string" } ] }, "method": "GET", "header": [], "url": { "raw": "api/showCompanyWithCostCentersAndDepartments/:id", "host": [ "api" ], "path": [ "showCompanyWithCostCentersAndDepartments", ":id" ], "variable": [ { "key": "id", "value": "1" } ] } }, "response": [] } ] }, { "name": "EMPLOYEE", "item": [ { "name": "complaints", "item": [ { "name": "requestPayrollComplaints", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"payroll_id\": \"469\",\r\n \"salary_issue\": \"overpaid\",\r\n \"complaint_text\": \"complaint_text\",\r\n \"specify_issue_text\": \"specify_issue_text\",\r\n \"custom_salary_issue_json\": [\r\n {\r\n \"label\": \"Basic Salary\",\r\n \"selected\": true\r\n },\r\n {\r\n \"label\": \"Bonus\",\r\n \"selected\": false\r\n },\r\n {\r\n \"label\": \"Overtime\",\r\n \"selected\": false\r\n },\r\n {\r\n \"label\": \"Housing Allowance\",\r\n \"selected\": false\r\n },\r\n {\r\n \"label\": \"Other (Specify Below)\",\r\n \"selected\": false\r\n }\r\n ]\r\n}\r\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "api/requestPayrollComplaints", "host": [ "api" ], "path": [ "requestPayrollComplaints" ] }, "description": "**Create Payroll Complaint (Employee)**\n\nEmployee submits a complaint about their payroll.\n\n**Required Fields:**\n- `payroll_id`: ID of the payroll being complained about\n- `salary_issue`: Must be one of: `overpaid`, `underpaid`, `other`\n\n**Optional Fields:**\n- `complaint_text`: Main complaint description\n- `specify_issue_text`: Additional details\n- `custom_salary_issue_json`: Array of issue categories with labels and selection status\n\n**Salary Issue Values:**\n- `overpaid`: Employee received more than expected\n- `underpaid`: Employee received less than expected\n- `other`: Other issues (use custom_salary_issue_json for details)\n\n**Note:** This action automatically rejects the payroll and notifies managers." }, "response": [ { "name": "New Request", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"payroll_id\": \"469\",\r\n \"salary_issue\": \"overpaid\",\r\n \"complaint_text\": \"complaint_text\",\r\n \"specify_issue_text\": \"specify_issue_text\",\r\n \"custom_salary_issue_json\": [\r\n {\r\n \"label\": \"Basic Salary\",\r\n \"selected\": true\r\n },\r\n {\r\n \"label\": \"Bonus\",\r\n \"selected\": false\r\n },\r\n {\r\n \"label\": \"Overtime\",\r\n \"selected\": false\r\n },\r\n {\r\n \"label\": \"Housing Allowance\",\r\n \"selected\": false\r\n },\r\n {\r\n \"label\": \"Other (Specify Below)\",\r\n \"selected\": false\r\n }\r\n ]\r\n}\r\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "api/requestPayrollComplaints", "host": [ "api" ], "path": [ "requestPayrollComplaints" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Connection", "value": "Keep-Alive" }, { "key": "Keep-Alive", "value": "timeout=5, max=100" }, { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application/json" }, { "key": "x-ratelimit-limit", "value": "60" }, { "key": "x-ratelimit-remaining", "value": "59" }, { "key": "access-control-allow-origin", "value": "*" }, { "key": "content-length", "value": "430" }, { "key": "date", "value": "Sun, 18 May 2025 13:00:42 GMT" }, { "key": "server", "value": "LiteSpeed" }, { "key": "strict-transport-security", "value": "max-age=63072000; includeSubDomains" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "alt-svc", "value": "h3=\":443\"; ma=2592000, h3-29=\":443\"; ma=2592000, h3-Q050=\":443\"; ma=2592000, h3-Q046=\":443\"; ma=2592000, h3-Q043=\":443\"; ma=2592000, quic=\":443\"; ma=2592000; v=\"43,46\"" } ], "cookie": [], "body": "{\n \"status\": true,\n \"data\": {\n \"payroll_id\": \"469\",\n \"salary_issue\": \"overpaid\",\n \"employee_id\": 57,\n \"complaint_text\": \"complaint_text\",\n \"specify_issue_text\": \"specify_issue_text\",\n \"custom_salary_issue_json\": [\n {\n \"label\": \"Basic Salary\",\n \"selected\": true\n },\n {\n \"label\": \"Bonus\",\n \"selected\": false\n },\n {\n \"label\": \"Overtime\",\n \"selected\": false\n },\n {\n \"label\": \"Housing Allowance\",\n \"selected\": false\n },\n {\n \"label\": \"Other (Specify Below)\",\n \"selected\": false\n }\n ]\n },\n \"messages\": null,\n \"code\": 200\n}" } ] }, { "name": "update PayrollComplaints", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"complaint_id\": 1,\r\n \"payroll_id\": 469,\r\n \"salary_issue\": \"overpaid\",\r\n \"complaint_text\": \"أطلب مراجعة تفاصيل الخصم حيث لم يتم توضيحه في قسيمة الراتب.\",\r\n \"specify_issue_text\": \"الخصم ظهر فقط في شهر أبريل بدون سبب واضح.\",\r\n \"custom_salary_issue_json\": [\r\n {\r\n \"label\": \"Basic Salary\",\r\n \"selected\": true\r\n },\r\n {\r\n \"label\": \"Bonus\",\r\n \"selected\": false\r\n },\r\n {\r\n \"label\": \"Overtime\",\r\n \"selected\": false\r\n },\r\n {\r\n \"label\": \"Housing Allowance\",\r\n \"selected\": false\r\n },\r\n {\r\n \"label\": \"Transportation Allowance\",\r\n \"selected\": false\r\n },\r\n {\r\n \"label\": \"Food Allowance\",\r\n \"selected\": false\r\n },\r\n {\r\n \"label\": \"Mobile Allowance\",\r\n \"selected\": false\r\n },\r\n {\r\n \"label\": \"Unjustified Deduction\",\r\n \"selected\": false\r\n },\r\n {\r\n \"label\": \"Delay in Salary Transfer\",\r\n \"selected\": false\r\n },\r\n {\r\n \"label\": \"Incorrect Working Days Count\",\r\n \"selected\": false\r\n },\r\n {\r\n \"label\": \"Other (Specify Below)\",\r\n \"selected\": false\r\n }\r\n ]\r\n}\r\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "api/updatePayrollComplaints", "host": [ "api" ], "path": [ "updatePayrollComplaints" ] }, "description": "**Update Payroll Complaint (Employee)**\n\nEmployee updates their existing complaint.\n\n**Required Fields:**\n- `complaint_id`: ID of the complaint to update\n- `salary_issue`: Must be one of: `overpaid`, `underpaid`, `other`\n\n**Optional Fields:**\n- `payroll_id`: Payroll ID (informational)\n- `complaint_text`: Updated complaint description\n- `specify_issue_text`: Updated additional details\n- `custom_salary_issue_json`: Updated array of issue categories\n\n**Restrictions:**\n- Can only update complaints in status: `pending`, `resubmitted`, or `submitted`\n- Employee can only update their own complaints" }, "response": [ { "name": "update PayrollComplaints", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"complaint_id\": 1,\r\n \"payroll_id\": 469,\r\n \"salary_issue\": \"overpaid\",\r\n \"complaint_text\": \"أطلب مراجعة تفاصيل الخصم حيث لم يتم توضيحه في قسيمة الراتب.\",\r\n \"specify_issue_text\": \"الخصم ظهر فقط في شهر أبريل بدون سبب واضح.\",\r\n \"custom_salary_issue_json\": [\r\n {\r\n \"label\": \"Basic Salary\",\r\n \"selected\": true\r\n },\r\n {\r\n \"label\": \"Bonus\",\r\n \"selected\": false\r\n },\r\n {\r\n \"label\": \"Overtime\",\r\n \"selected\": false\r\n },\r\n {\r\n \"label\": \"Housing Allowance\",\r\n \"selected\": false\r\n },\r\n {\r\n \"label\": \"Transportation Allowance\",\r\n \"selected\": false\r\n },\r\n {\r\n \"label\": \"Food Allowance\",\r\n \"selected\": false\r\n },\r\n {\r\n \"label\": \"Mobile Allowance\",\r\n \"selected\": false\r\n },\r\n {\r\n \"label\": \"Unjustified Deduction\",\r\n \"selected\": false\r\n },\r\n {\r\n \"label\": \"Delay in Salary Transfer\",\r\n \"selected\": false\r\n },\r\n {\r\n \"label\": \"Incorrect Working Days Count\",\r\n \"selected\": false\r\n },\r\n {\r\n \"label\": \"Other (Specify Below)\",\r\n \"selected\": false\r\n }\r\n ]\r\n}\r\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "api/updatePayrollComplaints", "host": [ "api" ], "path": [ "updatePayrollComplaints" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Connection", "value": "Keep-Alive" }, { "key": "Keep-Alive", "value": "timeout=5, max=100" }, { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application/json" }, { "key": "x-ratelimit-limit", "value": "60" }, { "key": "x-ratelimit-remaining", "value": "59" }, { "key": "access-control-allow-origin", "value": "*" }, { "key": "content-length", "value": "1169" }, { "key": "date", "value": "Mon, 09 Jun 2025 18:14:20 GMT" }, { "key": "server", "value": "LiteSpeed" }, { "key": "strict-transport-security", "value": "max-age=63072000; includeSubDomains" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "alt-svc", "value": "h3=\":443\"; ma=2592000, h3-29=\":443\"; ma=2592000, h3-Q050=\":443\"; ma=2592000, h3-Q046=\":443\"; ma=2592000, h3-Q043=\":443\"; ma=2592000, quic=\":443\"; ma=2592000; v=\"43,46\"" } ], "cookie": [], "body": "{\n \"status\": true,\n \"data\": {\n \"salary_issue\": \"overpaid\",\n \"complaint_text\": \"أطلب مراجعة تفاصيل الخصم حيث لم يتم توضيحه في قسيمة الراتب.\",\n \"specify_issue_text\": \"الخصم ظهر فقط في شهر أبريل بدون سبب واضح.\",\n \"custom_salary_issue_json\": [\n {\n \"label\": \"Basic Salary\",\n \"selected\": true\n },\n {\n \"label\": \"Bonus\",\n \"selected\": false\n },\n {\n \"label\": \"Overtime\",\n \"selected\": false\n },\n {\n \"label\": \"Housing Allowance\",\n \"selected\": false\n },\n {\n \"label\": \"Transportation Allowance\",\n \"selected\": false\n },\n {\n \"label\": \"Food Allowance\",\n \"selected\": false\n },\n {\n \"label\": \"Mobile Allowance\",\n \"selected\": false\n },\n {\n \"label\": \"Unjustified Deduction\",\n \"selected\": false\n },\n {\n \"label\": \"Delay in Salary Transfer\",\n \"selected\": false\n },\n {\n \"label\": \"Incorrect Working Days Count\",\n \"selected\": false\n },\n {\n \"label\": \"Other (Specify Below)\",\n \"selected\": false\n }\n ]\n },\n \"messages\": null,\n \"code\": 200\n}" } ] }, { "name": "Cancel Complaint", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "complaint_text", "value": "Cancelling this complaint", "type": "text", "description": "Optional: Reason for cancellation" } ] }, "url": { "raw": "api/complaints/:complaint/cancel", "host": [ "api" ], "path": [ "complaints", ":complaint", "cancel" ], "variable": [ { "key": "complaint", "value": "1" } ] }, "description": "**Cancel Complaint (Employee)**\n\nEmployee cancels their own complaint.\n\n**URL Parameter:**\n- `complaint`: Complaint ID\n\n**Optional Body:**\n- `complaint_text`: Reason for cancellation\n\n**Status Change:** → `cancelled`\n\n**Note:** Once cancelled, the complaint cannot be reactivated." }, "response": [ { "name": "Cancel Complaint", "originalRequest": { "method": "POST", "header": [], "url": { "raw": "api/complaints/:complaint/cancel", "host": [ "api" ], "path": [ "complaints", ":complaint", "cancel" ], "variable": [ { "key": "complaint", "value": "1" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Connection", "value": "Keep-Alive" }, { "key": "Keep-Alive", "value": "timeout=5, max=100" }, { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application/json" }, { "key": "x-ratelimit-limit", "value": "60" }, { "key": "x-ratelimit-remaining", "value": "57" }, { "key": "access-control-allow-origin", "value": "*" }, { "key": "content-length", "value": "54" }, { "key": "date", "value": "Fri, 23 May 2025 12:03:19 GMT" }, { "key": "server", "value": "LiteSpeed" }, { "key": "strict-transport-security", "value": "max-age=63072000; includeSubDomains" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "alt-svc", "value": "h3=\":443\"; ma=2592000, h3-29=\":443\"; ma=2592000, h3-Q050=\":443\"; ma=2592000, h3-Q046=\":443\"; ma=2592000, h3-Q043=\":443\"; ma=2592000, quic=\":443\"; ma=2592000; v=\"43,46\"" } ], "cookie": [], "body": "{\n \"status\": true,\n \"data\": null,\n \"messages\": null,\n \"code\": 200\n}" } ] }, { "name": "Resubmit Complaint", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "complaint_text", "value": "complaint_text", "type": "text" } ] }, "url": { "raw": "api/complaints/:complaint/resubmit", "host": [ "api" ], "path": [ "complaints", ":complaint", "resubmit" ], "variable": [ { "key": "complaint", "value": "1" } ] }, "description": "**Resubmit Complaint (Employee)**\n\nEmployee resubmits a previously rejected or reviewed complaint.\n\n**URL Parameter:**\n- `complaint`: Complaint ID\n\n**Optional Field:**\n- `complaint_text`: Additional notes for resubmission\n\n**Status Change:** → `resubmitted`\n\n**Use Case:** When employee wants to provide more information after manager review." }, "response": [ { "name": "Resubmit Complaint", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "complaint_text", "value": "complaint_text", "type": "text" } ] }, "url": { "raw": "api/complaints/:complaint/resubmit", "host": [ "api" ], "path": [ "complaints", ":complaint", "resubmit" ], "variable": [ { "key": "complaint", "value": "1" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Connection", "value": "Keep-Alive" }, { "key": "Keep-Alive", "value": "timeout=5, max=100" }, { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application/json" }, { "key": "x-ratelimit-limit", "value": "60" }, { "key": "x-ratelimit-remaining", "value": "59" }, { "key": "access-control-allow-origin", "value": "*" }, { "key": "content-length", "value": "54" }, { "key": "date", "value": "Fri, 23 May 2025 12:02:48 GMT" }, { "key": "server", "value": "LiteSpeed" }, { "key": "strict-transport-security", "value": "max-age=63072000; includeSubDomains" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "alt-svc", "value": "h3=\":443\"; ma=2592000, h3-29=\":443\"; ma=2592000, h3-Q050=\":443\"; ma=2592000, h3-Q046=\":443\"; ma=2592000, h3-Q043=\":443\"; ma=2592000, quic=\":443\"; ma=2592000; v=\"43,46\"" } ], "cookie": [], "body": "{\n \"status\": true,\n \"data\": null,\n \"messages\": null,\n \"code\": 200\n}" } ] }, { "name": "Accept Complaint Resolution", "request": { "method": "POST", "header": [], "url": { "raw": "api/complaints/:complaint/accept-resolution", "host": [ "api" ], "path": [ "complaints", ":complaint", "accept-resolution" ], "variable": [ { "key": "complaint", "value": "1" } ] } }, "response": [] }, { "name": "Show", "request": { "method": "GET", "header": [], "url": { "raw": "api/complaints/:payroll_id/complaints/:id", "host": [ "api" ], "path": [ "complaints", ":payroll_id", "complaints", ":id" ], "variable": [ { "key": "payroll_id", "value": "469" }, { "key": "id", "value": "1" } ] } }, "response": [ { "name": "Show Payrolls", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "api/complaints/:payroll_id/complaints/:id", "host": [ "api" ], "path": [ "complaints", ":payroll_id", "complaints", ":id" ], "variable": [ { "key": "payroll_id", "value": "469" }, { "key": "id", "value": "1" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Connection", "value": "Keep-Alive" }, { "key": "Keep-Alive", "value": "timeout=5, max=100" }, { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application/json" }, { "key": "x-ratelimit-limit", "value": "60" }, { "key": "x-ratelimit-remaining", "value": "58" }, { "key": "access-control-allow-origin", "value": "*" }, { "key": "content-length", "value": "880" }, { "key": "date", "value": "Fri, 23 May 2025 11:27:30 GMT" }, { "key": "server", "value": "LiteSpeed" }, { "key": "strict-transport-security", "value": "max-age=63072000; includeSubDomains" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "alt-svc", "value": "h3=\":443\"; ma=2592000, h3-29=\":443\"; ma=2592000, h3-Q050=\":443\"; ma=2592000, h3-Q046=\":443\"; ma=2592000, h3-Q043=\":443\"; ma=2592000, quic=\":443\"; ma=2592000; v=\"43,46\"" } ], "cookie": [], "body": "{\n \"status\": true,\n \"data\": {\n \"id\": 1,\n \"payroll_id\": \"469\",\n \"employee_id\": \"57\",\n \"salary_issue\": \"overpaid\",\n \"custom_salary_issue_json\": [\n {\n \"label\": \"Basic Salary\",\n \"selected\": true\n },\n {\n \"label\": \"Bonus\",\n \"selected\": false\n },\n {\n \"label\": \"Overtime\",\n \"selected\": false\n },\n {\n \"label\": \"Housing Allowance\",\n \"selected\": false\n },\n {\n \"label\": \"Other (Specify Below)\",\n \"selected\": false\n }\n ],\n \"specify_issue_text\": \"specify_issue_text\",\n \"complaint_text\": \"complaint_text\",\n \"status\": \"pending\",\n \"activity_log\": [\n {\n \"type\": \"note\",\n \"timestamp\": \"2025-05-18 13:00:42\",\n \"by\": {\n \"id\": 57,\n \"account_type\": \"employee\",\n \"name\": \"Nora Nader\",\n \"email\": \"employee16@company.com\",\n \"phone\": \"966517346506\",\n \"image\": null\n },\n \"message\": null\n }\n ],\n \"employee_accepted_resolution\": false,\n \"accepted_at\": null,\n \"cancelled_by_employee\": false,\n \"cancelled_at\": null,\n \"created_at\": \"2025-05-18T13:00:42.000000Z\",\n \"updated_at\": \"2025-05-18T13:00:42.000000Z\",\n \"deleted_at\": null\n },\n \"messages\": null,\n \"code\": 200\n}" }, { "name": "Show", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "api/complaints/:payroll_id/complaints/:id", "host": [ "api" ], "path": [ "complaints", ":payroll_id", "complaints", ":id" ], "variable": [ { "key": "payroll_id", "value": "469" }, { "key": "id", "value": "1" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Connection", "value": "Keep-Alive" }, { "key": "Keep-Alive", "value": "timeout=5, max=100" }, { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application/json" }, { "key": "x-ratelimit-limit", "value": "60" }, { "key": "x-ratelimit-remaining", "value": "58" }, { "key": "access-control-allow-origin", "value": "*" }, { "key": "content-length", "value": "2181" }, { "key": "date", "value": "Fri, 23 May 2025 12:02:57 GMT" }, { "key": "server", "value": "LiteSpeed" }, { "key": "strict-transport-security", "value": "max-age=63072000; includeSubDomains" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "alt-svc", "value": "h3=\":443\"; ma=2592000, h3-29=\":443\"; ma=2592000, h3-Q050=\":443\"; ma=2592000, h3-Q046=\":443\"; ma=2592000, h3-Q043=\":443\"; ma=2592000, quic=\":443\"; ma=2592000; v=\"43,46\"" } ], "cookie": [], "body": "{\n \"status\": true,\n \"data\": {\n \"id\": 1,\n \"payroll_id\": \"469\",\n \"employee_id\": \"57\",\n \"salary_issue\": \"overpaid\",\n \"custom_salary_issue_json\": [\n {\n \"label\": \"Basic Salary\",\n \"selected\": true\n },\n {\n \"label\": \"Bonus\",\n \"selected\": false\n },\n {\n \"label\": \"Overtime\",\n \"selected\": false\n },\n {\n \"label\": \"Housing Allowance\",\n \"selected\": false\n },\n {\n \"label\": \"Other (Specify Below)\",\n \"selected\": false\n }\n ],\n \"specify_issue_text\": \"specify_issue_text\",\n \"complaint_text\": \"complaint_text\",\n \"status\": \"resubmitted\",\n \"activity_log\": [\n {\n \"type\": \"note\",\n \"timestamp\": \"2025-05-18 13:00:42\",\n \"by\": {\n \"id\": 57,\n \"account_type\": \"employee\",\n \"name\": \"Nora Nader\",\n \"email\": \"employee16@company.com\",\n \"phone\": \"966517346506\",\n \"image\": null\n },\n \"message\": null\n },\n {\n \"type\": \"status_change\",\n \"timestamp\": \"2025-05-23 11:47:01\",\n \"by\": {\n \"id\": 43,\n \"account_type\": \"manager\",\n \"name\": \"Jennie Casimer Mitchell\",\n \"email\": \"manager20@company.com\",\n \"phone\": \"966542067492\",\n \"image\": null\n },\n \"status\": \"awaiting_employee_action\",\n \"note\": \"KAMAL WRITE NOTES\"\n },\n {\n \"type\": \"status_change\",\n \"timestamp\": \"2025-05-23 11:56:33\",\n \"by\": {\n \"id\": 43,\n \"account_type\": \"manager\",\n \"name\": \"Jennie Casimer Mitchell\",\n \"email\": \"manager20@company.com\",\n \"phone\": \"966542067492\",\n \"image\": null\n },\n \"status\": \"under_review\",\n \"note\": null\n },\n {\n \"type\": \"status_change\",\n \"timestamp\": \"2025-05-23 12:01:39\",\n \"by\": {\n \"id\": 43,\n \"account_type\": \"manager\",\n \"name\": \"Jennie Casimer Mitchell\",\n \"email\": \"manager20@company.com\",\n \"phone\": \"966542067492\",\n \"image\": null\n },\n \"status\": \"reviewed\",\n \"note\": \"REVIEW\"\n },\n {\n \"type\": \"status_change\",\n \"timestamp\": \"2025-05-23 12:01:49\",\n \"by\": {\n \"id\": 43,\n \"account_type\": \"manager\",\n \"name\": \"Jennie Casimer Mitchell\",\n \"email\": \"manager20@company.com\",\n \"phone\": \"966542067492\",\n \"image\": null\n },\n \"status\": \"awaiting_employee_action\",\n \"note\": \"KAMAL WRITE NOTES\"\n },\n {\n \"type\": \"status_change\",\n \"timestamp\": \"2025-05-23 12:02:48\",\n \"by\": {\n \"id\": 57,\n \"account_type\": \"employee\",\n \"name\": \"Nora Nader\",\n \"email\": \"employee16@company.com\",\n \"phone\": \"966517346506\",\n \"image\": null\n },\n \"status\": \"resubmitted\",\n \"note\": \"complaint_text\"\n }\n ],\n \"employee_accepted_resolution\": false,\n \"accepted_at\": null,\n \"cancelled_by_employee\": false,\n \"cancelled_at\": null,\n \"created_at\": \"2025-05-18T13:00:42.000000Z\",\n \"updated_at\": \"2025-05-23T12:02:48.000000Z\",\n \"deleted_at\": null,\n \"reviewed_at\": \"2025-05-23T12:01:49.000000Z\",\n \"resolved_at\": null\n },\n \"messages\": null,\n \"code\": 200\n}" } ] }, { "name": "mypayroll-complaints", "request": { "method": "GET", "header": [], "url": { "raw": "api/mypayroll-complaints?status_list[]=corrected", "host": [ "api" ], "path": [ "mypayroll-complaints" ], "query": [ { "key": "search", "value": "مشكلة في الراتب", "disabled": true }, { "key": "status", "value": "under_review", "disabled": true }, { "key": "salary_issue", "value": "underpaid", "disabled": true }, { "key": "created_from", "value": "2025-05-01", "disabled": true }, { "key": "created_to", "value": "2025-05-20", "disabled": true }, { "key": "reviewed_from", "value": "2025-05-10", "disabled": true }, { "key": "reviewed_to", "value": "2025-05-15", "disabled": true }, { "key": "accepted_from", "value": "2025-05-12", "disabled": true }, { "key": "accepted_to", "value": "2025-05-14", "disabled": true }, { "key": "cancelled_from", "value": "2025-05-01", "disabled": true }, { "key": "cancelled_to", "value": "2025-05-20", "disabled": true }, { "key": "sort_by", "value": "created_at", "disabled": true }, { "key": "sort_as", "value": "desc", "disabled": true }, { "key": "per_page", "value": "20", "disabled": true }, { "key": "status_list[]", "value": "corrected" } ] } }, "response": [ { "name": "mypayroll-complaints", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "api/mypayroll-complaints?status_list[]=corrected", "host": [ "api" ], "path": [ "mypayroll-complaints" ], "query": [ { "key": "search", "value": "مشكلة في الراتب", "disabled": true }, { "key": "status", "value": "under_review", "disabled": true }, { "key": "salary_issue", "value": "underpaid", "disabled": true }, { "key": "created_from", "value": "2025-05-01", "disabled": true }, { "key": "created_to", "value": "2025-05-20", "disabled": true }, { "key": "reviewed_from", "value": "2025-05-10", "disabled": true }, { "key": "reviewed_to", "value": "2025-05-15", "disabled": true }, { "key": "accepted_from", "value": "2025-05-12", "disabled": true }, { "key": "accepted_to", "value": "2025-05-14", "disabled": true }, { "key": "cancelled_from", "value": "2025-05-01", "disabled": true }, { "key": "cancelled_to", "value": "2025-05-20", "disabled": true }, { "key": "sort_by", "value": "created_at", "disabled": true }, { "key": "sort_as", "value": "desc", "disabled": true }, { "key": "per_page", "value": "20", "disabled": true }, { "key": "status_list[]", "value": "corrected" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Connection", "value": "Keep-Alive" }, { "key": "Keep-Alive", "value": "timeout=5, max=100" }, { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application/json" }, { "key": "x-ratelimit-limit", "value": "60" }, { "key": "x-ratelimit-remaining", "value": "58" }, { "key": "access-control-allow-origin", "value": "*" }, { "key": "content-length", "value": "52" }, { "key": "date", "value": "Mon, 02 Jun 2025 15:29:52 GMT" }, { "key": "server", "value": "LiteSpeed" }, { "key": "strict-transport-security", "value": "max-age=63072000; includeSubDomains" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "alt-svc", "value": "h3=\":443\"; ma=2592000, h3-29=\":443\"; ma=2592000, h3-Q050=\":443\"; ma=2592000, h3-Q046=\":443\"; ma=2592000, h3-Q043=\":443\"; ma=2592000, quic=\":443\"; ma=2592000; v=\"43,46\"" } ], "cookie": [], "body": "{\n \"status\": true,\n \"data\": [],\n \"messages\": null,\n \"code\": 200\n}" } ] } ] }, { "name": "Payrolls", "item": [ { "name": "showPayrolls", "description": "**Get Payroll Details (Employee)**\n\nEmployee views detailed information about a specific payroll.\n\n**URL Parameter:**\n- `id`: Payroll ID\n\n**Returns:**\n- Complete payroll information\n- Salary breakdown\n- Allowances and deductions\n- Payment status\n- Department and cost center info", "request": { "method": "GET", "header": [], "url": { "raw": "api/showPayrolls/:id", "host": [ "api" ], "path": [ "showPayrolls", ":id" ], "variable": [ { "key": "id", "value": "507" } ] } }, "response": [ { "name": "showPayrolls", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "api/showPayrolls/:id", "host": [ "api" ], "path": [ "showPayrolls", ":id" ], "variable": [ { "key": "id", "value": "469" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Connection", "value": "Keep-Alive" }, { "key": "Keep-Alive", "value": "timeout=5, max=100" }, { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application/json" }, { "key": "x-ratelimit-limit", "value": "60" }, { "key": "x-ratelimit-remaining", "value": "59" }, { "key": "access-control-allow-origin", "value": "*" }, { "key": "content-length", "value": "1172" }, { "key": "date", "value": "Sun, 18 May 2025 12:12:08 GMT" }, { "key": "server", "value": "LiteSpeed" }, { "key": "strict-transport-security", "value": "max-age=63072000; includeSubDomains" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "alt-svc", "value": "h3=\":443\"; ma=2592000, h3-29=\":443\"; ma=2592000, h3-Q050=\":443\"; ma=2592000, h3-Q046=\":443\"; ma=2592000, h3-Q043=\":443\"; ma=2592000, quic=\":443\"; ma=2592000; v=\"43,46\"" } ], "cookie": [], "body": "{\n \"status\": true,\n \"data\": {\n \"id\": 469,\n \"pay_month\": \"2025-03-01 / 2025-03-31\",\n \"pay_period\": \"monthly\",\n \"total_salary\": \"2390.02\",\n \"created_type\": \"manual\",\n \"department_id\": 2254,\n \"cost_center_id\": 363,\n \"custom_id\": null,\n \"leaver\": null,\n \"salary_details\": \"{\\\"basic\\\":3000,\\\"allowance\\\":1000,\\\"deductions\\\":500}\",\n \"confirmation_status\": \"pending\",\n \"confirmed_at\": null,\n \"confirmed_by\": null,\n \"created_by\": null,\n \"employee_id\": \"57\",\n \"rejected_by\": null,\n \"rejected_at\": null,\n \"rejection_reason\": null,\n \"deleted_at\": null,\n \"created_at\": \"2025-05-17T22:14:10.000000Z\",\n \"updated_at\": \"2025-05-17T22:14:10.000000Z\",\n \"department\": {\n \"id\": 2254,\n \"name\": \"Poultry Cutter\",\n \"code\": \"DEP-078\",\n \"cost_center_id\": 363,\n \"description\": \"Dolor tempora recusandae officia totam.\",\n \"status\": \"active\",\n \"company_id\": 221,\n \"created_at\": \"2025-05-17T22:14:08.000000Z\",\n \"updated_at\": \"2025-05-17T22:14:08.000000Z\",\n \"deleted_at\": null\n },\n \"cost_center\": {\n \"id\": 363,\n \"name\": \"dolores\",\n \"code\": \"CC-039\",\n \"parent_id\": null,\n \"description\": \"Earum nostrum illum sed praesentium quod.\",\n \"status\": \"active\",\n \"company_id\": 221,\n \"created_at\": \"2025-05-17T21:59:42.000000Z\",\n \"updated_at\": \"2025-05-17T21:59:42.000000Z\",\n \"deleted_at\": null\n },\n \"payroll_complaint\": null\n },\n \"messages\": null,\n \"code\": 200\n}" } ] }, { "name": "Confirm Payroll", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "is_leaver", "value": "1", "description": "0,1", "type": "text" }, { "key": "leaving_date", "value": "2025-05-23 13:16:18", "type": "text" } ] }, "url": { "raw": "api/payrolls/:payroll/confirm", "host": [ "api" ], "path": [ "payrolls", ":payroll", "confirm" ], "variable": [ { "key": "payroll", "value": "469" } ] } }, "response": [ { "name": "Confirm Payroll", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "is_leaver", "value": "1", "description": "0,1", "type": "text" }, { "key": "leaving_date", "value": "2025-05-23 13:16:18", "type": "text" } ] }, "url": { "raw": "api/payrolls/:payroll/confirm", "host": [ "api" ], "path": [ "payrolls", ":payroll", "confirm" ], "variable": [ { "key": "payroll", "value": "469" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Connection", "value": "Keep-Alive" }, { "key": "Keep-Alive", "value": "timeout=5, max=100" }, { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application/json" }, { "key": "x-ratelimit-limit", "value": "60" }, { "key": "x-ratelimit-remaining", "value": "59" }, { "key": "access-control-allow-origin", "value": "*" }, { "key": "content-length", "value": "54" }, { "key": "date", "value": "Fri, 23 May 2025 13:26:02 GMT" }, { "key": "server", "value": "LiteSpeed" }, { "key": "strict-transport-security", "value": "max-age=63072000; includeSubDomains" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "alt-svc", "value": "h3=\":443\"; ma=2592000, h3-29=\":443\"; ma=2592000, h3-Q050=\":443\"; ma=2592000, h3-Q046=\":443\"; ma=2592000, h3-Q043=\":443\"; ma=2592000, quic=\":443\"; ma=2592000; v=\"43,46\"" } ], "cookie": [], "body": "{\n \"status\": true,\n \"data\": null,\n \"messages\": null,\n \"code\": 200\n}" } ] }, { "name": "myPayrolls", "request": { "method": "GET", "header": [], "url": { "raw": "api/myPayrolls", "host": [ "api" ], "path": [ "myPayrolls" ] } }, "response": [] } ] }, { "name": "Company", "item": [ { "name": "myCompanies", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "GET", "header": [], "url": { "raw": "/api/myCompanies", "path": [ "api", "myCompanies" ] } }, "response": [] }, { "name": "Request Join Company", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "company_id", "value": "500", "type": "text" } ] }, "url": { "raw": "/api/requestJoinCompany", "path": [ "api", "requestJoinCompany" ] } }, "response": [] } ] }, { "name": "verifyCode", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "identifier", "value": "hr@company.com", "type": "text" }, { "key": "code", "value": "4745", "type": "text" } ] }, "url": { "raw": "api/verifyCode", "host": [ "api" ], "path": [ "verifyCode" ] } }, "response": [ { "name": "verifyCode", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "identifier", "value": "hr@company.com", "type": "text" }, { "key": "code", "value": "4745", "type": "text" } ] }, "url": { "raw": "api/verifyCode", "host": [ "api" ], "path": [ "verifyCode" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Connection", "value": "Keep-Alive" }, { "key": "Keep-Alive", "value": "timeout=5, max=100" }, { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application/json" }, { "key": "x-ratelimit-limit", "value": "60" }, { "key": "x-ratelimit-remaining", "value": "56" }, { "key": "access-control-allow-origin", "value": "*" }, { "key": "content-length", "value": "68" }, { "key": "date", "value": "Thu, 15 May 2025 01:05:39 GMT" }, { "key": "server", "value": "LiteSpeed" }, { "key": "strict-transport-security", "value": "max-age=63072000; includeSubDomains" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "alt-svc", "value": "h3=\":443\"; ma=2592000, h3-29=\":443\"; ma=2592000, h3-Q050=\":443\"; ma=2592000, h3-Q046=\":443\"; ma=2592000, h3-Q043=\":443\"; ma=2592000, quic=\":443\"; ma=2592000; v=\"43,46\"" } ], "cookie": [], "body": "{\n \"status\": true,\n \"data\": {\n \"is_exists\": true\n },\n \"messages\": null,\n \"code\": 200\n}" } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "packages": [], "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "packages": [], "exec": [ "" ] } } ] }, { "name": "MANAGER & HR", "item": [ { "name": "complaints", "item": [ { "name": "replyToComplaint", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "complaint_text", "value": "KAMAL WRITE NOTES", "type": "text" } ] }, "url": { "raw": "api/complaints/:complaint/replyToComplaint", "host": [ "api" ], "path": [ "complaints", ":complaint", "replyToComplaint" ], "variable": [ { "key": "complaint", "value": "1" } ] } }, "response": [ { "name": "replyToComplaint", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "complaint_text", "value": "KAMAL WRITE NOTES", "type": "text" } ] }, "url": { "raw": "api/complaints/:complaint/replyToComplaint", "host": [ "api" ], "path": [ "complaints", ":complaint", "replyToComplaint" ], "variable": [ { "key": "complaint", "value": "1" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Connection", "value": "Keep-Alive" }, { "key": "Keep-Alive", "value": "timeout=5, max=100" }, { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application/json" }, { "key": "x-ratelimit-limit", "value": "60" }, { "key": "x-ratelimit-remaining", "value": "57" }, { "key": "access-control-allow-origin", "value": "*" }, { "key": "content-length", "value": "54" }, { "key": "date", "value": "Fri, 23 May 2025 12:01:49 GMT" }, { "key": "server", "value": "LiteSpeed" }, { "key": "strict-transport-security", "value": "max-age=63072000; includeSubDomains" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "alt-svc", "value": "h3=\":443\"; ma=2592000, h3-29=\":443\"; ma=2592000, h3-Q050=\":443\"; ma=2592000, h3-Q046=\":443\"; ma=2592000, h3-Q043=\":443\"; ma=2592000, quic=\":443\"; ma=2592000; v=\"43,46\"" } ], "cookie": [], "body": "{\n \"status\": true,\n \"data\": null,\n \"messages\": null,\n \"code\": 200\n}" } ] }, { "name": "Review Complaint", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "complaint_text", "value": "REVIEW", "type": "text" } ] }, "url": { "raw": "api/complaints/:complaint/review", "host": [ "api" ], "path": [ "complaints", ":complaint", "review" ], "variable": [ { "key": "complaint", "value": "1" } ] } }, "response": [ { "name": "Review Complaint", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "complaint_text", "value": "REVIEW", "type": "text" } ] }, "url": { "raw": "api/complaints/:complaint/review", "host": [ "api" ], "path": [ "complaints", ":complaint", "review" ], "variable": [ { "key": "complaint", "value": "1" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Connection", "value": "Keep-Alive" }, { "key": "Keep-Alive", "value": "timeout=5, max=100" }, { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application/json" }, { "key": "x-ratelimit-limit", "value": "60" }, { "key": "x-ratelimit-remaining", "value": "58" }, { "key": "access-control-allow-origin", "value": "*" }, { "key": "content-length", "value": "54" }, { "key": "date", "value": "Fri, 23 May 2025 12:01:39 GMT" }, { "key": "server", "value": "LiteSpeed" }, { "key": "strict-transport-security", "value": "max-age=63072000; includeSubDomains" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "alt-svc", "value": "h3=\":443\"; ma=2592000, h3-29=\":443\"; ma=2592000, h3-Q050=\":443\"; ma=2592000, h3-Q046=\":443\"; ma=2592000, h3-Q043=\":443\"; ma=2592000, quic=\":443\"; ma=2592000; v=\"43,46\"" } ], "cookie": [], "body": "{\n \"status\": true,\n \"data\": null,\n \"messages\": null,\n \"code\": 200\n}" } ] }, { "name": "corrected", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "complaint_text", "value": "corrected", "type": "text" } ] }, "url": { "raw": "api/complaints/:complaint/corrected", "host": [ "api" ], "path": [ "complaints", ":complaint", "corrected" ], "variable": [ { "key": "complaint", "value": "1" } ] } }, "response": [] }, { "name": "rejectComplaint", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "complaint_text", "value": "reject text", "type": "text" } ] }, "url": { "raw": "api/complaints/:complaint/reject", "host": [ "api" ], "path": [ "complaints", ":complaint", "reject" ], "variable": [ { "key": "complaint", "value": "1" } ] } }, "response": [] }, { "name": "Show", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token_hr}}", "type": "string" } ] }, "method": "GET", "header": [], "url": { "raw": "api/complaints/:payroll_id/complaints/:id", "host": [ "api" ], "path": [ "complaints", ":payroll_id", "complaints", ":id" ], "variable": [ { "key": "payroll_id", "value": "469" }, { "key": "id", "value": "1" } ] } }, "response": [ { "name": "Show", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "api/complaints/:payroll_id/complaints/:id", "host": [ "api" ], "path": [ "complaints", ":payroll_id", "complaints", ":id" ], "variable": [ { "key": "payroll_id", "value": "469" }, { "key": "id", "value": "1" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Connection", "value": "Keep-Alive" }, { "key": "Keep-Alive", "value": "timeout=5, max=100" }, { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application/json" }, { "key": "x-ratelimit-limit", "value": "60" }, { "key": "x-ratelimit-remaining", "value": "59" }, { "key": "access-control-allow-origin", "value": "*" }, { "key": "content-length", "value": "1958" }, { "key": "date", "value": "Fri, 23 May 2025 12:02:16 GMT" }, { "key": "server", "value": "LiteSpeed" }, { "key": "strict-transport-security", "value": "max-age=63072000; includeSubDomains" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "alt-svc", "value": "h3=\":443\"; ma=2592000, h3-29=\":443\"; ma=2592000, h3-Q050=\":443\"; ma=2592000, h3-Q046=\":443\"; ma=2592000, h3-Q043=\":443\"; ma=2592000, quic=\":443\"; ma=2592000; v=\"43,46\"" } ], "cookie": [], "body": "{\n \"status\": true,\n \"data\": {\n \"id\": 1,\n \"payroll_id\": \"469\",\n \"employee_id\": \"57\",\n \"salary_issue\": \"overpaid\",\n \"custom_salary_issue_json\": [\n {\n \"label\": \"Basic Salary\",\n \"selected\": true\n },\n {\n \"label\": \"Bonus\",\n \"selected\": false\n },\n {\n \"label\": \"Overtime\",\n \"selected\": false\n },\n {\n \"label\": \"Housing Allowance\",\n \"selected\": false\n },\n {\n \"label\": \"Other (Specify Below)\",\n \"selected\": false\n }\n ],\n \"specify_issue_text\": \"specify_issue_text\",\n \"complaint_text\": \"complaint_text\",\n \"status\": \"awaiting_employee_action\",\n \"activity_log\": [\n {\n \"type\": \"note\",\n \"timestamp\": \"2025-05-18 13:00:42\",\n \"by\": {\n \"id\": 57,\n \"account_type\": \"employee\",\n \"name\": \"Nora Nader\",\n \"email\": \"employee16@company.com\",\n \"phone\": \"966517346506\",\n \"image\": null\n },\n \"message\": null\n },\n {\n \"type\": \"status_change\",\n \"timestamp\": \"2025-05-23 11:47:01\",\n \"by\": {\n \"id\": 43,\n \"account_type\": \"manager\",\n \"name\": \"Jennie Casimer Mitchell\",\n \"email\": \"manager20@company.com\",\n \"phone\": \"966542067492\",\n \"image\": null\n },\n \"status\": \"awaiting_employee_action\",\n \"note\": \"KAMAL WRITE NOTES\"\n },\n {\n \"type\": \"status_change\",\n \"timestamp\": \"2025-05-23 11:56:33\",\n \"by\": {\n \"id\": 43,\n \"account_type\": \"manager\",\n \"name\": \"Jennie Casimer Mitchell\",\n \"email\": \"manager20@company.com\",\n \"phone\": \"966542067492\",\n \"image\": null\n },\n \"status\": \"under_review\",\n \"note\": null\n },\n {\n \"type\": \"status_change\",\n \"timestamp\": \"2025-05-23 12:01:39\",\n \"by\": {\n \"id\": 43,\n \"account_type\": \"manager\",\n \"name\": \"Jennie Casimer Mitchell\",\n \"email\": \"manager20@company.com\",\n \"phone\": \"966542067492\",\n \"image\": null\n },\n \"status\": \"reviewed\",\n \"note\": \"REVIEW\"\n },\n {\n \"type\": \"status_change\",\n \"timestamp\": \"2025-05-23 12:01:49\",\n \"by\": {\n \"id\": 43,\n \"account_type\": \"manager\",\n \"name\": \"Jennie Casimer Mitchell\",\n \"email\": \"manager20@company.com\",\n \"phone\": \"966542067492\",\n \"image\": null\n },\n \"status\": \"awaiting_employee_action\",\n \"note\": \"KAMAL WRITE NOTES\"\n }\n ],\n \"employee_accepted_resolution\": false,\n \"accepted_at\": null,\n \"cancelled_by_employee\": false,\n \"cancelled_at\": null,\n \"created_at\": \"2025-05-18T13:00:42.000000Z\",\n \"updated_at\": \"2025-05-23T12:01:49.000000Z\",\n \"deleted_at\": null,\n \"reviewed_at\": \"2025-05-23T12:01:49.000000Z\",\n \"resolved_at\": null\n },\n \"messages\": null,\n \"code\": 200\n}" } ] }, { "name": "Accept Complaint Resolution", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "complaint_text", "value": "complaint_text", "type": "text" } ] }, "url": { "raw": "api/complaints/:complaint/accept-resolution", "host": [ "api" ], "path": [ "complaints", ":complaint", "accept-resolution" ], "variable": [ { "key": "complaint", "value": "1" } ] } }, "response": [ { "name": "Accept Complaint Resolution", "originalRequest": { "method": "POST", "header": [], "url": { "raw": "api/complaints/:complaint/accept-resolution", "host": [ "api" ], "path": [ "complaints", ":complaint", "accept-resolution" ], "variable": [ { "key": "complaint", "value": "1" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Connection", "value": "Keep-Alive" }, { "key": "Keep-Alive", "value": "timeout=5, max=100" }, { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application/json" }, { "key": "x-ratelimit-limit", "value": "60" }, { "key": "x-ratelimit-remaining", "value": "59" }, { "key": "access-control-allow-origin", "value": "*" }, { "key": "content-length", "value": "54" }, { "key": "date", "value": "Fri, 23 May 2025 12:04:22 GMT" }, { "key": "server", "value": "LiteSpeed" }, { "key": "strict-transport-security", "value": "max-age=63072000; includeSubDomains" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "alt-svc", "value": "h3=\":443\"; ma=2592000, h3-29=\":443\"; ma=2592000, h3-Q050=\":443\"; ma=2592000, h3-Q046=\":443\"; ma=2592000, h3-Q043=\":443\"; ma=2592000, quic=\":443\"; ma=2592000; v=\"43,46\"" } ], "cookie": [], "body": "{\n \"status\": true,\n \"data\": null,\n \"messages\": null,\n \"code\": 200\n}" } ] }, { "name": "underReview", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "complaint_text", "value": "", "type": "text" } ] }, "url": { "raw": "api/complaints/:complaint/underReview", "host": [ "api" ], "path": [ "complaints", ":complaint", "underReview" ], "variable": [ { "key": "complaint", "value": "1" } ] } }, "response": [ { "name": "underReview", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "complaint_text", "value": "", "type": "text" } ] }, "url": { "raw": "api/complaints/:complaint/underReview", "host": [ "api" ], "path": [ "complaints", ":complaint", "underReview" ], "variable": [ { "key": "complaint", "value": "1" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Connection", "value": "Keep-Alive" }, { "key": "Keep-Alive", "value": "timeout=5, max=100" }, { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application/json" }, { "key": "x-ratelimit-limit", "value": "60" }, { "key": "x-ratelimit-remaining", "value": "59" }, { "key": "access-control-allow-origin", "value": "*" }, { "key": "content-length", "value": "54" }, { "key": "date", "value": "Fri, 23 May 2025 11:56:33 GMT" }, { "key": "server", "value": "LiteSpeed" }, { "key": "strict-transport-security", "value": "max-age=63072000; includeSubDomains" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "alt-svc", "value": "h3=\":443\"; ma=2592000, h3-29=\":443\"; ma=2592000, h3-Q050=\":443\"; ma=2592000, h3-Q046=\":443\"; ma=2592000, h3-Q043=\":443\"; ma=2592000, quic=\":443\"; ma=2592000; v=\"43,46\"" } ], "cookie": [], "body": "{\n \"status\": true,\n \"data\": null,\n \"messages\": null,\n \"code\": 200\n}" } ] }, { "name": "payroll-complaints", "request": { "method": "GET", "header": [], "url": { "raw": "api/payroll-complaints?per_page=20", "host": [ "api" ], "path": [ "payroll-complaints" ], "query": [ { "key": "search", "value": "مشكلة في الراتب", "disabled": true }, { "key": "status", "value": "under_review", "disabled": true }, { "key": "salary_issue", "value": "underpaid", "disabled": true }, { "key": "created_from", "value": "2025-05-01", "disabled": true }, { "key": "created_to", "value": "2025-05-20", "disabled": true }, { "key": "reviewed_from", "value": "2025-05-10", "disabled": true }, { "key": "reviewed_to", "value": "2025-05-15", "disabled": true }, { "key": "accepted_from", "value": "2025-05-12", "disabled": true }, { "key": "accepted_to", "value": "2025-05-14", "disabled": true }, { "key": "cancelled_from", "value": "2025-05-01", "disabled": true }, { "key": "cancelled_to", "value": "2025-05-20", "disabled": true }, { "key": "sort_by", "value": "created_at", "disabled": true }, { "key": "sort_as", "value": "desc", "disabled": true }, { "key": "per_page", "value": "20" }, { "key": "status_list[]", "value": "under_review", "disabled": true } ] } }, "response": [] }, { "name": "mypayroll-complaints", "request": { "method": "GET", "header": [], "url": { "raw": "api/mypayroll-complaints?status_list[]=", "host": [ "api" ], "path": [ "mypayroll-complaints" ], "query": [ { "key": "search", "value": "مشكلة في الراتب", "disabled": true }, { "key": "status", "value": "under_review", "disabled": true }, { "key": "salary_issue", "value": "underpaid", "disabled": true }, { "key": "created_from", "value": "2025-05-01", "disabled": true }, { "key": "created_to", "value": "2025-05-20", "disabled": true }, { "key": "reviewed_from", "value": "2025-05-10", "disabled": true }, { "key": "reviewed_to", "value": "2025-05-15", "disabled": true }, { "key": "accepted_from", "value": "2025-05-12", "disabled": true }, { "key": "accepted_to", "value": "2025-05-14", "disabled": true }, { "key": "cancelled_from", "value": "2025-05-01", "disabled": true }, { "key": "cancelled_to", "value": "2025-05-20", "disabled": true }, { "key": "sort_by", "value": "created_at", "disabled": true }, { "key": "sort_as", "value": "desc", "disabled": true }, { "key": "per_page", "value": "20", "disabled": true }, { "key": "status_list[]", "value": "" } ] } }, "response": [] }, { "name": "Move To HR", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [] }, "url": { "raw": "api/complaints/:complaint/move", "host": [ "api" ], "path": [ "complaints", ":complaint", "move" ], "variable": [ { "key": "complaint", "value": "" } ] } }, "response": [] } ] }, { "name": "Employees", "item": [ { "name": "listEmployess", "request": { "method": "GET", "header": [], "url": { "raw": "api/listEmployess/:company?per_page=0&is_leaver=1", "host": [ "api" ], "path": [ "listEmployess", ":company" ], "query": [ { "key": "dropDown", "value": "1", "disabled": true }, { "key": "per_page", "value": "0" }, { "key": "sort", "value": "name", "disabled": true }, { "key": "sort_by", "value": "custom_id", "disabled": true }, { "key": "search", "value": "and Rogahn", "disabled": true }, { "key": "account_type", "value": "", "disabled": true }, { "key": "status", "value": "", "disabled": true }, { "key": "leaver_start_date", "value": "", "disabled": true }, { "key": "leaver_endt_date", "value": "", "disabled": true }, { "key": "joining_start_date", "value": "", "disabled": true }, { "key": "joining_end_date", "value": "", "disabled": true }, { "key": "is_leaver", "value": "1", "description": "1,0" }, { "key": "leave_date_status", "value": "none", "disabled": true } ], "variable": [ { "key": "company", "value": "" } ] } }, "response": [ { "name": "listEmployess", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "api/listEmployess/:company?dropDown=1&per_page=12&is_leaver=0", "host": [ "api" ], "path": [ "listEmployess", ":company" ], "query": [ { "key": "dropDown", "value": "1" }, { "key": "per_page", "value": "12" }, { "key": "sort_by", "value": "", "disabled": true }, { "key": "per_page", "value": "", "disabled": true }, { "key": "search", "value": "and Rogahn", "disabled": true }, { "key": "account_type", "value": null, "disabled": true }, { "key": "status", "value": null, "disabled": true }, { "key": "leaver_start_date", "value": null, "disabled": true }, { "key": "leaver_endt_date", "value": null, "disabled": true }, { "key": "joining_start_date", "value": null, "disabled": true }, { "key": "joining_end_date", "value": null, "disabled": true }, { "key": "is_leaver", "value": "0", "description": "1,0" } ], "variable": [ { "key": "company", "value": "1" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Connection", "value": "Keep-Alive" }, { "key": "Keep-Alive", "value": "timeout=5, max=100" }, { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application/json" }, { "key": "x-ratelimit-limit", "value": "60" }, { "key": "x-ratelimit-remaining", "value": "58" }, { "key": "access-control-allow-origin", "value": "*" }, { "key": "content-length", "value": "2356" }, { "key": "date", "value": "Fri, 23 May 2025 13:13:29 GMT" }, { "key": "server", "value": "LiteSpeed" }, { "key": "strict-transport-security", "value": "max-age=63072000; includeSubDomains" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "alt-svc", "value": "h3=\":443\"; ma=2592000, h3-29=\":443\"; ma=2592000, h3-Q050=\":443\"; ma=2592000, h3-Q046=\":443\"; ma=2592000, h3-Q043=\":443\"; ma=2592000, quic=\":443\"; ma=2592000; v=\"43,46\"" } ], "cookie": [], "body": "{\n \"status\": true,\n \"data\": [\n {\n \"id\": 30,\n \"name\": \"Dustin Lloyd Cartwright\",\n \"email\": \"company18@gmail.com\",\n \"account_type\": \"company\",\n \"phone\": \"966540552719\",\n \"status\": \"active\",\n \"leaving_date\": null\n },\n {\n \"id\": 29,\n \"name\": \"Keon Heidenreich\",\n \"email\": \"company17@gmail.com\",\n \"account_type\": \"company\",\n \"phone\": \"966586079477\",\n \"status\": \"active\",\n \"leaving_date\": null\n },\n {\n \"id\": 28,\n \"name\": \"Eusebio Runolfsson\",\n \"email\": \"company16@gmail.com\",\n \"account_type\": \"company\",\n \"phone\": \"966558880461\",\n \"status\": \"active\",\n \"leaving_date\": null\n },\n {\n \"id\": 27,\n \"name\": \"Hallie Roberto Bogan\",\n \"email\": \"company15@gmail.com\",\n \"account_type\": \"company\",\n \"phone\": \"966581668996\",\n \"status\": \"active\",\n \"leaving_date\": null\n },\n {\n \"id\": 26,\n \"name\": \"Eveline Spencer Heidenreich\",\n \"email\": \"company14@gmail.com\",\n \"account_type\": \"company\",\n \"phone\": \"966511120069\",\n \"status\": \"active\",\n \"leaving_date\": null\n },\n {\n \"id\": 25,\n \"name\": \"Nicolette Bernardo Roberts\",\n \"email\": \"company13@gmail.com\",\n \"account_type\": \"company\",\n \"phone\": \"966543202125\",\n \"status\": \"active\",\n \"leaving_date\": null\n },\n {\n \"id\": 24,\n \"name\": \"Priscilla Mabel Mosciski\",\n \"email\": \"company12@gmail.com\",\n \"account_type\": \"company\",\n \"phone\": \"966549172399\",\n \"status\": \"active\",\n \"leaving_date\": null\n },\n {\n \"id\": 23,\n \"name\": \"Dion Eliane Daniel\",\n \"email\": \"company11@gmail.com\",\n \"account_type\": \"company\",\n \"phone\": \"966517645692\",\n \"status\": \"active\",\n \"leaving_date\": null\n },\n {\n \"id\": 22,\n \"name\": \"Elisha Stokes\",\n \"email\": \"company10@gmail.com\",\n \"account_type\": \"company\",\n \"phone\": \"966518839113\",\n \"status\": \"active\",\n \"leaving_date\": null\n },\n {\n \"id\": 21,\n \"name\": \"Roderick Pouros\",\n \"email\": \"company9@gmail.com\",\n \"account_type\": \"company\",\n \"phone\": \"966571508235\",\n \"status\": \"active\",\n \"leaving_date\": null\n },\n {\n \"id\": 20,\n \"name\": \"Jaden Kaitlin Halvorson\",\n \"email\": \"company8@gmail.com\",\n \"account_type\": \"company\",\n \"phone\": \"966539775326\",\n \"status\": \"active\",\n \"leaving_date\": null\n },\n {\n \"id\": 19,\n \"name\": \"Tyra Stamm\",\n \"email\": \"company6@gmail.com\",\n \"account_type\": \"company\",\n \"phone\": \"966576270592\",\n \"status\": \"active\",\n \"leaving_date\": null\n },\n {\n \"id\": 18,\n \"name\": \"Taya Zieme\",\n \"email\": \"company5@gmail.com\",\n \"account_type\": \"company\",\n \"phone\": \"966554217238\",\n \"status\": \"active\",\n \"leaving_date\": null\n },\n {\n \"id\": 17,\n \"name\": \"Bette Julia Frami\",\n \"email\": \"company4@gmail.com\",\n \"account_type\": \"company\",\n \"phone\": \"966589385370\",\n \"status\": \"active\",\n \"leaving_date\": null\n },\n {\n \"id\": 16,\n \"name\": \"Ceasar Koch\",\n \"email\": \"company3@gmail.com\",\n \"account_type\": \"company\",\n \"phone\": \"966510857384\",\n \"status\": \"active\",\n \"leaving_date\": null\n }\n ],\n \"messages\": null,\n \"code\": 200\n}" } ] }, { "name": "get Details", "request": { "method": "GET", "header": [], "url": { "raw": "api/listEmployess/:cid/:uid", "host": [ "api" ], "path": [ "listEmployess", ":cid", ":uid" ], "query": [ { "key": "sort_by", "value": "", "disabled": true } ], "variable": [ { "key": "cid", "value": "1" }, { "key": "uid", "value": "104" } ] } }, "response": [ { "name": "get Details", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "api/listEmployess/:uid/:cid", "host": [ "api" ], "path": [ "listEmployess", ":uid", ":cid" ], "query": [ { "key": "sort_by", "value": "", "disabled": true } ], "variable": [ { "key": "uid", "value": "110" }, { "key": "cid", "value": "502" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Connection", "value": "Keep-Alive" }, { "key": "Keep-Alive", "value": "timeout=5, max=100" }, { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application/json" }, { "key": "x-ratelimit-limit", "value": "60" }, { "key": "x-ratelimit-remaining", "value": "55" }, { "key": "access-control-allow-origin", "value": "*" }, { "key": "content-length", "value": "1411" }, { "key": "date", "value": "Sun, 25 May 2025 21:00:08 GMT" }, { "key": "server", "value": "LiteSpeed" }, { "key": "strict-transport-security", "value": "max-age=63072000; includeSubDomains" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "x-content-type-options", "value": "nosniff" } ], "cookie": [], "body": "{\n \"status\": true,\n \"data\": {\n \"id\": 110,\n \"custom_id\": \"EM00000019\",\n \"name\": \"Ali Hassan Khaled\",\n \"first_name\": \"Ali\",\n \"middle_name\": \"Hassan\",\n \"last_name\": \"Khaled\",\n \"email\": \"exampl1211e@example.com\",\n \"phone\": \"1231678910\",\n \"email_verified_at\": null,\n \"account_type\": \"employee\",\n \"verified\": 1,\n \"status\": \"active\",\n \"national_insurance_number\": \"123456718910\",\n \"created_at\": \"2025-05-19T17:27:20.000000Z\",\n \"is_leaver\": 0,\n \"leaving_date\": null,\n \"updated_at\": \"2025-05-19T17:27:20.000000Z\",\n \"companies\": [\n {\n \"id\": 502,\n \"name\": \"Hayes, Bartoletti and Harris\",\n \"legal_name\": \"Gislason-Reilly LLC\",\n \"registration_number\": \"REG3630077\",\n \"vat_number\": \"VAT45954812\",\n \"tax_id\": \"TAX12631686\",\n \"country\": \"Belize\",\n \"city\": \"North Everardochester\",\n \"address_line\": \"33050 Kattie Radial\\nHackettmouth, MT 53130-2780\",\n \"postal_code\": \"90458\",\n \"phone\": \"251.749.6948\",\n \"status\": \"inactive\",\n \"email\": \"bobby46@cartwright.com\",\n \"website\": \"http://kemmer.com/sed-sed-dolores-consectetur-eos-rerum-corrupti-odit-ipsum\",\n \"industry_type\": \"Healthcare\",\n \"logo_path\": null,\n \"translation\": null,\n \"owner_id\": 18,\n \"deleted_at\": null,\n \"created_at\": \"2025-05-14T17:08:42.000000Z\",\n \"updated_at\": \"2025-05-14T17:08:42.000000Z\",\n \"department_name\": \"Cultural Studies Teacher\",\n \"cost_center_name\": \"molestiae\",\n \"pivot\": {\n \"user_id\": \"110\",\n \"company_id\": \"502\",\n \"emp_id\": \"111\",\n \"department_id\": \"5\",\n \"cost_center_id\": \"179\",\n \"created_at\": \"2025-05-19T17:27:20.000000Z\",\n \"updated_at\": \"2025-05-19T17:27:20.000000Z\"\n }\n }\n ]\n },\n \"messages\": null,\n \"code\": 200\n}" } ] } ] }, { "name": "PayRolls", "item": [ { "name": "Salary", "item": [ { "name": "importFile", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "src": "/C:/Users/kamal/OneDrive/Desktop/Payslip Exce2l.xlsx" }, { "key": "company_id", "value": "2", "type": "text" } ] }, "url": { "raw": "api/payrolls/importFile/execute", "host": [ "api" ], "path": [ "payrolls", "importFile", "execute" ] } }, "response": [] }, { "name": "addManual", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"pay_month\": \"01/02/2024 – 31/02/2024\",\r\n \"net_pay\": \"9809.87\",\r\n \"emp_id\": 2,\r\n \"company_id\" :2,\r\n \"salary_details\": [\r\n {\r\n \"key\": \"basic\",\r\n \"value\": \"3000\",\r\n \"type\": \"Payment\"\r\n },\r\n {\r\n \"key\": \"allowance\",\r\n \"value\": \"1000\",\r\n \"type\": \"Other\"\r\n },\r\n {\r\n \"key\": \"deductions\",\r\n \"value\": \"500\",\r\n \"type\": \"Deduction\"\r\n }\r\n ]\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "api/payrolls/addManual/execute", "host": [ "api" ], "path": [ "payrolls", "addManual", "execute" ] } }, "response": [ { "name": "addManual", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"pay_month\": \"01/02/2024 – 31/02/2024\",\r\n \"total_salary\": \"9809.87\",\r\n \"emp_id\": 2,\r\n \"company_id\" :2,\r\n \"salary_details\": [\r\n {\r\n \"key\": \"basic\",\r\n \"value\": 3000\r\n },\r\n {\r\n \"key\": \"allowance\",\r\n \"value\": 1000\r\n },\r\n {\r\n \"key\": \"deductions\",\r\n \"value\": 500\r\n }\r\n ]\r\n}\r\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "api/payrolls/addManual/execute", "host": [ "api" ], "path": [ "payrolls", "addManual", "execute" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Connection", "value": "Keep-Alive" }, { "key": "Keep-Alive", "value": "timeout=5, max=100" }, { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application/json" }, { "key": "x-ratelimit-limit", "value": "60" }, { "key": "x-ratelimit-remaining", "value": "58" }, { "key": "access-control-allow-origin", "value": "*" }, { "key": "content-length", "value": "809" }, { "key": "date", "value": "Mon, 16 Jun 2025 02:22:03 GMT" }, { "key": "server", "value": "LiteSpeed" }, { "key": "strict-transport-security", "value": "max-age=63072000; includeSubDomains" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "alt-svc", "value": "h3=\":443\"; ma=2592000, h3-29=\":443\"; ma=2592000, h3-Q050=\":443\"; ma=2592000, h3-Q046=\":443\"; ma=2592000, h3-Q043=\":443\"; ma=2592000, quic=\":443\"; ma=2592000; v=\"43,46\"" } ], "cookie": [], "body": "{\n \"status\": true,\n \"data\": {\n \"id\": 504,\n \"pay_month\": \"01/02/2024 – 31/02/2024\",\n \"pay_period\": \"monthly\",\n \"total_salary\": \"9809.87\",\n \"created_type\": \"manual\",\n \"department_id\": 1,\n \"cost_center_id\": 181,\n \"custom_id\": null,\n \"leaver\": null,\n \"salary_details\": [\n {\n \"key\": \"basic\",\n \"value\": 3000\n },\n {\n \"key\": \"allowance\",\n \"value\": 1000\n },\n {\n \"key\": \"deductions\",\n \"value\": 500\n }\n ],\n \"confirmation_status\": \"pending\",\n \"confirmed_at\": null,\n \"confirmed_by\": null,\n \"created_by\": null,\n \"employee_id\": 2,\n \"rejected_by\": null,\n \"rejected_at\": null,\n \"rejection_reason\": null,\n \"deleted_at\": null,\n \"created_at\": \"2025-06-16T02:22:03.000000Z\",\n \"is_leaver\": 0,\n \"leaving_date\": null,\n \"updated_at\": \"2025-06-16T02:22:03.000000Z\",\n \"salary_confirm_at\": null,\n \"salary_confirm_by\": null,\n \"company_id\": 2,\n \"moved_to\": null,\n \"moved_at\": null,\n \"moved_by\": null\n },\n \"messages\": \"Payroll successfully created.\",\n \"code\": 200\n}" } ] } ] }, { "name": "reject", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "rejection_reason", "value": "rejection reason", "type": "text" } ] }, "url": { "raw": "api/payrolls/:payroll/reject", "host": [ "api" ], "path": [ "payrolls", ":payroll", "reject" ], "variable": [ { "key": "payroll", "value": "469" } ] } }, "response": [] }, { "name": "list", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "rejection_reason", "value": "rejection reason", "type": "text" } ] }, "url": { "raw": "api/payrolls/:cid", "host": [ "api" ], "path": [ "payrolls", ":cid" ], "query": [ { "key": "per_page", "value": "12", "disabled": true }, { "key": "sort_by", "value": "created_at", "disabled": true }, { "key": "sort", "value": "desc", "disabled": true }, { "key": "created_from", "value": "2025-05-01", "disabled": true }, { "key": "confirmation_status", "value": "pending", "disabled": true } ], "variable": [ { "key": "cid", "value": "2" } ] }, "description": "StartFragment\n\n`GET /api/payrolls/{company_id}`\n\n- حيث أن `{company_id}` هو معرف الشركة المطلوب جلب مسيرات الرواتب الخاصة بها.\n \n\n---\n\n### بارامترات الاستعلام (Query Parameters):\n\n1. **per_page**: عدد صحيح (اختياري) \n \n يُستخدم لتحديد عدد العناصر التي سيتم عرضها في كل صفحة عند استخدام نظام pagination. إذا لم يتم إرساله أو كانت قيمته 0، سيتم جلب 100 نتيجة فقط باستخدام `limit(100)`.\n \n2. **sort_by**: نص (اختياري) \n \n العمود الذي سيتم ترتيب النتائج بناءً عليه. القيمة الافتراضية هي `id`. يمكن استخدام أعمدة مثل `created_at`، `id`، وغيرها.\n \n3. **sort**: نص (اختياري) \n \n اتجاه الترتيب: `asc` (تصاعدي) أو `desc` (تنازلي). القيمة الافتراضية هي `desc`.\n \n4. **created_from**: تاريخ بصيغة `YYYY-MM-DD` (اختياري) \n \n لتصفية النتائج حسب تاريخ الإنشاء بحيث يتم جلب العناصر التي تم إنشاؤها في أو بعد هذا التاريخ.\n \n5. **confirmation_status**: نص (اختياري) \n \n لتصفية النتائج حسب حالة التأكيد، مثل: `pending`، `confirmed`، أو `rejected`. إذا لم يتم تحديد القيمة، سيتم استخدام القيمة الافتراضية من الثابت `AppEnum::PAYROLL_PENDING`.\n \n\n---\n\n### العلاقات التي يتم تحميلها تلقائيًا مع النتائج:\n\n- `department` (القسم)\n \n- `cost_center` (مركز التكلفة)\n \n- `createdBy` (المستخدم الذي أنشأ السجل)\n \n- `confirmedBy` (المستخدم الذي قام بالتأكيد)\n \n- `rejectedBy` (المستخدم الذي قام بالرفض)\n \n\nEndFragment" }, "response": [] }, { "name": "confirm", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "is_leaver", "value": "1", "type": "text" }, { "key": "leaving_date", "value": "2025-05-23 13:16:18", "type": "text" } ] }, "url": { "raw": "api/payrolls/:payroll/confirm", "host": [ "api" ], "path": [ "payrolls", ":payroll", "confirm" ], "variable": [ { "key": "payroll", "value": "469" } ] } }, "response": [] }, { "name": "Move To HR", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [] }, "url": { "raw": "api/payrolls/:payroll/move", "host": [ "api" ], "path": [ "payrolls", ":payroll", "move" ], "variable": [ { "key": "payroll", "value": "" } ] } }, "response": [] } ] }, { "name": "Payroll Columns Management", "item": [ { "name": "Create Payroll Column", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"name\": \"Basic Salary\",\r\n \"type\": \"payment\",\r\n \"company_id\": 2\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "api/payroll-columns", "host": [ "api" ], "path": [ "payroll-columns" ] } }, "response": [] }, { "name": "Get Company Payroll Columns", "request": { "method": "GET", "header": [], "url": { "raw": "/api/payroll-columns?company_id=2", "path": [ "api", "payroll-columns" ], "query": [ { "key": "company_id", "value": "2" } ] } }, "response": [] } ] }, { "name": "Secure Contract Management", "item": [ { "name": "Upload Contract", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "employee_id", "value": "6", "description": "معرف الموظف - مطلوب", "type": "text" }, { "key": "contract_document", "description": "ملف العقد - صيغ مدعومة: PDF, DOC, DOCX, TXT - الحد الأقصى 10 ميجابايت - مطلوب", "type": "file", "src": "/C:/Users/kamal/Downloads/New Text Document.txt" }, { "key": "contract_type", "value": "full-time", "description": "نوع العقد - اختياري - مثال: دوام كامل، دوام جزئي، مؤقت", "type": "text" }, { "key": "effective_date", "value": "2025-12-01", "description": "تاريخ بدء العقد - اختياري - الصيغة: سنة-شهر-يوم مثال: 2025-12-01", "type": "text" }, { "key": "end_date", "value": "2026-12-01", "description": "تاريخ انتهاء العقد - اختياري - الصيغة: سنة-شهر-يوم مثال: 2026-12-01", "type": "text" } ] }, "url": { "raw": "api/secure/contracts", "host": [ "api" ], "path": [ "secure", "contracts" ] }, "description": "رفع عقد موظف\n\nهذا الطلب يسمح لأصحاب الصلاحيات برفع عقود للموظفين. يتم إرسال إشعار تلقائي للموظف عند رفع العقد.\n\nالصلاحيات المطلوبة\n\nmالك الشركة\nيمكنه رفع عقود لجميع الأدوار: الموارد البشرية، المدراء، الموظفين\n\nالموارد البشرية\nيمكنه رفع عقود للمدراء والموظفين فقط\n\nالمدير\nيمكنه رفع عقود للموظفين فقط\n\nالحقول المطلوبة\n\nemployee_id\nمعرف الموظف الذي سيتم رفع العقد له. يجب أن يكون الموظف موجودا في الشركة.\n\ncontract_document\nملف العقد. الصيغ المدعومة: PDF, DOC, DOCX, TXT. الحد الأقصى للحجم: 10 ميجابايت.\n\nالحقول الاختيارية\n\ncontract_type\nنوع العقد. مثال: دوام كامل، دوام جزئي، عقد مؤقت، عقد استشاري.\n\neffective_date\nتاريخ بدء سريان العقد. الصيغة: سنة-شهر-يوم (2025-12-01).\n\nend_date\nتاريخ انتهاء العقد. الصيغة: سنة-شهر-يوم (2026-12-01).\n\nmetadata\nبيانات إضافية بصيغة JSON. يمكن إضافة أي معلومات مخصصة مثل الراتب، المزايا، شروط خاصة.\n\nالإشعارات\n\nعند رفع العقد بنجاح يتم:\n- إرسال إشعار Firebase للموظف المعني\n- تسجيل العملية في سجل الأنشطة\n- حفظ معلومات من رفع العقد\n\nحالة العقد\n\nيتم إنشاء العقد بحالة معلق (pending) وينتظر قبول أو رفض الموظف." }, "response": [] }, { "name": "Get All Contracts", "request": { "method": "GET", "header": [], "url": { "raw": "api/secure/contracts", "host": [ "api" ], "path": [ "secure", "contracts" ] }, "description": "عرض جميع العقود\n\nهذا الطلب يعرض قائمة العقود حسب صلاحيات المستخدم.\n\nالصلاحيات\n\nمالك الشركة والموارد البشرية\nيمكنهم عرض جميع عقود الشركة بكل الحالات (معلق، مقبول، مرفوض).\n\nالمدير\nيمكنه عرض عقود الموظفين التابعين له فقط.\n\nالموظف\nيمكنه عرض عقوده الشخصية فقط.\n\nملاحظة\n\nالنتيجة مقسمة على صفحات (pagination) للأداء الأفضل." }, "response": [] }, { "name": "Get Contract by ID", "request": { "method": "GET", "header": [], "url": { "raw": "api/secure/contracts/:contractId", "host": [ "api" ], "path": [ "secure", "contracts", ":contractId" ], "variable": [ { "key": "contractId", "value": "1" } ] }, "description": "عرض تفاصيل عقد محدد\n\nهذا الطلب يعرض تفاصيل عقد معين باستخدام معرفه.\n\nالمعلومات المرجعة\n\n- معلومات الموظف المعني\n- معلومات من رفع العقد\n- حالة العقد (معلق/مقبول/مرفوض)\n- تفاصيل الملف والمسار\n- تواريخ البدء والانتهاء\n- تعليقات الموظف إن وجدت\n- البيانات الوصفية الإضافية\n\nالصلاحيات\n\nيجب أن يكون للمستخدم صلاحية عرض العقد حسب دوره." }, "response": [] }, { "name": "Get Contracts by Employee", "request": { "method": "GET", "header": [], "url": { "raw": "api/secure/contracts/employee/:employeeId", "host": [ "api" ], "path": [ "secure", "contracts", "employee", ":employeeId" ], "variable": [ { "key": "employeeId", "value": "31" } ] }, "description": "عرض عقود موظف محدد\n\nهذا الطلب يعرض جميع عقود موظف معين باستخدام معرفه.\n\nالمعلومات المرجعة\n\n- جميع عقود الموظف بكل الحالات\n- مرتبة حسب التاريخ (الأحدث أولا)\n- معلومات من رفع كل عقد\n\nالصلاحيات\n\nالموظف يمكنه عرض عقوده فقط. المدراء والموارد البشرية يمكنهم عرض عقود أي موظف." }, "response": [] }, { "name": "Update Contract", "request": { "method": "PUT", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "contract_type", "value": "permanent", "type": "text" }, { "key": "effective_date", "value": "2025-12-15", "type": "text" } ] }, "url": { "raw": "api/secure/contracts/:contractId", "host": [ "api" ], "path": [ "secure", "contracts", ":contractId" ], "variable": [ { "key": "contractId", "value": "1" } ] }, "description": "تعديل عقد\n\nهذا الطلب يسمح بتعديل تفاصيل عقد معلق فقط.\n\nملاحظة مهمة\n\nفقط العقود في حالة معلق يمكن تعديلها. العقود المقبولة أو المرفوضة لا يمكن تعديلها.\n\nالحقول القابلة للتعديل\n\n- contract_document: ملف عقد جديد (اختياري)\n- contract_type: نوع العقد\n- effective_date: تاريخ البدء\n- end_date: تاريخ الانتهاء\n- metadata: بيانات إضافية\n\nالصلاحيات\n\nفقط من رفع العقد أو من له صلاحية أعلى يمكنه التعديل.\n\nالإشعارات\n\nيتم إرسال إشعار للموظف عند تعديل عقده." }, "response": [] }, { "name": "Delete Contract", "request": { "method": "DELETE", "header": [], "url": { "raw": "api/secure/contracts/:contractId", "host": [ "api" ], "path": [ "secure", "contracts", ":contractId" ], "variable": [ { "key": "contractId", "value": "1" } ] }, "description": "حذف عقد\n\nهذا الطلب يحذف عقدا معلقا بشكل نهائي.\n\nملاحظة مهمة\n\nفقط العقود في حالة معلق يمكن حذفها. العقود المقبولة أو المرفوضة لا يمكن حذفها.\n\nعند الحذف\n\n- يتم حذف ملف العقد من الخادم\n- يتم حذف سجل العقد من قاعدة البيانات\n- يتم إرسال إشعار للموظف المعني\n- يتم تسجيل العملية في سجل الأنشطة\n\nالصلاحيات\n\nفقط من رفع العقد أو من له صلاحية أعلى يمكنه الحذف." }, "response": [] }, { "name": "Accept or Reject Contract", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"action\": \"accept\",\n \"comments\": \"I agree to the terms.\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "api/secure/contracts/:contractId/response", "host": [ "api" ], "path": [ "secure", "contracts", ":contractId", "response" ], "variable": [ { "key": "contractId", "value": "1" } ] }, "description": "قبول أو رفض عقد\n\nهذا الطلب يسمح للموظف بقبول أو رفض عقده.\n\nالحقول المطلوبة\n\naction\nالإجراء المطلوب. القيم المسموحة: accept (قبول) أو reject (رفض).\n\nالحقول الاختيارية\n\ncomments\nتعليقات الموظف على العقد. يمكن إضافة ملاحظات أو أسباب القبول أو الرفض. الحد الأقصى: 1000 حرف.\n\nملاحظة مهمة\n\nهذا الطلب متاح للموظف فقط. بعد القبول أو الرفض، لا يمكن تعديل أو حذف العقد.\n\nعند القبول\n\n- تتغير حالة العقد إلى مقبول\n- يتم تسجيل تاريخ القبول ومعرف الموظف\n- يتم إرسال إشعار لمن رفع العقد ومالك الشركة\n\nعند الرفض\n\n- تتغير حالة العقد إلى مرفوض\n- يتم تسجيل تاريخ الرفض والسبب ومعرف الموظف\n- يتم إرسال إشعار لمن رفع العقد ومالك الشركة مع السبب" }, "response": [] }, { "name": "Download Contract", "request": { "method": "GET", "header": [], "url": { "raw": "api/secure/contracts/:contractId/download", "host": [ "api" ], "path": [ "secure", "contracts", ":contractId", "download" ], "variable": [ { "key": "contractId", "value": "1" } ] }, "description": "تحميل ملف عقد\n\nهذا الطلب يحمل ملف العقد من الخادم.\n\nالمعلومات المرجعة\n\n- ملف العقد بالاسم الأصلي\n- يتم تحميله مباشرة في المتصفح\n\nالصلاحيات\n\nيجب أن يكون للمستخدم صلاحية عرض العقد حسب دوره." }, "response": [] } ], "description": "نظام إدارة العقود\n\nنظام شامل لإدارة عقود الموظفين يسمح للشركات برفع العقود ومتابعة حالتها مع إمكانية قبول أو رفض العقود من قبل الموظفين. النظام يوفر صلاحيات مختلفة حسب دور المستخدم ويرسل إشعارات تلقائية عند كل عملية.\n\nالأدوار والصلاحيات\n\nمالك الشركة \nيمتلك صلاحيات كاملة لإدارة جميع العقود في الشركة\n\n- رفع العقود: يمكنه رفع عقود لجميع الأدوار (الموارد البشرية، المدراء، الموظفين)\n \n- التعديل والحذف: يمكنه تعديل أو حذف أي عقد في حالة معلق فقط\n \n- العرض والتحميل: يمكنه عرض وتحميل جميع العقود الموجودة في الشركة\n \n- الإشعارات: يستلم إشعارات عندما يقبل أو يرفض موظف عقده\n \n\nالموارد البشرية \nصلاحيات واسعة لإدارة عقود المدراء والموظفين\n\n- رفع العقود: يمكنه رفع عقود للمدراء والموظفين فقط (لا يمكن رفع عقود لموارد بشرية أخرى)\n \n- التعديل والحذف: يمكنه تعديل أو حذف العقود المعلقة للمدراء والموظفين\n \n- العرض والتحميل: يمكنه عرض وتحميل جميع عقود الشركة\n \n- الإشعارات: يستلم إشعارات عند قبول أو رفض العقود التي رفعها\n \n\nالمدير \nصلاحيات محدودة لإدارة عقود الموظفين التابعين له فقط\n\n- رفع العقود: يمكنه رفع عقود للموظفين فقط\n \n- التعديل والحذف: يمكنه تعديل أو حذف العقود المعلقة للموظفين الذين رفع لهم العقود\n \n- العرض والتحميل: يمكنه عرض وتحميل عقود الموظفين التابعين له فقط\n \n- الإشعارات: يستلم إشعارات عند قبول أو رفض العقود التي رفعها\n \n\nالموظف \nصلاحيات محدودة للتعامل مع عقوده الشخصية فقط\n\n- قبول أو رفض: يمكنه قبول أو رفض العقود الخاصة به فقط\n \n- العرض والتحميل: يمكنه عرض وتحميل عقوده الشخصية فقط\n \n- إضافة تعليقات: يمكنه إضافة تعليقات عند قبول أو رفض العقد\n \n- الإشعارات: يستلم إشعارات عند رفع أو تحديث أو حذف عقوده\n \n\nحالات العقد\n\nمعلق\n\n- الحالة الافتراضية عند رفع العقد\n \n- ينتظر قبول أو رفض الموظف\n \n- يمكن تعديل أو حذف العقد في هذه الحالة\n \n- الموظف لم يتخذ قرار بعد\n \n\nمقبول\n\n- العقد تم قبوله من قبل الموظف\n \n- لا يمكن تعديل أو حذف العقد بعد القبول\n \n- تم تسجيل تاريخ ووقت القبول\n \n- تم تسجيل معرف المستخدم الذي قبل العقد\n \n\nمرفوض\n\n- العقد تم رفضه من قبل الموظف\n \n- لا يمكن تعديل أو حذف العقد بعد الرفض\n \n- تم تسجيل تاريخ ووقت الرفض\n \n- تم تسجيل معرف المستخدم الذي رفض العقد\n \n- يمكن للموظف إضافة تعليقات توضح سبب الرفض\n \n\nنظام الإشعارات\n\nيتم إرسال إشعارات تلقائية عبر Firebase في الحالات التالية\n\nعند رفع عقد جديد\n\n- يتم إرسال إشعار للموظف المعني\n \n- الإشعار يحتوي على رابط لعرض تفاصيل العقد\n \n- نوع الإشعار: CONTRACT_UPLOADED\n \n\nعند تحديث عقد\n\n- يتم إرسال إشعار للموظف المعني\n \n- الإشعار يوضح أن العقد تم تحديثه\n \n- نوع الإشعار: CONTRACT_UPDATED\n \n\nعند حذف عقد\n\n- يتم إرسال إشعار للموظف المعني\n \n- الإشعار يوضح أن العقد تم حذفه\n \n- نوع الإشعار: CONTRACT_DELETED\n \n\nعند قبول عقد\n\n- يتم إرسال إشعار للمستخدم الذي رفع العقد\n \n- يتم إرسال إشعار لمالك الشركة\n \n- الإشعار يحتوي على اسم الموظف الذي قبل العقد\n \n- نوع الإشعار: CONTRACT_ACCEPTED\n \n\nعند رفض عقد\n\n- يتم إرسال إشعار للمستخدم الذي رفع العقد\n \n- يتم إرسال إشعار لمالك الشركة\n \n- الإشعار يحتوي على اسم الموظف وسبب الرفض إن وجد\n \n- نوع الإشعار: CONTRACT_REJECTED\n \n\nمميزات النظام\n\nإدارة كاملة للعقود\n\n- رفع ملفات العقود بصيغة PDF أو صور\n \n- تحديد نوع العقد ومدته\n \n- إضافة بيانات وصفية إضافية\n \n- تحديد تاريخ البدء والانتهاء\n \n\nتتبع شامل\n\n- تسجيل كل العمليات على العقد\n \n- حفظ تاريخ ووقت كل عملية\n \n- معرفة من قام برفع أو تعديل العقد\n \n- معرفة من قبل أو رفض العقد\n \n\nصلاحيات متقدمة\n\n- صلاحيات مختلفة حسب الدور\n \n- منع التعديل على العقود المقبولة أو المرفوضة\n \n- فحص الصلاحيات قبل كل عملية\n \n\nإشعارات تلقائية\n\n- إشعارات فورية عبر Firebase\n \n- إشعارات لجميع الأطراف المعنية\n \n- روابط مباشرة لعرض العقود\n \n\nملاحظات مهمة\n\nالعقود المعلقة فقط\n\n- يمكن تعديل أو حذف العقود في حالة معلق فقط\n \n- العقود المقبولة أو المرفوضة لا يمكن تعديلها أو حذفها\n \n- هذا يضمن عدم التلاعب بالعقود بعد اتخاذ القرار\n \n\nصيغ الملفات المدعومة\n\n- PDF\n \n- الصور (JPG, PNG)\n \n- الحد الأقصى لحجم الملف يتم تحديده في إعدادات النظام\n \n\nالبيانات الوصفية\n\n- يمكن إضافة بيانات إضافية بصيغة JSON\n \n- مفيدة لتخزين معلومات مخصصة حسب احتياجات الشركة\n \n- مثل: الراتب، المزايا، شروط خاصة، إلخ\n \n\nتعليقات الموظف\n\n- يمكن للموظف إضافة تعليقات عند قبول أو رفض العقد\n \n- التعليقات اختيارية\n \n- تساعد في فهم أسباب القبول أو الرفض" }, { "name": "Invitation Management", "item": [ { "name": "Send Invitation", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"email\": \"newemployee@example.com\",\n \"phone\": \"+966501234567\",\n \"account_type\": \"employee\",\n \"delivery_method\": \"both\",\n \"expires_in_days\": 7,\n \"message\": \"مرحبا! نحن متحمسون لانضمامك لفريقنا.\",\n \"redirect_url\": \"https://yourfrontend.com/accept-invitation\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "api/invitations", "host": [ "api" ], "path": [ "invitations" ] }, "description": "إرسال دعوة\n\nهذا الطلب يسمح بإرسال دعوة لمستخدم جديد للانضمام إلى الشركة.\n\nالصلاحيات المطلوبة\n\nمالك الشركة\nيمكنه دعوة جميع الأدوار: موارد بشرية، مدراء، موظفين.\n\nالموارد البشرية\nيمكنه دعوة مدراء وموظفين فقط.\n\nالمدير\nيمكنه دعوة موظفين فقط.\n\nالحقول المطلوبة\n\nemail\nعنوان البريد الإلكتروني للمدعو. يجب أن يكون بريدا إلكترونيا صحيحا.\n\naccount_type\nالدور المطلوب. القيم المسموحة: hr (موارد بشرية)، manager (مدير)، employee (موظف).\n\ndelivery_method\nطريقة الإرسال. القيم المسموحة: email (بريد إلكتروني)، sms (رسالة نصية)، both (كلاهما).\n\nالحقول الاختيارية\n\nphone\nرقم الهاتف. مطلوب إذا كانت طريقة الإرسال sms أو both. الصيغة الدولية مع رمز الدولة (مثال: +966501234567).\n\nexpires_in_days\nعدد أيام صلاحية الدعوة. النطاق المسموح: 1-90 يوم. القيمة الافتراضية: 7 أيام.\n\nmessage\nرسالة مخصصة للمدعو. يمكن إضافة رسالة ترحيبية أو شخصية. الحد الأقصى: 1000 حرف.\n\nmetadata\nبيانات إضافية بصيغة JSON. يمكن إضافة أي معلومات مخصصة.\n\nredirect_url\nرابط التوجيه المخصص من الفرونت إند. عند تحديده، سيتم دمج الـ token و action كـ query parameters مع هذا الرابط. مثال: https://yourfrontend.com/accept-invitation?token=xxx&action=accept\n\nالاستجابة\n\nعند نجاح العملية:\n- يتم إنشاء الدعوة مع رمز فريد (64 حرف)\n- يتم إرسال بريد إلكتروني أو رسالة نصية أو كلاهما مباشرة (sync)\n- يتم تسجيل العملية في سجل الأنشطة\n\nالتحققات\n\n- لا يمكن إرسال دعوة لبريد له دعوة معلقة\n- لا يمكن دعوة مستخدم موجود بالفعل في الشركة\n- يتم التحقق من صلاحيات المرسل قبل إرسال الدعوة" }, "response": [] }, { "name": "Get All Invitations", "request": { "method": "GET", "header": [], "url": { "raw": "/api/invitations?status=pending&account_type=employee", "path": [ "api", "invitations" ], "query": [ { "key": "status", "value": "pending", "description": "تصفية حسب الحالة - اختياري - القيم: pending, accepted, rejected, expired" }, { "key": "account_type", "value": "employee", "description": "تصفية حسب الدور - اختياري - القيم: hr, manager, employee" } ] }, "description": "عرض جميع الدعوات\n\nهذا الطلب يعرض قائمة الدعوات حسب صلاحيات المستخدم مع إمكانية التصفية.\n\nالصلاحيات\n\nمالك الشركة والموارد البشرية\nيمكنهم عرض جميع دعوات الشركة بكل الحالات.\n\nالمدير\nيمكنه عرض دعوات الموظفين فقط.\n\nمعاملات التصفية الاختيارية\n\nstatus\nتصفية حسب حالة الدعوة. القيم المسموحة: pending (معلقة)، accepted (مقبولة)، rejected (مرفوضة)، expired (منتهية).\n\naccount_type\nتصفية حسب نوع الدور. القيم المسموحة: hr (موارد بشرية)، manager (مدير)، employee (موظف).\n\nالاستجابة\n\nقائمة مقسمة على صفحات تحتوي على:\n- معلومات الدعوة الكاملة\n- معلومات من أرسل الدعوة\n- معلومات المستخدم المسجل إن قبل الدعوة" }, "response": [] }, { "name": "Get Invitation by Token (Public)", "request": { "method": "GET", "header": [], "url": { "raw": "/api/invitations/:token", "path": [ "api", "invitations", ":token" ], "variable": [ { "key": "token", "value": "invitation_token_here" } ] }, "description": "**Get Invitation Details - PUBLIC ENDPOINT**\n\n**No authentication required**\n\nReturns invitation details including:\n- Company information\n- Role being offered\n- Inviter details\n- Expiration date\n- Custom message\n\n**Validation:**\n- Checks if invitation is expired\n- Checks if already responded" }, "response": [] }, { "name": "Accept Invitation & Register (Public)", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"first_name\": \"John\",\n \"middle_name\": \"M\",\n \"last_name\": \"Doe\",\n \"password\": \"SecurePass123!\",\n \"password_confirmation\": \"SecurePass123!\",\n \"phone\": \"+1234567890\",\n \"national_insurance_number\": \"AB123456C\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "/api/invitations/:token/accept", "path": [ "api", "invitations", ":token", "accept" ], "variable": [ { "key": "token", "value": "invitation_token_here" } ] }, "description": "**Accept Invitation & Register - PUBLIC ENDPOINT**\n\n**No authentication required**\n\n**Required Fields:**\n- `first_name` (string)\n- `last_name` (string)\n- `password` (string): min 8 chars\n- `password_confirmation` (string): must match\n\n**Optional Fields:**\n- `middle_name` (string)\n- `phone` (string)\n- `national_insurance_number` (string)\n\n**Process:**\n1. Validates invitation is still valid\n2. Creates new user account OR links existing user\n3. Attaches user to company with specified role\n4. Marks invitation as accepted\n5. Logs activity\n6. Notifies inviter and owner\n7. Returns user data + auth token\n\n**Note:** Email is auto-filled from invitation" }, "response": [] }, { "name": "Reject Invitation (Public)", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"reason\": \"Not interested at this time, thank you.\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "/api/invitations/:token/reject", "path": [ "api", "invitations", ":token", "reject" ], "variable": [ { "key": "token", "value": "invitation_token_here" } ] }, "description": "**Reject Invitation - PUBLIC ENDPOINT**\n\n**No authentication required**\n\n**Optional Fields:**\n- `reason` (string): Rejection reason (max 1000 chars)\n\n**Process:**\n1. Marks invitation as rejected\n2. Stores rejection reason\n3. Logs activity\n4. Notifies inviter and owner" }, "response": [] }, { "name": "Resend Invitation", "request": { "method": "POST", "header": [], "url": { "raw": "/api/invitations/:id/resend", "path": [ "api", "invitations", ":id", "resend" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "**Resend Invitation**\n\n**Permissions:**\n- Must be from same company\n- Only pending invitations can be resent\n\n**Process:**\n- Increments resend counter\n- Updates last_resent_at timestamp\n- Sends email/SMS based on original delivery method\n- Logs activity\n\n**Response on delivery failure:**\n- Returns 200 with delivery_status: partial_failure\n- Includes delivery_errors array with error details" }, "response": [] }, { "name": "Regenerate Invitation", "request": { "method": "POST", "header": [], "url": { "raw": "/api/invitations/:id/regenerate", "path": [ "api", "invitations", ":id", "regenerate" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "**تجديد الدعوة - Regenerate Invitation**\n\nيقوم بإنشاء token جديد للدعوة وإعادة إرسالها.\n\n**الصلاحيات:**\n- يجب أن تكون من نفس الشركة\n- فقط الدعوات المعلقة يمكن تجديدها\n\n**العملية:**\n- إنشاء token جديد (64 حرف)\n- تمديد تاريخ الانتهاء 7 أيام\n- زيادة عداد إعادة الإرسال\n- إرسال البريد/SMS حسب طريقة التسليم الأصلية\n- تسجيل النشاط\n\n**الاستجابة عند فشل الإرسال:**\n- يرجع 200 مع delivery_status: partial_failure\n- يتضمن delivery_errors مع تفاصيل الخطأ\n- الدعوة تبقى صالحة ويمكن إعادة المحاولة" }, "response": [] }, { "name": "Cancel Invitation", "request": { "method": "DELETE", "header": [], "url": { "raw": "/api/invitations/:id", "path": [ "api", "invitations", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "**Cancel Invitation**\n\n**Permissions:**\n- Must be from same company\n- Only pending invitations can be cancelled\n\n**Process:**\n- Soft deletes invitation\n- Logs activity" }, "response": [] } ], "description": "نظام إدارة الدعوات\n\nنظام متكامل ومتقدم لدعوة المستخدمين للانضمام إلى الشركات مع إمكانية الإرسال عبر البريد الإلكتروني أو الرسائل النصية أو كليهما معا. يوفر النظام صلاحيات متعددة حسب دور المستخدم مع قوالب بريد إلكتروني عصرية وتتبع شامل لحالة كل دعوة.\n\nنظرة عامة على النظام\n\nنظام الدعوات يسمح للشركات بدعوة مستخدمين جدد للانضمام إلى فريق العمل بطرق مرنة ومتعددة. يمكن إرسال الدعوات عبر البريد الإلكتروني فقط، أو الرسائل النصية فقط، أو كليهما معا لضمان وصول الدعوة. النظام يتتبع كل مرحلة من مراحل الدعوة من الإنشاء إلى القبول أو الرفض مع تسجيل كامل لكل العمليات.\n\nالأدوار والصلاحيات\n\nمالك الشركة\nيمتلك صلاحيات كاملة لإدارة جميع الدعوات في الشركة\n- إرسال الدعوات: يمكنه دعوة جميع الأدوار (موارد بشرية، مدراء، موظفين)\n- عرض الدعوات: يمكنه عرض جميع دعوات الشركة بكل حالاتها\n- إعادة الإرسال: يمكنه إعادة إرسال أي دعوة معلقة\n- الإلغاء: يمكنه إلغاء أي دعوة معلقة\n- الإشعارات: يستلم إشعارات عند قبول أو رفض الدعوات المرسلة\n\nالموارد البشرية\nصلاحيات واسعة لإدارة دعوات المدراء والموظفين\n- إرسال الدعوات: يمكنه دعوة المدراء والموظفين فقط (لا يمكن دعوة موارد بشرية أخرى)\n- عرض الدعوات: يمكنه عرض جميع دعوات الشركة\n- إعادة الإرسال: يمكنه إعادة إرسال دعوات المدراء والموظفين المعلقة\n- الإلغاء: يمكنه إلغاء دعوات المدراء والموظفين المعلقة\n- الإشعارات: يستلم إشعارات عند قبول أو رفض الدعوات التي أرسلها\n\nالمدير\nصلاحيات محدودة لدعوة الموظفين فقط\n- إرسال الدعوات: يمكنه دعوة الموظفين فقط\n- عرض الدعوات: يمكنه عرض دعوات الموظفين التي أرسلها فقط\n- إعادة الإرسال: يمكنه إعادة إرسال دعوات الموظفين المعلقة\n- الإلغاء: يمكنه إلغاء دعوات الموظفين المعلقة\n- الإشعارات: يستلم إشعارات عند قبول أو رفض الدعوات التي أرسلها\n\nالموظف\nلا يمتلك صلاحيات إرسال الدعوات\n- إرسال الدعوات: لا يمكنه إرسال دعوات\n- قبول الدعوة: يمكنه قبول الدعوات المرسلة إليه عبر رابط عام لا يحتاج تسجيل دخول\n- رفض الدعوة: يمكنه رفض الدعوات مع إمكانية ذكر سبب الرفض\n- التسجيل: عند قبول الدعوة يتم إنشاء حساب جديد أو ربط حساب موجود بالشركة\n\nحالات الدعوة ودورة حياتها\n\nمعلقة (Pending)\n- الحالة الافتراضية عند إنشاء الدعوة\n- تنتظر قبول أو رفض المدعو\n- يمكن إعادة إرسالها\n- يمكن إلغاؤها\n- لها تاريخ انتهاء صلاحية\n\nمقبولة (Accepted)\n- المدعو قبل الدعوة وأكمل التسجيل\n- تم إنشاء حساب جديد أو ربط حساب موجود\n- تم تسجيل تاريخ ووقت القبول\n- تم تسجيل معرف المستخدم الذي قبل الدعوة\n- لا يمكن إعادة إرسالها أو إلغاؤها\n\nمرفوضة (Rejected)\n- المدعو رفض الدعوة\n- تم تسجيل سبب الرفض إن وجد\n- تم تسجيل تاريخ ووقت الرفض\n- لا يمكن إعادة إرسالها أو إلغاؤها\n- يتم إرسال إشعار للمرسل ومالك الشركة\n\nمنتهية الصلاحية (Expired)\n- انتهت مدة صلاحية الدعوة\n- تحول تلقائيا من معلقة إلى منتهية بعد تجاوز تاريخ الانتهاء\n- يتم الفحص بشكل دوري عبر مهمة مجدولة كل ساعة\n- لا يمكن قبولها أو رفضها بعد انتهاء الصلاحية\n\nملغاة (Cancelled)\n- تم إلغاء الدعوة من قبل المرسل أو من له صلاحية\n- يتم حذف الدعوة بشكل ناعم (soft delete)\n- لا تظهر في قائمة الدعوات النشطة\n\nطرق توصيل الدعوة\n\nالبريد الإلكتروني فقط\n- يتم إرسال رسالة بريد إلكتروني بتصميم عصري واحترافي\n- تحتوي على شعار الشركة ومعلومات الاتصال\n- تعرض الدور المعروض بشكل واضح\n- تحتوي على أزرار واضحة للقبول أو الرفض\n- تعرض تاريخ انتهاء الصلاحية\n- يمكن إضافة رسالة مخصصة من المرسل\n- متجاوبة مع جميع الأجهزة (موبايل وديسكتوب)\n\nالرسائل النصية فقط\n- يتم إرسال رسالة نصية قصيرة عبر خدمة Twilio\n- تحتوي على اسم الشركة والدور المعروض\n- تحتوي على رابط مختصر للدعوة\n- تعرض تاريخ انتهاء الصلاحية\n- مناسبة للوصول السريع\n\nكلاهما معا\n- يتم إرسال بريد إلكتروني ورسالة نصية في نفس الوقت\n- يضمن وصول الدعوة بشكل أكيد\n- موصى به للأدوار المهمة مثل الموارد البشرية والمدراء\n- يسجل النظام وقت إرسال كل منهما بشكل منفصل\n\nمميزات قالب البريد الإلكتروني\n\nالتصميم والشكل\n- تصميم عصري ومتجاوب مع جميع الشاشات\n- ألوان متدرجة جذابة في الترويسة\n- شعار الشركة بشكل دائري احترافي\n- شارة ملونة تعرض الدور المعروض\n- تنسيق واضح ومنظم\n- خطوط واضحة وسهلة القراءة\n\nالمحتوى\n- ترحيب شخصي باسم المدعو\n- معلومات عن الشركة المرسلة\n- الدور المعروض بشكل بارز\n- رسالة مخصصة من المرسل إن وجدت\n- أزرار واضحة للقبول والرفض\n- عداد تنازلي لانتهاء الصلاحية\n- معلومات الاتصال بالشركة\n- تذييل احترافي\n\nالوظائف\n- روابط مباشرة للقبول والرفض\n- تعمل على جميع برامج البريد الإلكتروني\n- متوافقة مع أنظمة الحماية من البريد المزعج\n- CSS مضمنة لضمان ظهور التنسيق بشكل صحيح\n\nمحتوى الرسالة النصية\n\nيتم إرسال رسالة نصية قصيرة ومباشرة تحتوي على:\n- اسم الشركة المرسلة\n- الدور المعروض للمدعو\n- رابط مختصر للدعوة\n- تاريخ انتهاء صلاحية الدعوة\n- رسالة ترحيبية قصيرة\n\nمراحل دورة حياة الدعوة بالتفصيل\n\nمرحلة الإنشاء\n- التحقق من صلاحيات المرسل (هل يمكنه دعوة هذا الدور)\n- التحقق من عدم وجود دعوة معلقة للبريد الإلكتروني نفسه\n- التحقق من أن المدعو ليس عضوا في الشركة بالفعل\n- توليد رمز فريد مكون من 64 حرف عشوائي\n- تحديد تاريخ انتهاء الصلاحية (افتراضي 7 أيام، أقصى 90 يوم)\n- حفظ طريقة التوصيل المختارة\n- إرسال الدعوة عبر الطريقة أو الطرق المحددة\n- تسجيل العملية في سجل الأنشطة\n\nمرحلة القبول\n- نقطة وصول عامة لا تحتاج تسجيل دخول\n- التحقق من صلاحية الدعوة (غير منتهية، معلقة)\n- التحقق من عدم وجود مستخدم مسجل بنفس البريد الإلكتروني\n- إذا كان المستخدم موجودا: ربطه بالشركة بالدور المحدد\n- إذا كان المستخدم جديدا: إنشاء حساب جديد\n- ملء البريد الإلكتروني تلقائيا من الدعوة\n- تعيين الدور المحدد في الدعوة\n- توليد رمز مصادقة (auth token) للدخول المباشر\n- تحديث حالة الدعوة إلى مقبولة\n- تسجيل تاريخ ووقت القبول\n- إرسال إشعارات للمرسل ومالك الشركة\n- تسجيل العملية في سجل الأنشطة\n\nمرحلة الرفض\n- نقطة وصول عامة لا تحتاج تسجيل دخول\n- التحقق من صلاحية الدعوة\n- إمكانية إدخال سبب الرفض (اختياري)\n- تحديث حالة الدعوة إلى مرفوضة\n- حفظ سبب الرفض إن وجد\n- تسجيل تاريخ ووقت الرفض\n- إرسال إشعارات للمرسل ومالك الشركة مع سبب الرفض\n- تسجيل العملية في سجل الأنشطة\n\nمرحلة انتهاء الصلاحية\n- يتم الفحص تلقائيا كل ساعة عبر مهمة مجدولة\n- البحث عن جميع الدعوات المعلقة التي تجاوزت تاريخ الانتهاء\n- تحديث حالتها إلى منتهية\n- تسجيل العملية في سجل الأنشطة\n- يمكن أيضا انتهاء الصلاحية يدويا من خلال واجهة برمجية\n\nمرحلة إعادة الإرسال\n- متاحة فقط للدعوات المعلقة\n- التحقق من صلاحيات المستخدم\n- التحقق من أن الدعوة ما زالت معلقة\n- زيادة عداد إعادة الإرسال\n- تحديث تاريخ آخر إعادة إرسال\n- إرسال الدعوة مرة أخرى بنفس طريقة التوصيل الأصلية\n- تسجيل العملية في سجل الأنشطة\n- عدم إرسال إشعارات (تم الإرسال عبر البريد أو الرسائل)\n\nنظام تسجيل الأنشطة\n\nيتم تسجيل جميع العمليات المتعلقة بالدعوات تلقائيا في جدول سجل الأنشطة\n\nالعمليات المسجلة\n- invitation_sent: عند إرسال دعوة جديدة\n- invitation_accepted: عند قبول الدعوة والتسجيل\n- invitation_rejected: عند رفض الدعوة\n- invitation_expired: عند انتهاء صلاحية الدعوة\n- invitation_resent: عند إعادة إرسال الدعوة\n- invitation_cancelled: عند إلغاء الدعوة\n\nالبيانات المسجلة\n- المستخدم الذي قام بالعملية\n- الشركة المرتبطة\n- نوع العملية\n- وصف تفصيلي للعملية\n- القيم القديمة والجديدة (للتحديثات)\n- عنوان IP\n- معلومات المتصفح\n- طريقة الطلب (GET, POST, إلخ)\n- رابط الطلب\n- التوقيت الدقيق\n\nنظام الإشعارات\n\nيتم إرسال إشعارات عبر Firebase في الحالات التالية\n\nعند إرسال الدعوة\n- لا يتم إرسال إشعار Firebase (يتم الإرسال عبر البريد أو الرسائل)\n- يتم تسجيل العملية فقط\n\nعند قبول الدعوة\n- يتم إرسال إشعار للمستخدم الذي أرسل الدعوة\n- يتم إرسال إشعار لمالك الشركة (إذا كان مختلفا عن المرسل)\n- الإشعار يحتوي على اسم المدعو والدور\n- نوع الإشعار: invitation_accepted\n\nعند رفض الدعوة\n- يتم إرسال إشعار للمستخدم الذي أرسل الدعوة\n- يتم إرسال إشعار لمالك الشركة (إذا كان مختلفا عن المرسل)\n- الإشعار يحتوي على اسم المدعو وسبب الرفض إن وجد\n- نوع الإشعار: invitation_rejected\n\nعند إعادة الإرسال\n- لا يتم إرسال إشعارات Firebase\n- يتم الإرسال عبر البريد أو الرسائل فقط\n\nمميزات الأمان\n\nالرموز الفريدة\n- كل دعوة لها رمز فريد مكون من 64 حرف عشوائي\n- يستحيل تخمين الرمز\n- يستخدم لمرة واحدة فقط\n- لا يمكن إعادة استخدامه بعد القبول أو الرفض\n\nانتهاء الصلاحية\n- كل دعوة لها تاريخ انتهاء محدد\n- افتراضيا 7 أيام (يمكن تغييرها من 1 إلى 90 يوم)\n- الفحص التلقائي كل ساعة\n- لا يمكن قبول أو رفض دعوة منتهية\n\nالصلاحيات المتقدمة\n- فحص الصلاحيات قبل كل عملية\n- كل دور له صلاحيات محددة\n- لا يمكن تجاوز الصلاحيات\n- يتم رفض الطلبات غير المصرح بها تلقائيا\n\nمنع التكرار\n- لا يمكن إرسال دعوة لبريد إلكتروني له دعوة معلقة\n- يتم التحقق من عدم وجود المستخدم في الشركة بالفعل\n- يمنع إرسال دعوات مكررة\n\nالتحقق من الأعضاء الموجودين\n- قبل إرسال الدعوة يتم التحقق من أن المدعو ليس عضوا بالفعل\n- يمنع دعوة أعضاء موجودين\n- يقلل من الأخطاء والارتباك\n\nالإعدادات المطلوبة للتشغيل\n\nإعدادات البريد الإلكتروني\nيجب إضافة الإعدادات التالية في ملف env:\n- MAIL_MAILER: نوع خادم البريد (smtp)\n- MAIL_HOST: عنوان خادم البريد (مثل smtp.mailtrap.io)\n- MAIL_PORT: منفذ الاتصال (مثل 2525)\n- MAIL_USERNAME: اسم المستخدم\n- MAIL_PASSWORD: كلمة المرور\n- MAIL_ENCRYPTION: نوع التشفير (tls أو ssl)\n- MAIL_FROM_ADDRESS: البريد المرسل منه\n- MAIL_FROM_NAME: الاسم الظاهر للمرسل\n\nإعدادات الرسائل النصية (Twilio)\nاختيارية - فقط إذا كنت تريد استخدام الرسائل النصية:\n- TWILIO_ACCOUNT_SID: معرف حساب Twilio\n- TWILIO_AUTH_TOKEN: رمز المصادقة\n- TWILIO_FROM_NUMBER: رقم الهاتف المرسل\n- TWILIO_DEFAULT_COUNTRY_CODE: كود الدولة الافتراضي\n\nإعداد رابط الواجهة الأمامية\n- APP_FRONTEND_URL: رابط الواجهة الأمامية للتطبيق\n- يستخدم لتوليد روابط القبول والرفض في البريد والرسائل\n\nأفضل الممارسات\n\nمدة انتهاء الصلاحية\n- 7 أيام هي المدة الموصى بها\n- توازن بين الاستعجال والراحة\n- يمكن تقليلها للأدوار المهمة\n- يمكن زيادتها حسب الحاجة (حد أقصى 90 يوم)\n\nالرسائل المخصصة\n- شجع المرسلين على كتابة رسائل شخصية\n- الرسائل الشخصية تزيد من معدل القبول\n- اجعل الرسالة ودية ومرحبة\n- اذكر سبب اختيار المدعو إن أمكن\n\nطريقة التوصيل\n- استخدم كليهما معا للأدوار المهمة (موارد بشرية، مدراء)\n- استخدم البريد الإلكتروني فقط للموظفين العاديين\n- استخدم الرسائل النصية للوصول السريع والمباشر\n\nمراقبة إعادة الإرسال\n- راقب عدد مرات إعادة الإرسال\n- إذا تكررت إعادة الإرسال كثيرا قد تكون رسائل مزعجة\n- حد معقول هو 2-3 مرات كحد أقصى\n\nمراجعة سجل الأنشطة\n- راجع سجل الأنشطة بانتظام\n- تتبع أنماط الدعوات\n- تحليل معدلات القبول والرفض\n- تحسين عملية الدعوة بناء على البيانات" }, { "name": "Activity Logs", "item": [ { "name": "Get All Activity Logs", "request": { "method": "GET", "header": [], "url": { "raw": "/api/activity-logs?action=invitation_sent&user_id=1&subject_type=Invitation&start_date=2025-01-01&end_date=2025-12-31", "path": [ "api", "activity-logs" ], "query": [ { "key": "action", "value": "invitation_sent", "description": "Filter by action type" }, { "key": "user_id", "value": "1", "description": "Filter by user" }, { "key": "subject_type", "value": "Invitation", "description": "Filter by subject type" }, { "key": "start_date", "value": "2025-01-01", "description": "Start date filter" }, { "key": "end_date", "value": "2025-12-31", "description": "End date filter" } ] }, "description": "**Get Company Activity Logs**\n\n**Permissions:**\n- Company Owner/HR/Manager: View all company logs\n- Employee: View only their own logs\n\n**Query Parameters (all optional):**\n- `action`: Filter by specific action type\n- `user_id`: Filter by user who performed action\n- `subject_type`: Filter by affected model type\n- `start_date`: Filter from date\n- `end_date`: Filter to date\n\n**Response:**\n- Paginated activity logs (50 per page)\n- Includes user and subject details" }, "response": [] }, { "name": "Get Activity Log Details", "request": { "method": "GET", "header": [], "url": { "raw": "/api/activity-logs/:id", "path": [ "api", "activity-logs", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "**Get Single Activity Log**\n\nReturns detailed information including:\n- User who performed action\n- Old and new values (for updates)\n- Request details (IP, user agent, URL)\n- Subject model data" }, "response": [] }, { "name": "Get User Activities", "request": { "method": "GET", "header": [], "url": { "raw": "/api/activity-logs/user/:userId", "path": [ "api", "activity-logs", "user", ":userId" ], "variable": [ { "key": "userId", "value": "1" } ] }, "description": "**Get Activities for Specific User**\n\n**Permissions:**\n- Users can view their own activities\n- Owner/HR/Manager can view any user's activities\n\n**Returns:**\n- Last 100 activities for the user\n- Filtered by company context" }, "response": [] }, { "name": "Get Activity Statistics", "request": { "method": "GET", "header": [], "url": { "raw": "/api/activity-logs/statistics/overview?start_date=2025-01-01&end_date=2025-12-31", "path": [ "api", "activity-logs", "statistics", "overview" ], "query": [ { "key": "start_date", "value": "2025-01-01" }, { "key": "end_date", "value": "2025-12-31" } ] }, "description": "**Activity Statistics - Owner & HR Only**\n\n**Returns:**\n- Total activities count\n- Total unique users\n- Top 10 actions by count\n- Top 10 users by activity\n- Daily activity breakdown\n\n**Use for:**\n- Dashboard widgets\n- Monitoring user engagement\n- Identifying unusual activity patterns" }, "response": [] }, { "name": "Export Activity Logs", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"start_date\": \"2025-01-01\",\n \"end_date\": \"2025-12-31\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "api/activity-logs/export", "host": [ "api" ], "path": [ "activity-logs", "export" ] }, "description": "**Export Activity Logs - Owner & HR Only**\n\n**Request Body:**\n- `start_date`: Start date for export\n- `end_date`: End date for export\n\n**Returns:**\n- Formatted activity data (up to 1000 records)\n- Simplified structure for CSV/Excel export\n- Date range information\n\n**Use for:**\n- Compliance auditing\n- Security reviews\n- Data archiving" }, "response": [] } ], "description": "# Activity Logs System\n\n## Overview\nComprehensive activity logging system that tracks every action in the application for audit, security, and monitoring purposes.\n\n## What Gets Logged\n\n### User Actions\n- Login/Logout\n- Registration\n- Profile updates\n- Password changes\n\n### Invitation Actions\n- invitation_sent\n- invitation_accepted\n- invitation_rejected\n- invitation_expired\n- invitation_resent\n- invitation_cancelled\n\n### Contract Actions\n- contract_uploaded\n- contract_accepted\n- contract_rejected\n- contract_updated\n- contract_deleted\n\n### Payroll Actions\n- payroll_created\n- payroll_confirmed\n- payroll_updated\n\n### Company Actions\n- company_created\n- company_updated\n\n### And More\n- All CRUD operations on major models\n- Permission changes\n- Settings updates\n\n## Data Captured\n\nEach activity log includes:\n\n### Identity\n- **user_id**: Who performed the action\n- **company_id**: Company context\n\n### Action Details\n- **action**: Type of action performed\n- **description**: Human-readable description\n\n### Subject (What Changed)\n- **subject_type**: Model that was affected\n- **subject_id**: ID of the affected record\n\n### Change Tracking\n- **old_values**: Previous state (for updates)\n- **new_values**: New state\n- **properties**: Additional metadata\n\n### Request Context\n- **ip_address**: User's IP\n- **user_agent**: Browser/client info\n- **request_method**: GET, POST, PUT, DELETE\n- **request_url**: Full URL of request\n\n### Timestamp\n- **created_at**: When action occurred\n\n## Permissions\n\n### Company Owner\n- ✅ View all company activities\n- ✅ View statistics\n- ✅ Export logs\n\n### HR\n- ✅ View all company activities\n- ✅ View statistics\n- ✅ Export logs\n\n### Manager\n- ✅ View all company activities\n- ❌ Cannot view statistics\n- ❌ Cannot export\n\n### Employee\n- ✅ View only their own activities\n- ❌ Cannot view statistics\n- ❌ Cannot export\n\n## Use Cases\n\n### 1. Security Monitoring\n```\n- Track failed login attempts\n- Monitor unusual activity patterns\n- Identify unauthorized access attempts\n```\n\n### 2. Compliance & Auditing\n```\n- Full audit trail for regulators\n- Track who changed what and when\n- Export for external audits\n```\n\n### 3. Debugging & Support\n```\n- Understand what user did before error\n- Trace action sequences\n- Reproduce issues\n```\n\n### 4. Analytics\n```\n- User engagement metrics\n- Feature usage statistics\n- Activity trends over time\n```\n\n## Best Practices\n\n### For Developers\n1. Log all significant actions\n2. Use descriptive action names\n3. Include relevant old/new values\n4. Add meaningful descriptions\n5. Use ActivityLogService for consistency\n\n### For Administrators\n1. Review logs regularly\n2. Set up alerts for suspicious activity\n3. Export logs monthly for archiving\n4. Monitor statistics dashboard\n5. Investigate anomalies promptly\n\n## Query Examples\n\n### Find all logins today\n```\nGET /api/activity-logs?action=user_login&start_date=2025-11-24\n```\n\n### See what user 5 did\n```\nGET /api/activity-logs/user/5\n```\n\n### Get invitation activities\n```\nGET /api/activity-logs?subject_type=Invitation\n```\n\n### Monthly statistics\n```\nGET /api/activity-logs/statistics/overview?start_date=2025-11-01&end_date=2025-11-30\n```\n\n## Performance Considerations\n\n- Logs are indexed on:\n - user_id + created_at\n - company_id + created_at\n - action + created_at\n - subject_type + subject_id\n \n- Paginated responses (50 per page)\n- Export limited to 1000 records\n- Consider archiving old logs (>1 year)\n\n## Integration\n\n### Automatic Logging\nUse Model Observers for automatic logging:\n```php\nprotected static function boot()\n{\n parent::boot();\n \n static::created(function ($model) {\n ActivityLogService::logCreated($model);\n });\n}\n```\n\n### Manual Logging\n```php\nActivityLogService::log(\n action: 'custom_action',\n description: 'User performed X',\n subject: $model,\n properties: ['key' => 'value']\n);\n```" }, { "name": "verifyCode", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "identifier", "value": "hr@company.com", "type": "text" }, { "key": "code", "value": "4745", "type": "text" } ] }, "url": { "raw": "api/verifyCode", "host": [ "api" ], "path": [ "verifyCode" ] } }, "response": [ { "name": "verifyCode", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "identifier", "value": "hr@company.com", "type": "text" }, { "key": "code", "value": "4745", "type": "text" } ] }, "url": { "raw": "api/verifyCode", "host": [ "api" ], "path": [ "verifyCode" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Connection", "value": "Keep-Alive" }, { "key": "Keep-Alive", "value": "timeout=5, max=100" }, { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application/json" }, { "key": "x-ratelimit-limit", "value": "60" }, { "key": "x-ratelimit-remaining", "value": "56" }, { "key": "access-control-allow-origin", "value": "*" }, { "key": "content-length", "value": "68" }, { "key": "date", "value": "Thu, 15 May 2025 01:05:39 GMT" }, { "key": "server", "value": "LiteSpeed" }, { "key": "strict-transport-security", "value": "max-age=63072000; includeSubDomains" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "alt-svc", "value": "h3=\":443\"; ma=2592000, h3-29=\":443\"; ma=2592000, h3-Q050=\":443\"; ma=2592000, h3-Q046=\":443\"; ma=2592000, h3-Q043=\":443\"; ma=2592000, quic=\":443\"; ma=2592000; v=\"43,46\"" } ], "cookie": [], "body": "{\n \"status\": true,\n \"data\": {\n \"is_exists\": true\n },\n \"messages\": null,\n \"code\": 200\n}" } ] }, { "name": "leave-requests process", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": " {\r\n \"id\": 123,\r\n \"leaving_date\": \"2025-06-20\",\r\n \"action\": \"approved\"\r\n}\r\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "/api/leave-requests/process", "path": [ "api", "leave-requests", "process" ] } }, "response": [] }, { "name": "Secure Contract Management", "item": [ { "name": "Upload Contract", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "employee_id", "value": "1", "type": "text" }, { "key": "contract_document", "type": "file", "src": [] }, { "key": "contract_type", "value": "Full-Time", "type": "text" }, { "key": "effective_date", "value": "2024-01-01", "type": "text" }, { "key": "end_date", "value": "2025-01-01", "type": "text" } ] }, "url": { "raw": "{{base_url}}/api/secure/contracts", "host": [ "{{base_url}}" ], "path": [ "api", "secure", "contracts" ] } }, "response": [] }, { "name": "Get Contract Types", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/secure/contracts/types", "host": [ "{{base_url}}" ], "path": [ "api", "secure", "contracts", "types" ] }, "description": "Get all available contract types. Returns array of objects with value and label." }, "response": [] }, { "name": "Get All Contracts", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/secure/contracts?per_page=10", "host": [ "{{base_url}}" ], "path": [ "api", "secure", "contracts" ], "query": [ { "key": "per_page", "value": "10", "description": "Number of items per page (optional, default: all)" }, { "key": "status", "value": "pending,accepted", "description": "Filter by status (comma-separated): pending, accepted, rejected", "disabled": true }, { "key": "contract_type", "value": "full_time,part_time", "description": "Filter by contract type (comma-separated): full_time, part_time, temporary, freelance, internship, probation", "disabled": true }, { "key": "employee_id", "value": "1,2,3", "description": "Filter by employee IDs (comma-separated)", "disabled": true }, { "key": "uploaded_by", "value": "1", "description": "Filter by uploader IDs (comma-separated)", "disabled": true }, { "key": "accepted_by", "value": "1", "description": "Filter by user who accepted the contract", "disabled": true }, { "key": "rejected_by", "value": "1", "description": "Filter by user who rejected the contract", "disabled": true }, { "key": "effective_date_from", "value": "2024-01-01", "description": "Filter contracts with effective date from this date", "disabled": true }, { "key": "effective_date_to", "value": "2024-12-31", "description": "Filter contracts with effective date until this date", "disabled": true }, { "key": "end_date_from", "value": "2024-01-01", "description": "Filter contracts with end date from this date", "disabled": true }, { "key": "end_date_to", "value": "2024-12-31", "description": "Filter contracts with end date until this date", "disabled": true }, { "key": "created_at_from", "value": "2024-01-01", "description": "Filter contracts created from this date", "disabled": true }, { "key": "created_at_to", "value": "2024-12-31", "description": "Filter contracts created until this date", "disabled": true }, { "key": "responded_at_from", "value": "2024-01-01 00:00:00", "description": "Filter contracts responded from this datetime", "disabled": true }, { "key": "responded_at_to", "value": "2024-12-31 23:59:59", "description": "Filter contracts responded until this datetime", "disabled": true }, { "key": "search", "value": "employment", "description": "Search in document name, employee comments, employee name/email", "disabled": true }, { "key": "sort_by", "value": "created_at", "description": "Sort by field: created_at, effective_date, end_date, status, contract_type, responded_at", "disabled": true }, { "key": "sort_order", "value": "desc", "description": "Sort order: asc or desc", "disabled": true } ] }, "description": "Get all contracts with comprehensive filters:\n\n**Filters:**\n- `status` - Filter by status (comma-separated): pending, accepted, rejected\n- `contract_type` - Filter by type (comma-separated): full_time, part_time, temporary, freelance, internship, probation\n- `employee_id` - Filter by employee IDs (comma-separated)\n- `uploaded_by` - Filter by uploader IDs (comma-separated)\n- `accepted_by` - Filter by acceptor ID\n- `rejected_by` - Filter by rejector ID\n- `effective_date_from/to` - Date range for effective date\n- `end_date_from/to` - Date range for end date\n- `created_at_from/to` - Date range for creation date\n- `responded_at_from/to` - Datetime range for response\n- `search` - Text search in document name, comments, employee name/email\n\n**Sorting:**\n- `sort_by` - Field to sort by\n- `sort_order` - asc or desc\n\n**Pagination:**\n- `per_page` - Items per page" }, "response": [] }, { "name": "Get Contract by ID", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/secure/contracts/:contract", "host": [ "{{base_url}}" ], "path": [ "api", "secure", "contracts", ":contract" ], "variable": [ { "key": "contract", "value": "1" } ] } }, "response": [] }, { "name": "Get Employee Contracts", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/secure/contracts/employee/:employeeId?per_page=10", "host": [ "{{base_url}}" ], "path": [ "api", "secure", "contracts", "employee", ":employeeId" ], "query": [ { "key": "per_page", "value": "10", "description": "Number of items per page (optional, default: all)" } ], "variable": [ { "key": "employeeId", "value": "1", "description": "Employee ID (can be encrypted with 'enc:' prefix)" } ] }, "description": "Get all contracts for a specific employee. The employeeId can be sent encrypted with 'enc:' prefix for enhanced security. Supports pagination with per_page parameter." }, "response": [] }, { "name": "Update Contract", "request": { "method": "PUT", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "contract_type", "value": "Part-Time", "type": "text" }, { "key": "effective_date", "value": "2024-02-01", "type": "text" }, { "key": "contract_document", "type": "file", "src": [] } ] }, "url": { "raw": "{{base_url}}/api/secure/contracts/:contract", "host": [ "{{base_url}}" ], "path": [ "api", "secure", "contracts", ":contract" ], "variable": [ { "key": "contract", "value": "1" } ] } }, "response": [] }, { "name": "Delete Contract", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/api/secure/contracts/:contract", "host": [ "{{base_url}}" ], "path": [ "api", "secure", "contracts", ":contract" ], "variable": [ { "key": "contract", "value": "1" } ] } }, "response": [] }, { "name": "Accept Contract", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "action", "value": "accept", "type": "text" }, { "key": "notes", "value": "I accept the terms", "type": "text" } ] }, "url": { "raw": "{{base_url}}/api/secure/contracts/:contract/response", "host": [ "{{base_url}}" ], "path": [ "api", "secure", "contracts", ":contract", "response" ], "variable": [ { "key": "contract", "value": "1" } ] } }, "response": [] }, { "name": "Reject Contract", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "action", "value": "reject", "type": "text" }, { "key": "notes", "value": "I need to review further", "type": "text" } ] }, "url": { "raw": "{{base_url}}/api/secure/contracts/:contract/response", "host": [ "{{base_url}}" ], "path": [ "api", "secure", "contracts", ":contract", "response" ], "variable": [ { "key": "contract", "value": "1" } ] } }, "response": [] }, { "name": "Download Contract", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/secure/contracts/:contract/download", "host": [ "{{base_url}}" ], "path": [ "api", "secure", "contracts", ":contract", "download" ], "variable": [ { "key": "contract", "value": "1" } ] } }, "response": [] } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "packages": [], "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "packages": [], "exec": [ "" ] } } ] }, { "name": "SITE", "item": [ { "name": "Support Contact Forms", "item": [ { "name": "Submit Contact Form", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"name\": \"John Doe\",\r\n \"email\": \"john@company.com\",\r\n \"company\": \"Tech Company\",\r\n \"phone\": \"966500000000\",\r\n \"employee_count\": \"50-100\",\r\n \"message\": \"I would like to learn more about your payroll services\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "api/support/contact", "host": [ "api" ], "path": [ "support", "contact" ] }, "description": "**Submit Contact Form (Public - No Auth)**\n\n**Required Fields:**\n- `name` (string): Contact name\n- `email` (string): Contact email\n- `company` (string): Company name\n- `phone` (string): Contact phone\n- `employee_count` (string): Number of employees\n- `message` (string): Contact message\n\n**Employee Count Values:**\n- `1-10`\n- `11-50`\n- `51-100`\n- `101-500`\n- `500+`" }, "response": [] }, { "name": "Submit Issue Report", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"name\": \"Jane Doe\",\r\n \"email\": \"jane@example.com\",\r\n \"description\": \"The payroll calculation seems incorrect for this month\",\r\n \"browser_info\": \"Chrome 120.0.0\",\r\n \"user_agent\": \"Mozilla/5.0 (Windows NT 10.0; Win64; x64)\",\r\n \"page_url\": \"https://example.com/payroll\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "api/support/contact", "host": [ "api" ], "path": [ "support", "contact" ] } }, "response": [ { "name": "200 : Submit Contact Form", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"John Smith\",\n \"email\": \"john.smith@company.com\",\n \"company\": \"Acme Corp\",\n \"phone\": \"+44 20 1234 5678\",\n \"employeeCount\": 50,\n \"message\": \"I am interested in learning more about your payroll solutions for our company.\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "api/support/contact", "host": [ "api" ], "path": [ "support", "contact" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Connection", "value": "Keep-Alive" }, { "key": "Keep-Alive", "value": "timeout=5, max=100" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" }, { "key": "Content-Length", "value": "391" }, { "key": "Date", "value": "Sun, 22 Jun 2025 17:11:21 GMT" }, { "key": "Server", "value": "LiteSpeed" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "alt-svc", "value": "h3=\":443\"; ma=2592000, h3-29=\":443\"; ma=2592000, h3-Q050=\":443\"; ma=2592000, h3-Q046=\":443\"; ma=2592000, h3-Q043=\":443\"; ma=2592000, quic=\":443\"; ma=2592000; v=\"43,46\"" } ], "cookie": [], "body": "{\n \"status\": true,\n \"data\": {\n \"name\": \"John Smith\",\n \"email\": \"john.smith@company.com\",\n \"company\": \"Acme Corp\",\n \"phone\": \"+44 20 1234 5678\",\n \"message\": \"I am interested in learning more about your payroll solutions for our company.\",\n \"updated_at\": \"2025-06-22T17:11:21.000000Z\",\n \"created_at\": \"2025-06-22T17:11:21.000000Z\",\n \"id\": 1\n },\n \"messages\": \"Thank you for contacting us. We'll get back to you soon!\",\n \"code\": 200\n}" }, { "name": "400 : Submit Contact Form", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"John Smith\",\n // \"email\": \"john.smith@company.com\",\n \"company\": \"Acme Corp\",\n \"phone\": \"+44 20 1234 5678\",\n \"employeeCount\": 50,\n \"message\": \"I am interested in learning more about your payroll solutions for our company.\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "api/support/contact", "host": [ "api" ], "path": [ "support", "contact" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Connection", "value": "Keep-Alive" }, { "key": "Keep-Alive", "value": "timeout=5, max=100" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "58" }, { "key": "Access-Control-Allow-Origin", "value": "*" }, { "key": "Content-Length", "value": "81" }, { "key": "Date", "value": "Sun, 22 Jun 2025 17:11:42 GMT" }, { "key": "Server", "value": "LiteSpeed" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "alt-svc", "value": "h3=\":443\"; ma=2592000, h3-29=\":443\"; ma=2592000, h3-Q050=\":443\"; ma=2592000, h3-Q046=\":443\"; ma=2592000, h3-Q043=\":443\"; ma=2592000, quic=\":443\"; ma=2592000; v=\"43,46\"" } ], "cookie": [], "body": "{\n \"status\": false,\n \"data\": null,\n \"messages\": \"The email field is required.\",\n \"code\": 400\n}" } ] }, { "name": "Issue Report", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Jane Doe\",\n // \"email\": \"jane.doe@company.com\",\n \"description\": \"When I try to export payroll data, the system throws an error and the download fails. This happens consistently with large datasets.\",\n \"browserInfo\": \"Chrome 120.0.0.0 on macOS\",\n \"userAgent\": \"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36\",\n \"pageUrl\": \"/payroll/export\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "api/support/issue", "host": [ "api" ], "path": [ "support", "issue" ] }, "description": "**Submit Issue Report (Public - No Auth)**\n\n**Required Fields:**\n- `name` (string): Reporter name\n- `email` (string): Reporter email\n- `description` (string): Issue description\n\n**Optional Fields:**\n- `browser_info` (string): Browser information\n- `user_agent` (string): User agent string\n- `page_url` (string): URL where issue occurred" }, "response": [ { "name": "200 : Issue Report", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Jane Doe\",\n \"email\": \"jane.doe@company.com\",\n \"description\": \"When I try to export payroll data, the system throws an error and the download fails. This happens consistently with large datasets.\",\n \"browserInfo\": \"Chrome 120.0.0.0 on macOS\",\n \"userAgent\": \"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36\",\n \"pageUrl\": \"/payroll/export\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "api/support/issue", "host": [ "api" ], "path": [ "support", "issue" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Connection", "value": "Keep-Alive" }, { "key": "Keep-Alive", "value": "timeout=5, max=100" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "58" }, { "key": "Access-Control-Allow-Origin", "value": "*" }, { "key": "Content-Length", "value": "418" }, { "key": "Date", "value": "Sun, 22 Jun 2025 17:14:44 GMT" }, { "key": "Server", "value": "LiteSpeed" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "alt-svc", "value": "h3=\":443\"; ma=2592000, h3-29=\":443\"; ma=2592000, h3-Q050=\":443\"; ma=2592000, h3-Q046=\":443\"; ma=2592000, h3-Q043=\":443\"; ma=2592000, quic=\":443\"; ma=2592000; v=\"43,46\"" } ], "cookie": [], "body": "{\n \"status\": true,\n \"data\": {\n \"name\": \"Jane Doe\",\n \"email\": \"jane.doe@company.com\",\n \"description\": \"When I try to export payroll data, the system throws an error and the download fails. This happens consistently with large datasets.\",\n \"updated_at\": \"2025-06-22T17:14:44.000000Z\",\n \"created_at\": \"2025-06-22T17:14:44.000000Z\",\n \"id\": 3\n },\n \"messages\": \"Thank you for reporting this issue. We'll investigate and respond accordingly.\",\n \"code\": 200\n}" }, { "name": "400 : Issue Report", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Jane Doe\",\n // \"email\": \"jane.doe@company.com\",\n \"description\": \"When I try to export payroll data, the system throws an error and the download fails. This happens consistently with large datasets.\",\n \"browserInfo\": \"Chrome 120.0.0.0 on macOS\",\n \"userAgent\": \"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36\",\n \"pageUrl\": \"/payroll/export\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "api/support/issue", "host": [ "api" ], "path": [ "support", "issue" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Connection", "value": "Keep-Alive" }, { "key": "Keep-Alive", "value": "timeout=5, max=100" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "57" }, { "key": "Access-Control-Allow-Origin", "value": "*" }, { "key": "Content-Length", "value": "81" }, { "key": "Date", "value": "Sun, 22 Jun 2025 17:15:05 GMT" }, { "key": "Server", "value": "LiteSpeed" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "alt-svc", "value": "h3=\":443\"; ma=2592000, h3-29=\":443\"; ma=2592000, h3-Q050=\":443\"; ma=2592000, h3-Q046=\":443\"; ma=2592000, h3-Q043=\":443\"; ma=2592000, quic=\":443\"; ma=2592000; v=\"43,46\"" } ], "cookie": [], "body": "{\n \"status\": false,\n \"data\": null,\n \"messages\": \"The email field is required.\",\n \"code\": 400\n}" } ] } ] }, { "name": "Public Endpoints", "item": [ { "name": "Get Public Plans", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "/api/public/plans", "path": [ "api", "public", "plans" ] }, "description": "Get all active plans ordered by sort_order. No authentication required" }, "response": [] }, { "name": "Get Public Payment Methods", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "/api/public/payment-methods", "path": [ "api", "public", "payment-methods" ] }, "description": "Get all active payment methods ordered by sort_order. No authentication required" }, "response": [] } ], "description": "Publicly accessible endpoints without authentication. View plans and payment methods." } ] }, { "name": "Support Ticket API", "item": [ { "name": "Create Ticket", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"issue_type\": \"technical\",\r\n \"message\": \"I can't log in to my account\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "api/tickets", "host": [ "api" ], "path": [ "tickets" ] }, "description": "**Create New Support Ticket**\n\n**Required Fields:**\n- `issue_type` (string): Type of issue - Values: `technical`, `billing`, `account`, `general`, `other`\n- `message` (string): Description of the issue\n\n**Response:** Returns created ticket with status pending" }, "response": [ { "name": "Create Ticket", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"issue_type\": \"login_problem\",\n \"message\": \"I can't log in to my account.\"\n}" }, "url": { "raw": "api/tickets", "host": [ "api" ], "path": [ "tickets" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Connection", "value": "Keep-Alive" }, { "key": "Keep-Alive", "value": "timeout=5, max=100" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" }, { "key": "Content-Length", "value": "54" }, { "key": "Date", "value": "Mon, 23 Jun 2025 15:57:43 GMT" }, { "key": "Server", "value": "LiteSpeed" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "alt-svc", "value": "h3=\":443\"; ma=2592000, h3-29=\":443\"; ma=2592000, h3-Q050=\":443\"; ma=2592000, h3-Q046=\":443\"; ma=2592000, h3-Q043=\":443\"; ma=2592000, quic=\":443\"; ma=2592000; v=\"43,46\"" } ], "cookie": [], "body": "{\n \"status\": true,\n \"data\": null,\n \"messages\": null,\n \"code\": 200\n}" } ] }, { "name": "My Tickets", "request": { "method": "GET", "header": [], "url": { "raw": "/api/tickets/mine?status=&issue_type=&search=&created_start_date=&created_end_date=&sort_by=id&sort=desc&per_page=10", "path": [ "api", "tickets", "mine" ], "query": [ { "key": "status", "value": "", "description": "Filter by status: pending, in_progress, resolved, closed, cancelled" }, { "key": "issue_type", "value": "", "description": "Filter by issue type: technical, billing, account, general, other" }, { "key": "search", "value": "", "description": "Search in issue_type, description, support_reply" }, { "key": "created_start_date", "value": "", "description": "Filter by creation start date (YYYY-MM-DD)" }, { "key": "created_end_date", "value": "", "description": "Filter by creation end date (YYYY-MM-DD)" }, { "key": "sort_by", "value": "id", "description": "Sort by: id, created_at, status (default: id)" }, { "key": "sort", "value": "desc" }, { "key": "per_page", "value": "10" } ] }, "description": "\n### My Tickets\nRetrieve the list of support tickets for the authenticated user.\n\n**Method**: GET \n**URL**: `/api/support/mine` \n**Query Parameters**:\n- `sort_by` (optional): Field to sort by (`id`, `created_at`, `status`).\n- `sort` (optional): Sorting direction (`asc`, `desc`). Default: `desc`.\n- `per_page` (optional): Items per page. If not set, max 100 results returned.\n\n**Success Response**: 200 OK with paginated list of tickets.\n" }, "response": [ { "name": "My Tickets", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "api/tickets/mine?sort_by=created_at&sort=desc&per_page=10", "host": [ "api" ], "path": [ "tickets", "mine" ], "query": [ { "key": "sort_by", "value": "created_at" }, { "key": "sort", "value": "desc" }, { "key": "per_page", "value": "10" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Connection", "value": "Keep-Alive" }, { "key": "Keep-Alive", "value": "timeout=5, max=100" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "58" }, { "key": "Access-Control-Allow-Origin", "value": "*" }, { "key": "Content-Length", "value": "1093" }, { "key": "Date", "value": "Mon, 23 Jun 2025 15:57:56 GMT" }, { "key": "Server", "value": "LiteSpeed" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "alt-svc", "value": "h3=\":443\"; ma=2592000, h3-29=\":443\"; ma=2592000, h3-Q050=\":443\"; ma=2592000, h3-Q046=\":443\"; ma=2592000, h3-Q043=\":443\"; ma=2592000, quic=\":443\"; ma=2592000; v=\"43,46\"" } ], "cookie": [], "body": "{\n \"status\": true,\n \"data\": {\n \"current_page\": 1,\n \"data\": [\n {\n \"id\": 1,\n \"user_id\": 57,\n \"issue_type\": \"login_problem\",\n \"description\": \"I can't log in to my account.\",\n \"support_reply\": null,\n \"status\": \"pending\",\n \"history\": [\n {\n \"timestamp\": \"2025-06-23 15:57:43\",\n \"by\": {\n \"id\": 57,\n \"account_type\": \"employee\",\n \"name\": \"Nora Nader\",\n \"email\": \"employee16@company.com\",\n \"phone\": \"966517346506\",\n \"image\": null\n },\n \"message\": \"I can't log in to my account.\",\n \"status\": null\n }\n ],\n \"created_at\": \"2025-06-23T15:57:43.000000Z\",\n \"updated_at\": \"2025-06-23T15:57:43.000000Z\"\n }\n ],\n \"first_page_url\": \"https://endpoint.ngm4ido3.a2hosted.com/api/tickets/mine?page=1\",\n \"from\": 1,\n \"last_page\": 1,\n \"last_page_url\": \"https://endpoint.ngm4ido3.a2hosted.com/api/tickets/mine?page=1\",\n \"links\": [\n {\n \"url\": null,\n \"label\": \"« Previous\",\n \"active\": false\n },\n {\n \"url\": \"https://endpoint.ngm4ido3.a2hosted.com/api/tickets/mine?page=1\",\n \"label\": \"1\",\n \"active\": true\n },\n {\n \"url\": null,\n \"label\": \"Next »\",\n \"active\": false\n }\n ],\n \"next_page_url\": null,\n \"path\": \"https://endpoint.ngm4ido3.a2hosted.com/api/tickets/mine\",\n \"per_page\": 10,\n \"prev_page_url\": null,\n \"to\": 1,\n \"total\": 1\n },\n \"messages\": null,\n \"code\": 200\n}" } ] }, { "name": "Show My Ticket", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "api/tickets/mine/:id", "host": [ "api" ], "path": [ "tickets", "mine", ":id" ], "variable": [ { "key": "id", "value": "1" } ] } }, "response": [ { "name": "Show My Ticket", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "api/tickets/mine/:id", "host": [ "api" ], "path": [ "tickets", "mine", ":id" ], "variable": [ { "key": "id", "value": "1" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Connection", "value": "Keep-Alive" }, { "key": "Keep-Alive", "value": "timeout=5, max=100" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "57" }, { "key": "Access-Control-Allow-Origin", "value": "*" }, { "key": "Content-Length", "value": "508" }, { "key": "Date", "value": "Mon, 23 Jun 2025 15:58:30 GMT" }, { "key": "Server", "value": "LiteSpeed" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "alt-svc", "value": "h3=\":443\"; ma=2592000, h3-29=\":443\"; ma=2592000, h3-Q050=\":443\"; ma=2592000, h3-Q046=\":443\"; ma=2592000, h3-Q043=\":443\"; ma=2592000, quic=\":443\"; ma=2592000; v=\"43,46\"" } ], "cookie": [], "body": "{\n \"status\": true,\n \"data\": [\n {\n \"id\": 1,\n \"user_id\": 57,\n \"issue_type\": \"login_problem\",\n \"description\": \"I can't log in to my account.\",\n \"support_reply\": null,\n \"status\": \"pending\",\n \"history\": [\n {\n \"timestamp\": \"2025-06-23 15:57:43\",\n \"by\": {\n \"id\": 57,\n \"account_type\": \"employee\",\n \"name\": \"Nora Nader\",\n \"email\": \"employee16@company.com\",\n \"phone\": \"966517346506\",\n \"image\": null\n },\n \"message\": \"I can't log in to my account.\",\n \"status\": null\n }\n ],\n \"created_at\": \"2025-06-23T15:57:43.000000Z\",\n \"updated_at\": \"2025-06-23T15:57:43.000000Z\"\n }\n ],\n \"messages\": null,\n \"code\": 200\n}" }, { "name": "Show My Ticket", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "api/tickets/mine/:id", "host": [ "api" ], "path": [ "tickets", "mine", ":id" ], "variable": [ { "key": "id", "value": "1" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Connection", "value": "Keep-Alive" }, { "key": "Keep-Alive", "value": "timeout=5, max=100" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" }, { "key": "Content-Length", "value": "809" }, { "key": "Date", "value": "Mon, 23 Jun 2025 15:58:59 GMT" }, { "key": "Server", "value": "LiteSpeed" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "X-Content-Type-Options", "value": "nosniff" } ], "cookie": [], "body": "{\n \"status\": true,\n \"data\": [\n {\n \"id\": 1,\n \"user_id\": 57,\n \"issue_type\": \"login_problem\",\n \"description\": \"I can't log in to my account.\",\n \"support_reply\": \"We have checked your issue and it is resolved.\",\n \"status\": \"resolved\",\n \"history\": [\n {\n \"timestamp\": \"2025-06-23 15:57:43\",\n \"by\": {\n \"id\": 57,\n \"account_type\": \"employee\",\n \"name\": \"Nora Nader\",\n \"email\": \"employee16@company.com\",\n \"phone\": \"966517346506\",\n \"image\": null\n },\n \"message\": \"I can't log in to my account.\",\n \"status\": null\n },\n {\n \"timestamp\": \"2025-06-23 15:58:55\",\n \"by\": {\n \"id\": 43,\n \"account_type\": \"manager\",\n \"name\": \"Jennie Casimer Mitchell\",\n \"email\": \"manager20@company.com\",\n \"phone\": \"966542067492\",\n \"image\": null\n },\n \"message\": \"We have checked your issue and it is resolved.\",\n \"status\": \"resolved\"\n }\n ],\n \"created_at\": \"2025-06-23T15:57:43.000000Z\",\n \"updated_at\": \"2025-06-23T15:58:55.000000Z\"\n }\n ],\n \"messages\": null,\n \"code\": 200\n}" } ] }, { "name": "Get Single Ticket", "request": { "method": "GET", "header": [], "url": { "raw": "api/tickets/mine/1", "host": [ "api" ], "path": [ "tickets", "mine", "1" ] }, "description": "**Get Single Ticket Details**\n\nReturns full details of a specific ticket including history" }, "response": [] }, { "name": "Reply to Ticket", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"message\": \"Additional information about my issue\",\r\n \"status\": \"in_progress\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "api/tickets/1/reply", "host": [ "api" ], "path": [ "tickets", "1", "reply" ] }, "description": "**Reply to Ticket (User)**\n\n**Required Fields:**\n- `message` (string): Reply message\n\n**Optional Fields:**\n- `status` (string): Ticket status\n\n**Status Values:**\n- `pending`: Waiting for support\n- `in_progress`: Being handled\n- `resolved`: Issue resolved\n- `closed`: Ticket closed\n- `cancelled`: Ticket cancelled" }, "response": [] }, { "name": "Close Ticket", "request": { "method": "POST", "header": [], "url": { "raw": "api/tickets/1/close", "host": [ "api" ], "path": [ "tickets", "1", "close" ] }, "description": "**Close Ticket**\n\nUser can close their own ticket. Status will be set to `closed`" }, "response": [] }, { "name": "Cancel Ticket", "request": { "method": "POST", "header": [], "url": { "raw": "api/tickets/1/cancel", "host": [ "api" ], "path": [ "tickets", "1", "cancel" ] }, "description": "**Cancel Ticket**\n\nUser can cancel their own ticket. Status will be set to `cancelled`" }, "response": [] } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "packages": [], "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "packages": [], "exec": [ "" ] } } ] }, { "name": "ADMIN DASHBOARD", "item": [ { "name": "Statistics", "item": [ { "name": "Get Dashboard Statistics", "request": { "method": "GET", "header": [], "url": { "raw": "api/admin/dashboard/statistics", "host": [ "api" ], "path": [ "admin", "dashboard", "statistics" ] } }, "response": [] }, { "name": "Get Recent Activities", "request": { "method": "GET", "header": [], "url": { "raw": "/api/admin/dashboard/recent-activities?limit=50", "path": [ "api", "admin", "dashboard", "recent-activities" ], "query": [ { "key": "limit", "value": "50", "description": "Number of recent activities to fetch\n- Default: 20\n- Max: 100\n\nReturns latest activities across:\n- New users created\n- New companies registered\n- New payrolls\n- New complaints" } ] } }, "response": [] }, { "name": "Get System Hierarchy", "request": { "method": "GET", "header": [], "url": { "raw": "/api/admin/dashboard/system-hierarchy?company_id=&limit=50", "path": [ "api", "admin", "dashboard", "system-hierarchy" ], "query": [ { "key": "company_id", "value": "", "description": "Filter by specific company ID (optional)" }, { "key": "limit", "value": "50", "description": "Number of companies to show\n- Default: 50\n- Max: 200\n\nReturns hierarchical structure:\n- Companies → Departments → Employees" } ] }, "description": "Returns hierarchical structure of the system.\n\n**Query Parameters:**\n- company_id: Filter specific company (optional, integer)\n- limit: Number of companies (default: 50, max: 200)\n\n**Response includes:**\n- Company details with owner\n- Employees count per company\n- Departments count\n- Department details" }, "response": [] } ] }, { "name": "Reports & Analytics", "item": [ { "name": "System Hierarchy Report", "request": { "method": "GET", "header": [], "url": { "raw": "/api/admin/dashboard/reports/system-hierarchy?limit=20", "path": [ "api", "admin", "dashboard", "reports", "system-hierarchy" ], "query": [ { "key": "limit", "value": "20", "description": "Number of companies to include\n- Default: 20\n- Max: 100\n\nShows complete hierarchical structure per company" } ] }, "description": "Returns complete hierarchical structure of the system.\n\n**Response includes for each company:**\n- Company details with owner\n- Employees count\n- Departments count\n\n**Use cases:**\n- System overview\n- Organizational structure analysis\n- Company size comparison" }, "response": [] }, { "name": "Financial Overview Report", "request": { "method": "GET", "header": [], "url": { "raw": "api/admin/dashboard/reports/financial-overview", "host": [ "api" ], "path": [ "admin", "dashboard", "reports", "financial-overview" ] }, "description": "Returns comprehensive financial overview.\n\n**Response includes:**\n- Total payrolls count and amount\n- Average payroll amount\n- This year statistics (count & amount)\n- Top 10 companies by payroll amount\n\n**Use cases:**\n- Financial planning\n- Revenue analysis\n- Company performance comparison" }, "response": [] }, { "name": "Users Relationships Report", "request": { "method": "GET", "header": [], "url": { "raw": "/api/admin/dashboard/reports/users-relationships?limit=50", "path": [ "api", "admin", "dashboard", "reports", "users-relationships" ], "query": [ { "key": "limit", "value": "50", "description": "Number of users to include\n- Default: 50\n- Max: 200" } ] }, "description": "Shows user-company relationships.\n\n**Response includes for each user:**\n- User basic info (ID, name, email, account_type)\n- Companies count (how many companies user works for)\n- Owned companies count (how many companies user owns)\n\n**Use cases:**\n- Identify multi-company employees\n- Find company owners\n- Analyze user engagement" }, "response": [] }, { "name": "Performance Report", "request": { "method": "GET", "header": [], "url": { "raw": "api/admin/dashboard/reports/performance", "host": [ "api" ], "path": [ "admin", "dashboard", "reports", "performance" ] }, "description": "Shows system performance metrics.\n\n**Response includes:**\n\n**Users:**\n- Total count\n- Active users\n- Growth this month\n\n**Companies:**\n- Total count\n- Active companies\n- Growth this month\n\n**Payrolls:**\n- Total this month\n- Confirmed this month\n\n**Support:**\n- Open tickets count\n- Pending complaints count\n\n**Use cases:**\n- System health monitoring\n- Growth tracking\n- Workload assessment" }, "response": [] }, { "name": "Global Search", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"query\": \"ahmed\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "api/admin/dashboard/search/global", "host": [ "api" ], "path": [ "admin", "dashboard", "search", "global" ] }, "description": "Search across users, companies, and payrolls.\n\n**Required Field:**\n- query: Search term (string, min 2 characters)\n\n**Searches in:**\n- Users: name, email\n- Companies: name, registration_number\n- Payrolls: employee name\n\n**Returns:**\n- Top 10 matching users\n- Top 10 matching companies\n- Top 10 matching payrolls\n\n**Use cases:**\n- Quick find across all entities\n- Admin search functionality\n- Cross-reference data" }, "response": [] }, { "name": "User Growth Analytics", "request": { "method": "GET", "header": [], "url": { "raw": "/api/admin/dashboard/analytics/user-growth?months=12", "path": [ "api", "admin", "dashboard", "analytics", "user-growth" ], "query": [ { "key": "months", "value": "12", "description": "Number of months to analyze\n- Default: 12\n- Max: 24\n- Min: 1\n\nExamples:\n- 6 (last 6 months)\n- 12 (last year)\n- 24 (last 2 years)" } ] }, "description": "Returns user growth trends over time.\n\n**Response includes for each month:**\n- Month (YYYY-MM format)\n- New users registered\n- Total users at end of month\n\n**Use cases:**\n- Track user acquisition\n- Identify growth patterns\n- Forecast future growth" }, "response": [] }, { "name": "Company Growth Analytics", "request": { "method": "GET", "header": [], "url": { "raw": "/api/admin/dashboard/analytics/company-growth?months=12", "path": [ "api", "admin", "dashboard", "analytics", "company-growth" ], "query": [ { "key": "months", "value": "12", "description": "Number of months to analyze\n- Default: 12\n- Max: 24\n- Min: 1" } ] }, "description": "Returns company growth trends over time.\n\n**Response includes for each month:**\n- Month (YYYY-MM format)\n- New companies registered\n- Total companies at end of month\n\n**Use cases:**\n- Track business expansion\n- Market penetration analysis\n- Growth forecasting" }, "response": [] }, { "name": "Payroll Trends Analytics", "request": { "method": "GET", "header": [], "url": { "raw": "/api/admin/dashboard/analytics/payroll-trends?months=12", "path": [ "api", "admin", "dashboard", "analytics", "payroll-trends" ], "query": [ { "key": "months", "value": "12", "description": "Number of months to analyze\n- Default: 12\n- Max: 24\n- Min: 1" } ] }, "description": "Returns payroll trends and analytics.\n\n**Response includes for each month:**\n- Month (YYYY-MM format)\n- Count of payrolls processed\n- Total amount paid\n- Average per payroll\n- Confirmed payrolls count\n\n**Use cases:**\n- Financial trend analysis\n- Revenue forecasting\n- Seasonal pattern identification\n- Workload planning" }, "response": [] } ] }, { "name": "Support & Tickets Management", "item": [ { "name": "Statistics", "request": { "method": "GET", "header": [], "url": { "raw": "api/admin/dashboard/support/statistics", "host": [ "api" ], "path": [ "admin", "dashboard", "support", "statistics" ] }, "description": "**Support Statistics**\n\nReturns:\n- Total tickets by status (pending, in_progress, resolved, closed, cancelled)\n- Total contacts and this month's count\n- Total issues and this month's count" }, "response": [] }, { "name": "List All Tickets", "request": { "method": "GET", "header": [], "url": { "raw": "/api/admin/dashboard/support/tickets?search=&status=&issue_type=&user_id=&created_start_date=&created_end_date=&sort_by=id&sort=desc&per_page=15", "path": [ "api", "admin", "dashboard", "support", "tickets" ], "query": [ { "key": "search", "value": "", "description": "Search in issue_type, description, support_reply, user name, user email" }, { "key": "status", "value": "", "description": "Filter by status: pending, in_progress, resolved, closed, cancelled" }, { "key": "issue_type", "value": "", "description": "Filter by issue type: technical, billing, account, general, other" }, { "key": "user_id", "value": "", "description": "Filter by user" }, { "key": "created_start_date", "value": "", "description": "Filter by creation start date (YYYY-MM-DD)" }, { "key": "created_end_date", "value": "", "description": "Filter by creation end date (YYYY-MM-DD)" }, { "key": "sort_by", "value": "id", "description": "Sort by: id, created_at, status, issue_type" }, { "key": "sort", "value": "desc", "description": "Sort direction: asc, desc" }, { "key": "per_page", "value": "15", "description": "Items per page (0 for no pagination)" } ] } }, "response": [] }, { "name": "Get Ticket Details", "request": { "method": "GET", "header": [], "url": { "raw": "api/admin/dashboard/support/tickets/1", "host": [ "api" ], "path": [ "admin", "dashboard", "support", "tickets", "1" ] } }, "response": [] }, { "name": "Reply to Ticket", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"message\": \"We have investigated your issue and found a solution\",\r\n \"status\": \"resolved\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "api/admin/dashboard/support/tickets/1/reply", "host": [ "api" ], "path": [ "admin", "dashboard", "support", "tickets", "1", "reply" ] }, "description": "**Reply to Ticket (Admin)**\n\n**Required Fields:**\n- `message` (string): Reply message\n\n**Optional Fields:**\n- `status` (string): pending, in_progress, resolved, closed, cancelled" }, "response": [] }, { "name": "Update Ticket Status", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"status\": \"in_progress\",\r\n \"message\": \"Working on your issue\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "api/admin/dashboard/support/tickets/1/status", "host": [ "api" ], "path": [ "admin", "dashboard", "support", "tickets", "1", "status" ] }, "description": "**Update Ticket Status**\n\n**Required Fields:**\n- `status` (string): pending, in_progress, resolved, closed, cancelled\n\n**Optional Fields:**\n- `message` (string): Status update message\n\n**Status Descriptions:**\n- `pending`: Waiting for support\n- `in_progress`: Being handled\n- `resolved`: Issue resolved\n- `closed`: Ticket closed\n- `cancelled`: Ticket cancelled" }, "response": [] }, { "name": "Delete Ticket", "request": { "method": "DELETE", "header": [], "url": { "raw": "api/admin/dashboard/support/tickets/1", "host": [ "api" ], "path": [ "admin", "dashboard", "support", "tickets", "1" ] } }, "response": [] }, { "name": "List All Contacts", "request": { "method": "GET", "header": [], "url": { "raw": "/api/admin/dashboard/support/contacts?search=&employee_count=&created_start_date=&created_end_date=&sort_by=id&sort=desc&per_page=15", "path": [ "api", "admin", "dashboard", "support", "contacts" ], "query": [ { "key": "search", "value": "", "description": "Search in name, email, company, phone, message" }, { "key": "employee_count", "value": "", "description": "Filter by employee count" }, { "key": "created_start_date", "value": "", "description": "Filter by creation start date (YYYY-MM-DD)" }, { "key": "created_end_date", "value": "", "description": "Filter by creation end date (YYYY-MM-DD)" }, { "key": "sort_by", "value": "id", "description": "Sort by column" }, { "key": "sort", "value": "desc", "description": "Sort direction" }, { "key": "per_page", "value": "15", "description": "Items per page" } ] } }, "response": [] }, { "name": "Get Contact Details", "request": { "method": "GET", "header": [], "url": { "raw": "api/admin/dashboard/support/contacts/1", "host": [ "api" ], "path": [ "admin", "dashboard", "support", "contacts", "1" ] } }, "response": [] }, { "name": "Delete Contact", "request": { "method": "DELETE", "header": [], "url": { "raw": "api/admin/dashboard/support/contacts/1", "host": [ "api" ], "path": [ "admin", "dashboard", "support", "contacts", "1" ] } }, "response": [] }, { "name": "List All Issues", "request": { "method": "GET", "header": [], "url": { "raw": "/api/admin/dashboard/support/issues?search=&created_start_date=&created_end_date=&sort_by=id&sort=desc&per_page=15", "path": [ "api", "admin", "dashboard", "support", "issues" ], "query": [ { "key": "search", "value": "", "description": "Search in name, email, description, page_url" }, { "key": "created_start_date", "value": "", "description": "Filter by creation start date (YYYY-MM-DD)" }, { "key": "created_end_date", "value": "", "description": "Filter by creation end date (YYYY-MM-DD)" }, { "key": "sort_by", "value": "id", "description": "Sort by column" }, { "key": "sort", "value": "desc", "description": "Sort direction" }, { "key": "per_page", "value": "15", "description": "Items per page" } ] } }, "response": [] }, { "name": "Get Issue Details", "request": { "method": "GET", "header": [], "url": { "raw": "api/admin/dashboard/support/issues/1", "host": [ "api" ], "path": [ "admin", "dashboard", "support", "issues", "1" ] } }, "response": [] }, { "name": "Delete Issue", "request": { "method": "DELETE", "header": [], "url": { "raw": "api/admin/dashboard/support/issues/1", "host": [ "api" ], "path": [ "admin", "dashboard", "support", "issues", "1" ] } }, "response": [] } ] }, { "name": "Admin plans", "item": [ { "name": "List Plans", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "/api/admin/plans?search=&is_active=&billing_cycle=&min_price=&max_price=&sort_by=sort_order&sort=asc&per_page=15&dropDown=false", "path": [ "api", "admin", "plans" ], "query": [ { "key": "search", "value": "", "description": "Search in plan name or description" }, { "key": "is_active", "value": "", "description": "Filter by active status: true or false" }, { "key": "billing_cycle", "value": "", "description": "Filter by billing cycle. Options: monthly, quarterly, yearly" }, { "key": "min_price", "value": "", "description": "Filter plans with price greater than or equal to this value" }, { "key": "max_price", "value": "", "description": "Filter plans with price less than or equal to this value" }, { "key": "sort_by", "value": "sort_order", "description": "Sort by field. Options: id, name, price, sort_order, created_at" }, { "key": "sort", "value": "asc", "description": "Sort direction. Options: asc, desc" }, { "key": "per_page", "value": "15", "description": "Number of records per page. Use 0 to get all records without pagination" }, { "key": "dropDown", "value": "false", "description": "Return limited fields for dropdown. Options: true, false" } ] }, "description": "Get paginated list of subscription plans with filtering and sorting options. Role: admin" }, "response": [] }, { "name": "Create Plan", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Pro Plan\",\n \"description\": \"Professional plan with advanced features\",\n \"price\": 99.99,\n \"currency\": \"USD\",\n \"billing_cycle\": \"monthly\",\n \"duration_months\": 1,\n \"max_users\": 50,\n \"features\": [\"Feature 1\", \"Feature 2\", \"Feature 3\"],\n \"is_active\": true,\n \"trial_days\": 14,\n \"sort_order\": 1\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "/api/admin/plans", "path": [ "api", "admin", "plans" ] }, "description": "Create a new subscription plan. Role: admin\n\nParameters:\n- name (required, string, max 255): Plan name\n- description (optional, string): Plan description\n- price (required, numeric, min 0): Plan price\n- currency (required, string, size 3): Currency code (e.g., USD, EUR, SAR)\n- billing_cycle (required, string): Billing frequency. Options: monthly, quarterly, yearly\n- duration_months (required, integer, min 1): Subscription duration in months\n- max_users (optional, integer, min 1): Maximum number of users allowed. null = unlimited\n- features (optional, array): List of plan features\n- is_active (optional, boolean): Plan active status. Default: true\n- trial_days (optional, integer, min 0): Trial period in days. Default: 0\n- sort_order (optional, integer, min 0): Display order. Default: 0" }, "response": [] }, { "name": "Get Plan Details", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "/api/admin/plans/1", "path": [ "api", "admin", "plans", "1" ] }, "description": "Get detailed information about a specific plan including subscription count. Role: admin" }, "response": [] }, { "name": "Update Plan", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Pro Plan Updated\",\n \"price\": 109.99,\n \"is_active\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "/api/admin/plans/1", "path": [ "api", "admin", "plans", "1" ] }, "description": "Update an existing plan. All fields are optional (use 'sometimes' validation). Role: admin\n\nParameters:\n- name (optional, string, max 255): Plan name\n- description (optional, string): Plan description\n- price (optional, numeric, min 0): Plan price\n- currency (optional, string, size 3): Currency code\n- billing_cycle (optional, string): Options: monthly, quarterly, yearly\n- duration_months (optional, integer, min 1): Duration in months\n- max_users (optional, integer, min 1): Maximum users\n- features (optional, array): Plan features\n- is_active (optional, boolean): Active status\n- trial_days (optional, integer, min 0): Trial days\n- sort_order (optional, integer, min 0): Display order" }, "response": [] }, { "name": "Delete Plan", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "/api/admin/plans/1", "path": [ "api", "admin", "plans", "1" ] }, "description": "Delete a plan. Cannot delete if plan has active subscriptions. Role: admin" }, "response": [] }, { "name": "Get Active Plans", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "/api/admin/plans/active", "path": [ "api", "admin", "plans", "active" ] }, "description": "Get all active plans ordered by sort_order. Role: admin" }, "response": [] } ], "description": "Manage subscription plans. Create, update, delete plans with different pricing tiers. Only accessible by admin role." }, { "name": "Admin - Payment Transactions", "item": [ { "name": "List Transactions", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "/api/admin/payment-transactions?company_id=&subscription_id=&search=&status=&transaction_type=&payment_method=&payment_gateway=&sort_by=created_at&sort=desc&per_page=15", "path": [ "api", "admin", "payment-transactions" ], "query": [ { "key": "company_id", "value": "", "description": "Filter by company ID" }, { "key": "subscription_id", "value": "", "description": "Filter by subscription ID" }, { "key": "search", "value": "", "description": "Search in gateway transaction ID or company name" }, { "key": "status", "value": "", "description": "Filter by status. Options: pending, processing, completed, failed, refunded, cancelled" }, { "key": "transaction_type", "value": "", "description": "Filter by type. Options: subscription, renewal, upgrade, downgrade, refund" }, { "key": "payment_method", "value": "", "description": "Filter by payment method (e.g., stripe, paypal, bank_transfer, cash)" }, { "key": "payment_gateway", "value": "", "description": "Filter by payment gateway name" }, { "key": "sort_by", "value": "created_at", "description": "Sort field. Options: id, amount, created_at, paid_at" }, { "key": "sort", "value": "desc", "description": "Sort direction. Options: asc, desc" }, { "key": "per_page", "value": "15", "description": "Records per page" } ] }, "description": "List all payment transactions with filtering. Role: admin" }, "response": [] }, { "name": "Get Transaction Details", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "/api/admin/payment-transactions/1", "path": [ "api", "admin", "payment-transactions", "1" ] }, "description": "Get full transaction details including gateway data and receipt file. Role: admin" }, "response": [] }, { "name": "Get Pending Approvals", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "/api/admin/payment-transactions/pending-approvals?per_page=15", "path": [ "api", "admin", "payment-transactions", "pending-approvals" ], "query": [ { "key": "per_page", "value": "15", "description": "Records per page" } ] }, "description": "Get all pending transactions awaiting admin approval (bank_transfer, cash). Role: admin" }, "response": [] }, { "name": "Approve Transaction", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"admin_notes\": \"Bank receipt verified and approved\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "/api/admin/payment-transactions/1/approve", "path": [ "api", "admin", "payment-transactions", "1", "approve" ] }, "description": "Approve pending payment transaction. Activates associated subscription. Role: admin\n\nParameters:\n- admin_notes (optional, string, max 1000): Admin notes or comments" }, "response": [] }, { "name": "Reject Transaction", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"rejection_reason\": \"Invalid bank receipt\",\n \"admin_notes\": \"Receipt does not match transaction details\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "/api/admin/payment-transactions/1/reject", "path": [ "api", "admin", "payment-transactions", "1", "reject" ] }, "description": "Reject pending payment transaction. Cancels associated subscription. Role: admin\n\nParameters:\n- rejection_reason (required, string, max 500): Reason for rejection\n- admin_notes (optional, string, max 1000): Additional admin notes" }, "response": [] }, { "name": "Update Transaction Status", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"status\": \"completed\",\n \"gateway_transaction_id\": \"TXN_12345\",\n \"gateway_response\": {\"key\": \"value\"},\n \"notes\": \"Manual update\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "/api/admin/payment-transactions/1/status", "path": [ "api", "admin", "payment-transactions", "1", "status" ] }, "description": "Manually update transaction status and details. Role: admin\n\nParameters:\n- status (required, string): New status. Options: pending, processing, completed, failed, refunded, cancelled\n- gateway_transaction_id (optional, string): External transaction ID\n- gateway_response (optional, array): Gateway response data\n- gateway_error (optional, string): Error message if failed\n- notes (optional, string): Admin notes" }, "response": [] }, { "name": "Get Statistics", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "/api/admin/payment-transactions/statistics?start_date=2025-01-01&end_date=2025-12-31", "path": [ "api", "admin", "payment-transactions", "statistics" ], "query": [ { "key": "start_date", "value": "2025-01-01", "description": "Start date for statistics (YYYY-MM-DD)" }, { "key": "end_date", "value": "2025-12-31", "description": "End date for statistics (YYYY-MM-DD)" } ] }, "description": "Get payment statistics for date range: total, completed, failed, pending counts and amounts. Role: admin" }, "response": [] } ], "description": "View and manage payment transactions. Approve/reject bank transfers and cash payments. Admin only." }, { "name": "Admin - Payment Methods", "item": [ { "name": "List Payment Methods", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "/api/admin/payment-methods?is_active=", "path": [ "api", "admin", "payment-methods" ], "query": [ { "key": "is_active", "value": "", "description": "Filter by active status. Options: true, false" } ] }, "description": "List all payment methods. Role: admin" }, "response": [] }, { "name": "Create Payment Method", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Stripe\",\n \"code\": \"stripe\",\n \"description\": \"Pay with credit card via Stripe\",\n \"icon\": \"fa-credit-card\",\n \"is_active\": true,\n \"requires_gateway\": true,\n \"sort_order\": 1,\n \"settings\": {\"api_key\": \"sk_test_...\"}\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "/api/admin/payment-methods", "path": [ "api", "admin", "payment-methods" ] }, "description": "Create new payment method. Role: admin\n\nParameters:\n- name (required, string, max 255): Display name\n- code (required, string, unique): Unique code identifier\n- description (optional, string): Method description\n- icon (optional, string): Icon class or URL\n- is_active (optional, boolean): Active status. Default: true\n- requires_gateway (optional, boolean): Needs external gateway. Default: false\n- sort_order (optional, integer, min 0): Display order. Default: 0\n- settings (optional, array): Configuration settings as JSON" }, "response": [] }, { "name": "Update Payment Method", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Stripe Updated\",\n \"is_active\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "/api/admin/payment-methods/1", "path": [ "api", "admin", "payment-methods", "1" ] }, "description": "Update payment method. All fields optional. Role: admin\n\nParameters:\n- name (optional, string, max 255): Display name\n- description (optional, string): Description\n- icon (optional, string): Icon\n- is_active (optional, boolean): Active status\n- requires_gateway (optional, boolean): Gateway requirement\n- sort_order (optional, integer, min 0): Display order\n- settings (optional, array): Configuration" }, "response": [] }, { "name": "Delete Payment Method", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "/api/admin/payment-methods/1", "path": [ "api", "admin", "payment-methods", "1" ] }, "description": "Delete payment method. Role: admin" }, "response": [] }, { "name": "Get Active Methods", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "/api/admin/payment-methods/active", "path": [ "api", "admin", "payment-methods", "active" ] }, "description": "Get all active payment methods ordered by sort_order. Role: admin" }, "response": [] } ], "description": "Manage available payment methods (stripe, paypal, bank_transfer, cash, etc). Admin only." }, { "name": "Admin - Subscriptions Management", "item": [ { "name": "List Subscriptions", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "/api/admin/subscriptions?company_id=&search=&status=¤t_period_start_start_date=¤t_period_start_end_date=¤t_period_end_start_date=¤t_period_end_end_date=&sort_by=id&sort=desc&per_page=15", "path": [ "api", "admin", "subscriptions" ], "query": [ { "key": "company_id", "value": "", "description": "Filter by specific company ID" }, { "key": "search", "value": "", "description": "Search in company name" }, { "key": "status", "value": "", "description": "Filter by subscription status. Options: trial, active, past_due, suspended, cancelled, expired" }, { "key": "current_period_start_start_date", "value": "", "description": "Filter subscriptions starting from this date (YYYY-MM-DD)" }, { "key": "current_period_start_end_date", "value": "", "description": "Filter subscriptions starting until this date (YYYY-MM-DD)" }, { "key": "current_period_end_start_date", "value": "", "description": "Filter subscriptions ending from this date (YYYY-MM-DD)" }, { "key": "current_period_end_end_date", "value": "", "description": "Filter subscriptions ending until this date (YYYY-MM-DD)" }, { "key": "sort_by", "value": "id", "description": "Sort field. Options: id, created_at, current_period_end" }, { "key": "sort", "value": "desc", "description": "Sort direction. Options: asc, desc" }, { "key": "per_page", "value": "15", "description": "Records per page. Use 0 for all" } ] }, "description": "List all subscriptions with advanced filtering. Role: admin" }, "response": [] }, { "name": "Create Subscription (Manual)", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"company_id\": 1,\n \"plan_id\": 1,\n \"payment_method\": \"cash\",\n \"payment_gateway\": null\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "/api/admin/subscriptions", "path": [ "api", "admin", "subscriptions" ] }, "description": "Manually create subscription for a company. Creates pending transaction. Role: admin\n\nParameters:\n- company_id (required, exists:companies,id): Company to subscribe\n- plan_id (required, exists:plans,id): Selected plan\n- payment_method (required, string): Payment method used\n- payment_gateway (optional, string): External gateway name if applicable" }, "response": [] }, { "name": "Get Subscription Details", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "/api/admin/subscriptions/1", "path": [ "api", "admin", "subscriptions", "1" ] }, "description": "Get full subscription details including transactions and change history. Role: admin" }, "response": [] }, { "name": "Cancel Subscription", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"reason\": \"Customer requested cancellation\",\n \"immediate\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "/api/admin/subscriptions/1/cancel", "path": [ "api", "admin", "subscriptions", "1", "cancel" ] }, "description": "Cancel a subscription. Role: admin\n\nParameters:\n- reason (optional, string, max 500): Cancellation reason\n- immediate (optional, boolean): If true, cancel immediately. If false, cancel at period end. Default: false" }, "response": [] }, { "name": "Reactivate Subscription", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "/api/admin/subscriptions/1/reactivate", "path": [ "api", "admin", "subscriptions", "1", "reactivate" ] }, "description": "Reactivate a cancelled subscription. Only works for cancelled status. Role: admin" }, "response": [] }, { "name": "Suspend Subscription", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "/api/admin/subscriptions/1/suspend", "path": [ "api", "admin", "subscriptions", "1", "suspend" ] }, "description": "Suspend subscription due to payment issues or violations. Role: admin" }, "response": [] }, { "name": "Upgrade Subscription", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"new_plan_id\": 2\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "/api/admin/subscriptions/1/upgrade", "path": [ "api", "admin", "subscriptions", "1", "upgrade" ] }, "description": "Upgrade subscription to higher-priced plan. Role: admin\n\nParameters:\n- new_plan_id (required, exists:plans,id): New plan ID. Must be more expensive than current plan" }, "response": [] }, { "name": "Renew Subscription", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "/api/admin/subscriptions/1/renew", "path": [ "api", "admin", "subscriptions", "1", "renew" ] }, "description": "Manually renew subscription for another period. Creates new pending transaction. Role: admin" }, "response": [] } ], "description": "Manage company subscriptions. Create, view, cancel, suspend, reactivate, upgrade subscriptions. Admin only." }, { "name": "Admin - Dashboard Analytics", "item": [ { "name": "Financial Overview", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "/api/admin/dashboard/financial-overview?start_date=2025-01-01&end_date=2025-12-31", "path": [ "api", "admin", "dashboard", "financial-overview" ], "query": [ { "key": "start_date", "value": "2025-01-01", "description": "Start date (YYYY-MM-DD). Default: current month start" }, { "key": "end_date", "value": "2025-12-31", "description": "End date (YYYY-MM-DD). Default: current month end" } ] }, "description": "Get financial metrics: MRR, ARR, total revenue, growth rate, ARPU, revenue by plan. Role: admin" }, "response": [] }, { "name": "Subscription Metrics", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "/api/admin/dashboard/subscription-metrics", "path": [ "api", "admin", "dashboard", "subscription-metrics" ] }, "description": "Get subscription metrics: total active, new this month, cancelled, churn rate, renewal rate, trial count, past due, suspended. Role: admin" }, "response": [] }, { "name": "Payment Analytics", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "/api/admin/dashboard/payment-analytics", "path": [ "api", "admin", "dashboard", "payment-analytics" ] }, "description": "Get payment analytics: success rate, failed transactions, pending amount, distribution by method and gateway, recent failures. Role: admin" }, "response": [] }, { "name": "Company Analytics", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "/api/admin/dashboard/company-analytics", "path": [ "api", "admin", "dashboard", "company-analytics" ] }, "description": "Get company analytics: top companies by revenue, subscriptions by plan, expiring subscriptions. Role: admin" }, "response": [] }, { "name": "Overall Stats", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "/api/admin/dashboard/overall-stats", "path": [ "api", "admin", "dashboard", "overall-stats" ] }, "description": "Get all analytics combined: financial + subscription + payment metrics in one call. Role: admin" }, "response": [] } ], "description": "Comprehensive analytics dashboard for subscription metrics, financial data, and payment analytics. Admin only." } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "packages": [], "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "packages": [], "exec": [ "" ] } } ] }, { "name": "Secure Payrolls", "item": [ { "name": "Get All Payrolls (Encrypted)", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "/api/secure/payrolls?cid=1", "path": [ "api", "secure", "payrolls" ], "query": [ { "key": "cid", "value": "1", "description": "Company ID" } ] }, "description": "Get all payrolls with encrypted sensitive fields (total_salary, net_pay, salary_details)" }, "response": [] }, { "name": "Get My Payrolls (Encrypted)", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "/api/secure/myPayrolls", "path": [ "api", "secure", "myPayrolls" ] }, "description": "**Get My Payrolls (Encrypted)**\n\nEmployee retrieves their own payrolls with encrypted sensitive data.\n\n**Encrypted Fields:**\n- `total_salary`: Total salary amount\n- `net_pay`: Net payment after deductions\n- `salary_details`: Detailed salary breakdown\n- `allowances`: All allowance amounts\n- `deductions`: All deduction amounts\n\n**Authentication:** Required (Bearer token)\n\n**Middleware:** `decrypt.request`, `encrypt.response`" }, "response": [] }, { "name": "Get Single Payroll (Encrypted)", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "/api/secure/payrolls/1", "path": [ "api", "secure", "payrolls", "1" ] }, "description": "**Get Single Payroll Details (Encrypted)**\n\nRetrieve detailed information about a specific payroll with encrypted sensitive fields.\n\n**URL Parameter:**\n- Payroll ID in path\n\n**Encrypted Fields:**\n- `total_salary`\n- `net_pay`\n- `basic_salary`\n- `allowances` (all types)\n- `deductions` (all types)\n- `overtime_amount`\n- `bonus`\n\n**Returns:** Complete payroll information with all financial data encrypted" }, "response": [] }, { "name": "Create Payroll Manual (Encrypted)", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"employee_id\": 5,\n \"company_id\": 1,\n \"pay_month\": \"2024-01\",\n \"pay_period\": \"January 2024\",\n \"total_salary\": \"enc:U2FsdGVkX1...\",\n \"net_pay\": \"enc:U2FsdGVkX1...\",\n \"salary_details\": \"enc:U2FsdGVkX1...\",\n \"department_id\": 1,\n \"cost_center_id\": 1\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "/api/secure/payrolls/addManual/execute", "path": [ "api", "secure", "payrolls", "addManual", "execute" ] }, "description": "**Create Payroll Manually (Encrypted)**\n\nManager/HR creates a new payroll entry manually with encrypted financial data.\n\n**Required Encrypted Fields:**\n- `total_salary`: Total salary (prefix with enc:)\n- `net_pay`: Net payment (prefix with enc:)\n- `salary_details`: Detailed breakdown (prefix with enc:)\n\n**Required Fields:**\n- `employee_id`: Employee ID\n- `company_id`: Company ID\n- `pay_month`: Payment month (YYYY-MM)\n- `pay_period`: Period description\n- `department_id`: Department ID\n- `cost_center_id`: Cost center ID\n\n**Note:** All financial data must be encrypted before sending." }, "response": [] }, { "name": "Confirm Payroll", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "/api/secure/payrolls/1/confirm", "path": [ "api", "secure", "payrolls", "1", "confirm" ] }, "description": "**Confirm Payroll (Encrypted)**\n\nEmployee confirms receipt of their payroll.\n\n**URL Parameter:**\n- Payroll ID in path\n\n**Status Change:** confirmation_status → `confirmed`\n\n**Note:** Employee can only confirm their own payroll. Response data is encrypted." }, "response": [] }, { "name": "Import Payrolls from File (Encrypted)", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "src": [], "description": "Excel/CSV file with payroll data" }, { "key": "company_id", "value": "1", "type": "text", "description": "Company ID" } ] }, "url": { "raw": "/api/secure/payrolls/importFile/execute", "path": [ "api", "secure", "payrolls", "importFile", "execute" ] }, "description": "**Import Payrolls from File (Encrypted)**\n\nBulk import payrolls from Excel/CSV file with automatic encryption.\n\n**Required Fields:**\n- `file`: Excel or CSV file\n- `company_id`: Company ID\n\n**File Format:**\n- Must contain: employee_id, pay_month, total_salary, net_pay, etc.\n- Financial columns are automatically encrypted\n\n**Note:** Large files are processed in background jobs." }, "response": [] }, { "name": "Reject Payroll (Encrypted)", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"rejection_reason\": \"enc:U2FsdGVkX1...\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "/api/secure/payrolls/1/reject", "path": [ "api", "secure", "payrolls", "1", "reject" ] }, "description": "**Reject Payroll (Encrypted)**\n\nEmployee rejects their payroll with encrypted reason.\n\n**URL Parameter:**\n- Payroll ID in path\n\n**Required Encrypted Field:**\n- `rejection_reason`: Reason for rejection (prefix with enc:)\n\n**Status Change:** confirmation_status → `rejected`\n\n**Note:** This automatically creates a complaint." }, "response": [] }, { "name": "Move Payroll (Encrypted)", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"moved_to\": 5\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "/api/secure/payrolls/1/move", "path": [ "api", "secure", "payrolls", "1", "move" ] }, "description": "**Move Payroll to Another User (Encrypted)**\n\nManager/HR moves payroll responsibility to another user within the same company.\n\n**URL Parameter:**\n- Payroll ID in path\n\n**Required Fields:**\n- `moved_to`: User ID to move the payroll to (must be in same company)\n\n**Auto-filled Fields:**\n- `moved_at`: Current timestamp\n- `moved_by`: Current user ID\n\n**Authorization:**\n- User must have `selected_company`\n- `moved_to` user must belong to the same company\n\n**Note:** Response contains encrypted payroll data." }, "response": [] }, { "name": "Get Payslip HTML (Encrypted)", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "/api/secure/payrolls/1/html", "path": [ "api", "secure", "payrolls", "1", "html" ] }, "description": "**Get Payslip as HTML (Encrypted)**\n\nGenerate printable payslip in HTML format with encrypted data.\n\n**URL Parameter:**\n- Payroll ID in path\n\n**Returns:** HTML formatted payslip with all financial data encrypted\n\n**Use Case:** For printing or PDF generation on frontend" }, "response": [] }, { "name": "Get Payroll History", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "/api/secure/payrolls/1/history", "path": [ "api", "secure", "payrolls", "1", "history" ] }, "description": "Get all versions/history of a payroll" }, "response": [] } ] }, { "name": "Secure Complaints", "item": [ { "name": "Get All Complaints (Encrypted)", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "/api/secure/complaints?cid=1", "path": [ "api", "secure", "complaints" ], "query": [ { "key": "cid", "value": "1", "description": "Company ID (optional)" } ] }, "description": "**Get All Complaints (Encrypted)**\n\nRetrieve all payroll complaints with encrypted sensitive data.\n\n**Encrypted Fields:**\n- `complaint_text`: Complaint description\n- `specify_issue_text`: Additional issue details\n- `custom_salary_issue_json`: Multiple issue types\n\n**Query Parameters:**\n- `cid`: Company ID (optional)\n- `search`: Search term\n- `status`: Filter by status\n- `salary_issue`: Filter by issue type\n\n**Middleware:** `decrypt.request`, `encrypt.response`" }, "response": [] }, { "name": "Get My Complaints (Encrypted)", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "/api/secure/mypayroll-complaints", "path": [ "api", "secure", "mypayroll-complaints" ] }, "description": "**Get My Complaints (Encrypted)**\n\nEmployee retrieves their own complaints with encrypted sensitive data.\n\n**Encrypted Fields:**\n- `complaint_text`: Complaint description\n- `specify_issue_text`: Additional details\n- `custom_salary_issue_json`: Issue categories\n\n**Returns:** List of employee's own complaints with encrypted sensitive information" }, "response": [] }, { "name": "Create Complaint (Encrypted)", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"payroll_id\": 1,\n \"salary_issue\": \"underpaid\",\n \"specify_issue_text\": \"enc:U2FsdGVkX1...\",\n \"complaint_text\": \"enc:U2FsdGVkX1...\",\n \"custom_salary_issue_json\": [\"missing_allowance\", \"incorrect_deduction\"]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "/api/secure/requestPayrollComplaints", "path": [ "api", "secure", "requestPayrollComplaints" ] }, "description": "Create a new payroll complaint. Required fields:\n- payroll_id: ID of the payroll being complained about\n- salary_issue: (required) Must be one of: 'overpaid', 'underpaid', 'other'\n- complaint_text: (optional, encrypted) Main complaint description\n- specify_issue_text: (optional, encrypted) Additional issue details\n- custom_salary_issue_json: (optional, array) For multiple issue types or custom categories" }, "response": [] }, { "name": "Update Complaint (Encrypted)", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"complaint_id\": 25,\n \"salary_issue\": \"underpaid\",\n \"complaint_text\": \"enc:U2FsdGVkX1...\",\n \"specify_issue_text\": \"enc:U2FsdGVkX1...\",\n \"custom_salary_issue_json\": [\"missing_overtime\", \"incorrect_bonus\"]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "/api/secure/updatePayrollComplaints", "path": [ "api", "secure", "updatePayrollComplaints" ] }, "description": "Update an existing payroll complaint. Required fields:\n- complaint_id: ID of the complaint to update\n- salary_issue: (required) Must be one of: 'overpaid', 'underpaid', 'other'\n- complaint_text: (optional, encrypted) Main complaint description\n- specify_issue_text: (optional, encrypted) Additional issue details\n- custom_salary_issue_json: (optional, array) For multiple issue types when salary_issue='other'" }, "response": [] }, { "name": "Complaint History", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "/api/secure/complaints/1/history", "path": [ "api", "secure", "complaints", "1", "history" ] }, "description": "Get all versions/history of a complaint" }, "response": [] }, { "name": "Accept Resolution (Encrypted)", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"complaint_text\": \"enc:U2FsdGVkX1...\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "/api/secure/complaints/:complaint/accept-resolution", "path": [ "api", "secure", "complaints", ":complaint", "accept-resolution" ], "variable": [ { "key": "complaint", "value": "1" } ] }, "description": "Employee accepts the resolution provided by manager. Changes status to 'resolved'." }, "response": [] }, { "name": "Resubmit Complaint (Encrypted)", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"complaint_text\": \"enc:U2FsdGVkX1...\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "/api/secure/complaints/:complaint/resubmit", "path": [ "api", "secure", "complaints", ":complaint", "resubmit" ], "variable": [ { "key": "complaint", "value": "1" } ] }, "description": "Employee resubmits a complaint. Changes status to 'resubmitted'." }, "response": [] }, { "name": "Cancel Complaint (Encrypted)", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"complaint_text\": \"enc:U2FsdGVkX1...\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "/api/secure/complaints/:complaint/cancel", "path": [ "api", "secure", "complaints", ":complaint", "cancel" ], "variable": [ { "key": "complaint", "value": "1" } ] }, "description": "Employee cancels their complaint. Changes status to 'cancelled'." }, "response": [] }, { "name": "Reject Complaint (Encrypted)", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"complaint_text\": \"enc:U2FsdGVkX1...\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "/api/secure/complaints/:complaint/reject", "path": [ "api", "secure", "complaints", ":complaint", "reject" ], "variable": [ { "key": "complaint", "value": "1" } ] }, "description": "Manager/HR rejects the complaint. Changes status to 'rejected'." }, "response": [] }, { "name": "Move Complaint (Encrypted)", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"moved_to\": 5\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "/api/secure/complaints/:complaint/move", "path": [ "api", "secure", "complaints", ":complaint", "move" ], "variable": [ { "key": "complaint", "value": "1" } ] }, "description": "**Move Complaint to Another User (Encrypted)**\n\nManager/HR moves complaint responsibility to another user within the same company.\n\n**URL Parameter:**\n- Complaint ID in path\n\n**Required Fields:**\n- `moved_to`: User ID to move the complaint to (must be in same company)\n\n**Auto-filled Fields:**\n- `moved_at`: Current timestamp\n- `moved_by`: Current user ID\n\n**Authorization:**\n- User must have `selected_company`\n- `moved_to` user must belong to the same company\n\n**Note:** Only managers/HR can move complaints within their company." }, "response": [] }, { "name": "Mark as Corrected (Encrypted)", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"complaint_text\": \"enc:U2FsdGVkX1...\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "/api/secure/complaints/:complaint/corrected", "path": [ "api", "secure", "complaints", ":complaint", "corrected" ], "variable": [ { "key": "complaint", "value": "1" } ] }, "description": "Mark complaint as corrected. Changes status to 'corrected'." }, "response": [] }, { "name": "Mark as Reviewed (Encrypted)", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"complaint_text\": \"enc:U2FsdGVkX1...\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "/api/secure/complaints/:complaint/review", "path": [ "api", "secure", "complaints", ":complaint", "review" ], "variable": [ { "key": "complaint", "value": "1" } ] }, "description": "Mark complaint as reviewed. Changes status to 'reviewed'." }, "response": [] }, { "name": "Mark as Under Review (Encrypted)", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"complaint_text\": \"enc:U2FsdGVkX1...\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "/api/secure/complaints/:complaint/underReview", "path": [ "api", "secure", "complaints", ":complaint", "underReview" ], "variable": [ { "key": "complaint", "value": "1" } ] }, "description": "Mark complaint as under review. Changes status to 'under_review'." }, "response": [] }, { "name": "Reply to Complaint (Encrypted)", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"complaint_text\": \"enc:U2FsdGVkX1...\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "/api/secure/complaints/:complaint/replyToComplaint", "path": [ "api", "secure", "complaints", ":complaint", "replyToComplaint" ], "variable": [ { "key": "complaint", "value": "1" } ] }, "description": "Manager/HR sends a response to the complaint. Changes status to 'awaiting_employee_action'." }, "response": [] }, { "name": "Get Payroll Movement History (Encrypted)", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "/api/secure/payrolls/:payroll/movements", "path": [ "api", "secure", "payrolls", ":payroll", "movements" ], "variable": [ { "key": "payroll", "value": "1" } ] }, "description": "**Get Payroll Movement History (Encrypted)**\n\nRetrieve complete movement history for a specific payroll.\n\n**URL Parameter:**\n- Payroll ID in path\n\n**Returns:**\n- `payroll_id`: Payroll ID\n- `total_movements`: Total number of movements\n- `movements`: Array of movement records with:\n - `from`: User who had responsibility before\n - `to`: User who received responsibility\n - `by`: User who performed the move\n - `moved_at`: Timestamp\n - `moved_at_human`: Human readable time\n - `notes`: Optional notes\n - `metadata`: Additional data\n\n**Use Case:** Track payroll reassignments and responsibility changes" }, "response": [] }, { "name": "Get Complaint Movement History (Encrypted)", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "/api/secure/complaints/:complaint/movements", "path": [ "api", "secure", "complaints", ":complaint", "movements" ], "variable": [ { "key": "complaint", "value": "1" } ] }, "description": "**Get Complaint Movement History (Encrypted)**\n\nRetrieve complete movement history for a specific complaint.\n\n**URL Parameter:**\n- Complaint ID in path\n\n**Returns:**\n- `complaint_id`: Complaint ID\n- `total_movements`: Total number of movements\n- `movements`: Array of movement records\n\n**Use Case:** Track complaint reassignments between managers/HR" }, "response": [] }, { "name": "Get All Company Movements (Encrypted)", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "/api/secure/movements?per_page=20", "path": [ "api", "secure", "movements" ], "query": [ { "key": "per_page", "value": "20", "description": "Items per page (default: 20)" } ] }, "description": "**Get All Company Movements (Encrypted)**\n\nRetrieve all movement logs for the company with pagination.\n\n**Query Parameters:**\n- `per_page`: Items per page (default: 20)\n\n**Returns:**\n- Paginated list of all movements (payrolls + complaints)\n- Each movement includes full user details and metadata\n\n**Authorization:**\n- User must have `selected_company`\n- Only movements from user's company are returned\n\n**Use Case:** Company-wide movement audit and tracking" }, "response": [] }, { "name": "Get Movement Statistics (Encrypted)", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "/api/secure/movements/statistics", "path": [ "api", "secure", "movements", "statistics" ] }, "description": "**Get Movement Statistics (Encrypted)**\n\nRetrieve movement statistics and analytics for the company.\n\n**Returns:**\n- `total_movements`: Total number of all movements\n- `payroll_movements`: Number of payroll movements\n- `complaint_movements`: Number of complaint movements\n- `recent_movements`: Last 10 movements with full details\n\n**Use Case:** Dashboard analytics and reporting" }, "response": [] }, { "name": "Get Complaint Details (Encrypted)", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "/api/secure/complaints/:payroll_id/complaints/:id", "path": [ "api", "secure", "complaints", ":payroll_id", "complaints", ":id" ], "variable": [ { "key": "payroll_id", "value": "1" }, { "key": "id", "value": "1" } ] }, "description": "Get detailed information about a specific complaint including payroll, employee, department, and cost center details." }, "response": [] } ] }, { "name": "App Settings & Configuration", "item": [ { "name": "Get Configuration Data (Updated)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{token}}", "description": "Optional - for user-specific timezone" } ], "url": { "raw": "/api/configData", "path": [ "api", "configData" ] }, "description": "**Get App Configuration Data (Updated with Timezone & Invitation Settings)**\n\n**New Features Added:**\n- Timezone management settings\n- Invitation expiry configurations\n- User-specific timezone (if authenticated)\n\n**Response Structure:**\n```json\n{\n \"status\": true,\n \"data\": {\n \"time_zones\": [\n \"UTC\",\n \"Asia/Riyadh\",\n \"Asia/Dubai\",\n \"Asia/Kuwait\",\n \"Europe/London\",\n \"America/New_York\"\n ],\n \"popular_time_zones\": {\n \"UTC\": \"UTC (+00:00)\",\n \"Asia/Riyadh\": \"Riyadh (UTC+03:00)\",\n \"Asia/Dubai\": \"Dubai (UTC+04:00)\",\n \"Asia/Kuwait\": \"Kuwait (UTC+03:00)\",\n \"Asia/Beirut\": \"Beirut (UTC+02:00)\",\n \"Europe/London\": \"London (UTC+00:00)\",\n \"America/New_York\": \"Eastern Time (UTC-05:00)\"\n },\n \"app_config\": {\n \"application_version\": \"1.0.0\",\n \"available_time_zones\": [\"Asia/Riyadh\", \"Asia/Dubai\", \"UTC\"]\n },\n \"invitation_settings\": {\n \"default_expiry_days\": 7,\n \"max_expiry_days\": 30\n },\n \"user_timezone\": \"Asia/Riyadh\"\n }\n}\n```\n\n**Usage for Frontend:**\n- Use `popular_time_zones` for dropdown selection\n- Check `invitation_settings` for invitation form validation\n- Display `user_timezone` as current setting\n- All timezone values are ready for API calls" }, "response": [] }, { "name": "Send Invitation (Updated with Timezone)", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-Timezone", "value": "Asia/Riyadh", "description": "User's timezone for invitation expiry calculation" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"newemployee@company.com\",\n \"phone\": \"+966501234567\",\n \"account_type\": \"employee\",\n \"delivery_method\": \"both\",\n \"expires_in_days\": 7,\n \"message\": \"Welcome to our team!\",\n \"redirect_url\": \"https://app.example.com/accept-invitation\"\n}\n\n// Updated Features:\n// - expires_in_days now uses .env settings (max 30 days)\n// - Expiry calculated in user's timezone\n// - Supports X-Timezone header for accurate timing\n\n// Valid expires_in_days: 1-30 (configurable via INVITATION_MAX_EXPIRY_DAYS)\n// Default: 7 days (INVITATION_EXPIRY_DAYS)", "options": { "raw": { "language": "json" } } }, "url": { "raw": "/api/invitations/send", "path": [ "api", "invitations", "send" ] }, "description": "**Send Invitation (Updated with Timezone Support)**\n\n**New Features:**\n- Timezone-aware expiry calculation\n- Configurable expiry limits from .env\n- X-Timezone header support\n\n**Environment Variables:**\n- `INVITATION_EXPIRY_DAYS=7` (default)\n- `INVITATION_MAX_EXPIRY_DAYS=30` (maximum)\n\n**Request Body:**\n```json\n{\n \"email\": \"user@example.com\",\n \"phone\": \"+966501234567\",\n \"account_type\": \"employee|manager|hr\",\n \"delivery_method\": \"email|sms|both\",\n \"expires_in_days\": 7,\n \"message\": \"Optional custom message\",\n \"redirect_url\": \"Optional redirect URL\"\n}\n```\n\n**Response:**\n```json\n{\n \"status\": true,\n \"data\": {\n \"invitation\": {\n \"id\": 123,\n \"email\": \"user@example.com\",\n \"expires_at\": \"2025-12-16 17:06:00\",\n \"token\": \"abc123...\",\n \"status\": \"pending\"\n },\n \"delivery_status\": \"success\",\n \"delivery_errors\": []\n }\n}\n```\n\n**Timezone Behavior:**\n- Expiry calculated in user's timezone\n- Supports global teams across timezones\n- Consistent timing regardless of server location" }, "response": [] } ] }, { "name": "Timezone Management", "item": [ { "name": "Get Timezone Settings", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "/api/timezone", "path": [ "api", "timezone" ] }, "description": "**Get Timezone Settings**\n\nReturns user's current timezone and all available options.\n\n**Response Structure:**\n```json\n{\n \"status\": true,\n \"data\": {\n \"current_timezone\": \"UTC\",\n \"popular_timezones\": {\n \"UTC\": \"UTC (+00:00)\",\n \"America/New_York\": \"Eastern Time (UTC-05:00)\",\n \"America/Chicago\": \"Central Time (UTC-06:00)\",\n \"America/Denver\": \"Mountain Time (UTC-07:00)\",\n \"America/Los_Angeles\": \"Pacific Time (UTC-08:00)\",\n \"Europe/London\": \"London (UTC+00:00)\",\n \"Europe/Paris\": \"Paris (UTC+01:00)\",\n \"Europe/Berlin\": \"Berlin (UTC+01:00)\",\n \"Asia/Dubai\": \"Dubai (UTC+04:00)\",\n \"Asia/Riyadh\": \"Riyadh (UTC+03:00)\",\n \"Asia/Kuwait\": \"Kuwait (UTC+03:00)\",\n \"Asia/Beirut\": \"Beirut (UTC+02:00)\",\n \"Asia/Tokyo\": \"Tokyo (UTC+09:00)\",\n \"Asia/Shanghai\": \"Shanghai (UTC+08:00)\",\n \"Australia/Sydney\": \"Sydney (UTC+10:00)\"\n },\n \"all_timezones\": {\n \"Africa\": [\n {\"value\": \"Africa/Cairo\", \"label\": \"Africa/Cairo\", \"offset\": \"+02:00\"},\n {\"value\": \"Africa/Casablanca\", \"label\": \"Africa/Casablanca\", \"offset\": \"+01:00\"}\n ],\n \"America\": [\n {\"value\": \"America/New_York\", \"label\": \"America/New York\", \"offset\": \"-05:00\"},\n {\"value\": \"America/Chicago\", \"label\": \"America/Chicago\", \"offset\": \"-06:00\"}\n ],\n \"Asia\": [\n {\"value\": \"Asia/Riyadh\", \"label\": \"Asia/Riyadh\", \"offset\": \"+03:00\"},\n {\"value\": \"Asia/Dubai\", \"label\": \"Asia/Dubai\", \"offset\": \"+04:00\"},\n {\"value\": \"Asia/Kuwait\", \"label\": \"Asia/Kuwait\", \"offset\": \"+03:00\"},\n {\"value\": \"Asia/Beirut\", \"label\": \"Asia/Beirut\", \"offset\": \"+02:00\"}\n ],\n \"Europe\": [\n {\"value\": \"Europe/London\", \"label\": \"Europe/London\", \"offset\": \"+00:00\"},\n {\"value\": \"Europe/Paris\", \"label\": \"Europe/Paris\", \"offset\": \"+01:00\"}\n ]\n }\n }\n}\n```\n\n**For Frontend (Flutter/React):**\n- Use `popular_timezones` for quick selection dropdown\n- Use `all_timezones` for complete timezone picker\n- Each timezone has `value`, `label`, and `offset`" }, "response": [] }, { "name": "Update User Timezone", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"timezone\": \"Asia/Riyadh\"\n}\n\n// Other Examples:\n// {\"timezone\": \"Asia/Dubai\"} - UAE\n// {\"timezone\": \"Asia/Kuwait\"} - Kuwait \n// {\"timezone\": \"Asia/Qatar\"} - Qatar\n// {\"timezone\": \"Asia/Bahrain\"} - Bahrain\n// {\"timezone\": \"Asia/Baghdad\"} - Iraq\n// {\"timezone\": \"Asia/Beirut\"} - Lebanon\n// {\"timezone\": \"Africa/Cairo\"} - Egypt\n// {\"timezone\": \"Europe/London\"} - UK\n// {\"timezone\": \"UTC\"} - Universal", "options": { "raw": { "language": "json" } } }, "url": { "raw": "/api/timezone", "path": [ "api", "timezone" ] }, "description": "**Update User Timezone**\n\n**Request Body:**\n```json\n{\n \"timezone\": \"Asia/Riyadh\"\n}\n```\n\n**Valid Timezone Values:**\n\n**Popular Middle East & Arab Countries:**\n- `Asia/Riyadh` - Saudi Arabia (UTC+03:00)\n- `Asia/Dubai` - UAE (UTC+04:00)\n- `Asia/Kuwait` - Kuwait (UTC+03:00)\n- `Asia/Qatar` - Qatar (UTC+03:00)\n- `Asia/Bahrain` - Bahrain (UTC+03:00)\n- `Asia/Baghdad` - Iraq (UTC+03:00)\n- `Asia/Beirut` - Lebanon (UTC+02:00)\n- `Asia/Damascus` - Syria (UTC+02:00)\n- `Asia/Amman` - Jordan (UTC+02:00)\n- `Africa/Cairo` - Egypt (UTC+02:00)\n- `Africa/Casablanca` - Morocco (UTC+01:00)\n- `Africa/Tunis` - Tunisia (UTC+01:00)\n\n**Popular International:**\n- `UTC` - Coordinated Universal Time\n- `Europe/London` - UK (UTC+00:00)\n- `Europe/Paris` - France (UTC+01:00)\n- `Europe/Berlin` - Germany (UTC+01:00)\n- `America/New_York` - US Eastern (UTC-05:00)\n- `America/Chicago` - US Central (UTC-06:00)\n- `America/Los_Angeles` - US Pacific (UTC-08:00)\n- `Asia/Tokyo` - Japan (UTC+09:00)\n- `Asia/Shanghai` - China (UTC+08:00)\n- `Australia/Sydney` - Australia (UTC+10:00)\n\n**Response:**\n```json\n{\n \"status\": true,\n \"data\": {\n \"timezone\": \"Asia/Riyadh\",\n \"offset\": \"+03:00\",\n \"current_time\": \"2025-12-09 12:49:00\"\n },\n \"message\": \"Timezone updated successfully\"\n}\n```\n\n**For Frontend Implementation:**\n- Validate timezone before sending\n- Show user-friendly names in UI\n- Store timezone value (not display name)" }, "response": [] }, { "name": "Get Current Time", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "/api/timezone/current-time", "path": [ "api", "timezone", "current-time" ] }, "description": "**Get Current Time**\n\nReturns current time in user's configured timezone.\n\n**Response:**\n```json\n{\n \"status\": true,\n \"data\": {\n \"timezone\": \"Asia/Riyadh\",\n \"current_time\": \"2025-12-09 12:49:00\",\n \"utc_time\": \"2025-12-09 09:49:00\",\n \"offset\": \"+03:00\"\n },\n \"message\": \"Current time retrieved successfully\"\n}\n```\n\n**Usage for Frontend:**\n- Display `current_time` to user\n- Use `utc_time` for calculations\n- Show `offset` for timezone info\n- Perfect for real-time clocks and scheduling" }, "response": [] }, { "name": "Auto-Detect Timezone", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-Timezone", "value": "Asia/Dubai", "description": "Client timezone for auto-detection" } ], "body": { "mode": "raw", "raw": "{\n \"timezone\": \"Asia/Dubai\"\n}\n\n// Auto-Detection Examples:\n// {\"timezone\": \"Asia/Riyadh\"} - Saudi Arabia\n// {\"timezone\": \"Asia/Kuwait\"} - Kuwait\n// {\"timezone\": \"Asia/Qatar\"} - Qatar\n// {\"timezone\": \"Europe/London\"} - UK\n// {\"timezone\": \"America/New_York\"} - US East", "options": { "raw": { "language": "json" } } }, "url": { "raw": "/api/timezone/auto-detect", "path": [ "api", "timezone", "auto-detect" ] }, "description": "**Auto-Detect Timezone**\n\nAutomatically detect and update user's timezone from client.\n\n**Two Methods:**\n\n**Method 1: Request Body**\n```json\n{\n \"timezone\": \"Asia/Dubai\"\n}\n```\n\n**Method 2: Header (Recommended)**\n```\nX-Timezone: Asia/Dubai\n```\n\n**Frontend Implementation Examples:**\n\n**JavaScript/React:**\n```javascript\n// Get user's timezone\nconst timezone = Intl.DateTimeFormat().resolvedOptions().timeZone;\n// Send in header\nheaders: {\n 'X-Timezone': timezone\n}\n```\n\n**Flutter/Dart:**\n```dart\n// Get user's timezone\nString timezone = DateTime.now().timeZoneName;\n// Send in header\nheaders: {\n 'X-Timezone': timezone\n}\n```\n\n**Common Auto-Detected Values:**\n- `Asia/Riyadh` - Saudi Arabia\n- `Asia/Dubai` - UAE \n- `Asia/Kuwait` - Kuwait\n- `Asia/Qatar` - Qatar\n- `Europe/London` - UK\n- `America/New_York` - US East\n\n**Response:**\n```json\n{\n \"status\": true,\n \"data\": {\n \"timezone\": \"Asia/Dubai\",\n \"offset\": \"+04:00\",\n \"auto_detected\": true\n },\n \"message\": \"Timezone auto-detected and updated successfully\"\n}\n```\n\n**Best Practice:**\n- Call this on app startup\n- Only updates if different from current\n- Fallback to manual selection if detection fails" }, "response": [] } ] }, { "name": "Environment Variables & .env Settings", "item": [ { "name": "Current .env Configuration", "request": { "method": "GET", "header": [], "url": { "raw": "# This is a documentation request - not an actual API call", "host": [ "# This is a documentation request - not an actual API call" ] }, "description": "**Current .env Configuration Settings**\n\n**New Environment Variables Added:**\n\n```bash\n# Invitation Configuration\nINVITATION_EXPIRY_DAYS=7\nINVITATION_MAX_EXPIRY_DAYS=30\n\n# Transport Encryption (existing)\nTRANSPORT_ENCRYPTION_KEY=base64:+RZoTFkBn14vkSlZIThAn32ZOjYjoJNLAorOpOs7a9w=\nTRANSPORT_ENCRYPTION_ENABLED=true\n```\n\n**How These Affect APIs:**\n\n**1. Invitation APIs:**\n- Default expiry: 7 days (INVITATION_EXPIRY_DAYS)\n- Maximum allowed: 30 days (INVITATION_MAX_EXPIRY_DAYS)\n- Validation enforced in SendInvitationRequest\n\n**2. ConfigData API Response:**\n```json\n{\n \"invitation_settings\": {\n \"default_expiry_days\": 7,\n \"max_expiry_days\": 30\n }\n}\n```\n\n**3. Frontend Usage:**\n- Use these values for form validation\n- Set max value in date pickers\n- Show limits to users\n\n**4. Timezone Integration:**\n- All time calculations use user's timezone\n- Middleware automatically handles timezone conversion\n- Consistent across all APIs" }, "response": [] } ] }, { "name": "Updated API Behaviors", "item": [ { "name": "Middleware Changes Documentation", "request": { "method": "GET", "header": [], "url": { "raw": "# Documentation - Middleware Updates", "host": [ "# Documentation - Middleware Updates" ] }, "description": "**New Middleware: SetUserTimezone**\n\n**Automatic Timezone Handling:**\n\n**1. For Authenticated Users:**\n- Reads user's saved timezone from database\n- Sets application timezone for the request\n- All `now()` calls use user's timezone\n\n**2. X-Timezone Header Support:**\n```javascript\n// Frontend sends timezone in header\nheaders: {\n 'X-Timezone': 'Asia/Riyadh'\n}\n```\n- Automatically updates user's timezone if different\n- Overrides saved timezone for the request\n\n**3. Affected APIs:**\n- All invitation APIs (expiry calculation)\n- Dashboard statistics (time-based queries)\n- Activity logs (timestamps)\n- Payroll processing (date calculations)\n\n**4. Helper Functions Available:**\n```php\n// Use these in your code instead of now()\nuserNow() // Current time in user's timezone\ntoUserTimezone($utcTime) // Convert UTC to user timezone\ntoUTC($userTime) // Convert user time to UTC\nformatForUser($date, $format) // Format for user's timezone\n```\n\n**5. Backward Compatibility:**\n- Existing APIs work without changes\n- Default timezone: UTC (if user has no timezone set)\n- Gradual migration supported" }, "response": [] }, { "name": "User Model Updates", "request": { "method": "GET", "header": [], "url": { "raw": "# Documentation - User Model Changes", "host": [ "# Documentation - User Model Changes" ] }, "description": "**User Model Updates**\n\n**New Field Added:**\n- `timezone` (string, 50 chars, default: 'UTC')\n\n**Database Migration:**\n```sql\nALTER TABLE users ADD COLUMN timezone VARCHAR(50) DEFAULT 'UTC' AFTER selected_company;\n```\n\n**Fillable Fields Updated:**\n```php\nprotected $fillable = [\n // ... existing fields\n 'selected_company',\n 'timezone', // NEW\n];\n```\n\n**API Response Changes:**\n\n**User Login Response (Updated):**\n```json\n{\n \"status\": true,\n \"data\": {\n \"user\": {\n \"id\": 1,\n \"name\": \"John Doe\",\n \"email\": \"john@example.com\",\n \"timezone\": \"Asia/Riyadh\", // NEW FIELD\n \"selected_company\": \"123\"\n },\n \"token\": \"...\"\n }\n}\n```\n\n**Profile APIs:**\n- GET /api/user - includes timezone\n- PUT /api/profile - can update timezone\n- All user-related responses include timezone\n\n**Frontend Integration:**\n- Store user's timezone in app state\n- Use for local time displays\n- Send in API headers when needed" }, "response": [] }, { "name": "New Files Created", "request": { "method": "GET", "header": [], "url": { "raw": "# Documentation - New Files Added to Project", "host": [ "# Documentation - New Files Added to Project" ] }, "description": "**New Files Added to Project**\n\n**1. Database Migration:**\n📁 `database/migrations/2025_12_08_201100_add_timezone_to_users_table.php`\n- Adds `timezone` column to users table\n- Default value: 'UTC'\n- Run: `php artisan migrate`\n\n**2. Middleware:**\n📁 `app/Http/Middleware/SetUserTimezone.php`\n- Handles automatic timezone setting\n- Supports X-Timezone header\n- Auto-updates user timezone\n\n**3. Helper Class:**\n📁 `app/Helpers/TimezoneHelper.php`\n- Complete timezone management utilities\n- Popular timezone lists\n- Conversion functions\n- User-friendly formatting\n\n**4. API Controller:**\n📁 `app/Http/Controllers/API/UserTimezoneController.php`\n- GET /api/timezone - settings\n- PUT /api/timezone - update\n- GET /api/timezone/current-time\n- POST /api/timezone/auto-detect\n\n**5. Updated Files:**\n\n**User Model** (`app/Models/User.php`):\n- Added 'timezone' to fillable\n\n**Routes** (`routes/api.php`):\n- Added timezone management routes\n\n**Bootstrap** (`bootstrap/app.php`):\n- Registered SetUserTimezone middleware\n\n**Support Helpers** (`app/Helpers/support.php`):\n- Added userNow(), toUserTimezone(), toUTC(), formatForUser()\n\n**Settings Trait** (`app/Traits/SettingsAppsTraits.php`):\n- Updated configData() with timezone settings\n\n**Environment** (`.env`):\n- INVITATION_EXPIRY_DAYS=7\n- INVITATION_MAX_EXPIRY_DAYS=30\n\n**6. Updated Requests:**\n📁 `app/Http/Requests/API/Invitation/SendInvitationRequest.php`\n- Dynamic validation based on .env values\n- Updated error messages\n\n**7. Updated Controllers:**\n📁 `app/Http/Controllers/API/InvitationController.php`\n- Uses .env settings for expiry\n- Timezone-aware calculations\n- Uses userNow() instead of now()\n\n**Installation Steps:**\n1. `php artisan migrate`\n2. Clear config cache: `php artisan config:clear`\n3. Test timezone APIs in Postman\n4. Update frontend to use new timezone features" }, "response": [] } ] }, { "name": "Employee Management System", "item": [ { "name": "Employee Management", "item": [ { "name": "List Company Employees", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "/api/employees", "path": [ "api", "employees" ] }, "description": "**List All Company Employees**\n\nGet all employees in the current user's selected company with their department and cost center information.\n\n**Response Structure:**\n```json\n{\n \"status\": true,\n \"message\": \"Employees retrieved successfully\",\n \"data\": [\n {\n \"user_id\": 1,\n \"name\": \"John Doe\",\n \"email\": \"john@company.com\",\n \"phone\": \"+966501234567\",\n \"emp_id\": \"EMP001\",\n \"account_type\": \"employee\",\n \"department_id\": 1,\n \"cost_center_id\": 1,\n \"is_leaver\": false,\n \"leaving_date\": null,\n \"leave_date_status\": null,\n \"department\": {\n \"id\": 1,\n \"name\": \"IT Department\",\n \"code\": \"IT\"\n },\n \"cost_center\": {\n \"id\": 1,\n \"name\": \"Technology Center\",\n \"code\": \"TECH\"\n }\n }\n ]\n}\n```\n\n**Account Types:**\n- `employee` - Regular Employee\n- `manager` - Department Manager\n- `hr` - HR Personnel\n- `owner` - Company Owner\n\n**Leave Statuses:**\n- `requested` - Leave requested\n- `approved` - Leave approved\n- `rejected` - Leave rejected" }, "response": [] }, { "name": "Get Single Employee", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "/api/employees/{{user_id}}", "path": [ "api", "employees", "{{user_id}}" ] }, "description": "**Get Single Employee Details**\n\nRetrieve detailed information for a specific employee in the company.\n\n**Path Parameters:**\n- `user_id` (integer, required) - The user ID of the employee\n\n**Response Structure:**\n```json\n{\n \"status\": true,\n \"message\": \"Employee retrieved successfully\",\n \"data\": {\n \"user_id\": 1,\n \"name\": \"John Doe\",\n \"email\": \"john@company.com\",\n \"phone\": \"+966501234567\",\n \"emp_id\": \"EMP001\",\n \"account_type\": \"manager\",\n \"department_id\": 1,\n \"cost_center_id\": 1,\n \"is_leaver\": false,\n \"leaving_date\": null,\n \"leave_date_status\": null,\n \"department\": {\n \"id\": 1,\n \"name\": \"IT Department\",\n \"code\": \"IT\"\n },\n \"cost_center\": {\n \"id\": 1,\n \"name\": \"Technology Center\",\n \"code\": \"TECH\"\n }\n }\n}\n```\n\n**Error Responses:**\n- `404` - Employee not found in this company" }, "response": [] }, { "name": "Update Employee (Complete)", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"emp_id\": \"EMP002\",\n \"account_type\": \"manager\",\n \"department_id\": 2,\n \"cost_center_id\": 2,\n \"is_leaver\": false,\n \"leaving_date\": null,\n \"leave_date_status\": null\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "/api/employees/{{user_id}}", "path": [ "api", "employees", "{{user_id}}" ] }, "description": "**Update Employee Information (Complete)**\n\nUpdate all employee information in one request. All fields are optional - only provided fields will be updated.\n\n**Path Parameters:**\n- `user_id` (integer, required) - The user ID of the employee\n\n**Request Body:**\n```json\n{\n \"emp_id\": \"EMP002\",\n \"account_type\": \"manager\",\n \"department_id\": 2,\n \"cost_center_id\": 2,\n \"is_leaver\": false,\n \"leaving_date\": \"2024-12-31\",\n \"leave_date_status\": \"requested\"\n}\n```\n\n**Field Descriptions:**\n- `emp_id` (string, max 50) - Employee ID (unique within company)\n- `account_type` (enum) - employee, manager, hr, owner\n- `department_id` (integer) - Must exist in company\n- `cost_center_id` (integer) - Must exist in company and be linked to department\n- `is_leaver` (boolean) - Whether employee is leaving\n- `leaving_date` (date) - Must be future date if provided\n- `leave_date_status` (enum) - requested, approved, rejected\n\n**Validation Rules:**\n- Employee ID must be unique within the company\n- Department and cost center must belong to the company\n- Cost center must be linked to the selected department\n- Leaving date must be in the future\n\n**Response:**\n```json\n{\n \"status\": true,\n \"message\": \"Employee updated successfully\"\n}\n```" }, "response": [] }, { "name": "Update Employee Field (emp_id)", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"emp_id\": \"EMP003\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "/api/employees/{{user_id}}/emp_id", "path": [ "api", "employees", "{{user_id}}", "emp_id" ] }, "description": "**Update Single Field: Employee ID**\n\nUpdate only the employee ID field. This allows for granular updates without affecting other fields.\n\n**Path Parameters:**\n- `user_id` (integer, required) - The user ID of the employee\n- `field` = `emp_id` - The field to update\n\n**Request Body:**\n```json\n{\n \"emp_id\": \"EMP003\"\n}\n```\n\n**Validation:**\n- Must be unique within the company\n- Maximum 50 characters\n- Required field\n\n**Response:**\n```json\n{\n \"status\": true,\n \"message\": \"Employee emp_id updated successfully\"\n}\n```" }, "response": [] }, { "name": "Update Employee Field (account_type)", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"account_type\": \"manager\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "/api/employees/{{user_id}}/account_type", "path": [ "api", "employees", "{{user_id}}", "account_type" ] }, "description": "**Update Single Field: Account Type**\n\nChange employee's role/permissions within the company.\n\n**Path Parameters:**\n- `user_id` (integer, required) - The user ID of the employee\n- `field` = `account_type` - The field to update\n\n**Request Body:**\n```json\n{\n \"account_type\": \"manager\"\n}\n```\n\n**Valid Account Types:**\n- `employee` - Regular Employee (default permissions)\n- `manager` - Department Manager (can manage employees)\n- `hr` - HR Personnel (can manage HR functions)\n- `owner` - Company Owner (full access)\n\n**Permission Changes:**\n- Changing to `manager` grants department management rights\n- Changing to `hr` grants HR management rights\n- Changing to `owner` grants full company access\n- Changing to `employee` removes special permissions\n\n**Response:**\n```json\n{\n \"status\": true,\n \"message\": \"Employee account_type updated successfully\"\n}\n```" }, "response": [] }, { "name": "Update Employee Field (department_id)", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"department_id\": 3,\n \"cost_center_id\": 3\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "/api/employees/{{user_id}}/department_id", "path": [ "api", "employees", "{{user_id}}", "department_id" ] }, "description": "**Update Single Field: Department**\n\nMove employee to a different department. Cost center must also be updated to match the new department.\n\n**Path Parameters:**\n- `user_id` (integer, required) - The user ID of the employee\n- `field` = `department_id` - The field to update\n\n**Request Body:**\n```json\n{\n \"department_id\": 3,\n \"cost_center_id\": 3\n}\n```\n\n**Important Notes:**\n- Department must exist in the company\n- Cost center must be linked to the selected department\n- Both fields should be updated together for consistency\n\n**Validation:**\n- Department ID must exist in the company\n- Cost center must belong to the selected department\n- Required field\n\n**Response:**\n```json\n{\n \"status\": true,\n \"message\": \"Employee department_id updated successfully\"\n}\n```" }, "response": [] } ] }, { "name": "Department Management", "item": [ { "name": "List Departments", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "/api/departments?search={{search}}&status={{status}}&cost_center_id={{cost_center_id}}&sort_by={{sort_by}}&sort_order={{sort_order}}&per_page={{per_page}}", "path": [ "api", "departments" ], "query": [ { "key": "search", "value": "{{search}}", "description": "Search in name, code, or description" }, { "key": "status", "value": "{{status}}", "description": "Filter by status: active, inactive" }, { "key": "cost_center_id", "value": "{{cost_center_id}}", "description": "Filter by cost center ID" }, { "key": "sort_by", "value": "{{sort_by}}", "description": "Sort by field (default: name)" }, { "key": "sort_order", "value": "{{sort_order}}", "description": "Sort order: asc, desc (default: asc)" }, { "key": "per_page", "value": "{{per_page}}", "description": "Items per page (default: 15)" } ] }, "description": "**List All Company Departments**\n\nRetrieve all departments in the company with filtering and pagination options.\n\n**Query Parameters:**\n- `search` (string, optional) - Search in name, code, or description\n- `status` (string, optional) - Filter by status: active, inactive\n- `cost_center_id` (integer, optional) - Filter by cost center ID\n- `sort_by` (string, optional) - Sort by field (default: name)\n- `sort_order` (string, optional) - Sort order: asc, desc (default: asc)\n- `per_page` (integer, optional) - Items per page (default: 15)\n\n**Response Structure:**\n```json\n{\n \"status\": true,\n \"message\": \"Departments retrieved successfully\",\n \"data\": {\n \"current_page\": 1,\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"IT Department\",\n \"code\": \"IT\",\n \"description\": \"Information Technology Department\",\n \"status\": \"active\",\n \"cost_center_id\": 1,\n \"company_id\": 1,\n \"created_at\": \"2024-01-01T00:00:00.000000Z\",\n \"updated_at\": \"2024-01-01T00:00:00.000000Z\",\n \"cost_center\": {\n \"id\": 1,\n \"name\": \"Technology Center\",\n \"code\": \"TECH\"\n }\n }\n ],\n \"per_page\": 15,\n \"total\": 1\n }\n}\n```\n\n**Permissions:**\n- Manager, HR, Owner can view all departments\n- Employee can view departments (read-only)" }, "response": [] }, { "name": "Create Department", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Human Resources\",\n \"code\": \"HR\",\n \"cost_center_id\": 2,\n \"description\": \"Human Resources Department\",\n \"status\": \"active\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "/api/departments", "path": [ "api", "departments" ] }, "description": "**Create New Department**\n\nCreate a new department in the company. Only managers, HR, and owners can create departments.\n\n**Request Body:**\n```json\n{\n \"name\": \"Human Resources\",\n \"code\": \"HR\",\n \"cost_center_id\": 2,\n \"description\": \"Human Resources Department\",\n \"status\": \"active\"\n}\n```\n\n**Field Descriptions:**\n- `name` (string, required, max 255) - Department name\n- `code` (string, required, max 50) - Department code (unique within company)\n- `cost_center_id` (integer, required) - Must exist in company\n- `description` (string, optional, max 1000) - Department description\n- `status` (string, optional) - active, inactive (default: active)\n\n**Validation Rules:**\n- Department code must be unique within the company\n- Cost center must exist and belong to the company\n- Name is required and cannot be empty\n\n**Response:**\n```json\n{\n \"status\": true,\n \"message\": \"Department created successfully\",\n \"data\": {\n \"id\": 2,\n \"name\": \"Human Resources\",\n \"code\": \"HR\",\n \"cost_center_id\": 2,\n \"description\": \"Human Resources Department\",\n \"status\": \"active\",\n \"company_id\": 1,\n \"created_at\": \"2024-12-09T00:00:00.000000Z\",\n \"updated_at\": \"2024-12-09T00:00:00.000000Z\",\n \"cost_center\": {\n \"id\": 2,\n \"name\": \"Administrative Center\",\n \"code\": \"ADMIN\"\n }\n }\n}\n```\n\n**Permissions:**\n- Manager, HR, Owner can create departments\n- Employee cannot create departments" }, "response": [] }, { "name": "Get Department", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "/api/departments/{{department_id}}", "path": [ "api", "departments", "{{department_id}}" ] }, "description": "**Get Single Department**\n\nRetrieve detailed information for a specific department.\n\n**Path Parameters:**\n- `department_id` (integer, required) - The ID of the department\n\n**Response Structure:**\n```json\n{\n \"status\": true,\n \"message\": \"Department retrieved successfully\",\n \"data\": {\n \"id\": 1,\n \"name\": \"IT Department\",\n \"code\": \"IT\",\n \"cost_center_id\": 1,\n \"description\": \"Information Technology Department\",\n \"status\": \"active\",\n \"company_id\": 1,\n \"created_at\": \"2024-01-01T00:00:00.000000Z\",\n \"updated_at\": \"2024-01-01T00:00:00.000000Z\",\n \"cost_center\": {\n \"id\": 1,\n \"name\": \"Technology Center\",\n \"code\": \"TECH\"\n }\n }\n}\n```\n\n**Error Responses:**\n- `404` - Department not found in this company" }, "response": [] }, { "name": "Update Department (Complete)", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Information Technology\",\n \"code\": \"IT\",\n \"cost_center_id\": 1,\n \"description\": \"Updated IT Department Description\",\n \"status\": \"active\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "/api/departments/{{department_id}}", "path": [ "api", "departments", "{{department_id}}" ] }, "description": "**Update Department (Complete)**\n\nUpdate department information. All fields are optional - only provided fields will be updated.\n\n**Path Parameters:**\n- `department_id` (integer, required) - The ID of the department\n\n**Request Body:**\n```json\n{\n \"name\": \"Information Technology\",\n \"code\": \"IT\",\n \"cost_center_id\": 1,\n \"description\": \"Updated IT Department Description\",\n \"status\": \"active\"\n}\n```\n\n**Field Descriptions:**\n- `name` (string, optional, max 255) - Department name\n- `code` (string, optional, max 50) - Department code (unique within company)\n- `cost_center_id` (integer, optional) - Must exist in company\n- `description` (string, optional, max 1000) - Department description\n- `status` (string, optional) - active, inactive\n\n**Validation Rules:**\n- Department code must be unique within the company (excluding current department)\n- Cost center must exist and belong to the company\n- Cannot change to a cost center that would break employee assignments\n\n**Response:**\n```json\n{\n \"status\": true,\n \"message\": \"Department updated successfully\",\n \"data\": {\n \"id\": 1,\n \"name\": \"Information Technology\",\n \"code\": \"IT\",\n \"cost_center_id\": 1,\n \"description\": \"Updated IT Department Description\",\n \"status\": \"active\",\n \"company_id\": 1,\n \"updated_at\": \"2024-12-09T00:00:00.000000Z\",\n \"cost_center\": {\n \"id\": 1,\n \"name\": \"Technology Center\",\n \"code\": \"TECH\"\n }\n }\n}\n```\n\n**Permissions:**\n- Manager, HR, Owner can update departments\n- Employee cannot update departments" }, "response": [] }, { "name": "Update Department Field (name)", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Information Technology Department\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "/api/departments/{{department_id}}/name", "path": [ "api", "departments", "{{department_id}}", "name" ] }, "description": "**Update Single Field: Department Name**\n\nUpdate only the department name field.\n\n**Path Parameters:**\n- `department_id` (integer, required) - The ID of the department\n- `field` = `name` - The field to update\n\n**Request Body:**\n```json\n{\n \"name\": \"Information Technology Department\"\n}\n```\n\n**Validation:**\n- Required field\n- Maximum 255 characters\n- Cannot be empty\n\n**Response:**\n```json\n{\n \"status\": true,\n \"message\": \"Department name updated successfully\",\n \"data\": {\n \"id\": 1,\n \"name\": \"Information Technology Department\",\n \"code\": \"IT\",\n \"cost_center_id\": 1,\n \"description\": \"IT Department Description\",\n \"status\": \"active\",\n \"company_id\": 1,\n \"updated_at\": \"2024-12-09T00:00:00.000000Z\",\n \"cost_center\": {\n \"id\": 1,\n \"name\": \"Technology Center\",\n \"code\": \"TECH\"\n }\n }\n}\n```" }, "response": [] }, { "name": "Update Department Field (status)", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"status\": \"inactive\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "/api/departments/{{department_id}}/status", "path": [ "api", "departments", "{{department_id}}", "status" ] }, "description": "**Update Single Field: Department Status**\n\nActivate or deactivate a department.\n\n**Path Parameters:**\n- `department_id` (integer, required) - The ID of the department\n- `field` = `status` - The field to update\n\n**Request Body:**\n```json\n{\n \"status\": \"inactive\"\n}\n```\n\n**Valid Status Values:**\n- `active` - Department is active and can be used\n- `inactive` - Department is deactivated (employees remain assigned)\n\n**Important Notes:**\n- Deactivating a department does not remove employee assignments\n- Inactive departments cannot be assigned to new employees\n- Use with caution as it affects department visibility\n\n**Response:**\n```json\n{\n \"status\": true,\n \"message\": \"Department status updated successfully\",\n \"data\": {\n \"id\": 1,\n \"name\": \"IT Department\",\n \"code\": \"IT\",\n \"cost_center_id\": 1,\n \"description\": \"IT Department Description\",\n \"status\": \"inactive\",\n \"company_id\": 1,\n \"updated_at\": \"2024-12-09T00:00:00.000000Z\",\n \"cost_center\": {\n \"id\": 1,\n \"name\": \"Technology Center\",\n \"code\": \"TECH\"\n }\n }\n}\n```" }, "response": [] }, { "name": "Delete Department", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "/api/departments/{{department_id}}", "path": [ "api", "departments", "{{department_id}}" ] }, "description": "**Delete Department**\n\nPermanently delete a department from the company.\n\n**Path Parameters:**\n- `department_id` (integer, required) - The ID of the department\n\n**Important Restrictions:**\n- Cannot delete department with assigned employees\n- Must reassign all employees before deletion\n- This action is irreversible\n\n**Response (Success):**\n```json\n{\n \"status\": true,\n \"message\": \"Department deleted successfully\"\n}\n```\n\n**Error Responses:**\n- `400` - Cannot delete department with assigned employees\n- `404` - Department not found in this company\n\n**Permissions:**\n- Only Manager, HR, and Owner can delete departments\n- Employee cannot delete departments\n\n**Best Practices:**\n1. Check for assigned employees first\n2. Reassign employees to other departments\n3. Consider deactivating instead of deleting\n4. Ensure no payroll records reference this department" }, "response": [] } ] }, { "name": "Cost Center Management", "item": [ { "name": "List Cost Centers", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "/api/cost-centers?search={{search}}&status={{status}}&parent_id={{parent_id}}&sort_by={{sort_by}}&sort_order={{sort_order}}&per_page={{per_page}}", "path": [ "api", "cost-centers" ], "query": [ { "key": "search", "value": "{{search}}", "description": "Search in name, code, or description" }, { "key": "status", "value": "{{status}}", "description": "Filter by status: active, inactive" }, { "key": "parent_id", "value": "{{parent_id}}", "description": "Filter by parent cost center ID or null for root nodes" }, { "key": "sort_by", "value": "{{sort_by}}", "description": "Sort by field (default: name)" }, { "key": "sort_order", "value": "{{sort_order}}", "description": "Sort order: asc, desc (default: asc)" }, { "key": "per_page", "value": "{{per_page}}", "description": "Items per page (default: 15)" } ] }, "description": "List company cost centers with filters and pagination." }, "response": [] }, { "name": "Create Cost Center", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Technology Center\",\n \"code\": \"TECH\",\n \"parent_id\": null,\n \"description\": \"Main technology cost center\",\n \"status\": \"active\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "/api/cost-centers", "path": [ "api", "cost-centers" ] }, "description": "Create a new cost center in the company." }, "response": [] }, { "name": "Get Cost Center", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "/api/cost-centers/{{cost_center_id}}", "path": [ "api", "cost-centers", "{{cost_center_id}}" ] }, "description": "Get a single cost center details by ID." }, "response": [] }, { "name": "Update Cost Center (Complete)", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Updated Center\",\n \"code\": \"TECH2\",\n \"parent_id\": null,\n \"description\": \"Updated description\",\n \"status\": \"active\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "/api/cost-centers/{{cost_center_id}}", "path": [ "api", "cost-centers", "{{cost_center_id}}" ] }, "description": "Update all cost center fields in one request." }, "response": [] }, { "name": "Update Cost Center Field (Generic)", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Updated Name Only\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "/api/cost-centers/{{cost_center_id}}/{{field}}", "path": [ "api", "cost-centers", "{{cost_center_id}}", "{{field}}" ] }, "description": "Update a single field of a cost center using the generic updateField endpoint." }, "response": [] }, { "name": "Delete Cost Center", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "/api/cost-centers/{{cost_center_id}}", "path": [ "api", "cost-centers", "{{cost_center_id}}" ] }, "description": "Delete a cost center. Cannot delete if it has children, departments, or employees attached." }, "response": [] }, { "name": "Cost Center Tree", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "/api/cost-centers-tree", "path": [ "api", "cost-centers-tree" ] }, "description": "Get the hierarchical tree of all company cost centers." }, "response": [] } ] } ] } ], "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "packages": [], "requests": [], "exec": [ " \r", " let online = \"https://endpoint.ngm4ido3.a2hosted.com/\";\r", " let local = \"http://127.0.0.1:8000/\";\r", "\r", " let isLive = 1;\r", "let baseUrl = isLive == 1\r", " ?online\r", " : local;\r", " \r", " if (!baseUrl) {\r", " console.error(\"❌ baseUrl is undefined. تأكد من ضبط live_url و local_url في المتغيرات.\");\r", " return;\r", "}\r", "\r", " let originalUrl = pm.request.url.toString();\r", "let pathOnly = originalUrl.replace(/^https?:\\/\\/[^\\/]+/i, '');\r", "\r", " if (baseUrl.endsWith('/')) {\r", " baseUrl = baseUrl.slice(0, -1);\r", "}\r", "if (pathOnly.startsWith('/')) {\r", " pathOnly = pathOnly.slice(1);\r", "}\r", "\r", " let finalUrl = `${baseUrl}/${pathOnly}`;\r", "pm.request.url = finalUrl;\r", "\r", " \r", "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "packages": [], "requests": [], "exec": [ "" ] } } ], "variable": [ { "key": "token", "value": "35|tkY6EIIprRuGK3Bztpuex1fk2doOSFDUSZXtbY2Q58ce4287" }, { "key": "token_manager", "value": "35|tkY6EIIprRuGK3Bztpuex1fk2doOSFDUSZXtbY2Q58ce4287" }, { "key": "token_hr", "value": "35|tkY6EIIprRuGK3Bztpuex1fk2doOSFDUSZXtbY2Q58ce4287" }, { "key": "token_company", "value": "35|tkY6EIIprRuGK3Bztpuex1fk2doOSFDUSZXtbY2Q58ce4287" }, { "key": "EM00000016", "value": "" } ] }