API a3innuva Nómina

https://wke-cms.apimarket.io/library-apis
Admin
API a3innuva Nómina is a comprehensive RESTful API for managing payroll operations, employee...
Tokens:76,875
Snippets:305
Trust Score:4.5
Update:6 months ago
Show doc for...
Tokens:
Raw
### Get employee address example

Source: https://wke-cms.apimarket.io/library-apis/5

Example request path for retrieving employee address information.

```http
GET /api/companies/258/employees/000029/address/
```

--------------------------------

### List employees request example

Source: https://wke-cms.apimarket.io/library-apis/5

Example request path and filter parameters for listing employees.

```json
GET /api/companies/258/employees<br />
{<br />
   "filter": "workplaceCode eq 1 and (dropDate eq null or dropDate ge 2001-02-28)",<br />
   "orderBy": "employeeCode asc"<br />
   "pageNumber": 1,
```

--------------------------------

### List Employee Variable Concepts

Source: https://wke-cms.apimarket.io/library-apis/5

Example of a GET request to retrieve variable concepts within a specific date range.

```http
GET /api/companies/258/employees/000049/variableconcepts
```

--------------------------------

### GET /api/training/centers

Source: https://wke-cms.apimarket.io/library-apis/5

Retrieves a list of all training centers.

```APIDOC
## GET /api/training/centers

### Description
List training centers. Required User Permissions: Centros de Formación.

### Method
GET

### Endpoint
/api/training/centers

### Response
#### Success Response (200)
- **TrainingCenterDigestResource** (object) - Returns training centers
```

--------------------------------

### GET /api/personalisation/maintenence-groups

Source: https://wke-cms.apimarket.io/library-apis/5

Lists maintenance groups. Requires 'Ampliación' user permissions.

```APIDOC
## GET /api/personalisation/maintenence-groups

### Description
Lists available maintenance groups.

### Method
GET

### Endpoint
/api/personalisation/maintenence-groups

### Parameters
#### Query Parameters
- **pageSize** (integer) - Optional - The number of items to return per page.
- **pageNumber** (integer) - Optional - The page number to retrieve.
- **api-version** (string) - Required - The version of the API.

### Response
#### Success Response (200)
- Returns a list of maintenance groups.

#### Response Example
```json
[
  {
    "MaintenanceGroupModel": "example group"
  }
]
```

#### Error Responses
- **400**: Invalid input parameters.
- **500**: Internal server error.
```

--------------------------------

### GET /api/training/groups/{year}

Source: https://wke-cms.apimarket.io/library-apis/5

Lists training groups for a specific year.

```APIDOC
## GET /api/training/groups/{year}

### Description
List training groups by year.

### Method
GET

### Endpoint
/api/training/groups/{year}

### Parameters
#### Path Parameters
- **year** (integer) - Required - year

### Response
#### Success Response (200)
- **TrainingGroupForYear** (object) - Returns training centers
```

--------------------------------

### Create Employee Variable Concept

Source: https://wke-cms.apimarket.io/library-apis/5

Example of a POST request to create a new variable concept for an employee.

```json
POST /api/companies/258/employees/000049/variableconcept
{
   "inputData": "
     {
         "conceptCode": 1,
         "startDate": "2019-04-01T10:00:00.000Z",
         "endDate": "2019-04-01T10:00:00.000Z",
         "collectionDate": "2019-04-01T10:00:00.000Z",
         "payTypeId": 1,
         "amount": 5,
         "units": 1, 
         "prorateInPaySections": "false", 
         "attribution": "030101", 
         "enrolmentDropProrate": "false" 
     }"
}
```

--------------------------------

### GET /api/jobTitlesDescription

Source: https://wke-cms.apimarket.io/library-apis/5

Retrieves a list of job title descriptions. Supports pagination.

```APIDOC
## GET /api/jobTitlesDescription

### Description
Retrieves a list of job title descriptions. Supports pagination.

### Method
GET

### Endpoint
/api/jobTitlesDescription

### Parameters
#### Query Parameters
- **pageNumber** (integer) - Optional - The page number to retrieve.
- **pageSize** (integer) - Optional - The number of items per page.
- **api-version** (string) - Required - The version of the API to use.

### Response
#### Success Response (200)
- **JobTitleDescriptionItem** (array) - Returns job positions.
```

--------------------------------

### GET /api/educationlevels

Source: https://wke-cms.apimarket.io/library-apis/5

Retrieves a list of education levels.

```APIDOC
## GET /api/educationlevels

### Description
List education levels.

### Method
GET

### Endpoint
/api/educationlevels

### Response
#### Success Response (200)
- **KeyValuePairInt32String** (object) - Returns perception type codes
```

--------------------------------

### GET /api/agreements/{agreementcode}

Source: https://wke-cms.apimarket.io/library-apis/5

Retrieve details for a specific agreement.

```APIDOC
## GET /api/agreements/{agreementcode}

### Description
Get agreement details. Required User Permissions: Ficha de Convenio.

### Method
GET

### Endpoint
/api/agreements/{agreementcode}

### Parameters
#### Path Parameters
- **agreementcode** (string) - Required - Agreement code.

### Response
#### Success Response (200)
- **AgreementModel** (object) - Returns agreement details.
```

--------------------------------

### GET /api/hiringdatesdropcauses

