--- title: "Get Pay Statements by Employee and Date Range" method: GET path: "/apiHub/payroll/v1/companies/{companyId}/employees/{employeeId}/payStatements" tags: ["Pay Statements"] --- # Get Pay Statements by Employee and Date Range `GET /apiHub/payroll/v1/companies/{companyId}/employees/{employeeId}/payStatements` ## Request - Base URL: `https://dc1demogwext.paylocity.com` - URL: `https://dc1demogwext.paylocity.com/apiHub/payroll/v1/companies/{companyId}/employees/{employeeId}/payStatements` - Auth: HTTP bearer > 🚧 Partner Restricted > > This endpoint is only available to approved partners who have signed a Paylocity Technology Partnership Agreement. If you are not yet a partner and are interested, [please reach out to our team](https://www.paylocity.com/contact/partner-form/) to discuss partnership opportunities. **Summary Description** Retrieves all pay statements for the specified employee within the given date range. ## Path parameters - `companyId` string, required - `employeeId` string, required ## Query parameters - `rangeStart` string - `rangeEnd` string - `includeTotalCount` boolean - `limit` integer - `offset` integer - `fields` string - `filter` string - `agencyCheckProcessId` integer ## Headers - `testMode` boolean - `Authorization` string, required ## Response `200` OK - PayStatementV1Response[] - `payStatementId` string, uuid, nullable: Unique identifier of the pay statement. Format: GUID. - `payStatementDate` PayStatementDateDto: Dates associated with a pay statement. - `checkDate` string, date-time, nullable: Date the check was issued. Format: yyyy-MM-dd. - `processId` integer, nullable: Internal process identifier for this pay statement. - `periodBeginDate` string, date-time, nullable: Start date of the pay period. Format: yyyy-MM-dd. - `periodEndDate` string, date-time, nullable: End date of the pay period. Format: yyyy-MM-dd. - `checkType` string, nullable: Type of check issued (e.g., DirectDeposit, Live). Optional. Max length 50. - `payScheduleId` string, uuid, nullable: Pay Schedule ID that was used Optional. Omit if null. - `isDownloadable` boolean, nullable: Indicates if the pay statement is downloadable. - `totals` TotalsDto: Aggregated totals for a pay statement. - `regularHours` number, double, nullable: Total regular hours worked. - `overtimeHours` number, double, nullable: Total overtime hours worked. - `otherHours` number, double, nullable: Total other hours (e.g., paid time off). - `totalHours` number, double, nullable: Sum of all hours. - `employeeTaxes` number, double, nullable: Total employee tax dollars. - `employerTaxes` number, double, nullable: Total employer tax dollars. - `deductions` number, double, nullable: Total deduction dollars. - `benefits` number, double, nullable: Total benefit dollars. - `regularPay` number, double, nullable: Total dollars for regular pay. - `overtimePay` number, double, nullable: Total dollars for overtime pay. - `otherPay` number, double, nullable: Total dollars for other pay types. - `grossPay` number, double, nullable: Total gross pay dollars. - `takeHomePay` number, double, nullable: Net pay amount (take-home). - `directDeposit` number, double, nullable: Amount paid via direct deposit. - `netCheck` number, double, nullable: Amount paid via check(s). - `checkNumber` integer, nullable: Check number associated with this pay statement. - `voucherNumber` integer, nullable: Voucher number for direct deposit. - `retirementMatchEligibleCompensation` number, double, nullable: Amount of compensation eligible for retirement match. - `directDeposits` DirectDepositDto[], nullable: Breakdown of direct deposit allocations for this pay statement. Required. Array. - `bankName` string, nullable: Name of the bank receiving the deposit. Optional. Max length 100. - `accountNumberLastFour` string, nullable: Last four digits of the bank account number. Optional. Exactly 4 digits. - `amount` number, double, nullable: Amount deposited into the bank account. - `ytd` number, double, nullable: Year-to-date total deposited into this account. - `earnings` EarningDto[], nullable: Detailed earnings lines for this pay statement (e.g., regular, overtime, memo earnings). Required. Array. - `code` string, nullable: Earn code identifier. Optional. Max length 50. - `description` string, nullable: Description of the earn code. Optional. Max length 200. - `type` string, nullable: Type of earning (e.g., Regular, Overtime). Optional. Max length 50. - `hours` number, double, nullable: Hours for this earn code. - `rate` number, double, nullable: Rate applied to these hours. - `amount` number, double, nullable: Dollar amount for this earn line. - `ytdHours` number, double, nullable: Year-to-date hours for this earn code. - `ytd` number, double, nullable: Year-to-date dollars for this earn code. - `isMemo` boolean, nullable: Indicates if this earning is a memo entry. - `employeeTaxes` EmployeeTaxDto[], nullable: Employee tax line items for this pay statement. Required. Array. - `code` string, nullable: Tax code identifier. Optional. Max length 50. - `description` string, nullable: Description of the tax code. Optional. Max length 200. - `taxableWages` number, double, nullable: Taxable wages for this code. - `cappedTaxableWages` number, double, nullable: Wages capped at wage base limit. - `amount` number, double, nullable: Tax amount for this code. - `ytd` number, double, nullable: Year-to-date tax amount. - `taxForm` string, nullable: Tax form associated with this tax item. Optional. Omit if null. - `employerTaxes` EmployerTaxDto[], nullable: Employer tax line items for this pay statement. Required. Array. - `code` string, nullable: Tax code identifier. Optional. Max length 50. - `description` string, nullable: Description of the tax code. Optional. Max length 200. - `taxableWages` number, double, nullable: Taxable wages for this code. - `amount` number, double, nullable: Tax amount for this code. - `ytd` number, double, nullable: Year-to-date tax amount. - `deductions` DeductionDto[], nullable: Deduction line items for this pay statement. Required. Array. - `code` string, nullable: Deduction code identifier. Optional. Max length 50. - `description` string, nullable: Description of the deduction. Optional. Max length 200. - `type` string, nullable: Type of deduction (e.g., PreTax, PostTax). Optional. Max length 50. - `amount` number, double, nullable: Dollar amount deducted. - `ytd` number, double, nullable: Year-to-date deduction amount. - `isMemo` boolean, nullable: Indicates if this deduction is a memo entry. ## Other responses - `400`: Bad Request - `401`: Unauthorized --- [API](https://skmtc.dev/paylocity/apis/pay-details-api.md) - [All operations](https://skmtc.dev/paylocity/apis/pay-details-api/llms.txt) - [OpenAPI document](https://skmtc.dev/paylocity/apis/pay-details-api/revisions/8cbe85265888?raw)