# Recuperar empleos para un enlace

Recuperar empleos de un enlace existente.

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

## Header parameters:

  - `X-Belvo-Request-Mode` (string)
    Parámetro de encabezado recomendado para hacer que tu solicitud POST sea asincrónica (evitando así tiempos de espera y mejorando el flujo de datos).

Cuando realizas una solicitud asincrónica, Belvo responde con un payload 202 - Accepted, que incluye el request_id. Una vez que hayamos recuperado la información solicitada, recibirás un webhook con el enlace y los IDs de solicitud.
    Enum: "async"

## Query parameters:

  - `omit` (string)
    Omite ciertos campos para que no se devuelvan en la respuesta. Para más información, consulta nuestro artículo del DevPortal Filtrando respuestas.

  - `fields` (string)
    Devuelve solo los campos especificados en la respuesta. Para obtener más información, consulta nuestro artículo del DevPortal Filtrando respuestas.

## Request fields (application/json):

  - `link` (string, required)
    El link.id para el que deseas recuperar información.
    Example: "c81a1dea-6dd6-4999-8b9f-541ee8197058"

  - `date_from` (string)
    La fecha desde la cual deseas comenzar a obtener datos, en formato YYYY-MM-DD.

⚠️ El valor de date_from no puede ser mayor que date_to.
    Example: "2020-08-05"

  - `date_to` (string)
    La fecha en la que deseas dejar de recibir datos, en formato YYYY-MM-DD.

⚠️ El valor de date_to no puede ser mayor que la fecha de hoy (en otras palabras, no se permiten fechas futuras).
    Example: "2020-10-05"

  - `save_data` (boolean)
    Indica si se debe o no persistir los datos en Belvo. Por defecto, esto está configurado en true y devolvemos una respuesta 201 Created.

Cuando se establece en false, los datos no se persistirán y devolvemos una respuesta 200 OK.
    Example: true

## Response 200 fields (application/json):

  - `id` (string, required)
    Identificador único de Belvo para el elemento actual.
    Example: "0d3ffb69-f83b-456e-ad8e-208d0998d71d"

  - `link` (string,null, required)
    El link.id al que pertenecen los datos.
    Example: "30cb4806-6e00-48a4-91c9-ca55968576c8"

  - `created_at` (string, required)
    La marca de tiempo ISO-8601 de cuando se creó el punto de datos en la base de datos de Belvo.
    Example: "2022-02-09T08:45:50.406032Z"

  - `collected_at` (string, required)
    La marca de tiempo ISO-8601 cuando se recopiló el punto de datos.
    Example: "2022-02-09T08:45:50.406032Z"

  - `start_date` (string, required)
    La fecha de inicio del empleado en el empleador, en formato YYYY-MM-DD.
    Example: "2022-01-01"

  - `end_date` (string,null, required)
    La fecha de finalización del empleado en el empleador, en formato YYYY-MM-DD. Si es null, el empleado todavía está trabajando en el empleador.
    Example: "2023-01-01"

  - `employer_data` (object, required)
    Detalles sobre el empleador.

  - `employer_data.name` (string, required)
    El nombre del empleador.
    Example: "Wayne Industries"

  - `employer_data.code` (string, required)
    El código único de la institución para el empleador.
    Example: "49430669"

  - `employer_data.economic_activity` (string, required)
    La principal actividad económica en la que está involucrado el empleador. Para Brasil, este es el código de la Classificação Nacional de Atividades Econômicas (CNAE).
    Example: "6421-2 - BANCOS COMERCIAIS"

  - `occupations` (array, required)
    Las ocupaciones del empleado en el empleador.

  - `occupations.start_date` (string, required)
    La fecha en que el empleado comenzó el puesto, en formato YYYY-MM-DD.
    Example: "2022-01-01"

  - `occupations.end_date` (string,null, required)
    La fecha en que el empleado dejó de trabajar en este puesto, en formato YYYY-MM-DD. Si es null, esto significa que el empleado aún ocupa este puesto.
    Example: "2023-01-01"

  - `occupations.description` (string, required)
    El puesto que ocupaba el empleado. Para Brasil, esta descripción debe estar de acuerdo con el Ministerio de Trabajo y figurar en la Classificação Brasileira de Ocupações (CBO).
    Example: "ANALISTA DE PRODUTOS BANCARIOS"

  - `occupations.name` (string, required)
    La ocupación de los empleados, según lo proporcionado por el empleador.
    Example: "ANALISTA DE PRODUTOS BANCARIOS - 2525-40"

  - `occupations.locale` (string, required)
    Donde el empleado cumplió con sus deberes. Para Brasil, esto puede ser:
  - Urbana (Urbano)
  - Rural (Rural)
  - Não Identificado
  - null
    Example: "Urbana"

  - `salaries` (array, required)
    Los salarios que el empleado recibió del empleador.

  - `salaries.base_amount` (number, required)
    El monto base del salario, antes de cualquier deducción o bonificación.
    Example: 1033.09

  - `salaries.retained_amount` (number, required)
    El monto retenido por el Instituto Nacional do Seguro Social (INSS) de Brasil.
    Example: 0.01

  - `salaries.type` (string,null)
    El tipo de salario.

