# Listar contas

## ▶️ Uso

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

1.  Listar contas relacionadas a um link.id específico (usando o parâmetro de consulta ).
2. Filtrar as contas retornadas usando parâmetros de consulta (veja a seção Filtrando respostas abaixo).
3. Obter os detalhes de uma conta específica usando o parâmetro de consulta .

## 📖 Paginação

Este método retorna uma resposta paginada (padrão: 100 itens por página). Você pode usar o parâmetro de consulta  para aumentar o número de itens retornados até um máximo de 1000 itens. Você pode usar o parâmetro de consulta  para navegar pelos resultados. Para mais detalhes sobre como navegar pelas respostas paginadas da 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, veja nosso artigo Filtrando respostas.

Endpoint: GET /api/bills/
Version: 1.223.0
Security: basicAuth

## Query parameters:

  - `link` (string, required)
    O  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

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

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

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

  - `account` (string)
    O  pelo qual você deseja filtrar.

ℹ️ Recomendamos fortemente adicionar os filtros  ou  para melhorar seu desempenho.
    Example: "8848bd0c-9c7e-4f53-a732-ec896b11d4c4"

  - `account__in` (array)
    Retorne resultados apenas para esses s.
    Example: ["85b77707-90ef-46fd-9059-5a757f24247a"]

  - `due_date` (string)
    Retorne itens que tenham uma  nesta data ().
    Example: "2022-05-01"

  - `due_date__gt` (string)
    Retorne itens que tenham um  após esta data ().
    Example: "2022-05-05"

  - `due_date__gte` (string)
    Retorne itens que tenham uma  nesta data ou após ela ().
    Example: "2022-05-05"

  - `due_date__lt` (string)
    Retorne itens que tenham uma  antes desta data ().
    Example: "2022-05-05"

  - `due_date__lte` (string)
    Retorne itens que tenham uma  antes ou no dia desta data ().
    Example: "2022-05-05"

  - `due_date__range` (array)
    Retorne itens que tenham um  entre duas datas ().
    Example: ["2022-05-04"]

  - `collected_at__gt` (string)
    Retorne itens que foram recuperados da instituição após esta data ( ou timestamp completo ).
    Example: "2022-05-05"

  - `collected_at__gte` (string)
    Retorne itens que foram recuperados da instituição após ou nesta data ( ou timestamp completo ).
    Example: "2022-05-04"

  - `collected_at__lt` (string)
    Retorne itens que foram recuperados da instituição antes desta data ( ou timestamp completo ).
    Example: "2022-04-01"

  - `collected_at__lte` (string)
    Retorne itens que foram recuperados da instituição antes ou nesta data ( ou timestamp completo ).
    Example: "2022-03-30"

  - `collected_at__range` (array)
    Retorne itens que foram recuperados da instituição entre duas datas ( ou timestamp completo ).
    Example: ["2022-05-04"]

  - `created_at` (string)
    Retorne itens que foram atualizados pela última vez no banco de dados da Belvo nesta data (no formato ).
    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 ).
    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 ).
    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 ).
    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 ).
    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 ).
    Example: ["2022-03-03"]

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

Em nosso exemplo de documentação, usamos  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,  ou ).
    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á .

  - `results` (array)
    Um array de objetos Bill.

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

  - `results.created_at` (string)
    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)
    O carimbo de data/hora ISO-8601 quando o ponto de dados foi coletado.
    Example: "2022-02-09T08:45:50.406032Z"

  - `results.account` (object,null)
    Detalhes sobre a conta.

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

  - `results.account.institution` (object, required)
    Detalhes sobre a instituição.

  - `results.account.institution.name` (string)
    O nome da instituição, conforme designado pela Belvo.
    Example: "erebor_mx_retail"

  - `results.account.institution.type` (string)
    O tipo de instituição. Retornamos um dos seguintes valores:

  - 
  - 
  -
    Enum: "bank", "fiscal", "employment"

  - `results.account.last_accessed_at` (string,null, required)
    O timestamp ISO-8601 do acesso mais recente e bem-sucedido da Belvo à instituição para o link fornecido.
    Example: "2021-03-09T10:28:40.000Z"

  - `results.account.category` (string,null, required)
    O tipo de conta.  
