---
title: "Get employee pay statement summary data for the specified year."
method: GET
path: "/v2/companies/{companyId}/employees/{employeeId}/paystatement/summary/{year}"
tags: ["PayStatements"]
---

# Get employee pay statement summary data for the specified year.

`GET /v2/companies/{companyId}/employees/{employeeId}/paystatement/summary/{year}`

## Request

- Base URL: `https://api.paylocity.com/api`
- URL: `https://api.paylocity.com/api/v2/companies/{companyId}/employees/{employeeId}/paystatement/summary/{year}`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://api.paylocity.com/IdentityServer/connect/token` scopes: `WebLinkAPI`

Get pay statement summary API will return employee pay statement summary data currently available in Web Pay for the specified year.

## Path parameters

- `companyId` string, required
- `employeeId` string, required
- `year` string, required

## Query parameters

- `pagesize` integer
- `pagenumber` integer
- `includetotalcount` boolean

## Response `200`

Successfully Retrieved

- PayStatementSummary[]
  - `autoPay` boolean: .<br />
  - `beginDate` string, paylocity-date, nullable: .<br />
  - `checkDate` string, paylocity-date, nullable: .<br />
  - `checkNumber` integer: .<br />
  - `directDepositAmount` number, nullable: .<br />
  - `endDate` string, paylocity-date, nullable: .<br />
  - `grossPay` number, nullable: .<br />
  - `hours` number, nullable: .<br />
  - `netCheck` number, nullable: .<br />
  - `netPay` number, nullable: .<br />
  - `overtimeDollars` number, nullable: .<br />
  - `overtimeHours` number, nullable: .<br />
  - `process` integer: .<br />
  - `regularDollars` number, nullable: .<br />
  - `regularHours` number, nullable: .<br />
  - `transactionNumber` integer: <br />
  - `voucherNumber` integer: .<br />
  - `workersCompCode` string, nullable: .<br />
  - `year` integer: .<br />

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `404`: The employee, specified year, or check date does not exist
- `429`: Too Many Requests
- `500`: Internal Server Error

## Changes

- **2026-10-25** `4e4bf910efae`: 1 warning
  - deleted the `query` request parameter `codegroup`
- **2026-02-08** `e857a8d2bfad`: 1 info
  - added the new optional `query` request parameter `codegroup`

[Operation history](https://skmtc.dev/paylocity/apis/paylocity-api/changes/v2/companies/:companyId/employees/:employeeId/paystatement/summary/:year/get.md)

---

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