# Obter detalhes de uma renda

Obtenha os detalhes de uma renda específica.

Endpoint: GET /api/incomes/{id}/
Version: 1.223.0
Security: basicAuth

## Path parameters:

  - `id` (string, required)
    O income.id sobre o qual você deseja obter informações detalhadas.

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

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

  - `income_streams` (array, required)
    Um array de objetos de fluxo de renda enriquecidos.

  - `income_streams.account_id` (string, required)
    ID único para a conta bancária a ser verificada para fluxos de renda.
    Example: "EBACA-89077589"

  - `income_streams.income_type` (string, required)
    O tipo de renda usado nos cálculos.

Retornamos um dos seguintes valores do enum:

  - SALARY
  - GOVERNMENT
  - INTEREST
  - RENT
  - RETIREMENT
  - FREELANCE
  - ALTERNATIVE_INCOME
  - TRANSFER
  - DEPOSIT
  - UNKNOWN
    Enum: "SALARY", "GOVERNMENT", "INTEREST", "RENT", "RETIREMENT", "FREELANCE", "ALTERNATIVE_INCOME", "TRANSFER", "DEPOSIT", "UNKNOWN"

  - `income_streams.frequency` (string, required)
    Com que frequência a renda é recebida.

Retornamos um dos seguintes valores do enum:

- MONTHLY - Para transações que ocorrem uma vez por mês.
- FORTNIGHTLY - Para transações que ocorrem uma vez a cada duas semanas.
- WEEKLY - Para transações que ocorrem uma vez por semana.
- IRREGULAR - Para transações que não ocorrem em um padrão de frequência definido.
- SINGLE - Para transações que ocorrem apenas uma vez e não se repetem.
    Enum: "MONTHLY", "FORTNIGHTLY", "WEEKLY", "IRREGULAR", "SINGLE"

  - `income_streams.monthly_average` (number, required)
    A quantidade média de renda recebida da fonte durante periods_with_income.
    Example: 2500

  - `income_streams.monthly_median` (number)
    A quantidade mediana de renda recebida da fonte ao longo de um mês natural.
    Example: 2200

  - `income_streams.average_income_amount` (number, required)
    O valor médio da transação de renda da fonte.
    Example: 2500

  - `income_streams.last_income_amount` (number, required)
    O valor da renda mais recente recebida da fonte.
    Example: 2500

  - `income_streams.currency` (string, required)
    O código de moeda de três letras da receita. Por exemplo:

  • 🇧🇷 BRL (Real Brasileiro)
  • 🇨🇴 COP (Peso Colombiano)
  • 🇲🇽 MXN (Peso Mexicano)
    Example: "BRL"

  - `income_streams.last_income_description` (string, required)
    A descrição da receita mais recente do stream.
    Example: "Salário"

  - `income_streams.last_income_date` (string, required)
    A data em que a receita mais recente do stream foi recebida, no formato YYYY-MM-DD.
    Example: "2023-02-09"

  - `income_streams.stability` (number,null, required)
    A estabilidade da renda com base em seu valor, com um intervalo de 0 a 1, onde 1 representa estabilidade perfeita.

Nota: Para transações com frequency=SINGLE, este valor retorna null.
    Example: 1

  - `income_streams.regularity` (number,null, required)
    A regularidade da renda é baseada em sua frequência, com um intervalo de 0 a 1, onde 1 representa regularidade perfeita.

Nota: Para transações com frequency=SINGLE, este valor retorna null.
    Example: 1

  - `income_streams.trend` (number,null, required)
    A tendência de renda durante um período de tempo é calculada entre a última renda e a primeira renda recebida, onde:
  - um número float negativo significa que a tendência de renda está diminuindo durante o período de tempo.
  - um número float positivo significa que a tendência de renda está aumentando durante o período de tempo.

