DocumentationAPI Reference
API Reference

Get Printable Total Rewards Statement

get
https://{companyDomain}.bamboohr.com/api/v1/compensation/total_rewards//printable

Generate and return a PDF printable version of the employee's Total Rewards statement.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The ID of the employee.

Query Params
number

Hours-per-week multiplier for annualizing hourly pay.

integer

Statement year. Defaults to the current year when omitted.

Headers
string
enum
Defaults to application/problem+json

Generated from available response content types

Allowed:
Responses

Updated about 8 hours ago

Language
Credentials
OAuth2
Missing 1 required scope
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/problem+json

Updated about 8 hours ago