# Recuperar empregos para um link

Recuperar empregos de um link existente.

Endpoint: POST /api/br/employments/
Version: 1.223.0
Security: basicAuth

## Header parameters:

  - `X-Belvo-Request-Mode` (string)
    Parâmetro de cabeçalho recomendado para tornar sua solicitação POST assíncrona (evitando timeouts e melhorando o fluxo de dados).

Quando você faz uma solicitação assíncrona, a Belvo responde com um payload 202 - Accepted, incluindo o request_id. Assim que tivermos recuperado as informações solicitadas, você receberá um webhook com o link e os IDs de solicitação.
    Enum: "async"

## Query parameters:

  - `omit` (string)
    Omitir certos campos de serem retornados na resposta. Para mais informações, consulte nosso artigo Filtrando respostas no DevPortal.

  - `fields` (string)
    Retorne apenas os campos especificados na resposta. Para mais informações, consulte nosso artigo no DevPortal Filtrando respostas.

## Request fields (application/json):

  - `link` (string, required)
    O link.id para o qual você deseja recuperar informações.
    Example: "c81a1dea-6dd6-4999-8b9f-541ee8197058"

  - `date_from` (string)
    A data a partir da qual você deseja começar a obter dados, no formato YYYY-MM-DD.

⚠️ O valor de date_from não pode ser maior que date_to.
    Example: "2020-08-05"

  - `date_to` (string)
    A data em que você deseja parar de receber dados, no formato YYYY-MM-DD.

⚠️ O valor de date_to não pode ser maior que a data de hoje (ou seja, não são permitidas datas futuras).
    Example: "2020-10-05"

  - `save_data` (boolean)
    Indica se os dados devem ou não ser persistidos no Belvo. Por padrão, isso é definido como true e retornamos uma resposta 201 Created.

Quando definido como false, os dados não serão persistidos e retornamos uma resposta 200 OK.
    Example: true

## Response 200 fields (application/json):

  - `id` (string, required)
    Identificador único da Belvo para o item atual.
    Example: "0d3ffb69-f83b-456e-ad8e-208d0998d71d"

  - `link` (string,null, required)
    O link.id ao qual os dados pertencem.
    Example: "30cb4806-6e00-48a4-91c9-ca55968576c8"

  - `created_at` (string, required)
    O carimbo de data e hora ISO-8601 de quando o ponto de dados foi criado no banco de dados da Belvo.
    Example: "2022-02-09T08:45:50.406032Z"

  - `collected_at` (string, required)
    O carimbo de data/hora ISO-8601 quando o ponto de dados foi coletado.
    Example: "2022-02-09T08:45:50.406032Z"

  - `start_date` (string, required)
    A data de início do funcionário no empregador, no formato YYYY-MM-DD.
    Example: "2022-01-01"

  - `end_date` (string,null, required)
    A data de término do funcionário na empresa, no formato YYYY-MM-DD. Se for null, o funcionário ainda está trabalhando na empresa.
    Example: "2023-01-01"

  - `employer_data` (object, required)
    Detalhes sobre o empregador.

  - `employer_data.name` (string, required)
    O nome do empregador.
    Example: "Wayne Industries"

  - `employer_data.code` (string, required)
    O código único da instituição para o empregador.
    Example: "49430669"

  - `employer_data.economic_activity` (string, required)
    A principal atividade econômica em que o empregador está envolvido. Para o Brasil, este é o código da Classificação Nacional de Atividades Econômicas (CNAE).
    Example: "6421-2 - BANCOS COMERCIAIS"

  - `occupations` (array, required)
    As ocupações do funcionário no empregador.

  - `occupations.start_date` (string, required)
    A data em que o funcionário começou na posição, no formato YYYY-MM-DD.
    Example: "2022-01-01"

  - `occupations.end_date` (string,null, required)
    A data em que o funcionário parou de trabalhar nesta posição, no formato YYYY-MM-DD. Se for null, isso significa que o funcionário ainda ocupa esta posição.
    Example: "2023-01-01"

  - `occupations.description` (string, required)
    A posição que o funcionário ocupava. Para o Brasil, essa descrição deve estar de acordo com o Ministério do Trabalho e listada na Classificação Brasileira de Ocupações (CBO).
    Example: "ANALISTA DE PRODUTOS BANCARIOS"

  - `occupations.name` (string, required)
    A ocupação dos funcionários, conforme fornecida pelo empregador.
    Example: "ANALISTA DE PRODUTOS BANCARIOS - 2525-40"

  - `occupations.locale` (string, required)
    Onde o funcionário cumpriu suas funções. Para o Brasil, isso pode ser:
  - Urbana (Urbano)
  - Rural
  - Não Identificado
  - null
    Example: "Urbana"

  - `salaries` (array, required)
    Os salários que o funcionário recebeu do empregador.

  - `salaries.base_amount` (number, required)
    O valor base do salário, antes de quaisquer deduções ou bônus.
    Example: 1033.09

  - `salaries.retained_amount` (number, required)
    O valor retido pelo Instituto Nacional do Seguro Social (INSS) do Brasil.
    Example: 0.01

  - `salaries.type` (string,null)
    O tipo de salário.