Retornamos um dos seguintes valores do enum:  
  - 
  - 
  - 
  - 
  - 
  - 
  - 
  - 
  - 
  -
    Enum: "ADVANCE_DEPOSIT_ACCOUNT", "CHECKING_ACCOUNT", "CREDIT_CARD", "FINANCING_ACCOUNT", "INVESTMENT_ACCOUNT", "INVOICE_FINANCING_ACCOUNT", "LOAN_ACCOUNT", "PENSION_FUND_ACCOUNT", "SAVINGS_ACCOUNT", "UNCATEGORIZED"

  - `results.account.balance_type` (string,null, required)
    Indica se esta conta é um  ou um . Você pode considerar o saldo de um  como positivo, enquanto o saldo de um  como negativo.
    Example: "ASSET"

  - `results.account.overdraft` (object,null)

  - `results.account.overdraft.arranged` (number, required)
    O limite de cheque especial acordado entre o titular da conta e a instituição.

>  Um valor deve ser retornado pela rede de open finance do Brasil se o campo  estiver disponível.
    Example: 5000.5

  - `results.account.overdraft.used` (number, required)
    O valor do cheque especial utilizado.

>  Um valor deve ser retornado pela rede de open finance do Brasil se o campo  estiver disponível.
    Example: 1000.5

  - `results.account.overdraft.unarranged` (number, required)
    O cheque especial utilizado que não foi acordado entre o titular da conta e a instituição.

>  Um valor deve ser retornado pela rede de open finance do Brasil se o campo  estiver disponível.
    Example: 300.1

  - `results.account.type` (string, required)
    O tipo de conta, conforme designado pela instituição.

>  Um valor deve ser retornado pela rede de open finance do Brasil.
    Example: "STANDARD_NACIONAL"

  - `results.account.subtype` (string, required)
    O subtipo de conta, conforme designado pela instituição.

>  Um valor deve ser retornado pela rede de open finance do Brasil.
    Example: "FINANCIAMENTO_HABITACIONAL_SFH"

  - `results.account.name` (string,null, required)
    O nome da conta, conforme fornecido pela instituição.
    Example: "Cuenta Perfiles- M.N. - MXN-666"

  - `results.account.number` (string,null, required)
    O número da conta, conforme designado pela instituição.
    Example: "4057068115181"

  - `results.account.agency` (string,null, required)
    O código da agência onde o produto foi aberto.
    Example: "6272"

  - `results.account.check_digit` (string,null, required)
    O dígito verificador do número do produto, se aplicável.
    Example: "7"

  - `results.account.balance` (object, required)
    Detalhes sobre os saldos atual e disponível para a conta.

  - `results.account.balance.current` (number,null, required)
    O saldo atual é calculado de maneira diferente de acordo com o tipo de conta.

- :

O saldo da conta do usuário no timestamp .

- :

O valor que o usuário gastou no período de faturamento atual do cartão (consulte  para informações sobre quando o período de faturamento atual termina).

- :

O valor restante a pagar no empréstimo do usuário.
    Example: 5874.13

  - `results.account.balance.available` (number,null)
    O saldo que o titular da conta pode usar.

- :

O saldo disponível pode ser diferente do saldo  devido a transações pendentes.

- :

O valor de crédito que o usuário ainda tem disponível para o período atual. O valor é calculado como  menos .

- :

O valor presente necessário para quitar o empréstimo, conforme fornecido pela instituição.

 Se a instituição não fornecer esse valor, retornamos .
    Example: 5621.12

  - `results.account.balance.blocked` (number)
    O valor que está atualmente bloqueado devido a transações pendentes.

>  Um valor deve ser retornado pela rede de open finance do Brasil se o campo  estiver disponível.
    Example: 60.32

  - `results.account.balance.automatically_invested` (number)
    O valor que é automaticamente investido (conforme acordado com a instituição).

>  Um valor deve ser retornado pela rede de open finance do Brasil se o campo  estiver disponível.
    Example: 131.5

  - `results.account.currency` (string, required)
    O código de moeda de três letras (ISO-4217).

>  Um valor deve ser retornado pela rede de open finance do Brasil se o campo  estiver disponível.
    Example: "BRL"

  - `results.account.public_identification_name` (string,null, required)
    O nome público para o tipo de identificação. Para contas de poupança e corrente brasileiras 🇧🇷, este campo será .
    Example: "AGENCY/ACCOUNT"

  - `results.account.public_identification_value` (string,null, required)
    O valor para o .

