---
title: "Return a list of additional payments."
method: GET
path: "/compensation/additional-payments"
tags: ["Compensation"]
---

# Return a list of additional payments.

`GET /compensation/additional-payments`

This endpoint returns a paginated list of additional payments. The URL params help to return more accurate results.

## Query parameters

- `_userId` string
- `_companyId` string
- `currency` string
- `offset` number
- `limit` number

## Headers

- `Authorization` string, required

## Response `200`

OK.

- object
  - `data` object[]
    - `_id` string — The Kenjo _id of the returned additional payment.
    - `_userId` string — The employee id associated to the additional payment.
    - `_companyId` string — The company id associated to the additional payment.
    - `effectiveDate` string — The effective date of the additional payment in format YYYY-MM-DDThh:mm:ss.
    - `endDate` string — The end date of the additional payment in format YYYY-MM-DDThh:mm:ss. Omitted when the additional payment has no end date.
    - `additionalPaymentTypeId` string — The id of the addional payment type in format YYYY-MM-DDThh:mm:ss.
    - `amount` number — The the amount of money associated to the additional payment.
    - `currency` number — This currency in ISO 4217.
  - `metadata` object
    - `count` number — The number of rows retrieved according the pagination filters (limit + offset).
    - `offset` number — The number of pages to skip. Determines the page number when pagination is being used.
    - `limit` number — The maximum number of rows to retrieve. Determines the size of the page when pagination is being used.
    - `total` number — The total number of rows existing for the provided filters.

## Other responses

- `400` — BAD REQUEST. This is a wrong request in the client side due to invalid body or params.
- `401` — UNAUTHORIZED. The Authorization header is incorrect, not provided or the token expired.

---

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