### Get All Departments (GET)

Source: https://docs-api.convenia.com.br/index

This endpoint retrieves a list of all departments in the platform. The response contains the ID and name of each department. It's a simple GET request requiring only an authentication token.

```json
{
  "message": "",
  "data": [
    {
      "id": "0d379d76-a07e-4a6a-a0ac-24ca96ebc89b",
      "name": "Departamentos"
    }
  ],
  "redirect": null,
  "success": true
}
```

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

### Get Cities Data - GET Request

Source: https://docs-api.convenia.com.br/index

Retrieves a list of all available cities from the Convenia platform. This endpoint requires an authentication token in the header.

```HTTP
GET https://public-api.convenia.com.br/api/v3/cities

Headers:
  token: YOUR_API_TOKEN
```

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

### Get Banks Data - GET Request

Source: https://docs-api.convenia.com.br/index

Retrieves a list of all accepted banks in the Convenia platform. This endpoint requires an authentication token in the header.

```HTTP
GET https://public-api.convenia.com.br/api/v3/banks

Headers:
  token: YOUR_API_TOKEN
```

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

### Get States Data - GET Request

Source: https://docs-api.convenia.com.br/index

Retrieves a list of all available states from the Convenia platform. This endpoint requires an authentication token in the header.

```HTTP
GET https://public-api.convenia.com.br/api/v3/states

Headers:
  token: YOUR_API_TOKEN
```

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

### GET /api/v3/educations

Source: https://docs-api.convenia.com.br/index

Retrieves a list of all available education types in the Convenia platform.

```APIDOC
## GET /api/v3/educations

### Description
This endpoint returns a list of all education types available in the Convenia platform.

### Method
GET

### Endpoint
https://public-api.convenia.com.br/api/v3/educations

### Parameters

#### Query Parameters

#### Request Body

### Request Example
```json
{}
```

### Response
#### Success Response (200)
- **message** (string) - An empty string.
- **data** (array) - An array of education type objects.
  - **id** (string) - The unique identifier for the education type.
  - **name** (string) - The name of the education type.
- **redirect** (null) - Always null.
- **success** (boolean) - Indicates if the request was successful.

#### Response Example
```json
{
  "message": "",
  "data": [
    {
      "id": "1",
      "name": "Analfabeto, inclusive o que, embora tenha recebido instrução, não se alfabetizou"
    }
  ],
  "redirect": null,
  "success": true
}
```
```

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

### Start Admission

Source: https://docs-api.convenia.com.br/historic

Initiates the admission process for a new employee. Requires basic employee and position details.

```APIDOC
## POST /admissions

### Description
Initiates the admission process for a new employee. Requires basic employee and position details.

### Method
POST

### Endpoint
/admissions

### Parameters
#### Request Body
- **first_name** (string) - Required - The employee's first name.
- **last_name** (string) - Required - The employee's last name.
- **job_title_id** (integer) - Required - The ID of the employee's job title.
- **department_id** (integer) - Required - The ID of the employee's department.

### Request Example
{
  "first_name": "John",
  "last_name": "Doe",
  "job_title_id": 5,
  "department_id": 1
}

### Response
#### Success Response (201)
- **employee_id** (integer) - The ID of the newly created employee.
- **admission_id** (integer) - The ID of the admission process.
- **status** (string) - The current status of the admission process.

#### Response Example
{
  "employee_id": 101,
  "admission_id": 201,
  "status": "initiated"
}
```

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

### Employee Admission and Onboarding

Source: https://docs-api.convenia.com.br/historic

Endpoints related to the employee admission process, including starting the admission and updating stages.

