{ "info": { "_postman_id": "cd4cc3bd4245adc1cabf07c4179b5e47", "name": "Hifisys HRMS API", "description": "Complete enterprise human resource management API for employee lifecycle, attendance, leaves, payroll, payslips, work logs, and analytics.\n\nOfficial REST API Postman Collection (v2.1.0) for Hifisys Enterprise Platform.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "item": [ { "name": "Authentication & Health", "item": [ { "name": "Platform API Health Check", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/health", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "health" ] }, "description": "Verifies that the Hifisys REST API v1 gateway is operational (public health check)." }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] } ] }, { "name": "Employees", "item": [ { "name": "List Employees", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/hrms/employees", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "hrms", "employees" ] }, "description": "Returns paginated tenant employees with department and designation.\n\nRequired Scope: `employees:read`" }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "Create Employee", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/hrms/employees", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "hrms", "employees" ] }, "description": "Creates a tenant employee record with initial salary.\n\nRequired Scope: `employees:write`", "body": { "mode": "raw", "raw": "{\n \"first_name\": \"Elena\",\n \"last_name\": \"Vance\",\n \"email\": \"elena.vance@company.test\",\n \"joining_date\": \"2026-01-15\",\n \"current_salary\": 7500\n}", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "Get Employee Profile", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/hrms/employees/:id", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "hrms", "employees", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "Path parameter: id" } ] }, "description": "Retrieves a single tenant employee record.\n\nRequired Scope: `employees:read`" }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "Update Employee Profile", "request": { "method": "PUT", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/hrms/employees/:id", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "hrms", "employees", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "Path parameter: id" } ] }, "description": "Updates employee profile attributes.\n\nRequired Scope: `employees:write`", "body": { "mode": "raw", "raw": "{\n \"phone\": \"+919876500001\",\n \"work_mode\": \"Hybrid\"\n}", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "Terminate / Deactivate Employee", "request": { "method": "DELETE", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/hrms/employees/:id", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "hrms", "employees", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "Path parameter: id" } ] }, "description": "Marks employee as Terminated while preserving historical records.\n\nRequired Scope: `employees:write`" }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "Record Salary Revision", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/hrms/employees/:id/salary", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "hrms", "employees", ":id", "salary" ], "variable": [ { "key": "id", "value": "1", "description": "Path parameter: id" } ] }, "description": "Updates salary and writes an audit row to salary_history.\n\nRequired Scope: `employees:write`", "body": { "mode": "raw", "raw": "{\n \"new_salary\": 8500,\n \"reason\": \"Annual Appraisal\",\n \"effective_from\": \"2026-11-01\"\n}", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "List Employee Documents", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/hrms/employees/:id/documents", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "hrms", "employees", ":id", "documents" ], "variable": [ { "key": "id", "value": "1", "description": "Path parameter: id" } ] }, "description": "Lists documents uploaded for an employee.\n\nRequired Scope: `employees:read`" }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "Upload Employee Document", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/hrms/employees/:id/documents", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "hrms", "employees", ":id", "documents" ], "variable": [ { "key": "id", "value": "1", "description": "Path parameter: id" } ] }, "description": "Uploads a PDF/image document (multipart/form-data) to private storage.\n\nRequired Scope: `employees:write`", "body": { "mode": "formdata", "formdata": [ { "key": "title", "value": "Offer Letter", "type": "text" }, { "key": "document", "type": "file", "src": "" } ] } }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "Get Employee Audit History", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/hrms/employees/:id/history", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "hrms", "employees", ":id", "history" ], "variable": [ { "key": "id", "value": "1", "description": "Path parameter: id" } ] }, "description": "Retrieves employment lifecycle timeline.\n\nRequired Scope: `employees:read`" }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] } ] }, { "name": "Departments & Designations", "item": [ { "name": "List Departments", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/hrms/departments", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "hrms", "departments" ] }, "description": "Lists tenant departments.\n\nRequired Scope: `employees:read`" }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "Create Department", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/hrms/departments", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "hrms", "departments" ] }, "description": "Creates a tenant department.\n\nRequired Scope: `employees:write`", "body": { "mode": "raw", "raw": "{\n \"name\": \"Platform Engineering\",\n \"description\": \"Core infrastructure team\"\n}", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "Update Department", "request": { "method": "PUT", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/hrms/departments/:id", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "hrms", "departments", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "Path parameter: id" } ] }, "description": "Updates a tenant department.\n\nRequired Scope: `employees:write`", "body": { "mode": "raw", "raw": "{\n \"name\": \"Core Engineering\"\n}", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "Delete Department", "request": { "method": "DELETE", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/hrms/departments/:id", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "hrms", "departments", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "Path parameter: id" } ] }, "description": "Archives/deletes a tenant department.\n\nRequired Scope: `employees:write`" }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "List Designations", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/hrms/designations", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "hrms", "designations" ] }, "description": "Lists tenant job designations.\n\nRequired Scope: `employees:read`" }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "Create Designation", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/hrms/designations", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "hrms", "designations" ] }, "description": "Creates a job designation.\n\nRequired Scope: `employees:write`", "body": { "mode": "raw", "raw": "{\n \"name\": \"Staff Engineer\"\n}", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "Delete Designation", "request": { "method": "DELETE", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/hrms/designations/:id", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "hrms", "designations", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "Path parameter: id" } ] }, "description": "Deletes a tenant designation.\n\nRequired Scope: `employees:write`" }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] } ] }, { "name": "Shifts & Holidays", "item": [ { "name": "List Shifts", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/hrms/shifts", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "hrms", "shifts" ] }, "description": "Lists tenant work shifts.\n\nRequired Scope: `attendance:read`" }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "Create Shift", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/hrms/shifts", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "hrms", "shifts" ] }, "description": "Creates a work shift.\n\nRequired Scope: `attendance:write`", "body": { "mode": "raw", "raw": "{\n \"name\": \"Day Shift\",\n \"start_time\": \"09:00\",\n \"end_time\": \"18:00\"\n}", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "Delete Shift", "request": { "method": "DELETE", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/hrms/shifts/:id", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "hrms", "shifts", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "Path parameter: id" } ] }, "description": "Deletes a tenant work shift.\n\nRequired Scope: `attendance:write`" }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "List Holidays", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/hrms/holidays", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "hrms", "holidays" ] }, "description": "Lists tenant holiday calendar ordered by date.\n\nRequired Scope: `attendance:read`" }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "Create Holiday", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/hrms/holidays", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "hrms", "holidays" ] }, "description": "Creates a company or public holiday entry.\n\nRequired Scope: `attendance:write`", "body": { "mode": "raw", "raw": "{\n \"title\": \"Foundation Day\",\n \"date\": \"2026-12-01\",\n \"type\": \"Company\"\n}", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "Delete Holiday", "request": { "method": "DELETE", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/hrms/holidays/:id", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "hrms", "holidays", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "Path parameter: id" } ] }, "description": "Removes a tenant holiday entry.\n\nRequired Scope: `attendance:write`" }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] } ] }, { "name": "Attendance & Breaks", "item": [ { "name": "List Attendance Logs", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/hrms/attendance", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "hrms", "attendance" ] }, "description": "Lists paginated attendance logs with optional date, employee_id, and status filters.\n\nRequired Scope: `attendance:read`" }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "Attendance Clock-In", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/hrms/attendance/clock-in", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "hrms", "attendance", "clock-in" ] }, "description": "Records today's employee punch-in.\n\nRequired Scope: `attendance:write`", "body": { "mode": "raw", "raw": "{\n \"employee_id\": 1,\n \"notes\": \"Remote check-in\"\n}", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "Attendance Clock-Out", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/hrms/attendance/clock-out", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "hrms", "attendance", "clock-out" ] }, "description": "Records punch-out and calculates total working hours.\n\nRequired Scope: `attendance:write`", "body": { "mode": "raw", "raw": "{\n \"employee_id\": 1\n}", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "Start Attendance Break", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/hrms/attendance/break-start", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "hrms", "attendance", "break-start" ] }, "description": "Starts an attendance break for today's active session.\n\nRequired Scope: `attendance:write`", "body": { "mode": "raw", "raw": "{\n \"employee_id\": 1,\n \"break_type\": \"Lunch\"\n}", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "End Attendance Break", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/hrms/attendance/break-end", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "hrms", "attendance", "break-end" ] }, "description": "Closes the open break and calculates break duration.\n\nRequired Scope: `attendance:write`", "body": { "mode": "raw", "raw": "{\n \"employee_id\": 1\n}", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "Export Monthly Attendance Dataset", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/hrms/attendance/export", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "hrms", "attendance", "export" ] }, "description": "Returns structured monthly attendance export payload.\n\nRequired Scope: `attendance:read`" }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] } ] }, { "name": "Leaves & Time Off", "item": [ { "name": "List Leave Types", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/hrms/leaves/types", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "hrms", "leaves", "types" ] }, "description": "Returns active tenant and global leave policies.\n\nRequired Scope: `leave:read`" }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "Create Leave Type", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/hrms/leaves/types", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "hrms", "leaves", "types" ] }, "description": "Creates a tenant leave policy.\n\nRequired Scope: `leave:write`", "body": { "mode": "raw", "raw": "{\n \"name\": \"Annual Leave\",\n \"code\": \"AL\",\n \"days_allowed\": 18,\n \"is_paid\": true\n}", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "List Leave Requests", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/hrms/leaves/requests", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "hrms", "leaves", "requests" ] }, "description": "Lists tenant employee leave requests.\n\nRequired Scope: `leave:read`" }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "Get Leave Balances", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/hrms/leaves/balances", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "hrms", "leaves", "balances" ] }, "description": "Returns remaining leave balances per employee.\n\nRequired Scope: `leave:read`" }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "Apply for Leave", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/hrms/leaves/apply", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "hrms", "leaves", "apply" ] }, "description": "Submits an employee leave application.\n\nRequired Scope: `leave:write`", "body": { "mode": "raw", "raw": "{\n \"employee_id\": 1,\n \"leave_type_id\": 1,\n \"start_date\": \"2026-12-10\",\n \"end_date\": \"2026-12-11\",\n \"reason\": \"Family event\"\n}", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "Approve Leave Request", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/hrms/leaves/:id/approve", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "hrms", "leaves", ":id", "approve" ], "variable": [ { "key": "id", "value": "1", "description": "Path parameter: id" } ] }, "description": "Approves pending leave request and deducts leave balance.\n\nRequired Scope: `leave:approve`", "body": { "mode": "raw", "raw": "[]", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "Reject Leave Request", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/hrms/leaves/:id/reject", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "hrms", "leaves", ":id", "reject" ], "variable": [ { "key": "id", "value": "1", "description": "Path parameter: id" } ] }, "description": "Rejects pending leave request and records hr_remarks.\n\nRequired Scope: `leave:approve`", "body": { "mode": "raw", "raw": "{\n \"rejection_reason\": \"Sprint release freeze\"\n}", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] } ] }, { "name": "Payroll & Payslips", "item": [ { "name": "List Payroll Records", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/hrms/payrolls", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "hrms", "payrolls" ] }, "description": "Returns tenant payroll runs with breakdown items.\n\nRequired Scope: `payroll:read`" }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "Generate Monthly Payroll", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/hrms/payrolls/generate", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "hrms", "payrolls", "generate" ] }, "description": "Generates payroll entries and line items for all Active tenant employees.\n\nRequired Scope: `payroll:write`", "body": { "mode": "raw", "raw": "{\n \"month\": 11,\n \"year\": 2026\n}", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "Mark Payroll as Paid", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/hrms/payrolls/:id/mark-paid", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "hrms", "payrolls", ":id", "mark-paid" ], "variable": [ { "key": "id", "value": "1", "description": "Path parameter: id" } ] }, "description": "Marks a generated payroll record as Paid.\n\nRequired Scope: `payroll:write`", "body": { "mode": "raw", "raw": "{\n \"payment_method\": \"NEFT\",\n \"transaction_reference\": \"TXN-2026-001\"\n}", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "Download Payslip PDF", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/hrms/payrolls/:id/payslip", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "hrms", "payrolls", ":id", "payslip" ], "variable": [ { "key": "id", "value": "1", "description": "Path parameter: id" } ] }, "description": "Streams signed PDF payslip (supports optional X-Employee-ID self-service restriction).\n\nRequired Scope: `payslips:read`" }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] } ] }, { "name": "Recruitment ATS", "item": [ { "name": "List Recruitment Jobs", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/hrms/recruitment/jobs", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "hrms", "recruitment", "jobs" ] }, "description": "Lists open tenant recruitment requisitions.\n\nRequired Scope: `recruitment:read`" }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "Create Recruitment Job", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/hrms/recruitment/jobs", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "hrms", "recruitment", "jobs" ] }, "description": "Publishes a new tenant recruitment job opening.\n\nRequired Scope: `recruitment:write`", "body": { "mode": "raw", "raw": "{\n \"title\": \"Backend Engineer\",\n \"description\": \"Build distributed Laravel APIs.\",\n \"openings_count\": 2\n}", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "List Candidates", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/hrms/recruitment/candidates", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "hrms", "recruitment", "candidates" ] }, "description": "Lists tenant recruitment candidates filterable by job_id and stage.\n\nRequired Scope: `recruitment:read`" }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "Register Candidate Application", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/hrms/recruitment/candidates", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "hrms", "recruitment", "candidates" ] }, "description": "Registers a candidate against a tenant-owned recruitment job.\n\nRequired Scope: `recruitment:write`", "body": { "mode": "raw", "raw": "{\n \"job_id\": 1,\n \"first_name\": \"Devon\",\n \"email\": \"devon@candidate.test\",\n \"stage\": \"applied\"\n}", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "Update Candidate Stage", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/hrms/recruitment/candidates/:id/stage", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "hrms", "recruitment", "candidates", ":id", "stage" ], "variable": [ { "key": "id", "value": "1", "description": "Path parameter: id" } ] }, "description": "Transitions a candidate through recruitment pipeline stages.\n\nRequired Scope: `recruitment:write`", "body": { "mode": "raw", "raw": "{\n \"stage\": \"interview\"\n}", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] } ] }, { "name": "Tasks & Work Logs", "item": [ { "name": "List Assigned Tasks", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/hrms/tasks", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "hrms", "tasks" ] }, "description": "Lists tenant HRMS tasks with assignee and project metadata.\n\nRequired Scope: `tasks:read`" }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "Create / Assign Task", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/hrms/tasks", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "hrms", "tasks" ] }, "description": "Assigns a task to a tenant employee (auto-links default project if project_id omitted).\n\nRequired Scope: `tasks:write`", "body": { "mode": "raw", "raw": "{\n \"title\": \"Verify Payroll Sync\",\n \"employee_id\": 1,\n \"priority\": \"High\"\n}", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "List Work Logs", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/hrms/work-logs", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "hrms", "work-logs" ] }, "description": "Lists employee timesheet/work logs ordered by log_date.\n\nRequired Scope: `worklogs:read`" }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "Create Work Log", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/hrms/work-logs", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "hrms", "work-logs" ] }, "description": "Records daily work log duration (accepts time_spent_minutes or hours_spent).\n\nRequired Scope: `worklogs:write`", "body": { "mode": "raw", "raw": "{\n \"employee_id\": 1,\n \"log_date\": \"2026-11-12\",\n \"work_title\": \"API Integration Sprint\",\n \"time_spent_minutes\": 240,\n \"description\": \"Completed HRMS endpoint sync.\"\n}", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] } ] }, { "name": "Summary Analytics", "item": [ { "name": "Get HRMS Summary Analytics", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/hrms/summary", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "hrms", "summary" ] }, "description": "Returns active employee count, today attendance, pending leaves, and open tasks for tenant.\n\nRequired Scope: `reports:read`" }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] } ] } ], "variable": [ { "key": "base_url", "value": "https://hifisys.com", "type": "string" }, { "key": "api_key", "value": "YOUR_API_KEY", "type": "string" }, { "key": "product_slug", "value": "hrms-api", "type": "string" }, { "key": "api_version", "value": "v1", "type": "string" } ] }