# Lista de empleos

## ▶️ Uso

Con el método List Employments, puedes:

1. [Requerido] Listar empleos relacionados con un link.id específico (usando el parámetro de consulta link).
2. Obtener los detalles de un employment.id específico (usando el parámetro de consulta id).

## 📖 Paginación

Este método devuelve una respuesta paginada (por defecto: 100 elementos por página). Puedes usar el parámetro de consulta page_size para aumentar el número de elementos devueltos hasta un máximo de 1000 elementos. Puedes usar el parámetro de consulta page para navegar a través de los resultados. Para más detalles sobre cómo navegar por las respuestas paginadas de Belvo, consulta nuestro artículo Consejos de Paginación.

## 🔦 Filtrado de Respuestas

Consulta la lista de campos a continuación para ver los campos por los que puedes filtrar tus respuestas. Para más información sobre cómo usar filtros, consulta nuestro artículo Filtrado de respuestas.

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

## Query parameters:

  - `link` (string, required)
    El link.id por el que deseas filtrar.
    Example: "8848bd0c-9c7e-4f53-a732-ec896b11d4c4"

  - `page_size` (integer)
    Indica cuántos resultados devolver por página. Por defecto, devolvemos 100 resultados por página.

ℹ️ El número mínimo de resultados devueltos por página es 1 y el máximo es 1000. Si introduces un valor mayor que 1000, nuestra API usará por defecto el valor máximo (1000).
    Example: 100

  - `page` (integer)
    Un número de página dentro del conjunto de resultados paginados.
    Example: 1

  - `id` (string)
    Devuelve información solo para este recurso id.
    Example: "24ccab1d-3a86-4136-a6eb-e04bf52b356f"

  - `id__in` (array)
    Devuelve información para estos ids de recursos.
    Example: ["6b3dea0f-be29-49d1-aabe-1a6d588642e6"]

  - `link__in` (array)
    Devuelve resultados solo para estos link.ids.
    Example: ["5722d0ba-69d7-42dc-8ff5-33767b83c5d6"]

  - `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.

  - `start_date` (string)
    Devuelve los empleos que comenzaron en esta fecha, en formato YYYY-MM-DD.
    Example: "2022-05-05"

  - `start_date__gt` (string)
    Devuelve los empleos que comenzaron después de esta fecha, en formato YYYY-MM-DD.
    Example: "2022-05-06"

  - `start_date__gte` (string)
    Devuelve los empleos que comenzaron en o después de esta fecha, en formato YYYY-MM-DD.
    Example: "2022-05-04"

  - `start_date__lt` (string)
    Devuelve los empleos que comenzaron antes de esta fecha, en formato YYYY-MM-DD.
    Example: "2022-03-02"

  - `start_date__lte` (string)
    Devuelve los empleos que comenzaron en o antes de esta fecha, en formato YYYY-MM-DD.
    Example: "2022-03-01"

  - `start_date__range` (array)
    Devuelve los empleos que comenzaron dentro de estas dos fechas, en formato YYYY-MM-DD,YYYY-MM-DD. El primer valor indica el inicio del rango y el segundo valor indica el final del rango.
    Example: ["2022-01-01","2022-12-31"]

  - `end_date` (string)
    Devuelve los empleos que finalizaron en esta fecha, en formato YYYY-MM-DD.
    Example: "2022-05-05"

  - `end_date__gt` (string)
    Devuelve los empleos que finalizaron después de esta fecha, en formato YYYY-MM-DD.
    Example: "2022-05-06"

  - `end_date__gte` (string)
    Devuelve los empleos que finalizaron en o después de esta fecha, en formato YYYY-MM-DD.
    Example: "2022-05-04"

  - `end_date__lt` (string)
    Devuelve los empleos que finalizaron antes de esta fecha, en formato YYYY-MM-DD.
    Example: "2022-03-02"

  - `end_date__lte` (string)
    Devuelve los empleos que finalizaron en o antes de esta fecha, en formato YYYY-MM-DD.
    Example: "2022-03-01"

  - `end_date__range` (array)
    Devuelve los empleos que finalizaron dentro de estas dos fechas, en formato YYYY-MM-DD,YYYY-MM-DD. El primer valor indica el inicio del rango y el segundo valor indica el final del rango.
    Example: ["2022-01-01","2022-12-31"]

  - `created_at` (string)
    Devuelve los elementos que se actualizaron por última vez en la base de datos de Belvo en esta fecha (en formato YYYY-MM-DD).
    Example: "2022-05-05"

  - `created_at__gt` (string)
    Devuelve los elementos que se actualizaron por última vez en la base de datos de Belvo después de esta fecha (en formato YYYY-MM-DD).
    Example: "2022-05-05"

  - `created_at__gte` (string)
    Devuelve los elementos que se actualizaron por última vez en la base de datos de Belvo después o en esta fecha (en formato YYYY-MM-DD).
    Example: "2022-05-04"

  - `created_at__lt` (string)
    Devuelve los elementos que se actualizaron por última vez en la base de datos de Belvo antes de esta fecha (en formato YYYY-MM-DD).
    Example: "2022-04-01"

  - `created_at__lte` (string)
    Devuelve los elementos que se actualizaron por última vez en la base de datos de Belvo antes o en esta fecha (en formato YYYY-MM-DD).
    Example: "2022-03-30"

  - `created_at__range` (array)
    Devolver cuentas que fueron actualizadas por última vez en la base de datos de Belvo entre dos fechas (en formato YYYY-MM-DD). El primer valor indica el inicio del rango y el segundo valor indica el final del rango.
    Example: ["2022-01-01","2022-12-31"]

## Response 200 fields (application/json):

  - `count` (integer)
    El número total de resultados en tu cuenta de Belvo.
    Example: 130

  - `next` (string,null)
    La URL a la siguiente página de resultados. Cada página consta de hasta 100 elementos. Si no hay suficientes resultados para una página adicional, el valor es null.

En nuestro ejemplo de documentación, usamos {endpoint} como un valor de marcador de posición. En producción, este valor será reemplazado por el endpoint real que estás utilizando actualmente (por ejemplo, accounts o owners).
    Example: "https://sandbox.belvo.com/api/{endpoint}/?link=1bd948f7-245d-4313-b604-34d1044cb908page=2"

  - `previous` (string,null)
    La URL a la página anterior de resultados. Si no hay una página anterior, el valor es null.

  - `results` (array)
    Matriz de objetos de empleo.

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

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

  - `results.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"

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

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

  - `results.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"

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

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

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

  - `results.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"

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

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

  - `results.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"

  - `results.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"

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

  - `results.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"

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

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

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

  - `results.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

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

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

## Response 403 fields (application/json):

  - `code` (string)
    Un código de error único (access_to_resource_denied) 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 403 access_to_resource_denied.
    Example: "access_to_resource_denied"

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

Para los errores access_to_resource_denied, la descripción es:

  - You don't have access to this resource..
    Example: "You don't have access to this resource."

  - `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 404 fields (application/json):

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

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

Para errores not_found, la descripción es:

  - Not found
    Example: "Not found"

  - `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 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 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"