Para contas de poupança e corrente 🇧🇷 OFDA brasileiras, este campo será o número da agência e da conta bancária, separados por uma barra. Por exemplo: .

Para contas de cartão de crédito 🇧🇷 OFDA brasileiras, retornaremos uma string de números de cartão de crédito concatenados associados à conta. Por exemplo: "8763,9076,5522"
    Example: "0444/45722-0"

  - `results.account.internal_identification` (string, required)
    A identificação interna da instituição para a conta.

>  Um valor deve ser retornado pela rede de open finance do Brasil se o campo  estiver disponível.
    Example: "92792126019929279212650822221989319252576"

  - `results.account.credit_data` (object,null, required)
    Detalhes sobre os cartões de crédito associados a esta conta.

  - `results.account.credit_data.credit_limit` (number,null, required)
    O limite de crédito superior do cartão.

>  Um valor deve ser retornado pela rede de open finance do Brasil.
    Example: 192000.9

  - `results.account.credit_data.limits` (array)

  - `results.account.credit_data.limits.identification_number` (string,null, required)
    O número do cartão de crédito.

 Frequentemente, são apenas os últimos quatro dígitos do cartão de crédito.

>  Um valor deve ser retornado pela rede de open finance do Brasil.
    Example: "4453"

  - `results.account.credit_data.limits.credit_limit` (number,null, required)
    O limite do cartão de crédito.
    Example: 1000.04

  - `results.account.credit_data.limits.used_amount` (number,null, required)
    A quantidade utilizada.
    Example: 400.04

  - `results.account.credit_data.limits.available_amount` (number, required)
    O valor ainda disponível.

>  Um valor deve ser retornado pela rede de open finance do Brasil.
    Example: 600

  - `results.account.credit_data.limits.is_limit_flexible` (boolean, required)
    Boolean para indicar se o  é flexível.

>  Um valor deve ser retornado pela rede de open finance do Brasil.

  - `results.account.credit_data.limits.type` (string, required)
    O tipo de limite. Retornamos um dos seguintes valores:

  - 
  - 

  >  Um valor deve ser retornado pela rede de open finance do Brasil.
    Enum: "TOTAL_LIMIT", "MODAL_LIMIT"

  - `results.account.credit_data.limits.consolidation_type` (string, required)
    Indica se o limite de crédito é consolidado ou individual.

>  Um valor deve ser retornado pela rede de open finance do Brasil.
    Example: "INDIVIDUAL"

  - `results.account.credit_data.limits.line_name` (string,null, required)
    O nome da linha de limite de crédito.
    Example: "CREDITO_A_VISTA"

  - `results.account.credit_data.limits.line_name_additional_info` (string,null, required)
    Informações adicionais sobre o nome da linha.
    Example: "Informações adicionais e complementares"

  - `results.account.credit_data.cutting_date` (string,null)
    A data de vencimento da fatura do cartão de crédito.
    Example: "2019-12-11"

  - `results.account.credit_data.minimum_payment` (number,null)
    O valor mínimo que o proprietário da conta precisa pagar no período de crédito atual.
    Example: 2400.3

  - `results.account.credit_data.network` (string)
    A rede de crédito à qual o cartão está associado. Retornamos um dos seguintes valores:

  - 
  - 
  - 
  - 
  - 
  - 
  - 
  - 
  - 

  >  Um valor deve ser retornado pela rede de open finance do Brasil.
    Enum: "VISA", "MASTERCARD", "AMERICAN_EXPRESS", "DINERS_CLUB", "HIPERCARD", "BANDEIRA_PROPRIA", "CHEQUE_ELETRONICO", "ELO", "OTHER"

  - `results.account.credit_data.network_additional_info` (string,null)
    Informações adicionais sobre a rede de cartão de crédito.
    Example: "It's an orange card."

  - `results.account.credit_data.cards` (array)
    Detalhes sobre os cartões associados à conta.

  - `results.account.credit_data.cards.is_multiple` (boolean, required)
    Boolean para indicar se esta conta possui múltiplos cartões de crédito.

