# Listar saldos

## ▶️ Uso

Con el método List Balances, puedes:

1. [Requerido] Listar saldos relacionados con un link.id específico (usando el parámetro de consulta link).
2. [Altamente Recomendado] Listar saldos relacionados con un link.id y un account.id específicos (usando los parámetros de consulta link y account).
3. Obtener los detalles de un balance.id específico (usando el parámetro de consulta id).

## 🔦 Filtrado de Respuestas

Consulta la lista de campos a continuación para ver los campos por los que puedes filtrar tus respuestas. Para más información sobre cómo usar filtros, consulta nuestro artículo Filtrado de respuestas.

## 📖 Paginación

Este método devuelve una respuesta paginada (por defecto: 100 elementos por página). Puedes usar el parámetro de consulta page_size para aumentar el número de elementos devueltos hasta un máximo de 1000 elementos. Puedes usar el parámetro de consulta page para navegar a través de los resultados. Para más detalles sobre cómo navegar por las respuestas paginadas de Belvo, consulta nuestro artículo Consejos de Paginación.

## 🚨 Campos Obsoletos

Este recurso puede devolver campos obsoletos. En la documentación de la respuesta, puedes ver que un campo ha sido marcado como obsoleto. Esto significa que este campo ya no es mantenido por el equipo de Belvo. Aún puedes recibir datos para este campo dependiendo de la institución, sin embargo, no deberías depender de este campo.

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

## Query parameters:

  - `link` (string, required)
    El link.id por el que deseas filtrar.
    Example: "8848bd0c-9c7e-4f53-a732-ec896b11d4c4"

  - `account` (string)
    El account.id por el que deseas filtrar.

ℹ️ Recomendamos encarecidamente agregar filtros de link.id o account.id para mejorar tu rendimiento.
    Example: "8848bd0c-9c7e-4f53-a732-ec896b11d4c4"

  - `id` (string)
    Devuelve información solo para este recurso id.
    Example: "24ccab1d-3a86-4136-a6eb-e04bf52b356f"

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

  - `account__in` (array)
    Devuelve resultados solo para estos account.ids.
    Example: ["85b77707-90ef-46fd-9059-5a757f24247a"]

  - `id__in` (array)
    Devuelve información para estos ids de recursos.
    Example: ["6b3dea0f-be29-49d1-aabe-1a6d588642e6"]

  - `page_size` (integer)
    Indica cuántos resultados devolver por página. Por defecto, devolvemos 100 resultados por página.

ℹ️ El número mínimo de resultados devueltos por página es 1 y el máximo es 1000. Si introduces un valor mayor que 1000, nuestra API usará por defecto el valor máximo (1000).
    Example: 100

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

  - `omit` (string)
    Omite ciertos campos para que no se devuelvan en la respuesta. Para más información, consulta nuestro artículo del DevPortal Filtrando respuestas.

  - `fields` (string)
    Devuelve solo los campos especificados en la respuesta. Para obtener más información, consulta nuestro artículo del DevPortal Filtrando respuestas.

  - `collected_at` (string)
    Devuelve los elementos que fueron recuperados de la institución en esta fecha (YYYY-MM-DD o marca de tiempo completa ISO-8601).
    Example: "2022-05-01"

  - `collected_at__gt` (string)
    Devuelve los elementos que fueron recuperados de la institución después de esta fecha (YYYY-MM-DD o marca de tiempo completa en formato ISO-8601).
    Example: "2022-05-05"

  - `collected_at__gte` (string)
    Devolver los elementos que fueron recuperados de la institución en o después de esta fecha (YYYY-MM-DD o marca de tiempo completa ISO-8601).
    Example: "2022-05-04"

  - `collected_at__lt` (string)
    Devolver los elementos que fueron recuperados de la institución antes de esta fecha (YYYY-MM-DD o marca de tiempo completa ISO-8601).
    Example: "2022-04-01"

  - `collected_at__lte` (string)
    Devuelve los elementos que fueron recuperados de la institución en o antes de esta fecha (YYYY-MM-DD o marca de tiempo completa ISO-8601).
    Example: "2022-03-30"

  - `collected_at__range` (array)
    Devolver elementos que fueron recuperados de la institución entre dos fechas (YYYY-MM-DD o marca de tiempo completa ISO-8601). El primer valor indica el inicio del rango y el segundo valor indica el final del rango.
    Example: ["2022-01-01","2022-12-31"]

  - `created_at` (string)
    Devuelve los elementos que se actualizaron por última vez en la base de datos de Belvo en esta fecha (en formato YYYY-MM-DD).
    Example: "2022-05-05"

  - `created_at__gt` (string)
    Devuelve los elementos que se actualizaron por última vez en la base de datos de Belvo después de esta fecha (en formato YYYY-MM-DD).
    Example: "2022-05-05"

  - `created_at__gte` (string)
    Devuelve los elementos que se actualizaron por última vez en la base de datos de Belvo después o en esta fecha (en formato YYYY-MM-DD).
    Example: "2022-05-04"

  - `created_at__lt` (string)
    Devuelve los elementos que se actualizaron por última vez en la base de datos de Belvo antes de esta fecha (en formato YYYY-MM-DD).
    Example: "2022-04-01"

  - `created_at__lte` (string)
    Devuelve los elementos que se actualizaron por última vez en la base de datos de Belvo antes o en esta fecha (en formato YYYY-MM-DD).
    Example: "2022-03-30"

  - `created_at__range` (array)
    Devolver cuentas que fueron actualizadas por última vez en la base de datos de Belvo entre dos fechas (en formato YYYY-MM-DD). El primer valor indica el inicio del rango y el segundo valor indica el final del rango.
    Example: ["2022-01-01","2022-12-31"]