Devolvemos uno de los siguientes valores:
  - REGULAR
  - THIRTEENTH
  - VOLUNTARY
  - RETIREMENT
  - null
    Enum: "REGULAR", "THIRTEENTH", "VOLUNTARY", "RETIREMENT", null

  - `salaries.month` (string, required)
    El mes en que el empleado recibió su salario, en formato YYYY-MM.
    Example: "2022-01"

  - `salaries.currency` (string, required)
    El código de moneda de tres letras (ISO-4217).
    Example: "BRL"

## Response 202 fields (application/json):

  - `request_id` (string)
    El ID único para esta solicitud. Recomendamos que almacene este valor para identificar más tarde qué evento de webhook se relaciona con una solicitud asincrónica.
    Example: "b5d0106ac9cc43d5b36199fe831f6bbe"

## Response 408 fields (application/json):

  - `code` (string)
    Un código de error único (request_timeout) que te permite clasificar y manejar el error de manera programática.

ℹ️ Consulta nuestro DevPortal para obtener más información sobre cómo manejar errores 408 request_timeout.
    Example: "request_timeout"

  - `message` (string)
    Una breve descripción del error.

Para los errores de request_timeout, la descripción es:

  - 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)
    Un ID único de 32 caracteres de la solicitud (que coincide con un patrón regex de: [a-f0-9]{32}). Proporcione este ID al contactar al equipo de soporte de Belvo para acelerar las investigaciones.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"

## Response 428 fields (application/json):

  - `code` (string)
    Un código de error único (token_required) que te permite clasificar y manejar el error de forma programática. ℹ️ Consulta nuestro DevPortal para obtener más información sobre cómo manejar errores 428 token_required.
    Example: "token_required"

  - `message` (string)
    Una breve descripción del error. 
Para los errores token_required, la descripción es:

  - A MFA token is required by the institution to login.
    Example: "A MFA token is required by the institution to login"

  - `request_id` (string)
    Un ID único de 32 caracteres de la solicitud (que coincide con un patrón regex de: [a-f0-9]{32}). Proporcione este ID al contactar al equipo de soporte de Belvo para acelerar las investigaciones.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"

  - `session` (string)
    Un ID único de 32 caracteres de la sesión de inicio de sesión (que coincide con un patrón de regex de: [a-f0-9]{32}).
    Example: "2675b703b9d4451f8d4861a3eee54449"

  - `expiry` (integer)
    Tiempo de duración de la sesión en segundos.
    Example: 9600

  - `link` (string)
    Identificador único creado por Belvo, utilizado para referenciar el Link actual.
    Example: "30cb4806-6e00-48a4-91c9-ca55968576c8"

  - `token_generation_data` (object)
    Detalles sobre cómo generar el token.

  - `token_generation_data.instructions` (string)
    Instrucciones para la generación de tokens.
    Example: "Use this code to generate the token"

  - `token_generation_data.type` (string)
    Tipo de datos para generar el token (código QR, desafío numérico).
    Example: "numeric"

  - `token_generation_data.value` (string)
    Valor a utilizar para generar el token.
    Example: "12345"

  - `token_generation_data.expects_user_input` (boolean)
    Indica si el usuario necesita proporcionar información para completar la autenticación. Cuando se establece en false, es posible que su usuario necesite:
- confirmar el inicio de sesión en otro dispositivo
- escanear un código QR
Aún necesitará realizar una llamada PATCH para completar la solicitud.
    Example: true

## Response 500 fields (application/json):

  - `code` (string)
    Un código de error único (unexpected_error) que te permite clasificar y manejar el error de manera programática.

ℹ️ Consulta nuestro DevPortal para obtener más información sobre cómo manejar errores 500 unexpected_error.
    Example: "unexpected_error"

  - `message` (string)
    Una breve descripción del error.

Para los errores unexpected_error, la descripción es:

- Belvo no puede procesar la solicitud debido a un problema interno del sistema o a una respuesta no soportada de una institución.
    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)
    Un ID único de 32 caracteres de la solicitud (que coincide con un patrón regex de: [a-f0-9]{32}). Proporcione este ID al contactar al equipo de soporte de Belvo para acelerar las investigaciones.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"