# Listar relatórios de dívidas

## ▶️ Uso

Com o método Listar Relatórios de Dívida, você pode:

1. Listar relatórios de dívida relacionados a um link.id específico (usando o parâmetro de consulta link).
2. Obter os detalhes de um debt-report.id específico (usando o parâmetro de consulta id).
3. [Não Recomendado] Listar todos os relatórios de dívida relacionados à sua conta Belvo (sem usar nenhum 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 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 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/cl/debt-reports/
Version: 1.223.0
Security: basicAuth

## Query parameters:

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

ℹ️ Recomendamos fortemente adicionar o filtro link.id para melhorar seu desempenho.
    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.

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

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

  - `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-34d1044cb908&page=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 relatório de dívida.

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

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

  - `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.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.personal_data` (object)

  - `results.personal_data.full_name` (string)
    O nome completo do indivíduo.
    Example: "Cabezas Pérez Martín Vicente "

  - `results.personal_data.document_id_type` (string)
    O tipo de ID de documento do indivíduo. Para o Chile, isso será sempre definido como RUT.
    Enum: "RUT"

  - `results.personal_data.document_id_number` (string)
    O número de identificação do documento do indivíduo. Para o Chile, este será o número RUT.
    Example: "12345678-9"

  - `results.debt_data_last_update` (string)
    A data em que os dados da dívida foram atualizados pela última vez, no formato YYYY-MM-DD.
    Example: "2023-07-02"

  - `results.currency` (string)
    A moeda das dívidas. Para o Chile, será o CLP.
    Example: "CLP"

  - `results.total` (number,null)
    O valor total da dívida, incluindo dívidas atuais, inadimplentes, gravemente inadimplentes e inadimplidas.
    Example: 6506000.02

  - `results.current` (number,null)
    O montante da dívida que está atualmente em aberto, mas não vencida.
    Example: 5350000.02

  - `results.delinquent` (number,null)
    O valor da dívida que está vencida há 30-59 dias.

  - `results.severely_delinquent` (number,null)
    O valor da dívida que está vencida há 60-89 dias.
    Example: 56000.02

  - `results.defaulted` (number,null)
    O valor da dívida que está vencida há 90 dias.
    Example: 1100000.02

  - `results.direct_debts` (array,null)
    Uma lista de dívidas que são diretamente atribuídas ao indivíduo.

  - `results.direct_debts.financial_institution` (string)
    O nome da instituição financeira onde a dívida está mantida.
    Example: "Banco Santander"

  - `results.direct_debts.credit_type` (string)
    O tipo de crédito emitido pela instituição financeira. Por exemplo, Vivienda, Comercial, Consumo ou Otro.
    Example: "Vivienda"

  - `results.direct_debts.amount` (number)
    O valor total da dívida na instituição financeira.
    Example: 5000000.02

  - `results.direct_debts.current` (number,null)
    O valor atual pendente da dívida na instituição financeira.
    Example: 5000000.02

  - `results.direct_debts.delinquent` (number,null)
    O valor da dívida que está vencida há 30-59 dias.

  - `results.direct_debts.severely_delinquent` (number,null)
    O valor da dívida que está vencida há 60-89 dias.

  - `results.direct_debts.defaulted` (number,null)
    O valor da dívida que está vencida há 90 dias.

  - `results.indirect_debts` (array,null)
    Lista de dívidas indiretas de instituições financeiras.

  - `results.indirect_debts.financial_institution` (string)
    Nome da instituição financeira que fornece a dívida indireta.
    Example: "Banco BCI"

  - `results.indirect_debts.credit_type` (string)
    O tipo de crédito emitido pela instituição financeira. Por exemplo, Vivienda, Comercial, Consumo ou Otro.
    Example: "Consumo"

  - `results.indirect_debts.amount` (number)
    O valor total da dívida na instituição financeira.
    Example: 200000.02

  - `results.indirect_debts.current` (number,null)
    O valor atual pendente da dívida na instituição financeira.

  - `results.indirect_debts.delinquent` (number,null)
    O valor da dívida que está vencida há 30-59 dias.

  - `results.indirect_debts.severely_delinquent` (number,null)
    O valor da dívida que está vencida há 60-89 dias.

  - `results.indirect_debts.defaulted` (number,null)
    O valor da dívida que está vencida há 90 dias.
    Example: 200000.02

  - `results.credit_lines` (array,null)
    Lista de linhas de crédito (como cartões de crédito) disponíveis para o indivíduo.

  - `results.credit_lines.financial_institution` (string)
    O nome da instituição financeira que fornece a linha de crédito.
    Example: "Banco BCI"

  - `results.credit_lines.direct_amount` (number,null)
    A quantidade de crédito direto disponível.
    Example: 5000000.02

  - `results.credit_lines.indirect_amount` (number,null)
    A quantidade de crédito indireto disponível.

  - `results.other_credits` (array,null)
    Lista de outros créditos (como notas de garantia, crédito estrangeiro, etc.) disponíveis para o indivíduo.

  - `results.other_credits.financial_institution` (string)
    O nome da instituição financeira que fornece o crédito.
    Example: "Banco BCI"

  - `results.other_credits.direct_amount` (number,null)
    A quantidade de crédito direto disponível.

  - `results.other_credits.indirect_amount` (number,null)
    A quantidade de crédito indireto disponível.
    Example: 250000.02

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