Source: https://wke-cms.apimarket.io/library-apis/5

Retrieves a list of hiring date drop causes.

```APIDOC
## GET /api/hiringdatesdropcauses

### Description
List drop causes.

### Method
GET

### Endpoint
/api/hiringdatesdropcauses

### Response
#### Success Response (200)
- **KeyValuePairInt32String[]** (array) - Return drop causes
```

--------------------------------

### GET /api/companies/{companyCode}/agreements

Source: https://wke-cms.apimarket.io/library-apis/5

Retrieves a list of agreements for a given company.

```APIDOC
## GET /api/companies/{companyCode}/agreements

### Description
Lists of agreements for a company. Required User Permissions: Ficha de Empresa / Convenios y Pactos.

### Method
GET

### Endpoint
/api/companies/{companyCode}/agreements

### Parameters
#### Path Parameters
- **companyCode** (string) - Required - The unique code of the company.

#### Query Parameters
- **pageNumber** (integer) - Optional - The page number for pagination.
- **pageSize** (integer) - Optional - The number of items per page.
- **api-version** (string) - Required - The version of the API.

### Response
#### Success Response (200)
- **AgreementLookupResource** (array) - A list of agreements.

#### Error Response
- **400** - Invalid input parameters.
- **500** - Internal server error.
```

--------------------------------

### GET /api/companies/{companyCode}/pays/{year}/{month}

Source: https://wke-cms.apimarket.io/library-apis/5

Lists company pays for a specific year and month.

```APIDOC
## GET /api/companies/{companyCode}/pays/{year}/{month}

### Description
Lists company pays for a specific year and month. Required User Permissions: Histórico de Cobro.

### Method
GET

### Endpoint
/api/companies/{companyCode}/pays/{year}/{month}

### Parameters
#### Path Parameters
- **companyCode** (string) - Required - Company identifier
- **year** (integer) - Required - Year
- **month** (integer) - Required - Month

#### Query Parameters
- **workplaceCode** (integer) - Optional - Workplace code
- **payTypeId** (array) - Optional - List of pay type IDs

### Response
#### Success Response (200)
- **CompanyPayData** (array) - Returns company pay data
```

--------------------------------

### GET /api/companies/{companyCode}/employees/{employeeCode}/formation

Source: https://wke-cms.apimarket.io/library-apis/5

Retrieves the formation history for a specific employee.

```APIDOC
## GET /api/companies/{companyCode}/employees/{employeeCode}/formation

### Description
Retrieves the formation history for a specific employee. Requires 'Ficha de Persona / Perfil' permissions.

### Method
GET

### Endpoint
/api/companies/{companyCode}/employees/{employeeCode}/formation

### Parameters
#### Path Parameters
- **companyCode** (string) - Required - The unique code of the company.
- **employeeCode** (string) - Required - The unique code of the employee.

#### Query Parameters
- **pageSize** (integer) - Optional - Number of items per page.
- **pageNumber** (integer) - Optional - Page number to retrieve.

### Response
#### Success Response (200)
- **Array[EmployeeFormationResource]** (array) - Returns employee formation history.
```

--------------------------------

### GET /api/jobPositions

Source: https://wke-cms.apimarket.io/library-apis/5

Retrieves a list of job positions. Supports pagination.

```APIDOC
## GET /api/jobPositions

### Description
Retrieves a list of job positions. Supports pagination.

### Method
GET

### Endpoint
/api/jobPositions

### Parameters
#### Query Parameters
- **pageNumber** (integer) - Optional - The page number to retrieve.
- **pageSize** (integer) - Optional - The number of items per page.
- **api-version** (string) - Required - The version of the API to use.

### Response
#### Success Response (200)
- **JobPosition** (array) - Returns job positions.
```

--------------------------------

### POST /api/companies/{companyCode}/employees/{employeeCode}/temporarydisabilities/partialbirthpermits

Source: https://wke-cms.apimarket.io/library-apis/5

Creates an IT partial birth permit for an employee.

```APIDOC
## POST /api/companies/{companyCode}/employees/{employeeCode}/temporarydisabilities/partialbirthpermits

### Description
Creates an IT partial birth permit for an employee. Requires user permissions for IT and Absentismos.

### Method
POST

### Endpoint
/api/companies/{companyCode}/employees/{employeeCode}/temporarydisabilities/partialbirthpermits

### Parameters
#### Path Parameters
- **companyCode** (string) - Required - The company code.
- **employeeCode** (string) - Required - The employee code.

#### Query Parameters
- **api-version** (string) - Required - The API version.

#### Request Body
- **partialBirthPermitEntity** (object) - Required - The partial birth permit details.
  - *Refer to components/schemas/PartialBirthPermitPostEntity for schema details.*

### Response
#### Success Response (200)
- **partialBirthPermit** (object) - Returns the created partial birth permit.
  - *Refer to components/schemas/PartialBirthPermitGetEntity for schema details.*

#### Error Responses
- **400** - Invalid input parameters.
- **423** - Locked.
- **500** - Internal server error.
```

--------------------------------

### GET /api/identificationtypes

Source: https://wke-cms.apimarket.io/library-apis/5

Retrieves a list of identification types.

```APIDOC
## GET /api/identificationtypes

### Description
Returns a list of identification types.

### Method
GET

### Endpoint
/api/identificationtypes

### Response
#### Success Response (200)
- **IdentificationTypeResource[]** (array) - Returns list of identification types.
```

