Skip to main content
GET
/
cloud-gateway
/
v1
/
payrollContract
/
{contractId}
/
salaries
/
history
cURL
curl --request GET \
  --url http://localhost:8080/cloud-gateway/v1/payrollContract/{contractId}/salaries/history
[
  {
    "payrollContractId": "<string>",
    "year": 123,
    "month": 6,
    "totalSalary": 123,
    "baseSalary": 123,
    "values": [
      {
        "compensationComponentId": "<string>",
        "value": 123
      }
    ]
  }
]
Contract ids are used to identify individuals in the payroll system. One person can have multiple payroll contracts, e.g. if they have multiple jobs or roles in the organization.
In the past, payroll contracts were identified using a combination of the company and employee number. Currently, the ids are in the form ‘companyId-employeeNumber’. You can use this information if you already have it, but it may not be stable in the future.

Path Parameters

contractId
string
required

Query Parameters

from
string<date>
required
to
string<date>
required

Response

200 - */*

OK

payrollContractId
string

Identifier of the payroll contract this salary history entry belongs to

year
integer<int32>
month
integer<int32>

Month of the year, 1 for January, 2 for February, etc.

Required range: 1 <= x <= 12
totalSalary
number<double>
baseSalary
number<double>
values
object[]