---
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://dc1demogw.paylocity.com/api`
- URL: `https://dc1demogw.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 Paylocity Payroll/HR solution 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: Auto pay
  - `beginDate` string, paylocity-date: Begin date
  - `checkDate` string, paylocity-date: Check date
  - `checkNumber` integer: Check number
  - `directDepositAmount` number: Direct deposit amount
  - `endDate` string, paylocity-date: End date
  - `grossPay` number: Gross pay
  - `hours` number: Hours
  - `netCheck` number: Net check
  - `netPay` number: Net pay
  - `overtimeDollars` number: Overtime dollars
  - `overtimeHours` number: Overtime hours
  - `process` integer: Process
  - `regularDollars` number: Regular dollars
  - `regularHours` number: Regular hours
  - `transactionNumber` number: Transaction number
  - `voucherNumber` integer: Voucher number
  - `workersCompCode` string: Workers comp code
  - `year` integer: Year

## 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

---

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