Skip to main content
GET
/
organizations
/
{organization_id}
/
employees
/
{employee_id}
/
compensation-details
Get Employee Compensation Details
curl --request GET \
  --url https://preview.intermezzo.ai/organizations/{organization_id}/employees/{employee_id}/compensation-details \
  --header 'Authorization: Bearer <token>'
{
  "employeeId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "employmentCountry": "GB",
  "earnings": [
    {
      "wageTypeCode": "<string>",
      "amount": "<string>",
      "earningType": "AMOUNT",
      "earningFrequency": "MONTH",
      "isLumpsum": false
    }
  ],
  "benefits": [
    {
      "wageTypeCode": "<string>",
      "amount": "0.00",
      "makeGoodAmount": "0.00",
      "foregoneAmount": "0.00"
    }
  ],
  "deductions": [
    {
      "name": "<string>",
      "amount": "<string>",
      "wageTypeCode": "<string>"
    }
  ],
  "reimbursements": [
    {
      "wageTypeCode": "<string>",
      "amount": "<string>"
    }
  ],
  "validFrom": "2023-12-25",
  "validTo": "2023-12-25"
}

Authorizations

Authorization
string
header
required

Get token from Auth0 and paste it here

Path Parameters

organization_id
required
employee_id
required

Response

Successful Response

Response model for GB compensation details.

employeeId
string
required
createdAt
string<date-time> | null
required
updatedAt
string<date-time> | null
required
id
required
employmentCountry
string
default:GB
Allowed value: "GB"
earnings
AmountEarnings · object[] | null
benefits
Benefits · object[] | null
deductions
Deductions · object[] | null
reimbursements
Reimbursement · object[] | null
validFrom
string<date>

Effective date

validTo
string<date> | null

End date (None = current)