Get employee pay statement summary data for the specified year.

get https://apisandbox.paylocity.com/api/v2/companies/{companyId}/employees/{employeeId}/paystatement/summary/{year}

Get pay statement summary API will return employee pay statement summary data currently available in Paylocity Payroll/HR solution for the specified year.

Path Params

companyId

string

required

The Paylocity Company Identifier. This is the unique value provided by Paylocity to each specific Payroll Entity.
Allowable Values:
9 char max

employeeId

string

required

The Paylocity Employee ID. This is a unique value per Paylocity Company ID.
Allowable Values:
10 char max

year

string

required

The year for which to retrieve pay statement data

Query Params

pagesize

integer

Number of records per page. Default value is 25.

pagenumber

integer

Page number to retrieve; page numbers are 0-based (so to get the first page of results, pass pagenumber=0). Default value is 0.

includetotalcount

boolean

Whether to include the total record count in the header's X-Pcty-Total-Count property. Default value is true.

codegroup

string

Retrieve pay statement details related to specific deduction, earning or tax types. Common values include 401k, Memo, Reg, OT, Cash Tips, FED and SITW.

Responses

401

Unauthorized

403

Forbidden

429

Too Many Requests

Language

Credentials

OAuth2


xxxxxxxxxx
1
curl --request GET \
2
     --url https://apisandbox.paylocity.com/api/v2/companies/companyId/employees/employeeId/paystatement/summary/year \
3
     --header 'accept: application/json'


xxxxxxxxxx
23
 
1
[
2
  {
3
    "autoPay": true,
4
    "beginDate": "string",
5
    "checkDate": "string",
6
    "checkNumber": 0,
7
    "directDepositAmount": 0,
8
    "endDate": "string",
9
    "grossPay": 0,
10
    "hours": 0,
11
    "netCheck": 0,
12
    "netPay": 0,
13
    "overtimeDollars": 0,
14
    "overtimeHours": 0,
15
    "process": 0,
16
    "regularDollars": 0,
17
    "regularHours": 0,
18
    "transactionNumber": 0,
19
    "voucherNumber": 0,
20
    "workersCompCode": "string",
21
    "year": 0
22
  }
23
]

200Successfully Retrieved

404The employee, specified year, or check date does not exist

500Internal Server Error