---
title: "Get Employee Component Claims"
method: GET
path: "/payroll/employees/componentclaims"
tags: ["EmployeeComponentClaims"]
---

# Get Employee Component Claims

`GET /payroll/employees/componentclaims`

Retrieves component claims for a specific employee with optional filtering by financial year, claim status, and last modified date. Supports pagination for large result sets.

## Query parameters

- `EmployeeId` string
- `FinancialYear` integer
- `ClaimStatus` integer
- `LastModified` string, date-time
- `IncludePastClaims` boolean
- `IncludePendingClaims` boolean
- `pageNumber` integer
- `pageSize` integer

## Response `200`

OK

- APIEmployeeComponentClaimsResponsePagedResponse — 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` KekaAPIModelPayrollAPIEmployeeComponentClaimsResponse[], nullable — Gets or sets the data.
    - `id` string, nullable
    - `employeeNumber` string, nullable
    - `fullName` string, nullable
    - `email` string, nullable
    - `financialYear` string, nullable
    - `payrollDetails` KekaAPIModelPayrollAPIEmployeePayrollDetails
      - `payGroupId` string, nullable
      - `payGroupName` string, nullable
      - `currency` KekaAPIModelPayrollAPICurrencyInfo
        - `id` integer
        - `code` string, nullable
        - `precision` integer
    - `componentClaims` KekaAPIModelPayrollAPIEmployeeComponentClaimDetails[], nullable
      - `id` string, nullable
      - `componentName` string, nullable
      - `componentType` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 20 | 21 | 22 | 50
      - `lastModified` string, date-time, nullable
      - `note` string, nullable
      - `claimStatus` 0 | 1 | 2 | 3
      - `amounts` KekaAPIModelPayrollAPIComponentClaimAmounts
        - `totalClaimableAmount` number, double
        - `totalAccruedAmount` number, double
        - `currentClaimAmount` number, double
        - `totalClaimedAmount` number, double
        - `currentBalanceAmount` number, double
      - `paymentDetails` KekaAPIModelPayrollAPIComponentClaimPaymentDetails
        - `claimPaymentStatus` 0 | 1 | 2
        - `paidOn` string, date-time, nullable
        - `payDate` string, date-time, nullable
        - `payableAmount` number, double
        - `paidAmount` number, double
        - `processedCycleId` string, nullable
        - `comment` 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

- `400` — Bad Request
- `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)