v1

latestOpenAPI 3.0.02026-07-14800227.2 KB

Compensation

Return a list of salaries.

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

get/compensation/salaries

Query parameters

_userIdstring

Example:60a2db290da29e126a18789b

Optional filter. This field allows you to retrieve contracts based on their _userId. It can accept two formats: 1. A single _userId as a unique string. Example: _userId=80a2db290da29e126a18789c 2. Multiple _userId values separated by commas (up to a maximum of 15 values). Example: _userId=80a2db290da29e126a18789c,80a2db290da29e126a18789b,80a2db290da29e126a187891. These options provide flexibility in filtering contracts by their type, making it easier to retrieve the specific data you need.

_companyIdstring

Example:90a2db290da29e126a187891

Optional filter. This field allows you to retrieve contracts based on their _companyId. It can accept two formats: 1. A single _companyId as a unique string. Example: _companyId=80a2db290da29e126a18789c 2. Multiple _companyId values separated by commas (up to a maximum of 15 values). Example: _companyId=80a2db290da29e126a18789c,80a2db290da29e126a18789b,80a2db290da29e126a187891. These options provide flexibility in filtering contracts by their type, making it easier to retrieve the specific data you need.

paymentPeriod'Annual' | 'Monthly' | 'Hourly'

Example:Annual

Optional filter. This field allows you to retrieve contracts based on their paymentPeriod. Accepted values: 'Annual', 'Monthly' and 'Hourly'. It can accept two formats: 1. A single paymentPeriod as a unique string. Example: paymentPeriod=Annual 2. Multiple paymentPeriod values separated by commas (up to a maximum of 15 values). Example: paymentPeriod=Annual,Monthly. These options provide flexibility in filtering contracts by their type, making it easier to retrieve the specific data you need.

currencystring

Example:EUR

Optional filter. This field allows you to retrieve contracts based on their currency (ISO 4217). It can accept two formats: 1. A single currency as a unique string. Example: currency=EUR 2. Multiple currency values separated by commas (up to a maximum of 15 values). Example: currency=EUR,USD. These options provide flexibility in filtering contracts by their type, making it easier to retrieve the specific data you need.

offsetnumber

Example:1

Optional filter for pagination proposals. Determines the number of pages to skip when pagination is being used. If this value is not provided, by default the offset will be 1.

limitnumber

Example:25

Optional filter for pagination proposals. The maximum number of rows to retrieve which determines the size of the page. If this value is not provided then the limit will be 50 users. The maximum value of the limit is 100 users per page. Only are valid the following limit values: 25, 50 and 100.

Headers

Authorizationstring required

Example:Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJodHRwczovL2FwaS5rZW5qby5pbyIsInN1YiI6IjYwZjBhOTE2MjE0OTg3MjU2YmU5YzhmZiIsImF1ZCI6Imh0dHBzOi8vYXBpLmtlbmpvLmlvIiwiaWF0IjoxNjI2Mzg1MTE1LCJuYmYiOjE2MjYzODUxMTUsImV4cCI6MTYyNjU1NzkxNSwiYWNjZXNzVHlwZSI6IkFwaUFjY2VzcyIsInNfb3JnSWQiOiI2MGYwNGVhN2RmN2JhMjFlY2U0YmYzYzIifQ.cxG_7dIS-VbmDXdJuLkekoyuyCIzQG2fMcgc0nkfbWE8cihhcb5FnALbQkjU9b5-qVcEoMHZlSuUA-jMEBMMVQ

A valid bearer token.

Response

OK.

Example response

{
  "data": [
    {
      "_id": "60a2db290da29e126a18789a",
      "_userId": "80a2db290da29e126a18789b",
      "_companyId": "80a2db290da29e126a187809",
      "startDate": "2014-01-01T00:00:00",
      "endDate": "2024-05-10T00:00:00",
      "amount": 30000,
      "paymentPeriod": "Annual",
      "current": "EUR",
      "contractTypeId": "80a2db290da29e126a187878"
    },
    {
      "_id": "60a2db290da29e126a18789b",
      "_userId": "80a2db290da29e126a187891",
      "_companyId": "80a2db290da29e126a187809",
      "startDate": "2010-01-10T00:00:00",
      "amount": 4000,
      "paymentPeriod": "Monthly",
      "current": "USD",
      "contractTypeId": "80a2db290da29e126a18787a"
    }
  ],
  "metadata": {
    "count": 2,
    "offset": 1,
    "limit": 50,
    "total": 2
  }
}