>  Um valor deve ser retornado pela rede de open finance do Brasil.

  - `results.account.credit_data.next_payment_date` (string,null)
    Este campo não se aplica ao OF Brasil e retornará null.

  - `results.account.credit_data.no_interest_payment` (number,null)
    Este campo não se aplica ao OF Brasil e retornará null.

  - `results.account.credit_data.interest_rate` (number,null)
    Este campo não se aplica ao OF Brasil e retornará null.

  - `results.account.credit_data.monthly_payment` (number,null)
    Este campo não se aplica ao OF Brasil e retornará null.

  - `results.account.credit_data.last_payment_date` (string,null)
    Este campo não se aplica ao OF Brasil e retornará null.

  - `results.account.loan_data` (object,null, required)
    As opções de empréstimo associadas a esta conta.

  - `results.account.loan_data.loan_code` (string, required)
    O número de contrato padronizado específico do país.

>  Um valor deve ser retornado pela rede de open finance do Brasil.
    Example: "92792126019929279212650822221989319252576"

  - `results.account.loan_data.contract_amount` (number,null, required)
    O valor total inicial do empréstimo quando o contrato foi assinado, calculado pela instituição. Este valor inclui o principal + juros + impostos + taxas.
    Example: 202000

  - `results.account.loan_data.total_effective_cost` (number,null)
    O custo efetivo total inicial do empréstimo.
    Example: 209000

  - `results.account.loan_data.loan_type` (string, required)
    O tipo do empréstimo, de acordo com a instituição.

>  Um valor deve ser retornado pela rede de open finance do Brasil.
    Example: "HOME_EQUITY"

  - `results.account.loan_data.outstanding_balance` (number,null, required)
    O valor restante a pagar no total, incluindo juros.
    Example: 182000

  - `results.account.loan_data.interest_rates` (array, required)
    Detalhamento dos juros aplicados ao empréstimo. Com o OF Brasil, recomendamos fortemente o uso das informações em  para obter informações detalhadas.

>  Um valor deve ser retornado pela rede de open finance do Brasil.

  - `results.account.loan_data.interest_rates.name` (string,null, required)
    O nome do tipo de taxa de juros aplicada ao empréstimo.

 Para OFDA Brasil, recomendamos que você use o parâmetro .
    Example: "NOMINAL"

  - `results.account.loan_data.interest_rates.type` (string, required)
    O período em que o juro é aplicado ao empréstimo.

>  Um valor deve ser retornado pela rede de open finance do Brasil.
    Enum: "MONTHLY", "YEARLY"

  - `results.account.loan_data.interest_rates.value` (number,null, required)
    A taxa de juros (em porcentagem ou valor monetário).

 Para OFDA Brasil, recomendamos que você use os parâmetros  e .
    Example: 7.85

  - `results.account.loan_data.interest_rates.interest_rate_data` (object,null, required)
    Informações detalhadas sobre a taxa de juros.

  - `results.account.loan_data.interest_rates.interest_rate_data.tax_type` (string, required)
    O tipo de imposto sobre a taxa de juros. Retornamos um dos seguintes valores:

  - 
  - 
  
  >  Um valor deve ser retornado pela rede de open finance do Brasil.
    Enum: "NOMINAL", "EFFECTIVE"

  - `results.account.loan_data.interest_rates.interest_rate_data.rate_type` (string, required)
    O tipo de taxa de juros. Retornamos um dos seguintes valores:

  - 
  - 

  >  Um valor deve ser retornado pela rede de open finance do Brasil.
    Enum: "SIMPLE", "COMPOUND"

  - `results.account.loan_data.interest_rates.interest_rate_data.calculation_base` (string, required)
    O cálculo base para a taxa de juros.

>  Um valor deve ser retornado pela rede de open finance do Brasil.
    Example: "30/360"

  - `results.account.loan_data.interest_rates.interest_rate_data.reference_index_type` (string, required)
    A taxa de índice de referência. Retornamos um dos seguintes valores:

  - 
  - 
  - 
  - 
  - 
  - 
  - 

  >  Um valor deve ser retornado pela rede de open finance do Brasil.
    Enum: "WITHOUT_INDEX_TYPE", "PRE_FIXED", "POST_FIXED", "FLOATING", "INDEXED_PRICE", "RURAL_CREDIT", "OTHER_INDEX"

  - `results.account.loan_data.interest_rates.interest_rate_data.reference_index_subtype` (string,null, required)
    O subtipo da taxa de índice de referência.
    Example: "TR_TBF"

  - `results.account.loan_data.interest_rates.interest_rate_data.reference_index_info` (string,null, required)
    Informações adicionais sobre a taxa de índice de referência.
    Example: "Additional information"

  - `results.account.loan_data.interest_rates.interest_rate_data.pre_fixed_rate` (number, required)
    A taxa de juros com percentual prefixado.

