v1

latestOpenAPI 3.0.02026-07-14800227.2 KB

Employees

Update the financial section for a given employee id.

This endpoint updates the employee financial section for a given employee id. The operation only updates the fields provided in the body. Custom fields information can be provided in this operation. The API name of the custom field is required and the data format has to match with the type defined for the custom field in Kenjo. API names start with 'c_' and the rest is composed by the trimmed name (spaces are removed). Example: The custom field 'special tax' belongs to the 'financial' section:

{
  ...,
  "iban": "ES2345123456789077",
  "c_specialtax": 1500,
  ...
}

'special tax' is a field type 'Number'. It means that if a different type of data (string or boolean) is provided then the request will return an error.

put/employees/{employeeId}/financials

Path parameters

employeeIdstring required

Example:60a2db290da29e126a18789a

The _id of the employee to update.

Headers

Authorizationstring required

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

A valid bearer token.

Request body

accountHolderNamestring

The accounts holder's name.

bankNamestring

The bank name.

accountNumberstring

The account number.

ibanstring

The IBAN.

swiftCodestring

The SWIFT code.

nationalIdstring

The national id document.

passportstring

The passport number.

nationalInsuranceNumberstring

The national insurance number

taxCodestring

The tax number.

taxIdentificationNumberstring

The tax identification number.

Example request

{
  "accountHolderName": "Michael Corleone",
  "bankName": "Bank of Sicily",
  "accountNumber": "0093 344 2132221 3304 00",
  "iban": "DE32120222391919191911",
  "swiftCode": "12321234",
  "nationalId": "04123547X",
  "passport": "FA1234098",
  "nationalInsuranceNumber": "23123312321",
  "taxCode": "323451R",
  "taxIdentificationNumber": "T4312345"
}

Response

_idstring

The employee Kenjo _id.