--------------------------------

### PUT /api/training/centers/{centerCode}/years/{year}/groups/{groupCode}/workplaces/{workplaceCode}/employees/{employeeCode}

Source: https://wke-cms.apimarket.io/library-apis/5

Create or update a participant in a training group.

```APIDOC
## PUT /api/training/centers/{centerCode}/years/{year}/groups/{groupCode}/workplaces/{workplaceCode}/employees/{employeeCode}

### Description
Create participant training group. Required User Permissions: Centros de Formación.

### Method
PUT

### Endpoint
/api/training/centers/{centerCode}/years/{year}/groups/{groupCode}/workplaces/{workplaceCode}/employees/{employeeCode}

### Parameters
#### Path Parameters
- **centerCode** (string) - Required - training center code
- **year** (integer) - Required - year
- **groupCode** (string) - Required - training ggroup code
- **workplaceCode** (string) - Required - workpalce code
- **employeeCode** (string) - Required - employee code

### Request Body
- **trainingGroupParticitpant** (TrainingGroupParticitpantResource) - Required - training group participant

### Response
#### Success Response (200)
- **Description** - Updates training group participant information
```

--------------------------------

### GET /api/contribution-types

Source: https://wke-cms.apimarket.io/library-apis/5

Retrieves a list of contribution types.

```APIDOC
## GET /api/contribution-types

### Description
Returns a list of contribution types.

### Method
GET

### Endpoint
/api/contribution-types

### Response
#### Success Response (200)
- **ContributionTypeResource[]** (array) - Returns list of contribution types.
```

--------------------------------

### GET /api/contracttypes

Source: https://wke-cms.apimarket.io/library-apis/5

Retrieves a list of contract types.

```APIDOC
## GET /api/contracttypes

### Description
List contract types.

### Method
GET

### Endpoint
/api/contracttypes

### Response
#### Success Response (200)
- **ContractType[]** (array) - Returns perception type codes
```

--------------------------------

### List Regimes for Company

Source: https://wke-cms.apimarket.io/library-apis/5

Retrieves a list of available regimes for a specified company.

```APIDOC
## GET /api/companies/{companyCode}/regimes

### Description
Retrieves a list of available regimes for a specified company. Requires User Permissions: Ficha de Empresa / Cotización.

### Method
GET

### Endpoint
/api/companies/{companyCode}/regimes

### Parameters
#### Path Parameters
- **companyCode** (string) - Required - The code of the company.

#### Query Parameters
- **api-version** (string) - Required - The version of the API.

### Response
#### Success Response (200)
- Returns job positions available in the specified company.

#### Response Example
```json
[
  {
    "example": "RegimeModel object"
  }
]
```
```

--------------------------------

### POST /api/companies/{companyCode}/workplaces/{workplacecode}/employees/create-employee-request

Source: https://wke-cms.apimarket.io/library-apis/5

Creates a new employee request for a specific workplace.

```APIDOC
## POST /api/companies/{companyCode}/workplaces/{workplacecode}/employees/create-employee-request

### Description
Create a new employee request. Required User Permissions: Personas.

### Method
POST

### Endpoint
/api/companies/{companyCode}/workplaces/{workplacecode}/employees/create-employee-request

### Parameters
#### Path Parameters
- **companyCode** (string) - Required - Company identifier
- **workplacecode** (integer) - Required - Company workplace code where to create employee

### Response
#### Success Response (200)
- **uuid** (string) - Created new employee identifier
```

--------------------------------

### Create New Employee

Source: https://wke-cms.apimarket.io/library-apis/5

This endpoint allows for the creation of a new employee record in the system. It requires comprehensive employee data including identification, contact, bank, fiscal, and occupational information.

