v1

latestOpenAPI 3.1.02026-07-26294215839.4 KB

Total Rewards

Public API

Get Total Rewards Statement

Returns the full Total Rewards statement for the given employee, including compensation, benefits, bonuses, equity, reimbursements, and time-off data.

OAuth Scopes: total_rewards

get/api/v1/compensation/total_rewards/{employeeId}/statement

Path parameters

employeeIdstring required

The internal employee ID of the employee whose total rewards statement is returned.

Response

Total Rewards statement for the employee.

employeeIdstring nullable

Employee Id

employeeNamestring

Employee Name

jobTitlestring nullable

Employee Job Title

hasMixedCurrencyTypesboolean nullable

Employee statement has multiple currencies

companyNamestring nullable

Company name

companyLogoUrlstring nullable

Company logo URL

statementYearinteger nullable

Statement year

minStatementYearinteger nullable

Minimum selectable statement year