>  Um valor deve ser retornado pela rede de open finance do Brasil.
    Example: 0.062

  - `results.account.loan_data.interest_rates.interest_rate_data.post_fixed_rate` (number, required)
    A taxa de juros com percentual pós-fixado.

>  Um valor deve ser retornado pela rede de open finance do Brasil.
    Example: 0.062

  - `results.account.loan_data.interest_rates.interest_rate_data.additional_info` (string,null, required)
    Informações adicionais sobre a taxa de juros.
    Example: "Additional information"

  - `results.account.loan_data.fees` (array,null, required)
    Detalhamento das taxas aplicadas ao empréstimo.

  - `results.account.loan_data.fees.type` (string,null, required)
    Este campo não se aplica ao OF Brasil e retornará null.
    Enum: "OPERATION_FEE", "INSURANCE_FEE", "OTHERS", null

  - `results.account.loan_data.fees.value` (number,null, required)
    O valor total da taxa. Mesma moeda do empréstimo.
    Example: 5.6

  - `results.account.loan_data.fees.name` (string, required)
    O nome da taxa.

 >  Um valor deve ser retornado pela rede de open finance do Brasil se o campo  estiver disponível.
    Example: "Renovação de cadastro"

  - `results.account.loan_data.fees.code` (string, required)
    O código de tarifa.

 >  Um valor deve ser retornado pela rede de open finance do Brasil se o campo  estiver disponível.
    Example: "CADASTRO"

  - `results.account.loan_data.fees.fee_charge_type` (string, required)
    Indica o tipo de cobrança. Retornamos um dos seguintes valores:

  - 
  - 

   >  Um valor deve ser retornado pela rede de open finance do Brasil se o campo  estiver disponível.
    Enum: "SINGLE", "PER_INSTALLMENT"

  - `results.account.loan_data.fees.fee_charge` (string, required)
    Método de cobrança, conforme acordado com a instituição. Retornamos um dos seguintes valores:

  - 
  - 
  - 
  - 

   >  Um valor deve ser retornado pela rede de open finance do Brasil se o campo  estiver disponível.
    Enum: "MINIMUM", "MAXIMUM", "FIXED", "PERCENTAGE"

  - `results.account.loan_data.fees.rate` (number,null, required)
    A taxa percentual da tarifa. Necessária quando  está definido como .
    Example: 0.062

  - `results.account.loan_data.contracted_charges` (array,null)
    Parece que você não forneceu nenhum texto para tradução. Por favor, envie o texto que deseja que eu traduza do inglês para o português (Brasil).

  - `results.account.loan_data.contracted_charges.type` (string)
    O tipo de cobrança contratada. Retornamos um dos seguintes valores:

  - 
  - 
  - 
  - 
  - 
  - 
  - 

  >  Um valor deve ser retornado pela rede de open finance do Brasil se o campo  estiver disponível.
    Enum: "LATE_PAYMENT_INTEREST_FEE", "LATE_PAYMENT_PENALTY_FEE", "DEFAULT_INTEREST_FEE", "LOAN_CONTRACT_TAX", "LATE_PAYMENT_TAX", "NO_CHARGE", "OTHER"

  - `results.account.loan_data.contracted_charges.info` (string,null)
    Informações adicionais sobre a cobrança contratada.
    Example: "Late fee"

  - `results.account.loan_data.contracted_charges.rate` (number,null)
    A taxa percentual da cobrança, calculada com base no valor do empréstimo.
    Example: 0.062

  - `results.account.loan_data.collaterals` (array,null, required)
    Detalhes sobre quaisquer garantias de empréstimo que o indivíduo ou empresa forneceu.

  - `results.account.loan_data.collaterals.type` (string, required)
    O tipo de garantia, conforme definido pela instituição.

>  Um valor deve ser retornado pela rede de open finance do Brasil se o campo  estiver disponível.
    Example: "OPERACOES_GARANTIDAS_PELO_GOVERNO"

  - `results.account.loan_data.collaterals.subtype` (string, required)
    O subtipo da garantia, conforme definido pela instituição.

>  Um valor deve ser retornado pela rede de open finance do Brasil se o campo  estiver disponível.
    Example: "CCR_CONVENIO_CREDITOS_RECIPROCOS"

  - `results.account.loan_data.collaterals.amount` (number, required)
    O valor total da fatura.

