---
updatedAt: 2026-04-27T15:52:51.000Z
agentTools:
  siteIndex: https://developer.paylocity.com/llms.txt
  projectIndex: https://developer.paylocity.com/integrations/llms.txt
---

# Get Employee Pay Statement Details Data for the Specified Year and Check Date

Get pay statement details API will return employee pay statement detail data currently available in Paylocity Payroll/HR solution for the specified year and check date.

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "WebLink API",
    "description": "For documentation about this API, please visit https://developer.paylocity.com/integrations/reference/weblink-overview",
    "contact": {
      "email": "webservices@paylocity.com"
    },
    "version": "v2"
  },
  "servers": [
    {
      "url": "https://dc1demogw.paylocity.com/api"
    }
  ],
  "paths": {
    "/v2/companies/{companyId}/employees/{employeeId}/paystatement/details/{year}/{checkDate}": {
      "get": {
        "tags": [
          "PayStatements"
        ],
        "summary": "Get Employee Pay Statement Details Data for the Specified Year and Check Date",
        "description": "Get pay statement details API will return employee pay statement detail data currently available in Paylocity Payroll/HR solution for the specified year and check date.",
        "x-explorer-enabled": false,
        "operationId": "Gets employee pay statement detail data based on the specified year and check date",
        "parameters": [
          {
            "name": "companyId",
            "in": "path",
            "description": "The Paylocity Company Identifier. This is the unique value provided by Paylocity to each specific Payroll Entity.\r\n                **Allowable Values:**\r\n                9 char max",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "employeeId",
            "in": "path",
            "description": "The Paylocity Employee ID. This is a unique value per Paylocity Company ID.\r\n**Allowable Values:**\r\n10 char max",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "year",
            "in": "path",
            "description": "The year for which to retrieve pay statement data",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "checkDate",
            "in": "path",
            "description": "The check date for which to retrieve pay statement data",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "pagesize",
            "in": "query",
            "description": "Number of records per page. Default value is 25.",
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "pagenumber",
            "in": "query",
            "description": "Page number to retrieve; page numbers are 0-based (so to get the first page of results, pass pagenumber=0). Default value is 0.",
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "includetotalcount",
            "in": "query",
            "description": "Whether to include the total record count in the header's X-Pcty-Total-Count property. Default value is true.",
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "codegroup",
            "in": "query",
            "description": "Retrieve pay statement details related to specific deduction, earning or tax types. Common values include 401k, Memo, Reg, OT, Cash Tips, FED and SITW.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successfully Retrieved",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/payStatementDetails"
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {}
          },
          "403": {
            "description": "Forbidden",
            "content": {}
          },
          "404": {
            "description": "The employee, specified year, or check date does not exist",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/error"
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too Many Requests",
            "content": {}
          },
          "500": {
            "description": "Internal Server Error",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/error"
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "paylocity_auth": [
              "WebLinkAPI"
            ]
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "error": {
        "type": "object",
        "properties": {
          "field": {
            "type": "string",
            "description": "The name of the field, or property in the request message that contains an error."
          },
          "message": {
            "type": "string",
            "description": "The error message."
          },
          "options": {
            "type": "array",
            "description": "A list of options associated with this error. These options may indicate valid values for the field, or property that contains an error.",
            "items": {
              "type": "object",
              "properties": {
                "code": {
                  "type": "string",
                  "description": "The code associated with this option."
                },
                "description": {
                  "type": "string",
                  "description": "The description of the option."
                }
              },
              "description": "The error option model"
            }
          },
          "path": {
            "type": "string",
            "description": "The JSON path of the field, or property, that contains an error in the request message."
          }
        },
        "description": "The error model"
      },
      "payStatementDetails": {
        "type": "object",
        "properties": {
          "amount": {
            "type": "number",
            "description": "Amount"
          },
          "checkDate": {
            "type": "string",
            "description": "Check date",
            "format": "paylocity-date"
          },
          "det": {
            "type": "string",
            "description": "Det"
          },
          "detCode": {
            "type": "string",
            "description": "Det code"
          },
          "detType": {
            "type": "string",
            "description": "Det type"
          },
          "eligibleCompensation": {
            "type": "number",
            "description": "Eligible compensation"
          },
          "hours": {
            "type": "number",
            "description": "Hours"
          },
          "rate": {
            "type": "number",
            "description": "Rate"
          },
          "transactionNumber": {
            "type": "number",
            "description": "Transaction number"
          },
          "transactionType": {
            "type": "string",
            "description": "Transaction type"
          },
          "year": {
            "type": "integer",
            "description": "Year"
          }
        },
        "additionalProperties": false,
        "description": "The pay statement details model"
      }
    },
    "securitySchemes": {
      "paylocity_auth": {
        "type": "oauth2",
        "flows": {
          "clientCredentials": {
            "tokenUrl": "https://api.paylocity.com/IdentityServer/connect/token",
            "scopes": {
              "WebLinkAPI": "Web Link Api"
            }
          }
        }
      }
    }
  },
  "x-original-swagger-version": "2.0"
}
```