---
title: "Get Pay Register"
method: GET
path: "/payroll/paygroups/paycycles/payregister"
tags: ["PayCycles"]
---

# Get Pay Register

`GET /payroll/paygroups/paycycles/payregister`

## Query parameters

- `payGroupId` string, uuid
- `payCycleId` string, uuid
- `employeeIds` string
- `includeOutSideCTCPayables` boolean
- `pageNumber` integer
- `pageSize` integer

## Response `200`

OK

- APIPayRegisterViewPagedResponse — class represents paged response.
  - `succeeded` boolean — Gets or sets a value indicating whether this Keka.API.Web.Core.Response`1 is succeeded.
  - `message` string, nullable — Gets or sets the message.
  - `errors` string[], nullable — Gets or sets the errors.
  - `data` KekaAPIModelPayrollAPIPayRegisterView[], nullable — Gets or sets the data.
    - `identifier` string, nullable
    - `employeeNumber` string, nullable
    - `employeeName` string, nullable
    - `panNumber` string, nullable
    - `bankName` string, nullable
    - `accountNumber` string, nullable
    - `ifscCode` string, nullable
    - `dateJoined` string, date-time, nullable
    - `jobTitle` string, nullable
    - `department` string, nullable
    - `location` string, nullable
    - `payGroup` string, nullable
    - `employmentStatus` 0 | 1
    - `workerType` 0 | 1 | 2
    - `costCenter` string, nullable
    - `businessUnit` string, nullable
    - `remunerationType` 0 | 1 | 2 | 3 | 4
    - `gender` 0 | 1 | 2 | 3
    - `dateOfBirth` string, date-time, nullable
    - `exitDate` string, date-time, nullable
    - `cycleIdentifier` string, nullable
    - `cycleFrom` string, date-time
    - `cycleTo` string, date-time
    - `cycleMonthName` string, nullable
    - `cycleMonth` integer
    - `cycleYear` integer
    - `cyclePayDays` number, double
    - `workingDays` number, double
    - `lossOfPayDays` number, double
    - `noOfPayDays` number, double
    - `renumerationAmount` number, double, nullable
    - `status` 0 | 1 | 3 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 50
    - `statusDescription` string, nullable
    - `earnings` KekaAPIModelPayrollPayItemView[], nullable
      - `id` string, uuid
      - `componentIdentifier` string, nullable
      - `componentTitle` string, nullable
      - `amount` number, double
      - `accountingCode` string, nullable
    - `contributions` KekaAPIModelPayrollPayItemView[], nullable
      - `id` string, uuid
      - `componentIdentifier` string, nullable
      - `componentTitle` string, nullable
      - `amount` number, double
      - `accountingCode` string, nullable
    - `deductions` KekaAPIModelPayrollPayItemView[], nullable
      - `id` string, uuid
      - `componentIdentifier` string, nullable
      - `componentTitle` string, nullable
      - `amount` number, double
      - `accountingCode` string, nullable
    - `reimbursements` KekaAPIModelPayrollPayItemView[], nullable
      - `id` string, uuid
      - `componentIdentifier` string, nullable
      - `componentTitle` string, nullable
      - `amount` number, double
      - `accountingCode` string, nullable
    - `outsideGrossPayables` KekaAPIModelPayrollPayItemView[], nullable
      - `id` string, uuid
      - `componentIdentifier` string, nullable
      - `componentTitle` string, nullable
      - `amount` number, double
      - `accountingCode` string, nullable
    - `outsideCTCPayables` KekaAPIModelPayrollPayItemView[], nullable
      - `id` string, uuid
      - `componentIdentifier` string, nullable
      - `componentTitle` string, nullable
      - `amount` number, double
      - `accountingCode` string, nullable
    - `grossAmount` number, double
    - `totalOutsideGrossAmount` number, double
    - `total` number, double
    - `totalContributions` number, double
    - `totalDeductions` number, double
    - `totalReimbursements` number, double
    - `cashAdvanceAmount` number, double
    - `cashAdvanceSettlementAmount` number, double
    - `netAmount` number, double
    - `currencyCode` string, nullable
  - `pageNumber` integer — Gets or sets the page number.
  - `pageSize` integer — Gets or sets the size of the page.
  - `firstPage` string, uri, nullable — Gets or sets the first page.
  - `lastPage` string, uri, nullable — Gets or sets the last page.
  - `totalPages` integer — Gets or sets the total pages.
  - `totalRecords` integer — Gets or sets the total records.
  - `nextPage` string, uri, nullable — Gets or sets the next page.
  - `previousPage` string, uri, nullable — Gets or sets the previous page.

## Other responses

- `401` — Unauthorized
- `403` — Forbidden

---

[API](https://skmtc.net/keka/apis/keka-api.md) · [All operations](https://skmtc.net/keka/apis/keka-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/keka/keka-api/revisions/907ea395c885/schema)