# List debts reports

## ▶️ Usage

With the List Debt Reports method, you can:

1. List debt reports related to a specific link.id (using the link query parameter).
2. Get the details of a specific debt-report.id (using the id query parameter).
3. [Not Recommended] List all debt reports related to your Belvo account (without using any query parameters).

## 📖 Pagination

This method returns a paginated response (default: 100 items per page). You can use the page_size query parameter to increase the number of items returned to a maximum of 1000 items. You can use the page query parameter to navigate through the results. For more details on how to navigate Belvo's paginated responses, see our Pagination Tips article.

## 🔦 Filtering Responses

Please see the query list below for a list of fields that you can filter your responses by. For more information on how to use filters, see our Filtering responses article.

Endpoint: GET /api/cl/debt-reports/
Version: 1.223.0
Security: basicAuth

## Query parameters:

  - `link` (string)
    The link.id you want to filter by.

ℹ️ We highly recommend adding the link.id filter in order to improve your performance.
    Example: "8848bd0c-9c7e-4f53-a732-ec896b11d4c4"

  - `page_size` (integer)
    Indicates how many results to return per page. By default we return 100 results per page.

ℹ️ The minimum number of results returned per page is 1 and the maximum is 1000. If you enter a value greater than 1000, our API will default to the maximum value (1000).
    Example: 100

  - `page` (integer)
    A page number within the paginated result set.
    Example: 1

  - `omit` (string)
    Omit certain fields from being returned in the response. For more information, see our Filtering responses DevPortal article.

  - `fields` (string)
    Return only the specified fields in the response. For more information, see our Filtering responses DevPortal article.

  - `link__in` (array)
    Return results only for these link.ids.
    Example: ["5722d0ba-69d7-42dc-8ff5-33767b83c5d6"]

  - `id` (string)
    Return information only for this resource id.
    Example: "24ccab1d-3a86-4136-a6eb-e04bf52b356f"

  - `id__in` (array)
    Return information for these resource ids.
    Example: ["6b3dea0f-be29-49d1-aabe-1a6d588642e6"]

  - `created_at` (string)
    Return items that were last updated in Belvo's database on this date (in YYYY-MM-DD format).
    Example: "2022-05-05"

  - `created_at__gt` (string)
    Return items that were last updated in Belvo's database after this date (in YYYY-MM-DD format).
    Example: "2022-05-05"

  - `created_at__gte` (string)
    Return items that were last updated in Belvo's database after or on this date (in YYYY-MM-DD format).
    Example: "2022-05-04"

  - `created_at__lt` (string)
    Return items that were last updated in Belvo's database before this date (in YYYY-MM-DD format).
    Example: "2022-04-01"

  - `created_at__lte` (string)
    Return items that were last updated in Belvo's database before or on this date (in YYYY-MM-DD format).
    Example: "2022-03-30"

  - `created_at__range` (array)
    Return accounts that were last updated in Belvo's database between two dates (in YYYY-MM-DD format). The first value indicates the start of the range and the second value indicates the end of the range.
    Example: ["2022-01-01","2022-12-31"]

## Response 200 fields (application/json):

  - `count` (integer)
    The total number of results in your Belvo account.
    Example: 130

  - `next` (string,null)
    The URL to next page of results. Each page consists of up to 100 items. If there are not enough results for an additional page, the value is null.

In our documentation example, we use {endpoint} as a placeholder value. In production, this value will be replaced by the actual endpoint you are currently using (for example, accounts or owners).
    Example: "https://sandbox.belvo.com/api/{endpoint}/?link=1bd948f7-245d-4313-b604-34d1044cb908page=2"

  - `previous` (string,null)
    The URL to the previous page of results. If there is no previous page, the