>  Um valor deve ser retornado pela rede de open finance do Brasil se o campo  estiver disponível.
    Example: 45391.89

  - `results.account.loan_data.balloon_payments` (array,null, required)
    Informações detalhadas sobre quaisquer pagamentos de balloon para o empréstimo, se aplicável.

  - `results.account.loan_data.balloon_payments.due_date` (string,null, required)
    A data em que o pagamento do balloon deve ser efetuado, no formato .
    Example: "2021-09-06"

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

  - `results.account.loan_data.balloon_payments.amount` (number,null, required)
    O valor total do pagamento final.
    Example: 45391.89

  - `results.account.loan_data.installments_contract_term_frequency` (string,null, required)
    A frequência dos pagamentos parcelados contratados, conforme definido quando o contrato foi assinado pela primeira vez. Retornamos um dos seguintes:

  - 
  - 
  - 
  - 
  - 
  -
    Enum: "DAY", "WEEK", "MONTH", "YEAR", "NO_DEADLINE_REMAINING", null

  - `results.account.loan_data.installment_frequency` (string, required)
    A frequência com que as parcelas são pagas. Retornamos um dos seguintes valores:

  - 
  - 
  - 
  - 
  - 
  - 
  - 
  - 
  - 

  >  Um valor deve ser retornado pela rede de open finance do Brasil.
    Enum: "IRREGULAR", "WEEKLY", "FORTNIGHTLY", "MONTHLY", "BIMONTHLY", "QUARTERLY", "BIANNUALLY", "ANNUALLY", "OTHER"

  - `results.account.loan_data.installment_frequency_info` (string,null, required)
    Informações adicionais sobre o .
    Example: "Both the term and requency are the same."

  - `results.account.loan_data.first_installment_due_date` (string,null, required)
    A data em que a primeira parcela do empréstimo deve ser paga, no formato .
    Example: "2020-03-01"

  - `results.account.loan_data.number_of_installments_total` (integer,null, required)
    O número total de parcelas necessárias para quitar o empréstimo.
    Example: 60

  - `results.account.loan_data.number_of_installments_outstanding` (integer,null, required)
    O número de parcelas restantes a pagar.
    Example: 48

  - `results.account.loan_data.number_of_installments_paid` (integer,null, required)
    O número de parcelas já pagas.
    Example: 32

  - `results.account.loan_data.number_of_installments_past_due` (integer,null, required)
    O número de parcelas que estão em atraso.
    Example: 2

  - `results.account.loan_data.disbursement_dates` (array,null, required)
    Um array de datas em que o empréstimo foi desembolsado.
    Example: ["2021-09-23"]

  - `results.account.loan_data.settlement_date` (string,null, required)
    A data em que o empréstimo foi liquidado, no formato .
    Example: "2021-09-23"

  - `results.account.loan_data.contract_start_date` (string, required)
    A data em que o contrato de empréstimo foi assinado, no formato .

>  Um valor deve ser retornado pela rede de open finance do Brasil.
    Example: "2020-03-01"

  - `results.account.loan_data.contract_end_date` (string,null, required)
    A data em que se espera que o empréstimo seja concluído, no formato .
    Example: "2027-10-01"

  - `results.account.loan_data.contract_remaining_frequency` (string,null, required)
    A frequência dos pagamentos das parcelas restantes contratadas, conforme definido quando o contrato foi assinado pela primeira vez. Retornamos um dos seguintes valores:
- 
- 
- 
- 
- 
-
    Enum: "DAY", "WEEK", "MONTH", "YEAR", "NO_DEADLINE_REMAINING", null

  - `results.account.loan_data.contract_remaining_total` (integer,null, required)
    O número total de parcelas restantes no empréstimo.
    Example: 20

  - `results.account.loan_data.amortization_schedule` (string, required)
    O cronograma de amortização do empréstimo.