Nota: Para transações com frequency=SINGLE, este valor retorna null.

  - `income_streams.lookback_periods` (integer, required)
    Número de unidades de período (com base em meses móveis) usadas para gerar insights e cálculos.

Nota: Um mês móvel é um período de 30 dias. Por exemplo, de 2023-01-15 a 2023-02-15.
    Example: 9

  - `income_streams.full_periods` (integer, required)
    Número de unidades de período (baseado em meses móveis) com dados para realizar cálculos.

Nota: Um mês móvel é um período de 30 dias. Por exemplo, de 2023-01-15 a 2023-02-15.
    Example: 9

  - `income_streams.periods_with_income` (integer, required)
    Número de unidades de período (com base em meses móveis) com pelo menos uma receita disponível.

Nota: Um mês móvel é um período de 30 dias. Por exemplo, de 2023-01-15 a 2023-02-15.
    Example: 9

  - `income_streams.number_of_incomes` (integer, required)
    Número de transações de renda durante os lookback_periods.
    Example: 9

  - `income_streams.confidence` (string, required)
    Nível de confiança da Belvo para rendas futuras.

Retornamos um dos seguintes valores do enum:

  - HIGH
  - MEDIUM
  - LOW
    Enum: "HIGH", "MEDIUM", "LOW"

  - `income_source_type` (string, required)
    O tipo de fonte da qual geramos insights de renda.
Retornamos um dos seguintes valores de enum:

  - BANK
    Enum: "BANK"

  - `first_transaction_date` (string,null, required)
    A data em que a primeira transação ocorreu, no formato YYYY-MM-DD.
    Example: "2022-06-09"

  - `last_transaction_date` (string, required)
    A data em que a última transação ocorreu, no formato YYYY-MM-DD.
    Example: "2023-02-09"

  - `best_working_day_to_charge` (integer, required)
    O melhor dia útil do mês para cobrar o usuário.
    Example: 22

  - `good_working_days_to_charge` (array, required)
    Dias úteis adicionais que foram identificados como bons dias para cobrar o usuário.
    Example: [17,7,2]

  - `number_of_income_streams` (integer, required)
    Número total de fluxos de renda analisados.
    Example: 1

  - `monthly_average` (number, required)
    Valor médio de renda recebida por mês em todas as contas para o usuário específico.
    Example: 2500

  - `monthly_average_regular` (number, required)
    Valor médio de renda regular (com uma frequência de MONTHLY, FORTNIGHTLY ou WEEKLY) recebida por mês para o usuário específico.
    Example: 2500

  - `monthly_average_irregular` (number, required)
    Valor médio de renda irregular (com uma frequência de SINGLE ou IRREGULAR) recebida por mês para o usuário específico.

  - `monthly_average_low_confidence` (number, required)
    Valor médio de renda recebida por mês para o usuário específico com confiança LOW.

  - `monthly_average_medium_confidence` (number, required)
    Valor médio de renda recebida por mês para o usuário específico com confiança MEDIUM.

  - `monthly_average_high_confidence` (number, required)
    Valor médio de renda recebida por mês para o usuário específico com confiança HIGH.
    Example: 2500

  - `total_income_amount` (number, required)
    Valor total de toda a receita recebida para o usuário específico.
    Example: 22500

  - `total_regular_income_amount` (number, required)
    Valor total da renda regular (com uma frequência de MONTHLY, FORTNIGHTLY, WEEKLY) para o usuário específico.
    Example: 22500

  - `total_irregular_income_amount` (number)
    Valor total da renda irregular (com uma frequência de SINGLE ou IRREGULAR) para o usuário específico.

  - `total_low_confidence` (number, required)
    Valor total de renda para o usuário específico com confiança LOW.

  - `total_medium_confidence` (number, required)
    Quantidade total de renda para o usuário específico com confiança MEDIUM.

  - `total_high_confidence` (number, required)
    Valor total de renda para o usuário específico com confiança HIGH.
    Example: 22500

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