# Listar empregos

## ▶️ Uso

Com o método List Employments, você pode:

1. [Obrigatório] Listar empregos relacionados a um link.id específico (usando o parâmetro de consulta link).
2. Obter os detalhes de um employment.id específico (usando o parâmetro de consulta id).

## 📖 Paginação

Este método retorna uma resposta paginada (padrão: 100 itens por página). Você pode usar o parâmetro de consulta page_size para aumentar o número de itens retornados até um máximo de 1000 itens. Você pode usar o parâmetro de consulta page para navegar pelos resultados. Para mais detalhes sobre como navegar pelas respostas paginadas do Belvo, consulte nosso artigo Dicas de Paginação.

## 🔦 Filtrando Respostas

Consulte a lista de consultas abaixo para ver uma lista de campos pelos quais você pode filtrar suas respostas. Para mais informações sobre como usar filtros, consulte nosso artigo Filtrando respostas.

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

## Query parameters:

  - `link` (string, required)
    O link.id pelo qual você deseja filtrar.
    Example: "8848bd0c-9c7e-4f53-a732-ec896b11d4c4"

  - `page_size` (integer)
    Indica quantos resultados retornar por página. Por padrão, retornamos 100 resultados por página.

ℹ️ O número mínimo de resultados retornados por página é 1 e o máximo é 1000. Se você inserir um valor maior que 1000, nossa API usará o valor máximo por padrão (1000).
    Example: 100

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

  - `id` (string)
    Retorne informações apenas para este recurso id.
    Example: "24ccab1d-3a86-4136-a6eb-e04bf52b356f"

  - `id__in` (array)
    Retorne informações para esses ids de recurso.
    Example: ["6b3dea0f-be29-49d1-aabe-1a6d588642e6"]

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

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

  - `start_date` (string)
    Retorne os empregos que começaram nesta data, no formato YYYY-MM-DD.
    Example: "2022-05-05"

  - `start_date__gt` (string)
    Retorne os empregos que começaram após esta data, no formato YYYY-MM-DD.
    Example: "2022-05-06"

  - `start_date__gte` (string)
    Retorne os empregos que começaram nesta data ou após, no formato YYYY-MM-DD.
    Example: "2022-05-04"

  - `start_date__lt` (string)
    Retorne os empregos que começaram antes desta data, no formato YYYY-MM-DD.
    Example: "2022-03-02"

  - `start_date__lte` (string)
    Retorne os empregos que começaram nesta data ou antes, no formato YYYY-MM-DD.
    Example: "2022-03-01"

  - `start_date__range` (array)
    Retorne os empregos que começaram entre essas duas datas, no formato YYYY-MM-DD,YYYY-MM-DD. O primeiro valor indica o início do intervalo e o segundo valor indica o final do intervalo.
    Example: ["2022-01-01","2022-12-31"]

  - `end_date` (string)
    Retorne os empregos que terminaram nesta data, no formato YYYY-MM-DD.
    Example: "2022-05-05"

  - `end_date__gt` (string)
    Retorne os empregos que terminaram após esta data, no formato YYYY-MM-DD.
    Example: "2022-05-06"

  - `end_date__gte` (string)
    Retorne os empregos que terminaram nesta data ou depois, no formato YYYY-MM-DD.
    Example: "2022-05-04"

  - `end_date__lt` (string)
    Retorne os empregos que terminaram antes desta data, no formato YYYY-MM-DD.
    Example: "2022-03-02"

  - `end_date__lte` (string)
    Retorne os empregos que terminaram nesta data ou antes, no formato YYYY-MM-DD.
    Example: "2022-03-01"

  - `end_date__range` (array)
    Retorne os empregos que terminaram dentro dessas duas datas, no formato YYYY-MM-DD,YYYY-MM-DD. O primeiro valor indica o início do intervalo e o segundo valor indica o final do intervalo.
    Example: ["2022-01-01","2022-12-31"]

  - `created_at` (string)
    Retorne itens que foram atualizados pela última vez no banco de dados da Belvo nesta data (no formato YYYY-MM-DD).
    Example: "2022-05-05"

  - `created_at__gt` (string)
    Retorne itens que foram atualizados pela última vez no banco de dados da Belvo após esta data (no formato YYYY-MM-DD).
    Example: "2022-05-05"

  - `created_at__gte` (string)
    Retorne itens que foram atualizados pela última vez no banco de dados da Belvo após ou nesta data (no formato YYYY-MM-DD).
    Example: "2022-05-04"

  - `created_at__lt` (string)
    Retorne itens que foram atualizados pela última vez no banco de dados da Belvo antes desta data (no formato YYYY-MM-DD).
    Example: "2022-04-01"

  - `created_at__lte` (string)
    Retorne itens que foram atualizados pela última vez no banco de dados da Belvo antes ou na data especificada (no formato YYYY-MM-DD).
    Example: "2022-03-30"

  - `created_at__range` (array)
    Retorne contas que foram atualizadas pela última vez no banco de dados do Belvo entre duas datas (no formato YYYY-MM-DD). O primeiro valor indica o início do intervalo e o segundo valor indica o final do intervalo.
    Example: ["2022-01-01","2022-12-31"]

## Response 200 fields (application/json):

  - `count` (integer)
    O número total de resultados na sua conta Belvo.
    Example: 130

  - `next` (string,null)
    A URL para a próxima página de resultados. Cada página consiste em até 100 itens. Se não houver resultados suficientes para uma página adicional, o valor será null.

Em nosso exemplo de documentação, usamos {endpoint} como um valor de espaço reservado. Em produção, esse valor será substituído pelo endpoint real que você está usando atualmente (por exemplo, accounts ou owners).
    Example: "https://sandbox.belvo.com/api/{endpoint}/?link=1bd948f7-245d-4313-b604-34d1044cb908page=2"

  - `previous` (string,null)
    A URL para a página anterior de resultados. Se não houver uma página anterior, o valor será null.

  - `results` (array)
    Array de objetos de emprego.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

## Response 403 fields (application/json):

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

ℹ️ Consulte nosso DevPortal para mais informações sobre como lidar com 403 access_to_resource_denied.
    Example: "access_to_resource_denied"

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

Para erros access_to_resource_denied, a descrição é:

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

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

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

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

Para erros not_found, a descrição é:

  - Not found
    Example: "Not found"

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