# Enumera los gastos recurrentes. ## ▶️ Uso Con el método List Recurring Expenses, puedes: 1. Listar los gastos recurrentes relacionados con un específico (usando el parámetro de consulta ). 2. Obtener los detalles de un específico (usando el parámetro de consulta ). 3. Listar todos los gastos recurrentes relacionados con tu cuenta de Belvo (sin usar ningún parámetro de consulta). ## 📖 Paginación Este método devuelve una respuesta paginada (por defecto: 100 elementos por página). Puedes usar el parámetro de consulta para aumentar el número de elementos devueltos hasta un máximo de 1000 elementos. Puedes usar el parámetro de consulta 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. ## 🔦 Filtrado de Respuestas Por favor, consulta la lista de consultas a continuación para ver una lista de 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. Endpoint: GET /api/recurring-expenses/ Version: 1.223.0 Security: basicAuth ## Query parameters: - `link` (string) El por el que deseas filtrar. ℹ️ Recomendamos encarecidamente añadir el filtro para mejorar tu rendimiento. Example: "8848bd0c-9c7e-4f53-a732-ec896b11d4c4" - `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. - `link__in` (array) Devuelve resultados solo para estos s. Example: ["5722d0ba-69d7-42dc-8ff5-33767b83c5d6"] - `account` (string) El por el que deseas filtrar. ℹ️ Recomendamos encarecidamente agregar filtros de o para mejorar tu rendimiento. Example: "8848bd0c-9c7e-4f53-a732-ec896b11d4c4" - `account__in` (array) Devuelve resultados solo para estos s. Example: ["85b77707-90ef-46fd-9059-5a757f24247a"] - `id` (string) Devuelve información solo para este recurso . Example: "24ccab1d-3a86-4136-a6eb-e04bf52b356f" - `id__in` (array) Devuelve información para estos s de recursos. Example: ["6b3dea0f-be29-49d1-aabe-1a6d588642e6"] ## 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 . En nuestro ejemplo de documentación, usamos 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, o ). 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 . - `results` (array) Matriz de objetos de gastos recurrentes. - `results.id` (string) Identificador único de Belvo para el elemento actual. Example: "0d3ffb69-f83b-456e-ad8e-208d0998d71d" - `results.account` (object,null, required) Detalles sobre la cuenta. : Para nuestro recurso de gastos recurrentes, esta cuenta se refiere a la cuenta que fue analizada para generar el informe de gastos recurrentes. - `results.account.link` (string,null) El al que pertenecen los datos. Example: "30cb4806-6e00-48a4-91c9-ca55968576c8" - `results.account.institution` (object) Detalles sobre la institución. - `results.account.institution.name` (string) El nombre de la institución, según lo designado por Belvo. Example: "erebor_mx_retail" - `results.account.institution.type` (string) El tipo de institución. Devolvemos uno de los siguientes valores: - - - Enum: "bank", "fiscal", "employment" - `results.account.collected_at` (string, required) La marca de tiempo ISO-8601 cuando se recopiló el punto de datos. Example: "2022-02-09T08:45:50.406032Z" - `results.account.created_at` (string) La marca de tiempo ISO-8601 de cuando se creó el punto de datos en la base de datos de Belvo. Example: "2022-02-09T08:45:50.406032Z" - `results.account.category` (string,null, required) El tipo de cuenta. Devolvemos uno de los siguientes valores del enum: - - - - - - - - Enum: "CHECKING_ACCOUNT", "CREDIT_CARD", "INVESTMENT_ACCOUNT", "LOAN_ACCOUNT", "PENSION_FUND_ACCOUNT", "SAVINGS_ACCOUNT", "UNCATEGORIZED", null - `results.account.balance_type` (string,null, required) Indica si esta cuenta es un o un . Puedes considerar el saldo de un como positivo, mientras que el saldo de un como negativo. Example: "ASSET" - `results.account.type` (string,null, required) El tipo de cuenta, según lo designado por la institución. Example: "Cuentas de efectivo" - `results.account.name` (string,null, required) El nombre de la cuenta, tal como lo proporciona la institución. Example: "Cuenta Perfiles- M.N. - MXN-666" - `results.account.number` (string,null, required) El número de cuenta, según lo designado por la institución. Example: "4057068115181" - `results.account.balance` (object, required) Detalles sobre los saldos actual y disponible de la cuenta. - `results.account.balance.current` (number,null, required) El saldo actual se calcula de manera diferente según el tipo de cuenta. - : El saldo de la cuenta del usuario en el momento del timestamp . - : La cantidad que el usuario ha gastado en el período de facturación actual de la tarjeta (consulte para obtener información sobre cuándo finaliza el período de facturación actual). - : La cantidad restante por pagar en el préstamo del usuario. Example: 5874.13 - `results.account.balance.available` (number,null) El saldo que el propietario de la cuenta puede utilizar. - : El saldo disponible puede ser diferente al saldo debido a transacciones pendientes. - : El monto de crédito que el usuario aún tiene disponible para el período actual. El saldo puede ser diferente al saldo debido a transacciones pendientes o cuotas futuras. - : El valor presente requerido para liquidar el préstamo, según lo proporcionado por la institución. Si la institución no proporciona este valor, devolvemos . Example: 5621.12 - `results.account.currency` (string,null, required) La moneda de la cuenta. Por ejemplo: - 🇧🇷 BRL (Real Brasileño) - 🇨🇴 COP (Peso Colombiano) - 🇲🇽 MXN (Peso Mexicano) Tenga en cuenta que pueden devolverse otras monedas además de las enumeradas anteriormente. Example: "MXN" - `results.account.public_identification_name` (string,null, required) El nombre público para el tipo de identificación. Por ejemplo: . ℹ️ Para cuentas de ahorro y cheques en 🇧🇷 Brasil, este campo será . Example: "CLABE" - `results.account.public_identification_value` (string,null, required) El valor para el . ℹ️ Para cuentas de ahorro y corrientes en 🇧🇷 Brasil, este campo será el número de agencia y cuenta bancaria, separados por una barra. Por ejemplo: . Example: "150194683119900273" - `results.account.last_accessed_at` (string,null, required) La marca de tiempo ISO-8601 del acceso más reciente y exitoso de Belvo a la institución para el enlace dado. Example: "2021-03-09T10:28:40.000Z" - `results.account.credit_data` (object,null, required) Las opciones de crédito asociadas con esta cuenta. - `results.account.credit_data.credit_limit` (number,null, required) La cantidad máxima de crédito que el propietario puede recibir. Example: 192000 - `results.account.credit_data.cutting_date` (string,null, required) La fecha de cierre del período de crédito, en formato . Example: "2019-12-11" - `results.account.credit_data.next_payment_date` (string, required) La fecha de vencimiento para el próximo pago, en formato . Example: "2019-12-13" - `results.account.credit_data.minimum_payment` (number,null, required) El monto mínimo a pagar en la . Example: 2400.3 - `results.account.credit_data.no_interest_payment` (number,null, required) La cantidad mínima requerida para pagar y evitar generar intereses. Example: 2690.83 - `results.account.credit_data.interest_rate` (number,null, required) La tasa de interés anualizada del crédito. Example: 4 - `results.account.credit_data.monthly_payment` (number,null) - `results.account.credit_data.last_payment_date` (string,null) - `results.account.credit_data.last_period_balance` (string,null) - `results.account.loan_data` (object,null, required) Las opciones de préstamo asociadas con esta cuenta. - `results.account.loan_data.contract_amount` (number,null) El monto total inicial del préstamo, calculado por la institución, cuando se firmó el contrato. Este monto incluye el principal + intereses + impuestos + tarifas. Example: 202000 - `results.account.loan_data.principal` (number,null, required) Monto total del préstamo (la cantidad que el usuario recibe). Example: 192000 - `results.account.loan_data.loan_type` (string,null) El tipo de préstamo, según la institución. Example: "Consignado" - `results.account.loan_data.payment_day` (string,null) El día del mes en el que el propietario necesita pagar el préstamo (). Example: "27" - `results.account.loan_data.outstanding_principal` (number,null) Monto pendiente del préstamo, es decir, cuánto queda por pagar del principal (sin incluir intereses). Example: 142023 - `results.account.loan_data.outstanding_balance` (number,null, required) El monto restante a pagar en total, incluidos los intereses. Example: 182000 - `results.account.loan_data.monthly_payment` (number,null, required) El pago mensual recurrente, si corresponde. Example: 1000 - `results.account.loan_data.interest_rates` (array,null, required) Desglose del interés aplicado al préstamo. - `results.account.loan_data.interest_rates.name` (string,null, required) El nombre del tipo de tasa de interés aplicada al préstamo. Example: "jurosEfetivo" - `results.account.loan_data.interest_rates.type` (string,null, required) El período en el que se aplica el interés al préstamo. Devolvemos uno de los siguientes valores: - - Enum: "MONTHLY", "YEARLY" - `results.account.loan_data.interest_rates.value` (number,null, required) La tasa de interés (en porcentaje o valor monetario). Example: 7.85 - `results.account.loan_data.fees` (array,null) Desglose de las tarifas aplicadas al préstamo. - `results.account.loan_data.fees.type` (string, required) El tipo de tarifa. Devolvemos uno de los siguientes valores: - - - Enum: "OPERATION_FEE", "INSURANCE_FEE", "OTHERS" - `results.account.loan_data.fees.value` (number, required) El valor total de la tarifa. Misma moneda del Préstamo. Example: 5.6 - `results.account.loan_data.number_of_installments_total` (integer,null) El número total de cuotas necesarias para pagar el préstamo. Example: 60 - `results.account.loan_data.number_of_installments_outstanding` (integer,null) El número de cuotas restantes por pagar. Example: 48 - `results.account.loan_data.contract_start_date` (string,null) La fecha en que se firmó el contrato de préstamo, en formato . Example: "2020-03-01" - `results.account.loan_data.contract_end_date` (string) La fecha en la que se espera que el préstamo se complete, en formato . Example: "2027-10-01" - `results.account.loan_data.contract_number` (string,null) El número de contrato del préstamo, tal como lo proporciona la institución. Example: "890ASLDJF87SD00" - `results.account.loan_data.credit_limit` (number,null) Por favor, consulte en su lugar. - `results.account.loan_data.last_period_balance` (number,null) Por favor, consulte en su lugar. - `results.account.loan_data.interest_rate` (number,null) Por favor, consulte el objeto en su lugar. - `results.account.loan_data.limit_day` (string,null) Por favor, consulte en su lugar. - `results.account.loan_data.cutting_day` (string,null) El día de cierre del mes para el préstamo. - `results.account.loan_data.cutting_date` (string,null) La fecha de cierre del período del préstamo, en formato . - `results.account.loan_data.last_payment_date` (string,null) La fecha en que se realizó el último pago del préstamo, en formato . - `results.account.loan_data.next_payment_date` (string,null) Por favor, use en su lugar, en formato . - `results.account.loan_data.no_interest_payment` (number,null) La cantidad mínima requerida para pagar y evitar generar intereses. - `results.account.funds_data` (array,null) Uno o más fondos que contribuyen a la cuenta de pensión. - `results.account.funds_data.name` (string,null) El nombre del fondo de pensiones. Example: "FIX X" - `results.account.funds_data.type` (string,null) Tipo de fondo de pensiones. Example: "CNPJ" - `results.account.funds_data.public_identifications` (array,null) Los IDs públicos del fondo. - `results.account.funds_data.public_identifications.name` (string, required) El tipo de número de identificación para el fondo. Example: "CNPJ" - `results.account.funds_data.public_identifications.value` (string,null, required) El número de identificación del fondo. Example: "05.954.445/0221-68" - `results.account.funds_data.balance` (number,null) El monto en el fondo. Example: 88427.94 - `results.account.funds_data.percentage` (number,null) Cuánto contribuye este fondo, como porcentaje, al total de la cuenta de pensión. Example: 100 - `results.account.bank_product_id` (string,null) - `results.account.internal_identification` (string,null) - `results.name` (string,null, required) El nombre para el gasto recurrente. ℹ️ : Esta información se toma de la sección de descripción de una transacción y luego se normaliza para proporcionarte un nombre fácil de leer. Por lo tanto, a veces el nombre reflejará el comerciante al que se realiza el pago (por ejemplo, Netflix.com), mientras que para otros gastos recurrentes, podría ser algo como "Pago mensual a John". Example: "Netflix" - `results.transactions` (array, required) Un array de objetos de transacción minificados se utiliza para evaluar el gasto recurrente. Si no se encuentran transacciones, devolvemos un array vacío. - `results.transactions.amount` (number, required) El monto de la transacción. Example: 2145.45 - `results.transactions.description` (string,null, required) La descripción de la transacción proporcionada por la institución. Por lo general, este es el texto que el usuario final vería en el estado de cuenta bancario. La descripción puede ser una cadena vacía. Para EYOD Risk Insights, la descripción es la que proporcionaste en la solicitud inicial. Example: "Netflix.com/march" - `results.transactions.value_date` (string, required) La fecha en que ocurrió la transacción, en formato . Example: "2019-10-23" - `results.frequency` (string, required) La frecuencia con la que ocurre este gasto recurrente. ℹ️ Belvo solo identifica frecuencias . Enum: "MONTHLY" - `results.average_transaction_amount` (number, required) El monto promedio de la transacción del gasto recurrente. Example: 32.9 - `results.median_transaction_amount` (number, required) El monto medio de la transacción del gasto recurrente. Example: 32.9 - `results.days_since_last_transaction` (integer, required) Número de días desde que ocurrió el último gasto recurrente. Según la frecuencia, puedes inferir cuántos días faltan para que ocurra el próximo cargo. Example: 5 - `results.category` (string, required) La categoría de transacción para el gasto recurrente. Para obtener más información sobre las categorías disponibles, consulte nuestra documentación de categorización de transacciones. - (Netflix, Spotify, Membresías de gimnasio) - (electricidad, teléfono, internet) - (adelantos en efectivo de tarjetas de crédito, préstamo estudiantil, arrendamiento de embarcaciones) - (seguro de hogar, automóvil, y salud & vida) - (viaje en Uber, airbnb, estacionamiento) - (tarifa de servicio, donación, impuestos judiciales) Enum: "Bills & Utilities", "Credits & Loans", "Insurance", "Online Platforms & Leisure", "Transport & Travel", "Taxes" - `results.payment_type` (string,null, required) El tipo de gasto recurrente. Devolvemos uno de los siguientes valores: - - Enum: "SUBSCRIPTION", "REGULAR" ## Response 403 fields (application/json): - `code` (string) Un código de error único () 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 , la descripción es: - . 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: ). Proporcione este ID al contactar al equipo de soporte de Belvo para acelerar las investigaciones. Example: "9e7b283c6efa449c9c028a16b5c249fb" ## Response 404 fields (application/json): - `code` (string) Un código de error único () que te permite clasificar y manejar el error de manera programática. Example: "not_found" - `message` (string) Una breve descripción del error. Para errores , la descripción es: - Example: "Not found" - `request_id` (string) Un ID único de 32 caracteres de la solicitud (que coincide con un patrón regex de: ). 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 () 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 , la descripción es: - . 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: ). Proporcione este ID al contactar al equipo de soporte de Belvo para acelerar las investigaciones. Example: "9e7b283c6efa449c9c028a16b5c249fb" ## Response 428 fields (application/json): - `code` (string) Un código de error único () que te permite clasificar y manejar el error de forma programática. ℹ️ Consulta nuestro DevPortal para obtener más información sobre cómo manejar errores 428 token_required. Example: "token_required" - `message` (string) Una breve descripción del error. Para los errores , la descripción es: - . Example: "A MFA token is required by the institution to login" - `request_id` (string) Un ID único de 32 caracteres de la solicitud (que coincide con un patrón regex de: ). Proporcione este ID al contactar al equipo de soporte de Belvo para acelerar las investigaciones. Example: "9e7b283c6efa449c9c028a16b5c249fb" - `session` (string) Un ID único de 32 caracteres de la sesión de inicio de sesión (que coincide con un patrón de regex de: ). Example: "2675b703b9d4451f8d4861a3eee54449" - `expiry` (integer) Tiempo de duración de la sesión en segundos. Example: 9600 - `link` (string) Identificador único creado por Belvo, utilizado para referenciar el Link actual. Example: "30cb4806-6e00-48a4-91c9-ca55968576c8" - `token_generation_data` (object) Detalles sobre cómo generar el token. - `token_generation_data.instructions` (string) Instrucciones para la generación de tokens. Example: "Use this code to generate the token" - `token_generation_data.type` (string) Tipo de datos para generar el token (código QR, desafío numérico). Example: "numeric" - `token_generation_data.value` (string) Valor a utilizar para generar el token. Example: "12345" - `token_generation_data.expects_user_input` (boolean) Indica si el usuario necesita proporcionar información para completar la autenticación. Cuando se establece en , es posible que su usuario necesite: - confirmar el inicio de sesión en otro dispositivo - escanear un código QR Aún necesitará realizar una llamada PATCH para completar la solicitud. Example: true ## Response 500 fields (application/json): - `code` (string) Un código de error único () 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 , la descripción es: - . 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: ). Proporcione este ID al contactar al equipo de soporte de Belvo para acelerar las investigaciones. Example: "9e7b283c6efa449c9c028a16b5c249fb"