```APIDOC
## POST /api/employees/admissions/start

### Description
Initiates the admission process for a new employee.

### Method
POST

### Endpoint
/api/employees/admissions/start

### Parameters
#### Request Body
- **relationship_id** (string) - Required - The ID of the employment relationship.

### Request Example
```json
{
  "relationship_id": "rel_abc789"
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message of the initiated admission.

#### Response Example
```json
{
  "message": "Employee admission process started successfully."
}
```
```

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

### Initiate Employee Admission (POST Request)

Source: https://docs-api.convenia.com.br/index

This snippet demonstrates how to send a POST request to the Convenia API to initiate an employee's admission. It includes the endpoint URL and required headers.

```HTTP
POST https://public-api.convenia.com.br/api/v3/employees/admission

Headers:
- token: <Your Integration Token>
```

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

### Create Job (HTTP)

Source: https://docs-api.convenia.com.br/index

Creates a new job position. Requires a name, CBO code, and an authentication token. Optional fields include description and apprentice_quota.

```HTTP
POST https://public-api.convenia.com.br/api/v3/companies/jobs
Headers:
  token: sim | Token de integração gerado na plataforma Convenia
Payload:
  name: sim | texto | texto | Nome do cargo
  description: não | texto | texto | Descrição do cargo
  cbo_code: sim | texto | texto | Código cbo válido
  apprentice_quota: não | boleano | boleano | Indicador se o cargo deve ou não ser contabilizado para cálculo do relatório de riscos de menor aprendiz
```

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

### Get Nationalities Data - GET Request

Source: https://docs-api.convenia.com.br/index

Retrieves a list of all available nationalities from the Convenia platform. This endpoint requires an authentication token in the header.

```HTTP
GET https://public-api.convenia.com.br/api/v3/nationalities

Headers:
  token: YOUR_API_TOKEN
```

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

### GET /api/v3/address-description - List Address Description Options

Source: https://docs-api.convenia.com.br/index

Retrieves a list of all available options for address descriptions for foreigners.

```APIDOC
## GET /api/v3/address-description

### Description
Retrieves a list of all available options for address descriptions for foreigners.

### Method
GET

### Endpoint
/api/v3/address-description

### Parameters
#### Query Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **message** (string) - An empty string.
- **data** (array) - An array of address description objects, each with an `id` (integer) and `name` (string).
- **redirect** (null) - Always null.
- **success** (boolean) - True if the request was successful.

#### Response Example
```json
{
  "message": "",
  "data": [
    {
      "id": 1,
      "name": "Aeroporto"
    }
  ],
  "redirect": null,
  "success": true
}
```
```

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

### Obter Solicitações de Férias de um Colaborador (HTTP GET)

Source: https://docs-api.convenia.com.br/index

Realiza uma requisição GET para a API da Convenia para buscar todas as solicitações de férias associadas a um determinado colaborador. É necessário incluir o token de integração no header. O endpoint retorna uma lista paginada de solicitações, cada uma com detalhes como saldo, período, status e aprovações.

```http
GET https://public-api.convenia.com.br/api/v3/employees/{ColaboradorID}/vacations/solicitations
Header:
  token: SEU_TOKEN_DE_INTEGRACAO
```

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

### Get Ethnicities Data - GET Request

Source: https://docs-api.convenia.com.br/index

Retrieves a list of all available ethnicities from the Convenia platform. This endpoint requires an authentication token in the header.

```HTTP
GET https://public-api.convenia.com.br/api/v3/ethnicities

Headers:
  token: YOUR_API_TOKEN
```

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

### Webhooks

Source: https://docs-api.convenia.com.br/historic

Endpoints for setting up webhooks for various events.

```APIDOC
## POST /webhooks/absences/creation

### Description
Creates a webhook to be triggered when an absence or leave is created.

### Method
POST

### Endpoint
/webhooks/absences/creation

### Parameters
#### Request Body
- **webhook_url** (string) - Required - The URL to send the webhook notification to.
- **event_type** (string) - Required - The type of absence event (e.g., 'created', 'updated', 'deleted').
- **employee_id** (string) - Optional - Filter webhook by a specific employee.

### Request Example
{
  "webhook_url": "https://example.com/my-webhook-receiver",
  "event_type": "created",
  "employee_id": "emp_abcde"
}

### Response
#### Success Response (200)
- **message** (string) - Success message.

#### Response Example
{
  "message": "Absence creation webhook configured successfully."
}
```

```APIDOC
## POST /webhooks/absences/update

### Description
Creates a webhook to be triggered when an absence or leave is updated.

### Method
POST

### Endpoint
/webhooks/absences/update

### Parameters
#### Request Body
- **webhook_url** (string) - Required - The URL to send the webhook notification to.
- **event_type** (string) - Required - The type of absence event (e.g., 'created', 'updated', 'deleted').
- **employee_id** (string) - Optional - Filter webhook by a specific employee.

### Request Example
{
  "webhook_url": "https://example.com/my-webhook-receiver",
  "event_type": "updated"
}

### Response
#### Success Response (200)
- **message** (string) - Success message.

#### Response Example
{
  "message": "Absence update webhook configured successfully."
}
```

```APIDOC
## POST /webhooks/absences/deletion

### Description
Creates a webhook to be triggered when an absence or leave is deleted.

### Method
POST

### Endpoint
/webhooks/absences/deletion

### Parameters
#### Request Body
- **webhook_url** (string) - Required - The URL to send the webhook notification to.
- **event_type** (string) - Required - The type of absence event (e.g., 'created', 'updated', 'deleted').
- **employee_id** (string) - Optional - Filter webhook by a specific employee.

### Request Example
{
  "webhook_url": "https://example.com/my-webhook-receiver",
  "event_type": "deleted"
}

### Response
#### Success Response (200)
- **message** (string) - Success message.

#### Response Example
{
  "message": "Absence deletion webhook configured successfully."
}
```

```APIDOC
## POST /webhooks/salary_changes

### Description
Creates a webhook to be triggered when salary changes occur.

### Method
POST

### Endpoint
/webhooks/salary_changes

### Parameters
#### Request Body
- **webhook_url** (string) - Required - The URL to send the webhook notification to.
- **employee_id** (string) - Optional - Filter webhook by a specific employee.

### Request Example
{
  "webhook_url": "https://example.com/my-salary-webhook",
  "employee_id": "emp_abcde"
}

### Response
#### Success Response (200)
- **message** (string) - Success message.

#### Response Example
{
  "message": "Salary change webhook configured successfully."
}
```

```APIDOC
## POST /webhooks/vacations/creation

### Description
Creates a webhook to be triggered when a vacation is created.

### Method
POST

### Endpoint
/webhooks/vacations/creation

### Parameters
#### Request Body
- **webhook_url** (string) - Required - The URL to send the webhook notification to.
- **employee_id** (string) - Optional - Filter webhook by a specific employee.

### Request Example
{
  "webhook_url": "https://example.com/my-vacation-webhook",
  "employee_id": "emp_abcde"
}

### Response
#### Success Response (200)
- **message** (string) - Success message.

#### Response Example
{
  "message": "Vacation creation webhook configured successfully."
}
```

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

### Get Education Types Data - GET Request

Source: https://docs-api.convenia.com.br/index

Retrieves a list of all available education types from the Convenia platform. This endpoint requires an authentication token in the header.

```HTTP
GET https://public-api.convenia.com.br/api/v3/educations

Headers:
  token: YOUR_API_TOKEN
```

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

### Get Marital Status Data - GET Request

Source: https://docs-api.convenia.com.br/index

Retrieves a list of all available marital statuses from the Convenia platform. This endpoint requires an authentication token in the header.

```HTTP
GET https://public-api.convenia.com.br/api/v3/marital-status

Headers:
  token: YOUR_API_TOKEN
```

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

### Admission Started Webhook (Aug 6, 2024)

Source: https://docs-api.convenia.com.br/historic

Introduces a webhook that is triggered when an admission process is initiated.

```APIDOC
## Webhook: admission.started

### Description
This webhook is triggered when a new admission process is initiated in the system.

### Event Data
- **admission_id** (string) - The ID of the initiated admission.
- **employee_id** (string) - The ID of the employee being admitted.
- **timestamp** (string) - The time the event occurred.
```

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

### Get Bank Account Types Data - GET Request

Source: https://docs-api.convenia.com.br/index

Retrieves a list of all available bank account types from the Convenia platform. This endpoint requires an authentication token in the header.

```HTTP
GET https://public-api.convenia.com.br/api/v3/bank-accounts

Headers:
  token: YOUR_API_TOKEN
```

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

### Create Cost Center (HTTP)

Source: https://docs-api.convenia.com.br/index

Creates a new cost center for a company. Requires a name for the cost center and an authentication token in the headers.

```HTTP
POST https://public-api.convenia.com.br/api/v3/companies/cost-center
Headers:
  token: sim | Token de integração gerado na plataforma Convenia
Payload:
  name: sim | texto | texto | Nome do centro de custo
```

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

### POST /admissao/iniciar

Source: https://docs-api.convenia.com.br/historic

Initiates the admission process for a new collaborator, capturing essential personal, employment, and contact details.

```APIDOC
## POST /admissao/iniciar

### Description
Initiates the admission process for a new collaborator, capturing essential personal, employment, and contact details.

### Method
POST

### Endpoint
`/admissao/iniciar`

### Parameters
#### Request Body
- **vinculo_id** (integer) - Required - ID of the employment relationship.
- **estado_civil_id** (integer) - Required - ID of the marital status.
- **estado_natal** (string) - Required - State of birth.
- **primeiro_emprego** (boolean) - Required - Indicates if it's the first job.
- **rg_data_expedicao** (string) - Optional - RG issue date (YYYY-MM-DD).
- **rg_orgao_emissor** (string) - Optional - RG issuing authority.
- **bairro** (string) - Optional - Collaborator's neighborhood.
- **formacao_academica** (object) - Optional - Academic formation details.
  - **tipo_id** (integer) - Required - ID of the academic formation type.
  - **instituicao_ensino** (string) - Required - Name of the educational institution.
  - **curso** (string) - Required - Name of the course.
  - **ano_conclusao** (integer) - Required - Year of completion.
- **banco_id** (integer) - Optional - ID of the bank.
- **conta** (string) - Optional - Bank account number.
- **agencia** (string) - Optional - Bank branch number.
- **digito** (string) - Optional - Bank account digit.
- **tipo_conta_bancaria_id** (integer) - Optional - ID of the bank account type.
- **matricula** (string) - Optional - Collaborator's registration number.
- **data_aniversario** (string) - Optional - Collaborator's date of birth (YYYY-MM-DD).
- **genero** (string) - Optional - Collaborator's gender.
- **nome_pai** (string) - Optional - Father's name.
- **nome_mae** (string) - Optional - Mother's name.
- **data_admissao** (string) - Optional - Admission date (YYYY-MM-DD).
- **salario** (number) - Optional - Collaborator's salary.
- **telefone_residencial** (string) - Optional - Home phone number.
- **telefone_celular** (string) - Optional - Mobile phone number.
- **cpf** (string) - Optional - Collaborator's CPF.
- **rg** (string) - Optional - Collaborator's RG.
- **titulo_eleitor_numero** (string) - Optional - Voter registration number.
- **titulo_eleitor_inscricao** (string) - Optional - Voter registration inscription.
- **titulo_eleitor_zona** (string) - Optional - Voter registration zone.
- **ctps_numero** (string) - Optional - CTPS number.
- **ctps_serie** (string) - Optional - CTPS series.
- **cnh_numero** (string) - Optional - CNH number.
- **pis** (string) - Optional - PIS number.
- **cep** (string) - Optional - Collaborator's postal code.
- **rua** (string) - Optional - Collaborator's street address.
- **complemento** (string) - Optional - Address complement.
- **numero** (string) - Optional - Street number.
- **bairro** (string) - Optional - Collaborator's neighborhood.

### Request Example
```json
{
  "example": "{\"vinculo_id\": 1, \"estado_civil_id\": 2, \"estado_natal\": \"SP\", \"primeiro_emprego\": true, ...}"
}
```

### Response
#### Success Response (200)
- **message** (string) - Success message indicating the admission process has started.

#### Response Example
```json
{
  "example": "{\"message\": \"Início de admissão realizado com sucesso.\"}"
}
```
```

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

### Get Employment Relationships Data - GET Request

Source: https://docs-api.convenia.com.br/index

Retrieves a list of all available employment relationships (e.g., CLT) from the Convenia platform. This endpoint requires an authentication token in the header.

```HTTP
GET https://public-api.convenia.com.br/api/v3/relationships

Headers:
  token: YOUR_API_TOKEN
```

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

### Admission Started Webhook

Source: https://docs-api.convenia.com.br/index

Notifies your system when an admission process is initiated in Convenia. This webhook is sent via HTTPS POST.

```APIDOC
## Webhook: Admission Started

### Description
This webhook is triggered whenever an admission process is initiated in Convenia, whether through employee self-service or manual entry.

### When
Sent when an admission process is started.

### Method
POST

### Endpoint
(Configured URL in Convenia platform)

### Headers
- **content-type** (string) - Value: `application/json`
- **signature** (string) - Signature generated by encrypting the secret + payload, used for authentication.

### Request Body
```json
{
  "type": "admission.started",
  "employee": {
    "id": "55fe5c64-84c5-426d-9903-0768fcc8732d"
  },
  "status_name": "started"
}
```
```

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

### Get Employee Dependents (API Request)

Source: https://docs-api.convenia.com.br/index

This section details the HTTP GET request to retrieve dependents for a given employee ID. It specifies the endpoint URL and required headers for authentication.

```HTTP
GET https://public-api.convenia.com.br/api/v3/employees/{ColaboradorID}/dependents

Headers:
  token: sim | Token de integração gerado na plataforma Convenia
```

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

### Get All Teams (GET)

Source: https://docs-api.convenia.com.br/index

This endpoint retrieves a list of all teams within the company. The response includes the team's ID, name, and associated department IDs. This is useful for understanding team structures.

```json
{
  "message": "",
  "data": [
    {
      "id": "f39064c8-63f7-495c-880a-19cb95cffbcb",
      "name": "time",
      "departments_ids": ["0d379d76-a07e-4a6a-a0ac-24ca96ebc89b"]
    }
  ],
  "redirect": null,
  "success": true
}
```

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

### Estrutura de Resposta da API de Férias (JSON)

Source: https://docs-api.convenia.com.br/index

Exemplo da estrutura de dados retornada pela API ao consultar solicitações de férias. Contém informações gerais da paginação e uma lista de objetos, onde cada objeto representa uma solicitação de férias com detalhes do colaborador, período, status, aprovações e arquivos associados.

```json
{
  "message": "",
  "current_page": 1,
  "data": [
    {
      "id": "3228b4e2-3402-4df0-8d9b-96639424dda3",
      "employee_id": "257fbee4-71a2-4aca-8658-4a311fafd9e1",
      "allowance": 18,
      "thirteenth": true,
      "period_id": "b14fb6c6-5e10-44e9-a02d-733c21d8e066",
      "collective_id": "b57f6356-aa47-48aa-9454-ba743b67fa75",
      "justification": "Justificativa para solicitação",
      "requested_days": 15,
      "sent_to_accountant": true,
      "spent_balance": 25,
      "starts_at": "AAAA-MM-DD",
      "finishes_at": "AAAA-MM-DD",
      "status": "approved",
      "paid_leave": 1,
      "accounting_started_at": "AAAA-MM-DD HH:ii:ss",
      "hr_approvals_started_at": "AAAA-MM-DD HH:ii:ss",
      "supervisor_approvals_started_at": "AAAA-MM-DD HH:ii:ss",
      "signature_started_at": "AAAA-MM-DD HH:ii:ss",
      "supervisor_approvals": [
        {
          "id": "0a165537-0dec-4aff-a16a-03ae82be8d97",
          "status": "approved",
          "supervisor_id": "42a198c5-2e39-4302-afda-8e4098d83589",
          "action_date": "AAAA-MM-DD",
          "updated_at": "AAAA-MM-DD HH:ii:ss",
          "created_at": "AAAA-MM-DD HH:ii:ss"
        }
      ],
      "hr_approvals": [
        {
          "id": "7e3d5d55-621b-49a8-acaf-bc600c64b5ba",
          "status": "approved",
          "employee_id": "3339802f-f219-4b0c-b7dd-d8e8197479f6",
          "action_date": "AAAA-MM-DD HH:ii:ss",
          "updated_at": "AAAA-MM-DD HH:ii:ss",
          "created_at": "AAAA-MM-DD HH:ii:ss"
        }
      ],
      "files": [
        {
          "id": "bf24b8be-283f-4bb4-bc5d-1461c29d381d",
          "name": "file-name.jpg",
          "signable": true,
          "status": null,
          "updated_at": "AAAA-MM-DD HH:ii:ss",
          "created_at": "AAAA-MM-DD HH:ii:ss"
        }
      ],
      "available_steps": {
        "supervisor_approval": true,
        "hr_approval": true,
        "accounting": true,
        "signature": true
      },
      "canceled": {
        "employee_id": "128e21ee-7705-4b17-9025-0cc4b1a64f8d",
        "created_at": "AAAA-MM-DD HH:ii:ss",
        "updated_at": "AAAA-MM-DD HH:ii:ss"
      },
      "created_at": "AAAA-MM-DD\T00:00:00",
      "updated_at": "AAAA-MM-DD\T00:00:00"
    }
  ],
  "first_page_url": "\/?page=1",
  "from": 1,
  "last_page": 1,
  "last_page_url": "\/?page=1",
  "links": [
    {
      "url": null,
      "label": "&laquo; Previous",
      "active": false
    },
    {
      "url": "\/?page=1",
      "label": "1",
      "active": true
    },
    {
      "url": null,
      "label": "Next &raquo;",
      "active": false
    }
  ],
  "next_page_url": null,
  "path": "\/",
  "per_page": 1,
  "prev_page_url": null,
  "to": 1,
  "total": 1,
  "redirect": null,
  "success": true
}
```

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

### POST /api/v3/employees/admission

Source: https://docs-api.convenia.com.br/index

This endpoint is responsible for creating an employee on the platform and initiating a new admission process for them.

```APIDOC
## POST /api/v3/employees/admission

### Description
This endpoint is responsible for creating the collaborator on the platform and initiating a new admission for them.

### Method
POST

### Endpoint
https://public-api.convenia.com.br/api/v3/employees/admission

### Headers
#### Path Parameters
- **token** (string) - Required - Integration token generated on the Convenia platform.

### Request Body
*This endpoint does not explicitly define a request body in the provided text, but typically would include employee details for creation.*

### Request Example
*No request example provided in the source text.*

### Response
#### Success Response (200)
- **message** (string) - Status message.
- **data** (array) - Array containing admission data.
  - **id** (string) - Admission ID.
  - **status** (integer) - Admission status.
  - **employee_fill_form** (integer) - Indicates if the employee filled the form.
  - **employee** (object) - Employee details.
    - **id** (string) - Employee ID.
    - **name** (string) - Employee's first name.
    - **last_name** (string) - Employee's last name.
    - **job** (string) - Employee's job title.
    - **department** (string) - Employee's department.
    - **cost_center_id** (string) - Cost center ID.
    - **team_id** (string) - Team ID.
    - **registration** (integer) - Employee registration number.
    - **birth_date** (string) - Employee's birth date (YYYY-MM-DD).
    - **gender** (string) - Employee's gender (M/F).
    - **marital_status_id** (string) - Marital status ID.
    - **relationship_id** (integer) - Relationship ID.
    - **father_name** (string) - Father's name.
    - **mother_name** (string) - Mother's name.
    - **hiring_date** (string) - Hiring date (YYYY-MM-DD).
    - **salary** (float) - Employee's salary.
    - **personal_email** (string) - Employee's personal email.
    - **phone** (string) - Employee's phone number.
    - **cell** (string) - Employee's cell phone number.
    - **natural_from_state_uf** (string) - State of origin (UF).
    - **natural_from_city** (string) - City of origin.
    - **natural_from_city_id** (integer) - City ID of origin.
    - **natural_from_state_id** (integer) - State ID of origin.
    - **first_job** (boolean) - Indicates if it's the employee's first job.
    - **nationality_id** (integer) - Nationality ID.
    - **nationality** (object) - Nationality details.
      - **id** (integer) - Nationality ID.
      - **name** (string) - Nationality name.
    - **ethnicity_id** (integer) - Ethnicity ID.
    - **ethnicity** (object) - Ethnicity details.
      - **id** (integer) - Ethnicity ID.
      - **name** (string) - Ethnicity name.
    - **documents** (object) - Employee document details.
      - **cpf** (string) - CPF number.
      - **rg** (string) - RG number.
      - **rg_expedition** (string) - RG expedition date (YYYY-MM-DD).
      - **rg_emission** (string) - RG issuing state.
      - **voter_card** (string) - Voter card number.
      - **voter_card_zone** (string) - Voter card zone.
      - **voter_card_section** (string) - Voter card section.
      - **ctps** (string) - CTPS number.
      - **ctps_serie** (string) - CTPS series.
      - **ctps_emission** (string) - CTPS expedition date (YYYY-MM-DD).
      - **cnh** (string) - CNH number.
      - **pis** (string) - PIS number.
    - **address** (object) - Employee address details.
      - **zip_code** (string) - Zip code.
      - **address** (string) - Street address.
      - **complement** (string) - Address complement.
      - **number** (integer) - Street number.
      - **district** (string) - District.
      - **city** (string) - City.
      - **state** (string) - State.
      - **city_id** (integer) - City ID.
      - **state_id** (integer) - State ID.
    - **education** (object) - Employee education details.
      - **course** (string) - Course name.
      - **institution** (string) - Educational institution.
      - **graduation_year** (integer) - Graduation year.
      - **education_type_id** (integer) - Education type ID.
      - **educationType** (object) - Education type details.
        - **name** (string) - Education type name.
    - **bankAccount** (object) - Employee bank account details.
      - **account** (integer) - Bank account number.
      - **agency** (integer) - Bank agency number.
      - **digit** (integer) - Account digit.
      - **accountant_type_id** (integer) - Accountant type ID.
      - **bank_id** (integer) - Bank ID.
      - **bank** (object) - Bank details.
        - **name** (string) - Bank name.
        - **code** (integer) - Bank code.
- **redirect** (null) - Redirect URL, if any.
- **success** (boolean) - Indicates if the request was successful.

#### Response Example
```json
{
  "message": "",
  "data": [
    {
      "id": "521260c6-3433-49d2-800a-48e614958183",
      "status": 0,
      "employee_fill_form":0,
      "employee": {
        "id": "1d93b0b1-6b93-4670-b8ae-7f4df7f3ff86",
        "name": "Colaborador",
        "last_name": "A",
        "job": "Cargo",
        "department": "Departamento",
        "cost_center_id": "56ac0fe4-570b-4001-9ae2-08aca33d74a8",
        "team_id": "f39064c8-63f7-495c-880a-19cb95cffbcb",
        "registration": 123,
        "birth_date": "AAAA-MM-DD",
        "gender": "M/F",
        "marital_status_id": "Solteiro",
        "relationship_id": 1,
        "father_name": "Pai do Colaborador",
        "mother_name": "Mãe do Colaborador",
        "hiring_date": "AAAA-MM-DD",
        "salary": 1000.00,
        "personal_email": "colaboradora@gmail.com",
        "phone": "1188887777",
        "cell": "11988887777",
        "natural_from_state_uf": "SP",
        "natural_from_city": "Adamantina",
        "natural_from_city_id": 1,
        "natural_from_state_id": 1,
        "first_job": false,
        "nationality_id": 9,
        "nationality": {
          "id": 9,
          "name": "Naturalizado Brasileiro"
        },
        "ethnicity_id": 1,
        "ethnicity": {
          "id": 1,
          "name": "Indígena"
        },
        "documents": {
          "cpf": "XXXXXXXXXXX",
          "rg": "XXXXXXXXXX",
          "rg_expedition": "YYYY-mm-dd",
          "rg_emission": "SP",
          "voter_card": "XXXXXXXXXXXX",
          "voter_card_zone": "XXX",
          "voter_card_section": "XXXX",
          "ctps": "XXXXXX",
          "ctps_serie": "XXXXX-XX",
          "ctps_emission": "YYYY-mm-dd",
          "cnh": "XXXXXXXXXXX",
          "pis": "XXXXXXXXXXXXX"
        },
        "address": {
          "zip_code": "XXXXXXXX",
          "address": "Rua",
          "complement": "Apto",
          "number": 123,
          "district": "Bairro",
          "city": "Adamantina",
          "state": "SP",
          "city_id": 1,
          "state_id": 1,
        },
        "education": {
          "course": "Curso",
          "institution": "Instituição",
          "graduation_year": 2021,
          "education_type_id": 8,
          "educationType": {
            "name": "Educação Superior incompleta"
          }
        },
        "bankAccount": {
          "account": 123,
          "agency": 456,
          "digit": 9,
          "accountant_type_id": 2,
          "bank_id": 1,
          "bank": {
            "name": "ABC Brasil S.A.",
            "code": 246
          }
        }
      }
    }
  ],
  "redirect": null,
  "success": true
}
```

#### Error Response
*No specific error responses were detailed in the provided text.*

```

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

### Get All Departments

Source: https://docs-api.convenia.com.br/index

Retrieves all departments associated with the company.

```APIDOC
## Get All Departments

### Description
Retrieves all departments associated with the company.

### Method
GET

### Endpoint
`https://public-api.convenia.com.br/api/v3/companies/departments`

### Headers
- **token** (string) - Required - Integration token generated on the Convenia platform.

### Response
#### Success Response (200)
- **message** (string) - The response message.
- **data** (array) - An array of department objects.
  - **id** (uuid) - The ID of the department.
  - **name** (string) - The name of the department.
- **redirect** (null) - Null value.
- **success** (boolean) - Indicates if the operation was successful.

#### Response Example
```json
{
  "message": "",
  "data": [
    {
      "id": "0d379d76-a07e-4a6a-a0ac-24ca96ebc89b",
      "name": "Departamentos"
    }
  ],
  "redirect": null,
  "success": true
}
```
```

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

### Get All Jobs (HTTP)

Source: https://docs-api.convenia.com.br/index

Retrieves a list of all job positions within the company. Requires an authentication token in the headers.

```HTTP
GET https://public-api.convenia.com.br/api/v3/companies/jobs
Headers:
  token: sim | Token de integração gerado na plataforma Convenia
```

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

### Get All Teams

Source: https://docs-api.convenia.com.br/index

Retrieves all teams associated with the company.

```APIDOC
## Get All Teams

### Description
Retrieves all teams associated with the company.

### Method
GET

### Endpoint
`https://public-api.convenia.com.br/api/v3/companies/teams`

### Headers
- **token** (string) - Required - Integration token generated on the Convenia platform.

### Response
#### Success Response (200)
- **message** (string) - The response message.
- **data** (array) - An array of team objects.
  - **id** (uuid) - The ID of the team.
  - **name** (string) - The name of the team.
  - **departments_ids** (array) - An array of department IDs associated with the team.
- **redirect** (null) - Null value.
- **success** (boolean) - Indicates if the operation was successful.

#### Response Example
```json
{
  "message": "",
  "data": [
    {
      "id": "f39064c8-63f7-495c-880a-19cb95cffbcb",
      "name": "time",
      "departments_ids": ["0d379d76-a07e-4a6a-a0ac-24ca96ebc89b"]
    }
  ],
  "redirect": null,
  "success": true
}
```
```

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

### Create Employee Academic Information

Source: https://docs-api.convenia.com.br/index

Creates academic information for an employee. Requires authentication token. Accepts employee ID in the URL and a JSON payload with education details. Returns a success message and the created data.

```json
{
  "education_type_id": 1,
  "course": "Técnologia da Informação",
  "institution": "Universidade",
  "graduation_year": 2000
}
```

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

### GET /collective-vacations

Source: https://docs-api.convenia.com.br/includes/Convenia_api_insomnia

Retrieves a list of all collective vacations.

```APIDOC
## GET /collective-vacations

### Description
Fetches a list of all available collective vacation entries.

### Method
GET

### Endpoint
`/collective-vacations`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```json
{} 
```

### Response
#### Success Response (200)
- **collective_vacations** (array) - An array of collective vacation objects.
    - Each object may contain details like ID, dates, etc.

#### Response Example
```json
{
    "collective_vacations": [
        {
            "id": "vacation_id_1",
            "start_date": "YYYY-MM-DD",
            "end_date": "YYYY-MM-DD"
        },
        {
            "id": "vacation_id_2",
            "start_date": "YYYY-MM-DD",
            "end_date": "YYYY-MM-DD"
        }
    ]
}
```
```

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

### Example API Response for Employee Change History

Source: https://docs-api.convenia.com.br/index

This JSON object illustrates a successful response when retrieving a specific employee change history. It includes details about the change, such as the employee ID, action taken, section modified, owner, and the specific changes made with old and new values. The timestamps are placeholders.

```json
{
  "message": "",
  "data": {
    "id": "f10e1989-5f73-4845-9160-7faea8998207",
    "employee_id": "33fb5be0-5614-43b3-83f6-b36a087f3699",
    "action": "created",
    "section": "accountancy",
    "owner_name": "Pessoa A",
    "changes": {
      "process_number": {
        "new_value": 100,
        "old_value": null
      },
      "social_security_type_id": {
        "new_id": 1,
        "old_id": null,
        "new_value": "Regime Geral de Previdência Social - RGPS",
        "old_value": null
      }
    },
    "created_at": "AAAA-MM-DD\THH:ii:ss",
    "updated_at": "AAAA-MM-DD\THH:ii:ss"
  },
  "redirect": null,
  "success": true
}
```

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

### Get Company Payrolls (GET)

Source: https://docs-api.convenia.com.br/index

Retrieves a list of payrolls for a company. This endpoint supports filtering and pagination. Requires an integration token in the headers. Query parameters allow for exact matches, differences, pattern matching, and pagination control. Deprecated fields `is_accounting` and `due_date` will be removed after 31/03/2025.

```http
GET https://public-api.convenia.com.br/api/v3/payrolls
Headers:
  token: [Your Integration Token]
Query Params (examples):
  ?match[created_at]=2020-09-09T23:00:00,2020-09-10T23:00:00
  ?different[rh_refusal_motive]=%00
  ?like[created_at]=2020-09
  ?paginate=200
  ?paginate=200&page=2
```

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

### GET /departamentos

Source: https://docs-api.convenia.com.br/historic

Retrieves a list of all departments within the organization.

```APIDOC
## GET /departamentos

### Description
Retrieves a list of all departments within the organization.

### Method
GET

### Endpoint
`/departamentos`

### Request Example
```json
{
  "example": "GET /departamentos"
}
```

### Response
#### Success Response (200)
- **id** (integer) - The department's unique identifier.
- **nome** (string) - The name of the department.

#### Response Example
```json
{
  "example": "[
    {
      "id": 1, 
      "nome": "Engenharia"
    },
    {
      "id": 2, 
      "nome": "Recursos Humanos"
    }
  ]"
}
```
```

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

### Create Department

Source: https://docs-api.convenia.com.br/index

Creates a new department for the company.

```APIDOC
## Create Department

### Description
Creates a new department for the company.

### Method
POST

### Endpoint
`https://public-api.convenia.com.br/api/v3/companies/departments`

### Headers
- **token** (string) - Required - Integration token generated on the Convenia platform.

### Request Body
- **name** (string) - Required - The name of the department.

### Response
#### Success Response (200)
- **message** (string) - The response message.
- **data** (object) - The data object containing the created department.
  - **id** (uuid) - The ID of the newly created department.
  - **name** (string) - The name of the department.
  - **company_id** (uuid) - The ID of the company.
- **redirect** (null) - Null value.
- **success** (boolean) - Indicates if the operation was successful.

#### Response Example
```json
{
  "message": "",
  "data": {
    "id": "4c3decd1-402d-412f-9024-ade3166be417",
    "name": "Nome do departamento",
    "company_id": "51eeeddf-25cb-4da1-88bb-82e8060080e6"
  },
  "redirect": null,
  "success": true
}
```
```