v1
latestOpenAPI 3.1.02026-07-26294215839.4 KBTotal Rewards
Public API
Get Printable Total Rewards Statement
Generate and return a PDF printable version of the employee's Total Rewards statement.
OAuth Scopes: total_rewards
get/api/v1/compensation/total_rewards/{employeeId}/printable
Path parameters
employeeIdstring required
The internal employee ID of the employee whose printable Total Rewards statement is returned.
Query parameters
multipliernumber
Hours-per-week multiplier for annualizing hourly pay.
yearinteger
Statement year. Defaults to the current year when omitted.
Response
PDF document streamed with Content-Disposition: attachment.