value is null.

  - `results` (array)
    Array of debt report objects.

  - `results.id` (string)
    Belvo's unique identifier for the current item.
    Example: "0d3ffb69-f83b-456e-ad8e-208d0998d71d"

  - `results.link` (string,null)
    The link.id the data belongs to.
    Example: "30cb4806-6e00-48a4-91c9-ca55968576c8"

  - `results.collected_at` (string)
    The ISO-8601 timestamp when the data point was collected.
    Example: "2022-02-09T08:45:50.406032Z"

  - `results.created_at` (string)
    The ISO-8601 timestamp of when the data point was created in Belvo's database.
    Example: "2022-02-09T08:45:50.406032Z"

  - `results.personal_data` (object)

  - `results.personal_data.full_name` (string)
    The full name of the individual.
    Example: "Cabezas Pérez Martín Vicente "

  - `results.personal_data.document_id_type` (string)
    The type of document ID of the individual. For Chile, this will be always set to RUT.
    Enum: "RUT"

  - `results.personal_data.document_id_number` (string)
    The document ID number of the individual. For Chile, this will be the RUT number.
    Example: "12345678-9"

  - `results.debt_data_last_update` (string)
    The date when the debt data was last updated, in YYYY-MM-DD format.
    Example: "2023-07-02"

  - `results.currency` (string)
    The currency of the debts. For Chile, this will be the CLP.
    Example: "CLP"

  - `results.total` (number,null)
    The total amount of debt including current, delinquent, severely delinquent, and defaulted debts.
    Example: 6506000.02

  - `results.current` (number,null)
    The amount of debt that is currently outstanding but not past due.
    Example: 5350000.02

  - `results.delinquent` (number,null)
    The amount of debt that is 30-59 days past due.

  - `results.severely_delinquent` (number,null)
    The amount of debt that is 60-89 days past due.
    Example: 56000.02

  - `results.defaulted` (number,null)
    The amount of debt that is 90 days past due.
    Example: 1100000.02

  - `results.direct_debts` (array,null)
    A list of debts that are directly atttribued to the individual.

  - `results.direct_debts.financial_institution` (string)
    The name of the financial institution where the debt is held.
    Example: "Banco Santander"

  - `results.direct_debts.credit_type` (string)
    The type of credit issued by the financial institution. For example, Vivienda, Comercial, Consumo, or Otro.
    Example: "Vivienda"

  - `results.direct_debts.amount` (number)
    The total amount of the debt at the financial institution.
    Example: 5000000.02

  - `results.direct_debts.current` (number,null)
    The current outstanding amount of the debt at the financial institution.
    Example: 5000000.02

  - `results.direct_debts.delinquent` (number,null)
    The amount of debt that is 30-59 days past due.

  - `results.direct_debts.severely_delinquent` (number,null)
    The amount of debt that is 60-89 days past due.

  - `results.direct_debts.defaulted` (number,null)
    The amount of debt that is 90 days past due.

  - `results.indirect_debts` (array,null)
    List of indirect debts from financial institutions.

  - `results.indirect_debts.financial_institution` (string)
    Name of the financial institution providing the indirect debt.
    Example: "Banco BCI"

  - `results.indirect_debts.credit_type` (string)
    The type of credit issued by the financial institution. For example, Vivienda, Comercial, Consumo, or Otro.
    Example: "Consumo"

  - `results.indirect_debts.amount` (number)
    The total amount of the debt at the financial institution.
    Example: 200000.02

  - `results.indirect_debts.current` (number,null)
    The current outstanding amount of the debt at the financial institution.

  - `results.indirect_debts.delinquent` (number,null)
    The amount of debt that is 30-59 days past due.

  - `results.indirect_debts.severely_delinquent` (number,null)
    The amount of debt that is 60-89 days past due.

  - `results.indirect_debts.defaulted` (number,null)
    The amount of debt that is 90 days past due.
    Example: 200000.02

  - `results.credit_lines` (array,null)
    List of credit lines (such as credit cards) available to the individual.

  - `results.credit_lines.financial_institution` (string)
    The name of the financial institution providing the credit line.
    Example: "Banco BCI"

  - `results.credit_lines.direct_amount` (number,null)
    The amount of direct credit available.
    Example: 5000000.02

  - `results.credit_lines.indirect_amount` (number,null)
    The amount of indirect credit available.

  - `results.other_credits` (array,null)
    List of other credits (such as guarantee notes, foreign credit, and so on) available to the individual.

  - `results.other_credits.financial_institution` (string)
    The name of the financial institution providing the credit.
    Example: "Banco BCI"

  - `results.other_credits.direct_amount` (number,null)
    The amount of direct credit available.

  - `results.other_credits.indirect_amount` (number,null)
    The amount of indirect credit available.
    Example: 250000.02

## Response 403 fields (application/json):

  - `code` (string)
    A unique error code (access_to_resource_denied) that allows you to classify and handle the error programmatically.


ℹ️ Check our DevPortal for more information on how to handle 403 access_to_resource_denied.
    Example: "access_to_resource_denied"

  - `message` (string)
    A short description of the error. 


For access_to_resource_denied errors, the description is:
  
  - You don't have access to this resource..
    Example: "You don't have access to this resource."

  - `request_id` (string)
    A 32-character unique ID of the request (matching a regex pattern of: [a-f0-9]{32}). Provide this ID when contacting the Belvo support team to accelerate investigations.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"

## Response 404 fields (application/json):

  - `code` (string)
    A unique error code (not_found) that allows you to classify and handle the error programmatically.
    Example: "not_found"

  - `message` (string)
    A short description of the error.


For not_found errors, the description is:

  - Not found
    Example: "Not found"

  - `request_id` (string)
    A 32-character unique ID of the request (matching a regex pattern of: [a-f0-9]{32}). Provide this ID when contacting the Belvo support team to accelerate investigations.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"

## Response 408 fields (application/json):

  - `code` (string)
    A unique error code (request_timeout) that allows you to classify and handle the error programmatically.


ℹ️ Check our DevPortal for more information on how to handle 408 request_timeout errors.
    Example: "request_timeout"

  - `message` (string)
    A short description of the error. 


For request_timeout errors, the description is:
  
  - 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)
    A 32-character unique ID of the request (matching a regex pattern of: [a-f0-9]{32}). Provide this ID when contacting the Belvo support team to accelerate investigations.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"

## Response 500 fields (application/json):

  - `code` (string)
    A unique error code (unexpected_error) that allows you to classify and handle the error programmatically.


ℹ️ Check our DevPortal for more information on how to handle 500 unexpected_error errors.
    Example: "unexpected_error"

  - `message` (string)
    A short description of the error. 


For unexpected_error errors, the description is:
  
  - Belvo is unable to process the request due to an internal system issue or to an unsupported response from an institution.
    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)
    A 32-character unique ID of the request (matching a regex pattern of: [a-f0-9]{32}). Provide this ID when contacting the Belvo support team to accelerate investigations.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"