Retornamos um dos seguintes valores:
  - REGULAR
  - THIRTEENTH
  - VOLUNTARY
  - RETIREMENT
  - null
    Enum: "REGULAR", "THIRTEENTH", "VOLUNTARY", "RETIREMENT", null

  - `salaries.month` (string, required)
    O mês em que o funcionário recebeu seu salário, no formato YYYY-MM.
    Example: "2022-01"

  - `salaries.currency` (string, required)
    O código de moeda de três letras (ISO-4217).
    Example: "BRL"

## Response 202 fields (application/json):

  - `request_id` (string)
    O ID único para esta solicitação. Recomendamos que você armazene este valor para identificar posteriormente qual evento de webhook está relacionado a uma solicitação assíncrona.
    Example: "b5d0106ac9cc43d5b36199fe831f6bbe"

## Response 408 fields (application/json):

  - `code` (string)
    Um código de erro único (request_timeout) que permite classificar e lidar com o erro programaticamente.

ℹ️ Consulte nosso DevPortal para mais informações sobre como lidar com erros 408 request_timeout.
    Example: "request_timeout"

  - `message` (string)
    Uma breve descrição do erro.

Para erros de request_timeout, a descrição é:

  - The request timed out, you can retry asking for less data by changing your query parameters.
    Example: "The request timed out, you can retry asking for less data by changing your query parameters"

  - `request_id` (string)
    Um ID único de 32 caracteres da solicitação (correspondente a um padrão regex de: [a-f0-9]{32}). Forneça este ID ao entrar em contato com a equipe de suporte da Belvo para acelerar as investigações.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"

## Response 428 fields (application/json):

  - `code` (string)
    Um código de erro único (token_required) que permite classificar e lidar com o erro programaticamente.
ℹ️ Consulte nosso DevPortal para mais informações sobre como lidar com erros 428 token_required.
    Example: "token_required"

  - `message` (string)
    Uma breve descrição do erro. Para erros token_required, a descrição é:

- A instituição requer um token MFA para fazer login.
    Example: "A MFA token is required by the institution to login"

  - `request_id` (string)
    Um ID único de 32 caracteres da solicitação (correspondente a um padrão regex de: [a-f0-9]{32}). Forneça este ID ao entrar em contato com a equipe de suporte da Belvo para acelerar as investigações.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"

  - `session` (string)
    Um ID único de 32 caracteres da sessão de login (correspondente a um padrão regex de: [a-f0-9]{32}).
    Example: "2675b703b9d4451f8d4861a3eee54449"

  - `expiry` (integer)
    Tempo de duração da sessão em segundos.
    Example: 9600

  - `link` (string)
    Identificador único criado pela Belvo, usado para referenciar o Link atual.
    Example: "30cb4806-6e00-48a4-91c9-ca55968576c8"

  - `token_generation_data` (object)
    Detalhes sobre como gerar o token.

  - `token_generation_data.instructions` (string)
    Instruções para geração de token.
    Example: "Use this code to generate the token"

  - `token_generation_data.type` (string)
    Tipo de dados para gerar o token (QR code, desafio numérico).
    Example: "numeric"

  - `token_generation_data.value` (string)
    Valor a ser usado para gerar o token.
    Example: "12345"

  - `token_generation_data.expects_user_input` (boolean)
    Indica se o usuário precisa fornecer entrada para concluir a autenticação. Quando definido como false, seu usuário pode precisar:
- confirmar o login em outro dispositivo
- escanear um código QR
Você ainda precisará fazer uma chamada PATCH para concluir a solicitação.
    Example: true

## Response 500 fields (application/json):

  - `code` (string)
    Um código de erro único (unexpected_error) que permite classificar e tratar o erro de forma programática.

ℹ️ Consulte nosso DevPortal para mais informações sobre como lidar com erros 500 unexpected_error.
    Example: "unexpected_error"

  - `message` (string)
    Uma breve descrição do erro.

Para erros unexpected_error, a descrição é:

  - Belvo não consegue processar a solicitação devido a um problema interno do sistema ou a uma resposta não suportada de uma instituição.
    Example: "Belvo is unable to process the request due to an internal system issue or to an unsupported response from an institution"

  - `request_id` (string)
    Um ID único de 32 caracteres da solicitação (correspondente a um padrão regex de: [a-f0-9]{32}). Forneça este ID ao entrar em contato com a equipe de suporte da Belvo para acelerar as investigações.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"