v1

latestOpenAPI 3.0.02026-07-14800227.2 KB

Employees

Return a list of employee financials.

This endpoint returns a list with the financial sections of the existing employees. Additionally, custom fields from this section will also be included.

get/employees/financials

Query parameters

accountHolderNamestring

Example:Michael Corleone

The accounts holder's name.

bankNamestring

Example:Bank of Sicily

The bank name.

accountNumberstring

Example:0093 344 2132221 3304 00

The account number.

ibanstring

Example:DE32120222391919191911

The IBAN.

swiftCodestring

Example:12321234

The SWIFT code.

nationalIdstring

Example:04123547X

The national id document

passportstring

Example:FA1234098

The passport number.

nationalInsuranceNumberstring

Example:23123312321

The national insurance number.

taxCodestring

Example:323451R

The tax number.

taxIdentificationNumberstring

Example:T4312345

The tax identification number.

Headers

Authorizationstring required

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

A valid bearer token.

Response

Example response

{
  "data": [
    {
      "_id": "80a2db290da29e126a18789a",
      "accountHolderName": "Michael Corleone",
      "bankName": "Bank of Sicily",
      "accountNumber": "0093 344 2132221 3304 00",
      "iban": "DE32120222391919191911",
      "swiftCode": "12321234",
      "nationalId": "12123547R",
      "passport": "MK1234098",
      "nationalInsuranceNumber": "23123312321",
      "taxCode": "323451R",
      "taxIdentificationNumber": "T4312345"
    },
    {
      "_id": "80a2db290da29e126a187894",
      "accountHolderName": "Tony Soprano",
      "bankName": "Bank of New Jersey",
      "accountNumber": "0093 344 3212121 3304 00",
      "iban": "IT32120222391919191911",
      "swiftCode": "3212235",
      "nationalId": "09123547J",
      "passport": "TQ1234098",
      "nationalInsuranceNumber": "23123312321",
      "taxCode": "453251R",
      "taxIdentificationNumber": "J4312345"
    },
    {
      "_id": "80a2db290da29e126a187892",
      "accountHolderName": "Donnie Brasco",
      "bankName": "Bank of Chicago",
      "accountNumber": "0093 344 12312312 3304 00",
      "iban": "ES32120222391919191911",
      "swiftCode": "12312567",
      "nationalId": "04123547X",
      "passport": "FA1234098",
      "nationalInsuranceNumber": "23123312321",
      "taxCode": "543251R",
      "taxIdentificationNumber": "F4312345"
    }
  ]
}