>  Um valor deve ser retornado pela rede de open finance do Brasil.
    Example: "SEM_SISTEMA_AMORTIZACAO"

  - `results.account.loan_data.amortization_schedule_info` (string,null, required)
    Informações adicionais sobre o .
    Example: "No need for a schedule."

  - `results.account.loan_data.consignee_id` (string,null, required)
    O ID do consignatário do empréstimo.
    Example: "60500998000135"

  - `results.account.loan_data.contract_number` (string,null, required)
    O número do contrato do empréstimo, conforme fornecido pela instituição.
    Example: "1324926521496"

  - `results.account.loan_data.principal` (number,null, required)
    Este campo não se aplica ao OF Brasil e retornará null.

  - `results.account.loan_data.payment_day` (string,null, required)
    Este campo não se aplica ao OF Brasil e retornará null.

  - `results.account.loan_data.outstanding_principal` (number,null, required)
    Este campo não se aplica ao OF Brasil e retornará null.

  - `results.account.loan_data.credit_limit` (number,null, required)
    Este campo não se aplica ao OF Brasil e retornará null.

  - `results.account.loan_data.last_period_balance` (number,null, required)
    Este campo não se aplica ao OF Brasil e retornará null.

  - `results.account.loan_data.limit_day` (string,null, required)
    Este campo não se aplica ao OF Brasil e retornará null.

  - `results.account.loan_data.cutting_day` (string,null, required)
    Este campo não se aplica ao OF Brasil e retornará null.

  - `results.account.loan_data.cutting_date` (string,null, required)
    Este campo não se aplica ao OF Brasil e retornará null.

  - `results.account.funds_data` (string,null, required)
    Este campo não se aplica ao OF Brasil e retornará null.

  - `results.internal_identification` (string,null)
    O identificador interno da instituição para a fatura.
    Example: "92792126019929279212650822221989319252576"

  - `results.bill_name` (string,null)
    O título da fatura mensal do cartão de crédito à qual a transação pertence. O formato do valor retornado é específico da instituição, no entanto, alguns exemplos comuns são:

- diciembre-2021
- dec-2021
- dec-21

> : Este campo é retornado apenas para faturas 'fechadas' (o que significa que o período de faturamento terminou e a fatura foi emitida). Se o período de faturamento ainda estiver em andamento, retornamos .
    Example: "apr-2020"

  - `results.due_date` (string,null)
    A data em que a fatura deve ser paga, no formato .
    Example: "2021-09-06"

  - `results.total_amount` (number,null)
    O valor total da conta.
    Example: 45391.89

  - `results.minimum_amount` (number,null)
    O valor mínimo a pagar.
    Example: 391.89

  - `results.is_installment` (boolean,null)
    Boolean para indicar se esta fatura pode ser paga em parcelas.

  - `results.finance_charges` (array)

  - `results.finance_charges.type` (string,null)
    O tipo de encargo financeiro aplicado à fatura. Retornamos um dos seguintes valores:

  - 
  - 
  - 
  - 
  - 
  - 
  -
    Enum: "LATE_PAYMENT_INTEREST", "LATE_FEE", "ARREARS_INTEREST", "IOF", "NO_CHARGE", "OTHER", null

  - `results.finance_charges.additional_info` (string,null)
    Informações adicionais sobre a cobrança financeira.
    Example: "Paid 15 days late, fee applied."

  - `results.finance_charges.amount` (number,null)
    O valor do encargo financeiro.
    Example: 91.89

  - `results.payments` (array)

  - `results.payments.type` (string,null)
    O tipo de pagamento. Retornamos um dos seguintes valores:

  - 
  - 
  - 
  -
    Enum: "INSTALLMENT", "FULL", "OTHER", null

  - `results.payments.payment_date` (string,null)
    A data em que o pagamento foi realizado, no formato .
    Example: "2021-09-04"

  - `results.payments.payment_mode` (string,null)
    O método pelo qual o pagamento foi realizado. Retornamos um dos seguintes valores:

  - 
  - 
  - 
  - 
  -
    Enum: "DIRECT_DEBIT", "BANK_SLIP", "SALARY_DEDUCTION", "PIX", null

  - `results.payments.amount` (number,null)
    O valor do pagamento.
    Example: 500.15

## Response 403 fields (application/json):

  - `code` (string)
    Um código de erro único () 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 , a descrição é:

  - .
    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: ). 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 () que permite classificar e lidar com o erro programaticamente.
    Example: "not_found"

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

Para erros , a descrição é:

  -
    Example: "Not found"

  - `request_id` (string)
    Um ID único de 32 caracteres da solicitação (correspondente a um padrão regex de: ). 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 () 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 , a descrição é:

  - .
    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: ). 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 () 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 , a descriçã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: ). Forneça este ID ao entrar em contato com a equipe de suporte da Belvo para acelerar as investigações.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"