> For the complete documentation index, see [llms.txt](https://acessorh.gitbook.io/project/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://acessorh.gitbook.io/project/v2/api/posicoes.md).

# Posições

Posições são as vagas, convites para os candidatos iniciarem o preenchimento do *"application"*  (formulário). Dentro da *position* estarão todos os dados preenchidos na criação da vaga, quanto os dados preenchidos pelo candidato ([Pessoas](/project/v2/referencias/documentos/brasil-1/pessoas.md) e [Documentos](/project/v2/referencias/documentos/brasil-1/brasil.md)).

## Create position

<mark style="color:green;">`POST`</mark> `https://api.acessorh.com.br/v2/positions`

Cria uma posição na filial selecionada.\
\
*Caso utilize as funcionalidades de Guia de Exame Médico e Carta de Abertura de Conta Bancária, será necessário antes criá-las através da chamada de Upload de Arquivos e então referenciar seus UIDs nos campos de Guia e Carta.*

#### Path Parameters

| Name          | Type   | Description                                                   |
| ------------- | ------ | ------------------------------------------------------------- |
| Authorization | string | Token ded acesso adquirido pela plataforma Identity(*Bearer*) |

{% tabs %}
{% tab title="201 " %}

```
{
    "code": 201,
    "messages": null,
    "result": {
        "position_id": "9ed9063b-ed1f-44f6-9b26-f3b57b64f632"
    },
    "status": "ok"
}
```

{% endtab %}
{% endtabs %}

* [Descrição do body JSON da request](/project/v2/api/posicoes.md#req-create-positions)
* [Exemplo de requisição](/project/v2/api/posicoes.md#exemplo-de-requisicao-1)

#### Descrição do body JSON da request <a href="#req-create-positions" id="req-create-positions"></a>

| Chave                                                                                                                                              | Tipo                         | Descrição                                                                          |
| -------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- | ---------------------------------------------------------------------------------- |
| <p><strong>numMatricula</strong></p><p>optional</p>                                                                                                | string                       | Número da matrícula                                                                |
| <p><strong>limitDate</strong></p><p><em>required</em></p>                                                                                          | string, format("YYYY-mm-dd") | Data limite para o preenchimento do cadastro                                       |
| <p><strong>admissionDate</strong></p><p><em>optional</em></p>                                                                                      | string, format("YYYY-mm-dd") | Data de admissão                                                                   |
| <p><strong>costCenter</strong></p><p><em>optional</em></p>                                                                                         | string                       | Centro de custo                                                                    |
| <p><strong>posNumber</strong></p><p><em>optional</em></p>                                                                                          | string                       | Número da posição                                                                  |
| <p><strong>role</strong></p><p><em>required</em></p>                                                                                               | string                       | UID ou código do cargo indicado para a vaga                                        |
| <p><strong>department</strong></p><p><em>required</em></p>                                                                                         | string                       | UID ou código do departamento indicado para a vaga                                 |
| <p><strong>unitID</strong></p><p><em>required</em></p>                                                                                             | string                       | UID da filial onde a posição será criada.                                          |
| <p><a href="/pages/-Lch6l0paus90ymSyWPz#pagamento"><strong>pagamento</strong></a></p><p><em>required</em></p>                                      | object                       | Informações sobre o pagamento                                                      |
| <p><strong>deficiencia</strong></p><p><em>required</em></p>                                                                                        | boolean                      | Indica se a vaga é PCD                                                             |
| <p><strong>jornada</strong></p><p><em>optional</em></p>                                                                                            | string                       | Informações sobre a jornada de trabalho                                            |
| <p><a href="/pages/-Lch6l0paus90ymSyWPz#profile"><strong>profile</strong></a></p><p><em>required</em></p>                                          | object                       | Informações de contato do candidato                                                |
| <p><a href="/pages/-Lch6l0paus90ymSyWPz#exame"><strong>exame</strong></a></p><p><em>optional</em></p>                                              | object                       | Informações sobre o agendamento de exame médico                                    |
| <p><a href="https://acessorh.gitbook.io/project/v/v2/referencias/documentos/brasil-1/brasil"><strong>docs</strong></a></p><p><em>optional</em></p> | array\[string]               | UIDs dos documentos adicionais a serem solicitados para a vaga                     |
| **benefits**                                                                                                                                       | array\[string]               | UIDs dos grupos de benefícios.(Obs.: Deverá ter apenas um por categoria.)          |
| <p><strong>sendSMS</strong></p><p><em>required</em></p>                                                                                            | boolean                      | Indica a necessidade do envio da notificação para o candidato através de um SMS    |
| <p><strong>sendEmail</strong></p><p><em>required</em></p>                                                                                          | boolean                      | Indica a necessidade do envio da notificação para o candidato através de um e-mail |

#### Pagamento

| Chave                                                                                                                  | Tipo                                                                       | Descrição                                                       |
| ---------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------- | --------------------------------------------------------------- |
| <p><strong>vinculo</strong></p><p><em>required</em></p>                                                                | string ([options](/project/v2/api/posicoes.md#opcoes-de-vinculo))          | Vínculo empregatício                                            |
| <p><strong>valor</strong></p><p><em>optional\*</em></p>                                                                | string                                                                     | Valor da remuneração                                            |
| <p><strong>recorrencia</strong></p><p><em>optional\*</em></p>                                                          | string ([options](/project/v2/api/posicoes.md#opcoes-de-recorrencia))      | Recorrência do pagamento                                        |
| <p><strong>dataInicio</strong></p><p><em>optional</em></p>                                                             | string, format("YYYY-mm-dd")                                               | Data de início do contrato de estágio ou aprendiz               |
| <p><strong>dataTermino</strong></p><p><em>optional</em></p>                                                            | string, format("YYYY-mm-dd")                                               | Data de término do contrato de estágio ou aprendiz              |
| <p><strong>agenteIntegrador</strong></p><p><em>optional</em></p>                                                       | string([options](/project/v2/api/posicoes.md#opcoes-de-agente-integrador)) | Agente integrador do contrato de estágio ou aprendiz            |
| <p><a href="/pages/-Lch6l0paus90ymSyWPz#conta-bancaria"><strong>contaBancaria</strong></a></p><p><em>optional</em></p> | object                                                                     | Dados referentes à  configuração de cartas de abertura de conta |

{% hint style="info" %}
Os campos de `recorrencia` e de `valor` são interdependentes. Caso um seja preenchido o outro se torna *required*.
{% endhint %}

#### Opções de vínculo

```
"clt", "estagio", "aprendiz", "autonomo", "temporario", "verde-amarelo", "intermitente", "estatuario"
```

#### Opções de recorrência

```
"horista", "mensalista", "aulista", "comissionista", "diarista"
```

#### Opções de agente integrador

```
"ciee", "nube", "senai", "senac", "mudes", "coep", "rede_cidada", "espro", "guarda_mirim", "outros"
```

#### Conta bancária

| Chave                                                      | Tipo                                                           | Descrição                                                      |
| ---------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| <p><strong>banco</strong></p><p><em>required</em></p>      | string([options](/project/v2/api/posicoes.md#opcoes-de-banco)) | Código do banco do qual a carta de abertura de conta se refere |
| <p><strong>carta</strong></p><p><em>optional\*</em></p>    | string                                                         | UID do arquivo contendo a carta de abertura de conta           |
| <p><strong>template</strong></p><p><em>optional\*</em></p> | string                                                         | UID do modelo de abertura de conta                             |

{% hint style="info" %}
Caso queira criar a posição com uma carta de abertura de conta anexada, é necessário realizar o seu upload antes.

Apenas uma opção deve ser escolhida: carta ou template.

O ID do modelo de carta pode ser encontrado no próprio módulo de criação dentro do Acesso RH.
{% endhint %}

#### Opções de banco

```
"001", "033", "041", "047", "104", "151", "237", "341", "399", "735", "745", "748", "755"
```

#### Profile

| Chave                                                  | Tipo                          | Descrição                      |
| ------------------------------------------------------ | ----------------------------- | ------------------------------ |
| <p><strong>name</strong></p><p><em>required</em></p>   | string                        | Nome do candidato              |
| <p><strong>email</strong></p><p><em>required</em></p>  | string                        | E-mail do candidato            |
| <p><strong>mobile</strong></p><p><em>required</em></p> | string, format("11911111111") | Número do celular do candidato |

#### Exame <a href="#exame" id="exame"></a>

| Chave                                                   | Tipo                         | Descrição                                      |
| ------------------------------------------------------- | ---------------------------- | ---------------------------------------------- |
| <p><strong>clinica</strong></p><p><em>required</em></p> | string                       | UID ou código da clínica                       |
| <p><strong>data</strong></p><p><em>optional</em></p>    | string, format("YYYY-mm-dd") | Data do agendamento                            |
| <p><strong>hora</strong></p><p><em>optional</em></p>    | string, format("HH:MM")      | Hora do agendamento                            |
| <p><strong>obs</strong></p><p><em>optional</em></p>     | string                       | Observações do agendamento                     |
| <p><strong>guia</strong></p><p><em>optional\*</em></p>  | string                       | UID do arquivo contendo a guia do exame médico |

{% hint style="info" %}
**Obs**: Os campos *data*, *hora* e *obs*, não são obrigatórios mas é indicado que eles sejam preenchidos pois são essas informações que serão disponibilizadas para os candidatos no momento do preenchimento da vaga.

**\*guia**: Caso queira criar a posição com uma guia de exame médico anexada, é necessário realizar o seu upload antes.
{% endhint %}

### Exemplo de requisição <a href="#exemplo-de-requisicao-1" id="exemplo-de-requisicao-1"></a>

```
{
  "numMatricula": "4242424",
  "limitDate": "2018-01-01",
  "admissionDate": "2018-01-01",
  "costCenter": "anywhere",
  "posNumber": "pos-test",
  "role": "b63e065f-d7e0-49e1-91b7-88f74516e3fe",
  "department": "bf559996-a8b9-4f5e-af57-86111b0dbde3",
  "unitID": "e37dab24-c7a4-4b92-b9d1-d2ed538b8398",
  "pagamento": {
    "vinculo": "clt",
    "valor": "4200",
    "recorrencia": "mensalista",
    "contaBancaria": {
      "banco": "001",
      "carta": "c9160763-db6c-4e8c-a1ad-ad8709c99be2"
    }
  },
  "deficiencia": false,
  "jornada": "De segunda a sexta das 15 as 19",
  "profile": {
    "name": "John Doe",
    "email": "john.doe@acessodigital.com.br",
    "mobile": "11911111111"
  },
  "exame": {
    "clinica": "6dc84ce4-7d9f-48ec-b9b1-a8a895a21fd4",
    "data": "2018-01-01",
    "hora": "14:00",
    "obs":descricao-do-body-json-da-request-1 "Comparecer de manhã",
    "guia": "e37dab24-c7a4-4b92-b9d1-32ed538b8300",
  },
  "docs": ["c9e26093-5e0c-4bd2-bea3-ac5182a6179f"],
  "benefits": ["d4260f8d-f19a-463d-acdf-958ed358bb43"],
  "sendSMS": true,
  "sendEmail": true
}
```

## Export position

<mark style="color:green;">`POST`</mark> `https://api.acessorh.com.br/v2/positions/export`

Exporta posições conforme o filtro informado no formato selecionado.

#### Headers

| Name          | Type   | Description                                                   |
| ------------- | ------ | ------------------------------------------------------------- |
| Authorization | string | Token de acesso adquirido pela plataforma Identity *(bearer)* |

{% tabs %}
{% tab title="200 " %}

```
```

{% endtab %}
{% endtabs %}

* [Descrição do body JSON da request](/project/v2/api/posicoes.md#descricao-do-body-json-da-request-2)
* [Exemplo de requisição](/project/v2/api/posicoes.md#exemplo-de-requisicao)

### Descrição do body JSON da request <a href="#descricao-do-body-json-da-request-2" id="descricao-do-body-json-da-request-2"></a>

| Chave                                                                                                           | Tipo                                                            | Descrição                                            |
| --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | ---------------------------------------------------- |
| <p><strong>account</strong></p><p><em>optional\*</em></p>                                                       | string                                                          | UID da empresa                                       |
| <p><strong>units</strong></p><p><em>optional\*</em></p>                                                         | array\[string]                                                  | UID das filiais                                      |
| <p><strong>limit</strong></p><p><em>optional</em></p>                                                           | integer                                                         | Quantidade limite de resultados (paginação)          |
| <p><strong>skip</strong></p><p><em>optional</em></p>                                                            | integer                                                         | Quantidade de resultados a serem pulados (paginação) |
| <p><strong>template</strong></p><p><em>required</em></p>                                                        | string([options](/project/v2/referencias/templates.md))         | Formatação do resultado da consulta                  |
| <p><strong>templateOptions</strong></p><p><em>optional</em></p>                                                 | object                                                          | Opções complementares à formatação do resultado      |
| <p><strong>sort</strong></p><p><em>optional</em></p>                                                            | string([options](/project/v2/api/posicoes.md#opcoes-de-sort))   | Ordenação dos resultados                             |
| <p><strong>status</strong></p><p><em>optional</em></p>                                                          | string([options](/project/v2/api/posicoes.md#opcoes-de-status)) | Filtro de status das posições                        |
| <p><a href="/pages/-Lch6l0paus90ymSyWPz#filtro-por-data"><strong>dates</strong></a></p><p><em>optional</em></p> | object                                                          | Filtro de resultado por data                         |

{% hint style="warning" %}
Um dos dois parâmetros,`account` ou `units,`deve ser enviado.

O máximo de resultados permitidos em uma requisição é 100. Caso o parâmetro `limit` não seja enviado, ele será definido como 100.
{% endhint %}

#### Opções de sort

```
"created", "-created", "updated", "-updated"
```

{% hint style="info" %}
As opções que contem o símbolo `-`  no início, são utilizadas quando a ordenação desejada é decrescente.
{% endhint %}

#### Opções de status

```
"pending", "review", "validation", "completed",	"archived"
```

| Status     | Descrição                           |
| ---------- | ----------------------------------- |
| pending    | Posições pendentes de preenchimento |
| review     | Posições em correção após análise   |
| validation | Posições em análise                 |
| completed  | Posições preenchidas e validadas    |
| archived   | Posições arquivadas                 |

#### Filtro por data

| Chave                                                                                                                  | Tipo   | Descrição                              |
| ---------------------------------------------------------------------------------------------------------------------- | ------ | -------------------------------------- |
| <p><a href="/pages/-Lch6l0paus90ymSyWPz#range-de-datas"><strong>admissionDate</strong></a></p><p><em>optional</em></p> | object | Range da data de admissão do candidato |

#### Range de datas

| Chave                                                 | Tipo   | Descrição   |
| ----------------------------------------------------- | ------ | ----------- |
| <p><strong>start</strong></p><p><em>required</em></p> | string | Data início |
| <p><strong>end</strong></p><p><em>required</em></p>   | string | Data fim    |

### Exemplo de requisição

```javascript
{
    "account": "2d9174c4-06b7-4956-a5dc-8824d8a2f49e",
    "limit": 100,
    "skip": 0,
    "template": "csv-v2.2",
    "sort": "-created",
    "status": [ "pending" ],
    "dates": {
       "admissionDate": {
           "start": "2020-09-01",
            "end": "2020-09-30"
        } 
    }
}
```