latestOpenAPI 3.0.1Proprietary2026-08-1844131294.9 KB

59cd6443fdbf

Employee Compensation Details

Retrieve employee compensation details

Get comprehensive compensation information including salary, pay frequency, and structured allowance breakdowns.

This endpoint provides access to the employee's compensation details including gross salary, designation, salary frequency, effective date, and detailed salary breakup components.

get/v1/employees/{employeeId}/compensation

Path parameters

employeeIdstring uuid required

Unique identifier for the employee

Response

Employee compensation details retrieved successfully

Example response

{
  "compensationDetails": {
    "baseSalary": {
      "amount": 50000,
      "currency": "INR",
      "frequency": "MONTHLY"
    },
    "designation": "CSM",
    "salaryFrequency": "MONTHLY",
    "effectiveFrom": "2025-10-31",
    "additionalPays": [
      {
        "name": "HRA",
        "label": "House Rent Allowance",
        "amount": 3497,
        "currency": "INR",
        "frequency": "MONTHLY"
      }
    ]
  }
}