```APIDOC
## POST /api/employees

### Description
Creates a new employee record with the provided details.

### Method
POST

### Endpoint
/api/employees

### Request Body
- **data** (object) - Required - Contains all the information for the new employee.
  - **identification** (object) - Required - Personal identification details.
    - **name** (string) - Required - Employee's first name.
    - **surname** (string) - Required - Employee's first surname.
    - **surname2** (string) - Optional - Employee's second surname.
    - **sex** (string) - Required - Employee's sex (e.g., 'H' for male, 'M' for female).
    - **identificationDocumentTypeID** (integer) - Required - ID of the identification document type.
    - **identificationDocumentNumber** (string) - Required - The identification document number.
    - **dateOfBirth** (string) - Required - Employee's date of birth in ISO 8601 format (e.g., "2026-02-25T12:53:38.1147214+00:00").
  - **contactDetails** (object) - Required - Employee's contact information.
    - **street** (string) - Required - Street name.
    - **town** (string) - Required - City or town.
    - **countryID** (integer) - Required - ID of the country.
    - **postalCode** (string) - Required - Postal code.
    - **buildingNumber** (string) - Optional - Building number.
    - **floor** (string) - Optional - Floor number.
    - **gate** (string) - Optional - Gate or apartment identifier.
    - **stairwell** (string) - Optional - Stairwell identifier.
    - **streetType** (string) - Optional - Type of street (e.g., 'Calle').
    - **phone** (string) - Optional - Employee's phone number.
    - **email** (string) - Optional - Employee's email address.
  - **bank** (object) - Optional - Employee's bank account details.
    - **bankCode** (string) - Required - Bank code.
    - **branchCode** (string) - Required - Branch code.
    - **checkDigit** (string) - Required - Check digit.
    - **accountNumber** (string) - Required - Bank account number.
  - **fiscal** (object) - Optional - Fiscal and social security information.
    - **ssAffiliationNumberPrefix** (string) - Optional - Social security affiliation number prefix (2 digits).
    - **ssAffiliationNumber** (string) - Optional - Social security affiliation number (8 digits).
    - **ssAffiliationNumberSuffix** (string) - Optional - Social security affiliation number suffix (2 digits).
    - **birthCountryID** (integer) - Optional - ID of the country of birth.
    - **birthRegion** (string) - Optional - Region of birth.
  - **ocupational** (object) - Optional - Occupational details.
    - **jobPositionCode** (string) - Optional - Job position code.
    - **companyAgreementCode** (string) - Optional - Company agreement code.
    - **classificationCode** (integer) - Optional - Classification code.
  - **enrolmentDate** (string) - Required - The date the employee was enrolled, in ISO 8601 format (e.g., "2020-01-01T00:00:00.0000000+00:00").
- **observations** (string) - Optional - Additional observations about the employee creation request.

### Request Example
```json
{
  "data": {
    "identification": {
      "name": "Bilbo",
      "surname": "Baggins",
      "surname2": "Bobbins",
      "sex": "H",
      "identificationDocumentTypeID": 1,
      "identificationDocumentNumber": "Y3227222T",
      "dateOfBirth": "2026-02-25T12:53:38.1147214+00:00"
    },
    "contactDetails": {
      "street": "a street",
      "town": "Atown",
      "countryID": 724,
      "postalCode": "09999",
      "buildingNumber": "1",
      "floor": "1",
      "gate": "2",
      "stairwell": "L",
      "streetType": "Calle",
      "phone": "677999999",
      "email": "someone@somwhere.com"
    },
    "bank": {
      "bankCode": "1234",
      "branchCode": "0001",
      "checkDigit": "01",
      "accountNumber": "1234567890"
    },
    "fiscal": {
      "ssAffiliationNumberPrefix": "99",
      "ssAffiliationNumber": "12345678",
      "ssAffiliationNumberSuffix": "99",
      "birthCountryID": 724,
      "birthRegion": "Barcelona"
    },
    "ocupational": {
      "jobPositionCode": "1001",
      "companyAgreementCode": "10001010",
      "classificationCode": 2
    },
    "enrolmentDate": "2022-05-01"
  },
  "observations": "some observations"
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating successful employee creation.

#### Response Example
```json
{
  "message": "Employee created successfully."
}
```
```

--------------------------------

### GET /api/paytypes

Source: https://wke-cms.apimarket.io/library-apis/5

Retrieves a list of pay types.

```APIDOC
## GET /api/paytypes

### Description
Retrieves a list of pay types.

### Method
GET

### Endpoint
/api/paytypes

### Parameters
#### Query Parameters
- **api-version** (string) - Required - The version of the API to use.

### Response
#### Success Response (200)
- **KeyValuePairInt32String** (object) - Paytype id's.
```

--------------------------------

### Get Organigram for Company

Source: https://wke-cms.apimarket.io/library-apis/5

Retrieves the organigram for a specified company.

```APIDOC
## GET /api/companies/{companyCode}/organigram

### Description
Retrieves the organigram for a specified company. Requires User Permissions: Organigramas.

### Method
GET

### Endpoint
/api/companies/{companyCode}/organigram

### Parameters
#### Path Parameters
- **companyCode** (string) - Required - The code of the company.

#### Query Parameters
- **api-version** (string) - Required - The version of the API.

### Response
#### Success Response (200)
- Returns the organigram for the company.

#### Response Example
```json
{
  "example": "OrganigramNodeResource object"
}
```
```

--------------------------------

### GET /api/paytypegroups

Source: https://wke-cms.apimarket.io/library-apis/5

Retrieves a list of pay type groups.

```APIDOC
## GET /api/paytypegroups

### Description
Returns a list of pay type groups.

### Method
GET

### Endpoint
/api/paytypegroups

### Response
#### Success Response (200)
- **string[]** (array) - Returns Pay Type Grouping Names.
```

--------------------------------

### List IT complements for agreement

Source: https://wke-cms.apimarket.io/library-apis/5

Retrieves a list of IT complements associated with a specific agreement. Requires user permissions for 'Ficha de Empresa / Convenios y Pactos'.

```APIDOC
## GET /api/companies/{companyCode}/agreements/{agreementCode}/{revision}/itcomplements

### Description
Retrieves a list of IT complements for a given company agreement.

### Method
GET

### Endpoint
/api/companies/{companyCode}/agreements/{agreementCode}/{revision}/itcomplements

### Parameters
#### Path Parameters
- **companyCode** (string) - Required - The unique identifier for the company.
- **agreementCode** (string) - Required - The code of the agreement.
- **revision** (integer) - Required - The revision number of the agreement.

#### Query Parameters
- **pageNumber** (integer) - Optional - The page number for pagination.
- **pageSize** (integer) - Optional - The number of items per page.
- **api-version** (string) - Required - The version of the API to use.

### Response
#### Success Response (200)
- **AgreementITComplementResource** (array) - A list of IT complements associated with the agreement.
```

--------------------------------

### GET /api/conceptcollectiontypes

Source: https://wke-cms.apimarket.io/library-apis/5

Retrieves a list of concept collection types.

```APIDOC
## GET /api/conceptcollectiontypes

### Description
Returns a list of concept collection types.

### Method
GET

### Endpoint
/api/conceptcollectiontypes

### Response
#### Success Response (200)
- **ConceptCollectionType[]** (array) - Returns concept collection types.
```

--------------------------------

### GET /api/perceptionSubTypes

Source: https://wke-cms.apimarket.io/library-apis/5

Retrieves a list of perception subtype codes.

```APIDOC
## GET /api/perceptionSubTypes

### Description
Returns a list of perception subtype codes.

### Method
GET

### Endpoint
/api/perceptionSubTypes

### Response
#### Success Response (200)
- **PerceptionSubkeyResource[]** (array) - Returns list of perception subtypes.
```

--------------------------------

### Data Models Overview

Source: https://wke-cms.apimarket.io/library-apis/5

Definitions for bank account and disability data structures used within the system.

```APIDOC
## Data Models

### WorkplaceBankAccountModel
- **bank1** (string)
- **bank2** (string) - ReadOnly
- **bank3** (string) - ReadOnly
- **bank4** (string) - ReadOnly
- **ibanSuffix** (string) - ReadOnly
- **iban** (string) - ReadOnly
- **bic** (string) - ReadOnly
- **isBigAccount** (boolean) - ReadOnly

### TemporaryDisability
- **temporaryDisabilityID** (uuid)
- **employeeID** (uuid)
- **employeeCode** (string)
- **incidentTypeID** (integer)
- **description** (string)
- **startdate** (date-time)
- **enddate** (date-time)
- **indCovid19** (boolean)
- **indHospitalization** (boolean)
- **indComplement** (boolean)
- **percentagePartialMaternity** (number)
- **benefitTypeId** (integer)
- **contingencyID** (integer)
- **relapsedIncidentID** (uuid)
- **parentIncidentID** (uuid)
- **lastUpdate** (date-time)
- **indAutManEndDate** (boolean)
- **forcedDescription** (string)

### BankAccountsResource
- **entity** (string) - Required - Pattern: ^[0-9]{4}$
- **agency** (string) - Required - Pattern: ^[0-9]{4}$
- **digitControl** (string) - Required - Pattern: ^[0-9]{2}$
- **account** (string) - Required - Pattern: ^[0-9]{10}$
- **iban** (string)
- **holder** (string)
- **isMainAccount** (boolean)
- **distributionAmount** (number)
- **distributionPercentage** (number)
- **bic** (string)
- **conceptCode** (integer)
- **conceptDescription** (string)
```

--------------------------------

### GET /api/dismissaltypes

Source: https://wke-cms.apimarket.io/library-apis/5

Retrieves a list of laboral dismissal types.

```APIDOC
## GET /api/dismissaltypes

### Description
Returns a list of laboral dismissal types.

### Method
GET

### Endpoint
/api/dismissaltypes

### Response
#### Success Response (200)
- **DismissalTypeResource[]** (array) - Returns list of dismissal types.
```

--------------------------------

### List Employee Incentives

Source: https://wke-cms.apimarket.io/library-apis/5

Retrieves a list of incentives for a given employee. Requires user permissions for 'Ficha de Persona / Retribuciones'.

```APIDOC
## GET /api/companies/{companyCode}/employees/{employeeCode}/incentives

### Description
Retrieves a list of incentives for a given employee.

### Method
GET

### Endpoint
/api/companies/{companyCode}/employees/{employeeCode}/incentives

### Parameters
#### Path Parameters
- **companyCode** (string) - Required - The company code.
- **employeeCode** (string) - Required - The employee code.

#### Query Parameters
- **api-version** (string) - Required - The API version.

### Response
#### Success Response (200)
- **EmployeeIncentive** (array) - Returns employee incentives.
```

--------------------------------

### GET /api/testdaytypes

Source: https://wke-cms.apimarket.io/library-apis/5

Retrieves a list of test day types.

```APIDOC
## GET /api/testdaytypes

### Description
Returns a list of test day type codes.

### Method
GET

### Endpoint
/api/testdaytypes

### Response
#### Success Response (200)
- **KeyValuePairInt32String** (object) - Returns perception type codes.
```

--------------------------------

### POST /api/companies/{companyCode}/create-professional

Source: https://wke-cms.apimarket.io/library-apis/5

Creates or updates a list of professionals for a company.

```APIDOC
## POST /api/companies/{companyCode}/create-professional

### Description
Create or update a list of professionals. Required User Permissions: Personas.

### Method
POST

### Endpoint
/api/companies/{companyCode}/create-professional

### Parameters
#### Path Parameters
- **companyCode** (string) - Required

#### Request Body
- **newProfessionals** (array) - Required - Incoming list of professionals

### Response
#### Success Response (200)
- **CreatedProfessional** (array) - Professionals created
```

--------------------------------

### GET /api/cnooccupations

Source: https://wke-cms.apimarket.io/library-apis/5

Retrieves a list of CNO Occupation codes.

```APIDOC
## GET /api/cnooccupations

### Description
List of CNO Occupation codes.

### Method
GET

### Endpoint
/api/cnooccupations

### Response
#### Success Response (200)
- **Occupation[]** (array) - Returns cno occupations
```

--------------------------------

### List Employee Portals

Source: https://wke-cms.apimarket.io/library-apis/5

Retrieves a list of employee portals. Requires 'Gestión de Portales' user permissions.

```APIDOC
## GET /api/portals

### Description
Retrieves a list of employee portals. This endpoint is useful for fetching all available portals for a user or company.

### Method
GET

### Endpoint
/api/portals

### Parameters
#### Query Parameters
- **pageSize** (integer) - Optional - The number of items to return per page.
- **pageNumber** (integer) - Optional - The page number to retrieve.
- **companyCode** (integer) - Optional - Filters portals by a specific company code.
- **api-version** (string) - Required - Specifies the API version.

### Response
#### Success Response (200)
- **Portal** (array) - Returns an array of Portal objects.

#### Response Example
```json
[
  {
    "id": "string",
    "name": "string",
    "description": "string"
  }
]
```
```

--------------------------------

### GET /api/perceptiontypecodes

Source: https://wke-cms.apimarket.io/library-apis/5

Retrieves a list of perception type codes.

```APIDOC
## GET /api/perceptiontypecodes

### Description
Retrieves a list of perception type codes.

### Method
GET

### Endpoint
/api/perceptiontypecodes

### Parameters
#### Query Parameters
- **api-version** (string) - Required - The version of the API to use.

### Response
#### Success Response (200)
- **KeyValuePairStringString** (object) - Returns perception type codes.
```

--------------------------------

### POST /api/companies/{companyCode}/employees/create-employee

Source: https://wke-cms.apimarket.io/library-apis/5

Creates a new employee record for a specific company. Requires 'Personas' user permissions.

```APIDOC
## POST /api/companies/{companyCode}/employees/create-employee

### Description
Creates a new employee record for a specific company.

### Method
POST

### Endpoint
/api/companies/{companyCode}/employees/create-employee

### Parameters
#### Path Parameters
- **companyCode** (string) - Required - The code of the company.

#### Query Parameters
- **entityMode** (string) - Optional - Entity mode to use (Default, Shared, Single). Default: Default.
- **api-version** (string) - Required - API version.

### Request Example
{
  "workplaceCode": 1,
  "identification": {
    "identificationType": 1,
    "identifierNumber": "Z7357618S",
    "employeeCode": "8882",
    "legalName": "name",
    "secondName1": "surname",
    "secondName2": "surname2",
    "sex": "H",
    "ssAffiliationNumberPrefix": "02",
    "ssAffiliationNumber": "00323232",
    "ssAffiliationNumberSuffix": "11",
    "enrollmentDate": "2021-01-01",
    "personType": "2",
    "birthRegion": "HUELVA",
    "birthCountry": "ESPAÑA"
  },
  "agreement": {
    "jobPositionCode": "00000077",
    "companyAgreementCode": "00000000000001",
    "classificationCode": 2,
    "subClassificationCode": 2,
    "cnoOccupationID": "0001"
  },
  "contribution": {
    "contributionTypeID": 2,
    "regime": "5bbc8d2b-2d03-4b9f-a017-64c6f02a9870",
    "tariffGroupID": 2,
    "occupationCodeTGSS": "x",
    "ims": 3.35,
    "it": 3.35,
    "paymentFrequency": 2
  },
  "address": {
    "acronymID": "string",
    "streetName": "string",
    "buildingNumber": "string",
    "stairwell": "string",
    "floor": "string",
    "gate": "string",
    "town": "string",
    "postalCode": "string",
    "countryID": 724,
    "poBox": "string"
  }
}

### Response
#### Success Response (200)
- **uuid** (string) - The unique identifier of the created employee.

#### Response Example
"00000000-0000-0000-0000-000000000000"
```

--------------------------------

### GET /api/training/centers/{centerCode}/years/{year}/groups/{groupCode}/actions

Source: https://wke-cms.apimarket.io/library-apis/5

List all actions associated with a specific training group.

```APIDOC
## GET /api/training/centers/{centerCode}/years/{year}/groups/{groupCode}/actions

### Description
List training group actions. Required User Permissions: Centros de Formación.

### Method
GET

### Endpoint
/api/training/centers/{centerCode}/years/{year}/groups/{groupCode}/actions

### Parameters
#### Path Parameters
- **centerCode** (string) - Required - training center code
- **year** (integer) - Required - year
- **groupCode** (string) - Required - training group code

### Response
#### Success Response (200)
- **Description** - Returns training group actions
```

--------------------------------

### GET /api/training/centers/{centerCode}

Source: https://wke-cms.apimarket.io/library-apis/5

Retrieves information for a specific training center.

```APIDOC
## GET /api/training/centers/{centerCode}

### Description
Retrieves training center information. Required User Permissions: Centros de Formación.

### Method
GET

### Endpoint
/api/training/centers/{centerCode}

### Parameters
#### Path Parameters
- **centerCode** (string) - Required - training center code

### Response
#### Success Response (200)
- **TrainingCenterResource** (object) - Returns training center information
```

--------------------------------

### POST /api/companies/{companyCode}/employees/{employeeCode}/temporarydisabilities/{temporaryDisabilityID}/relapse

Source: https://wke-cms.apimarket.io/library-apis/5

Creates a relapse record for an employee's temporary disability. Requires appropriate user permissions.

```APIDOC
## POST /api/companies/{companyCode}/employees/{employeeCode}/temporarydisabilities/{temporaryDisabilityID}/relapse

### Description
Creates a relapse record for an employee's temporary disability. Requires appropriate user permissions.

### Method
POST

### Endpoint
/api/companies/{companyCode}/employees/{employeeCode}/temporarydisabilities/{temporaryDisabilityID}/relapse

### Parameters
#### Path Parameters
- **companyCode** (string) - Required - The company code.
- **employeeCode** (string) - Required - The employee code.
- **temporaryDisabilityID** (string) - Required - The ID of the parent temporary disability.

#### Query Parameters
- **api-version** (string) - Required - The version of the API.

#### Request Body
- **relapse** (object) - Required - The relapse data.
  - **relapseDate** (string) - Required - The date of the relapse (YYYY-MM-DD).
  - **relapseDescription** (string) - Optional - A description of the relapse.
  - **relapseType** (string) - Required - The type of relapse.

### Request Example
```json
{
  "relapse": {
    "relapseDate": "2023-11-15",
    "relapseDescription": "Returned to work after initial recovery.",
    "relapseType": "Work-related"
  }
}
```

### Response
#### Success Response (200)
- (object) - Indicates the relapse was created successfully.

#### Success Response (201)
- **string** - Returns the ID of the created relapse record.

#### Response Example (200)
```json
{
  "message": "Relapse created successfully."
}
```

#### Response Example (201)
```json
"relapseId12345"
```
```

--------------------------------

### GET /api/portals/users

Source: https://wke-cms.apimarket.io/library-apis/5

Retrieves a list of users associated with an employee portal.

```APIDOC
## GET /api/portals/users

### Description
List users of an employee portal. Required User Permissions: Gestión de Portales.

### Method
GET

### Endpoint
/api/portals/users

### Parameters
#### Query Parameters
- **companyCode** (integer, int32) - Optional - Company code
- **portalCode** (integer, int32) - Optional - Portal code

### Response
#### Success Response (200)
- **PortalUser** (object) - Returns portal users
```

--------------------------------

### POST /api/companies/{companyCode}/employees/{employeeCode}/temporarydisabilities/special

Source: https://wke-cms.apimarket.io/library-apis/5

Creates a new IT special situation for an employee's temporary disability. Requires 'IT y Absentismos' user permissions.

```APIDOC
## POST /api/companies/{companyCode}/employees/{employeeCode}/temporarydisabilities/special

### Description
Creates a new IT special situation for an employee's temporary disability.

### Method
POST

### Endpoint
/api/companies/{companyCode}/employees/{employeeCode}/temporarydisabilities/special

### Parameters
#### Path Parameters
- **companyCode** (string) - Required - The company code.
- **employeeCode** (string) - Required - The employee code.

#### Query Parameters
- **api-version** (string) - Required - The API version.

#### Request Body
- **special** (object) - Required - The special IT definition.
  - *See* `#/components/schemas/Special` for schema details.

### Request Example
```json
{
  "special": {
    "someField": "someValue"
  }
}
```

### Response
#### Success Response (200)
- **object** (object) - Created successfully.

#### Success Response (201)
- **uuid** (string) - Returns the ID of the created special situation.

#### Response Example (201)
```json
{
  "example": "00000000-0000-0000-0000-000000000000"
}
```

#### Error Responses
- **400** - Invalid input parameters.
- **401** - Unauthorized.
- **423** - Locked.
- **500** - Internal server error.
```

--------------------------------

### POST /api/companies/{companyCode}/employees/{employeeCode}/temporarydisabilities/professionalillnesses

Source: https://wke-cms.apimarket.io/library-apis/5

Creates a new professional illness record for an employee's temporary disability. Requires appropriate user permissions.

```APIDOC
## POST /api/companies/{companyCode}/employees/{employeeCode}/temporarydisabilities/professionalillnesses

### Description
Creates a new professional illness record for an employee's temporary disability. Requires appropriate user permissions.

### Method
POST

### Endpoint
/api/companies/{companyCode}/employees/{employeeCode}/temporarydisabilities/professionalillnesses

### Parameters
#### Path Parameters
- **companyCode** (string) - Required - The company code.
- **employeeCode** (string) - Required - The employee code.

#### Request Body
- **ProfessionalIllness** (object) - Required - The professional illness data.
  - **accidentCode** (string) - Required - The code for the accident.
  - **accidentDate** (string) - Required - The date of the accident (YYYY-MM-DD).
  - **accidentDescription** (string) - Optional - A description of the accident.
  - **accidentType** (string) - Required - The type of accident.
  - **companyId** (string) - Required - The ID of the company.
  - **companyName** (string) - Required - The name of the company.
  - **employeeId** (string) - Required - The ID of the employee.
  - **employeeName** (string) - Required - The name of the employee.
  - **employeeSurname** (string) - Required - The surname of the employee.
  - **employeeTaxId** (string) - Required - The tax ID of the employee.
  - **illnessCode** (string) - Required - The code for the illness.
  - **illnessDate** (string) - Required - The date of the illness (YYYY-MM-DD).
  - **illnessDescription** (string) - Optional - A description of the illness.
  - **illnessType** (string) - Required - The type of illness.
  - **isProfessionalIllness** (boolean) - Required - Indicates if it is a professional illness.
  - **professionalIllnessCode** (string) - Required - The code for the professional illness.
  - **professionalIllnessDate** (string) - Required - The date of the professional illness (YYYY-MM-DD).
  - **professionalIllnessDescription** (string) - Optional - A description of the professional illness.
  - **professionalIllnessType** (string) - Required - The type of professional illness.
  - **temporaryDisabilityId** (string) - Required - The ID of the temporary disability.
  - **temporaryDisabilityStartDate** (string) - Required - The start date of the temporary disability (YYYY-MM-DD).
  - **temporaryDisabilityEndDate** (string) - Optional - The end date of the temporary disability (YYYY-MM-DD).

### Request Example
```json
{
  "ProfessionalIllness": {
    "accidentCode": "ACC123",
    "accidentDate": "2023-10-26",
    "accidentDescription": "Fell from a ladder",
    "accidentType": "Workplace Accident",
    "companyId": "COMP456",
    "companyName": "Tech Solutions Inc.",
    "employeeId": "EMP789",
    "employeeName": "John",
    "employeeSurname": "Doe",
    "employeeTaxId": "123-456-7890",
    "illnessCode": "ILL001",
    "illnessDate": "2023-10-26",
    "illnessDescription": "Fractured arm",
    "illnessType": "Injury",
    "isProfessionalIllness": true,
    "professionalIllnessCode": "PROF001",
    "professionalIllnessDate": "2023-10-27",
    "professionalIllnessDescription": "Work-related strain",
    "professionalIllnessType": "Occupational Disease",
    "temporaryDisabilityId": "TD12345",
    "temporaryDisabilityStartDate": "2023-10-26"
  }
}
```

### Response
#### Success Response (200)
- **ProfessionalIllnessesResource** (object) - The created professional illness resource.

#### Response Example
```json
{
  "ProfessionalIllnessesResource": {
    "accidentCode": "ACC123",
    "accidentDate": "2023-10-26",
    "accidentDescription": "Fell from a ladder",
    "accidentType": "Workplace Accident",
    "companyId": "COMP456",
    "companyName": "Tech Solutions Inc.",
    "employeeId": "EMP789",
    "employeeName": "John",
    "employeeSurname": "Doe",
    "employeeTaxId": "123-456-7890",
    "illnessCode": "ILL001",
    "illnessDate": "2023-10-26",
    "illnessDescription": "Fractured arm",
    "illnessType": "Injury",
    "isProfessionalIllness": true,
    "professionalIllnessCode": "PROF001",
    "professionalIllnessDate": "2023-10-27",
    "professionalIllnessDescription": "Work-related strain",
    "professionalIllnessType": "Occupational Disease",
    "temporaryDisabilityId": "TD12345",
    "temporaryDisabilityStartDate": "2023-10-26",
    "temporaryDisabilityEndDate": null
  }
}
```
```

--------------------------------

### GET /api/jobpositiondropcauses

Source: https://wke-cms.apimarket.io/library-apis/5

Retrieves a list of job position drop causes.

```APIDOC
## GET /api/jobpositiondropcauses

### Description
List job position drop causes.

### Method
GET

### Endpoint
/api/jobpositiondropcauses

### Response
#### Success Response (200)
- **JobPositionDropCause** (object) - Return job position drop causes
```

--------------------------------

### GET /api/collectivetypes

Source: https://wke-cms.apimarket.io/library-apis/5

Retrieves a list of collective types affiliation data.

```APIDOC
## GET /api/collectivetypes

### Description
List Collective types affiliation data.

### Method
GET

### Endpoint
/api/collectivetypes

### Response
#### Success Response (200)
- **CollectiveType[]** (array) - Returns collective types
```

--------------------------------

### Vacation Days Summary

Source: https://wke-cms.apimarket.io/library-apis/5

Summary of vacation days, including initial, previous year, and other days.

```APIDOC
## Vacation Days Summary

### Description
Provides a summary of vacation days, detailing initial, previous year, and other accrued days.

### Schema
```json
{
  "type": "object",
  "properties": {
    "initalDays": {
      "type": "number",
      "format": "double"
    },
    "previousYearDays": {
      "type": "number",
      "format": "double"
    },
    "otherDays": {
      "type": "number",
      "format": "double"
    },
    "total": {
      "type": "number",
      "format": "double"
    },
    "observations": {
      "type": "string"
    }
  }
}
```
```

--------------------------------

### GET /api/training/centers/{centerCode}/years/{year}/groups/{groupCode}/participants

Source: https://wke-cms.apimarket.io/library-apis/5

Retrieves a list of participants for a specific training group.

```APIDOC
## GET /api/training/centers/{centerCode}/years/{year}/groups/{groupCode}/participants

### Description
List participants for a training group. Required User Permissions: Centros de Formación.

### Method
GET

### Endpoint
/api/training/centers/{centerCode}/years/{year}/groups/{groupCode}/participants

### Parameters
#### Path Parameters
- **centerCode** (string) - Required - training center code
- **year** (integer) - Required - year
- **groupCode** (string) - Required - training group code

### Response
#### Success Response (200)
- **TrainingGroupParticitpantDigestResource** (object) - Returns training group participants
```
Tokens:
Raw