## Response 200 fields (application/json):

  - `count` (integer)
    El número total de resultados en tu cuenta de Belvo.
    Example: 130

  - `next` (string,null)
    La URL a la siguiente página de resultados. Cada página consta de hasta 100 elementos. Si no hay suficientes resultados para una página adicional, el valor es null.

En nuestro ejemplo de documentación, usamos {endpoint} como un valor de marcador de posición. En producción, este valor será reemplazado por el endpoint real que estás utilizando actualmente (por ejemplo, accounts o owners).
    Example: "https://sandbox.belvo.com/api/{endpoint}/?link=1bd948f7-245d-4313-b604-34d1044cb908page=2"

  - `previous` (string,null)
    La URL a la página anterior de resultados. Si no hay una página anterior, el valor es null.

  - `results` (array)
    Un arreglo de objetos de balance.

  - `results.id` (string, required)
    El identificador único creado por Belvo utilizado para referenciar el saldo actual.
    Example: "0b94bdf9-3719-43a9-81e7-be95d2318595"

  - `results.link` (string, required)
    El identificador único del enlace al que pertenece este balance.
    Example: "0b94bdf9-3719-43a9-81e7-be95d2318595"

  - `results.account_id` (string, required)
    El account.id de Belvo al que pertenece este balance.
    Example: "c4bfecf9-4eb6-4920-9f9f-e1f1e60ef321"

  - `results.account_internal_identification` (string, required)
    La identificación interna de la institución para la cuenta.
    Example: "92792126019929279212650822221989319252576"

  - `results.collected_at` (string, required)
    La marca de tiempo ISO-8601 cuando se recopiló el punto de datos.
    Example: "2024-05-21T08:32:00Z"

  - `results.created_at` (string, required)
    La marca de tiempo ISO-8601 de cuando se creó el punto de datos en la base de datos de Belvo.
    Example: "2024-05-21T08:32:00Z"

  - `results.last_updated_at` (string, required)
    La marca de tiempo ISO-8601 de cuando esta institución actualizó por última vez el saldo.

> 🚧 Advertencia
>
> El parámetro last_updated_at depende de cómo la institución procesa (o almacena) los datos. En el caso de que la institución almacene datos de manera sincrónica (es decir, tan pronto como ocurre una transacción, el saldo se actualiza), entonces last_updated_at reflejará el saldo en tiempo casi real. En el caso de que la institución almacene datos de manera asincrónica (es decir, recupera datos en bloque y luego actualiza el saldo), la información del saldo puede referirse a horas o días atrás. Además, en el caso de que la institución no pueda proporcionar la hora específica (debido a un error interno), la institución puede proporcionar una hora general en la que actualizaron por última vez la información de la cuenta y el saldo.
    Example: "2021-05-21T08:30:00Z"

  - `results.currency` (string, required)
    El código de moneda de tres letras (ISO-4217).
    Example: "USD"

  - `results.available` (number, required)
    El saldo disponible de la cuenta.
    Example: 1000.02

  - `results.blocked` (number, required)
    La cantidad que está actualmente bloqueada debido, por ejemplo, a transacciones pendientes.
    Example: 1000.02

  - `results.automatically_invested` (number, required)
    La cantidad que se invierte automáticamente (según lo acordado con la institución).
    Example: 1000.02

## Response 403 fields (application/json):

  - `code` (string)
    Un código de error único (access_to_resource_denied) que te permite clasificar y manejar el error de manera programática.

ℹ️ Consulta nuestro DevPortal para obtener más información sobre cómo manejar 403 access_to_resource_denied.
    Example: "access_to_resource_denied"

  - `message` (string)
    Una breve descripción del error.

Para los errores access_to_resource_denied, la descripción es:

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

  - `request_id` (string)
    Un ID único de 32 caracteres de la solicitud (que coincide con un patrón regex de: [a-f0-9]{32}). Proporcione este ID al contactar al equipo de soporte de Belvo para acelerar las investigaciones.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"

## Response 408 fields (application/json):

  - `code` (string)
    Un código de error único (request_timeout) que te permite clasificar y manejar el error de manera programática.

ℹ️ Consulta nuestro DevPortal para obtener más información sobre cómo manejar errores 408 request_timeout.
    Example: "request_timeout"

  - `message` (string)
    Una breve descripción del error.

Para los errores de request_timeout, la descripción es:

  - 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)
    Un ID único de 32 caracteres de la solicitud (que coincide con un patrón regex de: [a-f0-9]{32}). Proporcione este ID al contactar al equipo de soporte de Belvo para acelerar las investigaciones.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"

## Response 500 fields (application/json):

  - `code` (string)
    Un código de error único (unexpected_error) que te permite clasificar y manejar el error de manera programática.

ℹ️ Consulta nuestro DevPortal para obtener más información sobre cómo manejar errores 500 unexpected_error.
    Example: "unexpected_error"

  - `message` (string)
    Una breve descripción del error.

Para los errores unexpected_error, la descripción es:

- Belvo no puede procesar la solicitud debido a un problema interno del sistema o a una respuesta no soportada de una institución.
    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)
    Un ID único de 32 caracteres de la solicitud (que coincide con un patrón regex de: [a-f0-9]{32}). Proporcione este ID al contactar al equipo de soporte de Belvo para acelerar las investigaciones.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"