--- title: "Get Total Rewards Statement" method: GET path: "/api/v1/compensation/total_rewards/{employeeId}/statement" tags: ["Total Rewards", "Public API"] --- # Get Total Rewards Statement `GET /api/v1/compensation/total_rewards/{employeeId}/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 ## Path parameters - `employeeId` string, required ## Response `200` Total Rewards statement for the employee. - TotalRewardsEmployeeStatement — Schema for a total rewards statement - `employeeId` string, nullable — Employee Id - `employeeName` string — Employee Name - `jobTitle` string, nullable — Employee Job Title - `hasMixedCurrencyTypes` boolean, nullable — Employee statement has multiple currencies - `overviewSection` TotalRewardsOverviewSectionValues — Schema for total rewards overview section - `estimatedTotalCompValue` string, nullable — Estimated total compensation - `paidPer` string, nullable — Paid per reference - `multiplierValue` number, float, nullable — Multiplier for hours worked for hourly paid type - `paySection` TotalRewardsTimelineSectionValues — Schema for total rewards overview section - `compSummary` TotalRewardsCompSummaryValues — Schema for total rewards compensation summary values - `title` string — Title - `subtitle` string, nullable — Subtitle - `value` string, nullable — Value - `subvalue` string, nullable — When conversion applies: localized “(from …)” fragment including the original amount - `timelineData` TotalRewardsTimelineItem[] — Timeline data - `value` string, nullable — Value - `subvalue` string, nullable — When conversion applies: localized “(from …)” fragment including the original amount, e.g. (from $48,000.00 / Year) - `label` union — Label - string - string[] - `placeholderText` string, nullable — Placeholder text - `bonusSection` TotalRewardsTimelineSectionValues — Schema for total rewards overview section - `compSummary` TotalRewardsCompSummaryValues — Schema for total rewards compensation summary values - `title` string — Title - `subtitle` string, nullable — Subtitle - `value` string, nullable — Value - `subvalue` string, nullable — When conversion applies: localized “(from …)” fragment including the original amount - `timelineData` TotalRewardsTimelineItem[] — Timeline data - `value` string, nullable — Value - `subvalue` string, nullable — When conversion applies: localized “(from …)” fragment including the original amount, e.g. (from $48,000.00 / Year) - `label` union — Label - string - string[] - `placeholderText` string, nullable — Placeholder text - `commissionSection` TotalRewardsTimelineSectionValues — Schema for total rewards overview section - `compSummary` TotalRewardsCompSummaryValues — Schema for total rewards compensation summary values - `title` string — Title - `subtitle` string, nullable — Subtitle - `value` string, nullable — Value - `subvalue` string, nullable — When conversion applies: localized “(from …)” fragment including the original amount - `timelineData` TotalRewardsTimelineItem[] — Timeline data - `value` string, nullable — Value - `subvalue` string, nullable — When conversion applies: localized “(from …)” fragment including the original amount, e.g. (from $48,000.00 / Year) - `label` union — Label - string - string[] - `placeholderText` string, nullable — Placeholder text - `benefitSection` TotalRewardsBenefitSectionValues — Schema for a total rewards benefit section - `compSummary` TotalRewardsCompSummaryValues — Schema for total rewards compensation summary values - `title` string — Title - `subtitle` string, nullable — Subtitle - `value` string, nullable — Value - `subvalue` string, nullable — When conversion applies: localized “(from …)” fragment including the original amount - `benefitDetails` TotalRewardsBenefitDetailsValues[] — Benefit details - `name` string — Name - `companyContributionAmount` string — Company contribution amount - `companyContributionSubvalue` string, nullable — Source contribution when the amount was currency-converted - `summary` string, nullable — Summary - `url` string, nullable — Url - `benefitModalValuesLink` string, nullable — Link to the benefits modal - `equitySection` TotalRewardsEquitySectionValues — Schema for total rewards equity section values - `compSummary` TotalRewardsCompSummaryValues — Schema for total rewards compensation summary values - `title` string — Title - `subtitle` string, nullable — Subtitle - `value` string, nullable — Value - `subvalue` string, nullable — When conversion applies: localized “(from …)” fragment including the original amount - `conditions` string, nullable — Terms and conditions - `disclaimers` string, nullable — Disclaimers - `equityDetails` TotalRewardsEquityDetailsValues[] — Equity details - `cliffMonths` integer, nullable — Cliff months - `estimatedExerciseCost` string, nullable — Estimated exercise cost - `estimatedExerciseCostSubvalue` string, nullable — Source exercise cost when converted - `estimatedSharePrice` string — Estimated share price - `estimatedSharePriceSubvalue` string, nullable — Source share price when converted - `estimatedTotalValue` string — Estimated total value - `estimatedTotalValueSubvalue` string, nullable — Source total when converted - `grantDate` string, date — Grant date - `grantType` string — Grant type - `grantName` string, nullable — Grant name - `equityGrowthChartData` TotalRewardsEquityGrowthChartItem[], nullable — Equity growth chart data - `label` string — Label - `estimatedNetValue` string — Estimated value - `subvalue` string, nullable — Source amount for estimated value when it was currency-converted - `vested` number, float, nullable — Amount vested - `current` number, float, nullable — Current value - `unvested` number, float, nullable — Amount unvested - `numShares` integer — Number of shares - `numVestedShares` integer — Number of vested shares - `percentVested` number, float — Percent vested - `strikePrice` string, nullable — Strike price - `strikePriceSubvalue` string, nullable — Source strike when converted - `vestingMonths` integer, nullable — Vesting months - `vestingSchedule` string — Vesting schedule - `vestingStartDate` string, date — Vesting start date - `vestedValue` string — Vested value - `vestedValueSubvalue` string, nullable — Source vested when converted - `equityEstimatedValuation` TotalRewardsEquityEstimatedValuationValues — Schema for total rewards equity growth valuation - `equityGrowthEstimationItems` TotalRewardsEquityGrowthEstimation[] — Equity estimated growth items - `stop` integer — Stop - `companyValuation` string — Company valuation - `companyValuationSubvalue` string, nullable — Source company valuation when converted - `totalValue` string — Total value - `totalValueSubvalue` string, nullable — Source total when converted - `vestedValue` string — Vested amount value - `vestedValueSubvalue` string, nullable — Source vested when converted - `numberOfVestedShares` integer — Number of vested shares - `numberOfTotalShares` integer — Number of total shares - `equityGrowthSliderMax` integer, nullable — Equity growth slider max value - `equityGrowthSliderMin` integer, nullable — Equity growth slider min value - `calendarSection` TotalRewardsCalendarSectionValues — Schema for total rewards calendar section - `holidays` TotalRewardsHolidayValue[] — List of holidays - `title` string — Title - `startDate` string — Start date - `endDate` string, nullable — End date - `timeOffPolicies` TotalRewardsTimeOffPolicyValue[] — List of time off policies - `title` string — Title - `value` string — Value - `showDisclaimer` boolean, nullable — Show disclaimer - `showEligible` boolean, nullable — Show eligibility - `hourlyAccrualDisclaimer` string, nullable — Hourly accrual disclaimer text - `extraPaySection` TotalRewardsExtraPaySectionValues — Schema for total rewards extra pay section values - `title` string — Title - `compSummary` TotalRewardsCompSummaryValues — Schema for total rewards compensation summary values - `title` string — Title - `subtitle` string, nullable — Subtitle - `value` string, nullable — Value - `subvalue` string, nullable — When conversion applies: localized “(from …)” fragment including the original amount - `extraPayDetails` TotalRewardsExtraPayDetailsValues[] — Extra pay details - `name` string — Name - `amount` string — Amount - `amountSubvalue` string, nullable — Source amount when amount was currency-converted - `frequency` string — Frequency - `formattedDateString` string, date — Extra pay formatted date - `annualizedAmount` string — Annualized amount - `annualizedSubvalue` string, nullable — Source text when annualized amount was currency-converted - `customDisclaimerInfo` TotalRewardsCustomDisclaimerInfo — Schema for a total rewards custom disclaimer info - `isViewerAdmin` boolean — Is admin currently viewing - `customDisclaimer` string, nullable — Custom disclaimer text - `companyName` string, nullable — Company name - `companyLogoUrl` string, nullable — Company logo URL - `statementYear` integer, nullable — Statement year - `minStatementYear` integer, nullable — Minimum selectable statement year ## Other responses - `400` — Invalid request (e.g. employee has no current compensation or invalid schedule type). - `403` — The authenticated caller lacks permission to view this employee's Total Rewards statement. - `500` — Unexpected server error. --- [API](https://skmtc.net/bamboohr/apis/bamboohr-api.md) · [All operations](https://skmtc.net/bamboohr/apis/bamboohr-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bamboohr/bamboohr-api/versions/19ebf391a399/schema)