---
title: "Get Printable Total Rewards Statement"
method: GET
path: "/api/v1/compensation/total_rewards/{employeeId}/printable"
tags: ["Total Rewards", "Public API"]
---

# Get Printable Total Rewards Statement

`GET /api/v1/compensation/total_rewards/{employeeId}/printable`

## Request

- Base URL: `https://companySubDomain.bamboohr.com`
- URL: `https://companySubDomain.bamboohr.com/api/v1/compensation/total_rewards/{employeeId}/printable`
- Auth: OAuth 2
  - Authorization code: `/authorize.php`
  - Token URL: `/token.php` scopes: `total_rewards`
- TypeScript: <https://skmtc.dev/bamboohr/apis/bamboohr-api/docs/api/v1/compensation/total_rewards/:employeeId/printable/get.ts> (a function with typed inputs; its response is checked against the schema)

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

OAuth Scopes: total_rewards

## Path parameters

- `employeeId` string, required

## Query parameters

- `multiplier` number
- `year` integer

## Response `200`

PDF document streamed with Content-Disposition: attachment.

## Other responses

- `400`: Invalid argument (e.g. bad year or multiplier).
- `403`: The authenticated caller lacks permission to view this employee's Total Rewards statement.
- `500`: Unexpected server error.

---

[API](https://skmtc.dev/bamboohr/apis/bamboohr-api.md) - [All operations](https://skmtc.dev/bamboohr/apis/bamboohr-api/llms.txt) - [OpenAPI document](https://skmtc.dev/bamboohr/apis/bamboohr-api/revisions/922fc15f43a7?raw)