openapi: 3.0.2
info:
  title: Documentación de la API de Belvo
  version: 1.222.0
  description: >-
    # Introducción


    Alcanza nuevas audiencias y convierte más usuarios conectándote fácil y
    seguramente a sus datos financieros, entendiendo su comportamiento y
    habilitando pagos instantáneos con finanzas abiertas. A través de nuestra
    API, puedes acceder a:


    ## Información Disponible y Métodos de Pago


    Belvo es una API de banca abierta para América Latina que permite a las
    empresas acceder a información bancaria y fiscal de manera segura y ágil.


    A través de nuestra API, puedes acceder a:


    - Información Bancaria en Brasil

    - Información Laboral en Brasil

    - Información Laboral en México

    - Información Fiscal en México

    - Información Fiscal en Chile


    También puedes usar nuestra API para realizar pagos en:


    - Brasil

    - México


    ## Diccionarios de Datos


    Si deseas la documentación de respuesta en formato Excel o CSV, por favor
    descárgalos desde nuestro Repositorio Público de GitHub: <a
    href="https://github.com/belvo-finance-opensource/documentation"
    target="_blank">Diccionarios de Datos de Belvo Open Finance</a>.


    Nuestros archivos EXCEL y CSV están adicionalmente localizados en español y
    portugués (Brasil).


    ## Entornos


    Actualmente ofrecemos dos entornos: sandbox y producción.


    ### Sandbox


    Disponible para:


    - 🟢 Agregación y Enriquecimiento

    - ⚪️ Iniciación de Pagos


    Usa nuestro entorno Sandbox para construir tu integración. Ofrecemos datos
    ficticios que imitan casos de uso del mundo real, lo que significa que
    puedes probar todos los endpoints, usar el widget e implementar webhooks,
    tal como lo harías con datos reales.


    Todo lo que necesitas para comenzar con el entorno Sandbox es obtener tus
    claves API. Realmente recomendamos que comiences creando tu integración en
    este entorno.


    ### Producción


    Disponible para:


    - 🟢 Agregación y Enriquecimiento

    - 🟢 Iniciación de Pagos


    Después de haber probado tu integración en el entorno Sandbox y estar listo
    para ir en vivo, necesitarás solicitar acceso a nuestro entorno de
    Producción. Después de solicitar acceso, nuestro equipo de ventas se pondrá
    en contacto contigo para programar una reunión solo para asegurarse de que
    se cumplan tus necesidades, y luego solo necesitarás pasar por un proceso de
    certificación con uno de nuestros ingenieros para asegurarte de que tu
    integración esté funcionando de manera óptima. Para prepararte para la
    reunión de certificación, solo sigue nuestra lista de verificación de
    integración.


    Una vez que tu integración esté certificada, todo lo que necesitarás hacer
    es:


    - [ ] Solicitar claves API de Producción (y cambiar tus claves API de
    Sandbox en el código por estas nuevas).

    - [ ] Cambiar la URL base a la que haces solicitudes de `sandbox.belvo.com`
    a `api.belvo.com`.

    - [ ] Si estás usando webhooks, asegúrate de establecer una URL de
    Producción para tus webhooks.


    ## Códigos de Respuesta


    Usamos el siguiente código de estado HTTP en la respuesta dependiendo del
    éxito o fracaso:


    | Código de Estado | Descripción |

    |-----------|-------|

    | `200` | ✅ **Éxito** - El contenido está disponible en el cuerpo de la
    respuesta. |

    | `201` | ✅ **Éxito** - El contenido fue creado exitosamente en Belvo. |

    | `204` | ✅ **Éxito** - No hay contenido para devolver. |

    | `400` | ❌ **Error de Solicitud Incorrecta** - La solicitud devolvió un
    error, detalle en el contenido.|

    | `401` | ❌ **No Autorizado** - Las credenciales de Belvo proporcionadas no
    son válidas.|

    | `404` | ❌ **No Encontrado** - El recurso al que intentas acceder no se
    puede encontrar.|

    | `405` | ❌ **Método No Permitido** - El método HTTP que estás usando no es
    aceptado para este recurso.|

    | `408` | ❌ **Tiempo de Solicitud Agotado** - La solicitud se agotó y fue
    terminada por el servidor.|

    | `428` | ❌ **Se Requiere Token MFA** - La institución requirió un token MFA
    para conectar. |

    | `500` | ❌ **Error Interno del Servidor** - El detalle del error está
    disponible en el cuerpo de la respuesta.|


    ## Manejo de Errores


    Los errores de la API de Belvo se devuelven en formato JSON. Por ejemplo, un
    error podría verse así:


    ```json

    [
        {
          "request_id": "a6e1c493d7a29d91aed4338e6fcf077d",
          "message": "Este campo es obligatorio.",
          "code": "required",
          "field": "link"
        }
    ]

    ```


    Típicamente, una respuesta de error tendrá los siguientes parámetros:


    - `request_id`: un ID único para la solicitud, debes compartirlo con el
    equipo de soporte de Belvo para investigaciones.

    - `message`: descripción del error en lenguaje humano.

    - `code`: un código único para el error. Consulta la tabla a continuación
    para ver cómo manejar cada código de error.

    - `field` *(opcional)*: El campo específico en el cuerpo de la solicitud que
    tiene un problema.


    ### Identificador de Solicitud


    Cuando necesites ayuda con un error específico, incluye el identificador de
    solicitud (`request_id`) en tu mensaje al equipo de soporte de Belvo. Esto
    acelerará las investigaciones y te permitirá volver a funcionar en poco
    tiempo.


    ### Códigos de Error y Solución de Problemas


    Para una lista completa de errores y cómo solucionarlos, por favor consulta
    nuestro artículo dedicado <a
    href="../developer_resources/resources-belvo-api-errors"
    target="_blank">Manejo de Errores</a>.


    ### Política de Reintentos


    #### Errores 50x


    Implementa un retroceso exponencial automatizado de hasta cinco reintentos.
    Recomendamos usar un intervalo base de tres segundos con un factor de dos.
    Por ejemplo, el primer reintento debe ser después de tres segundos, el
    segundo reintento después de seis segundos (2 * 3), el tercer reintento
    después de 12 segundos (2 * 6), el cuarto reintento después de 24 segundos
    (2 * 12), y el quinto reintento después de 48 segundos (2 * 24).


    #### Errores 40x


    No debes reintentar hacer solicitudes si recibes una respuesta 40x, ya que
    esto es un error del cliente.


    La única excepción es el error de "Demasiadas Sesiones", ya que significa
    que tu usuario final está accediendo a la cuenta desde otro navegador al
    mismo tiempo. En este caso, por favor implementa la misma política de
    reintentos que con los errores 50x.


    ## Campos Obsoletos


    En nuestro esquema, puedes ver que un campo ha sido marcado como
    `deprecated`. 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 debes **confiar** en este campo.


    ## OpenAPI: campos requeridos y anulables


    En nuestra especificación de API, verás que algunos parámetros de respuesta
    tendrán una anotación de **required**. Según la especificación de OpenAPI,
    cuando un parámetro de respuesta está marcado como **required**, esto
    significa que la clave de respuesta debe ser devuelta. Sin embargo, el valor
    de ese parámetro de respuesta puede ser `null`.


    > 📘 Info

    > 

    > En resumen, cualquier parámetro de respuesta marcado como requerido será
    devuelto por nuestra API, pero el valor puede ser establecido en null.
  contact:
    name: Need help?
    url: https://developers.belvo.com
    email: support@belvo.com
  x-logo:
    url: https://files.readme.io/5111448-belvo-for-developers.svg
    altText: Belvo Logo
servers:
  - url: https://sandbox.belvo.com
    description: Sandbox
security:
  - basicAuth: []
tags:
  - name: Institutions
    description: >-
      Una **institución** es una entidad de la que Belvo puede acceder a
      información. Puede ser una:


      - institución bancaria, como Nubank Brasil.

      - institución fiscal, como el *Servicio de Administración Tributaria
      (SAT)* en México.

      - institución de empleo, como el *Instituto Mexicano del Seguro Social
      (IMSS)* en México o el *Instituto Nacional do Seguro Social (INSS)* en
      Brasil.
  - name: Links
    description: >-
      Un **Link** es un conjunto de credenciales asociadas al acceso de un
      usuario final a una **institución**. Necesitarás registrar un **Link**
      antes de acceder a la información de ese usuario final específico, como
      los detalles de cuenta o transacciones.


      Recomendamos usar el Belvo Hosted Widget para gestionar el proceso de
      conexión.
  - name: Consents
    description: >-
      Un consentimiento es un permiso otorgado por el usuario final para acceder
      a sus datos financieros en la Red de Finanzas Abiertas en Brasil.
  - name: Accounts
    description: >-
      Una **cuenta** es la representación de una cuenta bancaria dentro de una
      institución financiera. Un usuario puede tener una o más cuentas en una
      institución.


      Por ejemplo, un usuario (o enlace) puede tener una cuenta corriente,
      varias tarjetas de crédito y una cuenta de préstamo.


      Consultar la información de la cuenta de un usuario es útil ya que puedes
      obtener información sobre:


      - qué tipos de cuentas tiene el usuario.

      - el saldo de cada cuenta (ahorros, cuenta corriente, tarjeta de crédito,
      préstamo, etc.).

      - información detallada sobre sus gastos con tarjeta de crédito.

      - la situación actual de cualquier préstamo que puedan tener.
  - name: Transactions
    description: >-
      Una **transacción** contiene la información detallada de cada movimiento
      dentro de una cuenta. Por ejemplo, una compra en una tienda o un
      restaurante.
  - name: Owners
    description: >-
      Un **owner** representa a la persona que tiene acceso a un Link y es el
      propietario de todas las cuentas dentro del Link.


      Puedes usar este endpoint para obtener información útil sobre tu cliente,
      como:


      - su nombre completo

      - información de contacto clave

      - información sobre el documento de identificación que usaron al abrir la
      cuenta
  - name: Bills
    description: >-
      Una **bill** se refiere a la factura de la tarjeta de crédito que un
      usuario recibe para una cuenta determinada.
  - name: Balances
    description: >-
      Un saldo es la cantidad de dinero disponible en una cuenta bancaria
      determinada (corriente o de ahorros) en un momento dado.
  - name: Employments Brazil
    description: >-
      Nuestro recurso de empleos para Brasil te permite obtener una vista
      completa del historial laboral actual de tu usuario y la información
      salarial.


      Para cada usuario, proporcionamos:


      - historial laboral (incluyendo ocupaciones y datos del empleador)

      - información salarial histórica y actual (por empleador)


      En este momento, el recurso de empleos está disponible para:


      - 🇧🇷 Brasil (INSS)
  - name: Employment Records Mexico
    description: >-
      Nuestro recurso de registros de empleo para México te permite obtener una
      visión completa de las contribuciones actuales al seguro social y el
      historial laboral de tu usuario.


      Con el recurso de registros de empleo de Belvo para México, puedes acceder
      a información sobre las contribuciones actuales al seguro social y el
      historial laboral de tu usuario. Para cada usuario, proporcionamos:


      - datos personales

      - historial laboral

      - salario base diario histórico y actual

      - ¡y más!


      En este momento, el recurso de registros de empleo está disponible para:


      - 🇲🇽 México (IMSS)

      - 🇲🇽 México (ISSSTE)
  - name: Current Employments Mexico
    description: >-
      El recurso de Empleos Actuales proporciona acceso en tiempo real al estado
      de empleo actual de individuos en México. Este recurso ofrece información
      detallada sobre si una persona está actualmente empleada o desempleada,
      junto con sus registros de empleo activos.


      ## Características Clave


      - **Estado de Empleo en Tiempo Real**: Obtén información actualizada sobre
      la situación laboral actual de una persona

      - **Actual vs Histórico**: A diferencia de los Registros de Empleo, este
      recurso se centra específicamente en el estado de empleo actual en lugar
      de los datos históricos de empleo

      - **Detalles Completos de Empleo**: Cuando está empleado, recibe
      información detallada que incluye detalles del empleador, información
      salarial y duración del empleo

      - **Estado de Desempleo**: Indicación clara cuando una persona está
      actualmente desempleada


      Cuando una persona está **empleada**, recibirás:

      - Datos de identificación personal (nombre, fecha de nacimiento, NSS,
      CURP)

      - Estado de empleo actual

      - Información del empleador (nombre, RFC, ID)

      - Ubicación del empleo (estado)

      - Duración del empleo (días empleados)

      - Información salarial (salario base y mensual)
  - name: Incomes
    description: >-
      Utiliza el endpoint de Incomes para obtener información sobre las fuentes
      de ingresos de una cuenta en los últimos 365 días. Este endpoint es
      particularmente útil cuando deseas verificar los ingresos de una persona.


      > 📘 Información

      >

      > El recurso de incomes está **solo** disponible para cuentas de Checking
      y Savings asociadas con enlaces bancarios.
  - name: Recurring Expenses
    description: >-
      La API de Gastos Recurrentes de Belvo te permite identificar los pagos
      regulares de un usuario para servicios de suscripción, como Netflix o
      membresías de gimnasio, así como pagos de servicios públicos, como
      facturas de electricidad o teléfono. Devolvemos información de hasta 365
      días.


      > 📘 Info

      >

      > El recurso de gastos recurrentes está **solo** disponible para cuentas
      de Cheques, Ahorros y Tarjetas de Crédito asociadas con enlaces bancarios.
  - name: Payment Institutions (Brazil)
    description: >-
      Una **institución de pago** es una entidad de la que Belvo puede acceder a
      información. Puedes ver una lista completa de instituciones disponibles
      para pagos haciendo una solicitud de Lista a este endpoint.
  - name: Customers (Brazil)
    description: >-
      Un **customer** es el pagador que va a transferir fondos a tu cuenta
      bancaria. Necesitas crear un customer para recibir pagos entrantes en la
      cuenta bancaria de tu organización.
  - name: Bank Accounts (Brazil)
    description: >-
      Para recibir pagos entrantes en la cuenta bancaria de su organización,
      debe registrar las cuentas bancarias (individuales y empresariales)
      utilizando la Payments API de Belvo.


      - Las cuentas bancarias **individuales** deben ser creadas para cada
      pagador (su cliente).

      - Las cuentas bancarias **empresariales** deben ser creadas para el
      beneficiario del pago (su organización).
  - name: Payment Links (Brazil)
    description: Este es un enlace de pago.
  - name: Payment Intents (Brazil)
    description: >-
      Un **payment intent** es un punto único de acceso para crear pagos
      utilizando cualquier método de pago ofrecido por Belvo.


      Un payment intent captura toda la información del pago (como el monto a
      cobrar, la descripción del pago, el proveedor, etc.) y guía a tus clientes
      a través del flujo de pago.


      > **Nota:** Para las instituciones que requieren el `username_type` en el
      array `form_fields`, debes enviar este valor en tu solicitud PATCH.
  - name: Payment Authorizations (Brazil)
    description: >-
      Una Autorización de Pago es el consentimiento que tu usuario te da para
      cargar (debitando dinero de) sus cuentas. Necesitas realizar una
      Autorización de Pago por cada ‘contrato’ (por ejemplo, si tu empresa
      maneja tanto electricidad como agua pero se facturan por separado,
      entonces deberás crear dos Autorizaciones de Pago separadas).


      Una vez que el usuario confirma la autorización, necesitarás escuchar un
      webhook `PAYMENT_AUTHORIZATION` con el estado configurado en `AUTHORIZED`.
      Una vez que recibas este webhook, el proceso de autorización estará
      completo y podrás cargar a tu usuario.


      {% admonition type="info" name="¿Qué es un cargo?" %}

      Un **cargo** representa el pago individual (débito) que tu cliente
      realizará.

      {% /admonition %}


      {% admonition type="danger" name="Encabezado de Versión" %}
        El recurso de Autorización de Pago requiere que envíes el encabezado `X-Belvo-API-Resource-Version` configurado en `Payments-BR.V2`.
      {% /admonition %}
  - name: Biometric Pix Widget Access Token (Brazil)
    description: >-
      Utilice las solicitudes de Token del Biometric Pix Widget para crear un
      token de acceso para Pagos Biométricos.
  - name: Payment Transactions (Brazil)
    description: >-
      Cada vez que recibes un pago entrante de tu cliente, se crea una
      **transacción** en la base de datos de Belvo.


      Puedes utilizar el recurso de Payment Transactions para obtener
      información útil sobre una transacción, así como el cargo específico
      asociado con ella.
paths:
  /api/institutions/:
    get:
      tags:
        - Institutions
      operationId: ListInstitutions
      summary: Enumerar instituciones
      description: >-
        ## ▶️ Uso


        Con el método List Institutions, puedes:


        1. Listar todas las instituciones disponibles en Belvo.


        ## 📖 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 <a
        href="https://developers.belvo.com/docs/belvo-pagination-tips"
        target="_blank">Consejos de paginación</a>.


        ## 🔦 Filtrado de Respuestas


        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 <a
        href="https://developers.belvo.com/docs/searching-and-filtering"
        target="_blank">Filtrado de respuestas</a>.
      parameters:
        - $ref: '#/components/parameters/page_size'
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/display_name'
        - $ref: '#/components/parameters/country_code'
        - $ref: '#/components/parameters/country_code__in'
        - $ref: '#/components/parameters/resources__allin'
        - $ref: '#/components/parameters/name'
        - $ref: '#/components/parameters/name__in'
        - $ref: '#/components/parameters/status_institutions'
        - $ref: '#/components/parameters/status__in_institutions'
        - $ref: '#/components/parameters/type_institutions'
        - $ref: '#/components/parameters/type__in_institutions'
        - $ref: '#/components/parameters/website'
      responses:
        '200':
          description: De acuerdo
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - $ref: '#/components/schemas/common_pagination_properties'
                  - properties:
                      results:
                        type: array
                        description: Matriz de objetos de institución.
                        items:
                          $ref: '#/components/schemas/InstitutionPublicApi'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
  /api/institutions/{id}/:
    get:
      tags:
        - Institutions
      operationId: DetailInstitution
      summary: Obtener los detalles de una institución
      description: Obtén los detalles de una institución específica.
      parameters:
        - name: id
          required: true
          in: path
          description: >-
            El `institution.id` sobre el cual deseas obtener información
            detallada.
          schema:
            type: string
            pattern: '[0-9]+'
      responses:
        '200':
          description: De acuerdo
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InstitutionPublicApi'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
  /api/links/:
    get:
      tags:
        - Links
      operationId: ListLinks
      summary: Enumerar enlaces
      description: >-
        ## ▶️ Uso


        Con el método List Links, puedes:


        1. Listar todos los enlaces relacionados con tu cuenta de Belvo (sin
        usar parámetros de consulta).

        2. Obtener los detalles de un `link.id` específico (usando el parámetro
        de consulta `id`).


        ## 📖 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 <a
        href="https://developers.belvo.com/docs/belvo-pagination-tips"
        target="_blank">Consejos de Paginación</a>.


        ## 🔦 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 <a
        href="https://developers.belvo.com/docs/searching-and-filtering"
        target="_blank">Filtrado de respuestas</a>.
      parameters:
        - $ref: '#/components/parameters/page_size'
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/id__in'
        - $ref: '#/components/parameters/institution'
        - $ref: '#/components/parameters/institution__in'
        - $ref: '#/components/parameters/access_mode'
        - $ref: '#/components/parameters/created_at'
        - $ref: '#/components/parameters/created_at__gt'
        - $ref: '#/components/parameters/created_at__gte'
        - $ref: '#/components/parameters/created_at__lt'
        - $ref: '#/components/parameters/created_at__lte'
        - $ref: '#/components/parameters/created_at__range'
        - $ref: '#/components/parameters/created_by__not_in'
        - $ref: '#/components/parameters/external_id'
        - $ref: '#/components/parameters/external_id__in'
        - $ref: '#/components/parameters/institution_user_id'
        - $ref: '#/components/parameters/institution_user_id__in'
        - $ref: '#/components/parameters/refresh_rate'
        - $ref: '#/components/parameters/status_links'
        - $ref: '#/components/parameters/status__in_links'
      responses:
        '200':
          description: De acuerdo
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - $ref: '#/components/schemas/common_pagination_properties'
                  - properties:
                      results:
                        type: array
                        description: Matriz de objetos de enlace.
                        items:
                          $ref: '#/components/schemas/Link'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
    post:
      tags:
        - Links
      operationId: RegisterLink
      summary: Registrar un nuevo enlace
      description: >-
        ## ▶️ Uso


        Registra un nuevo enlace (una conexión entre tu usuario y su
        institución) utilizando la API de Belvo.


        > 👍 Recomendamos encarecidamente usar nuestro <a
        href="https://developers.belvo.com/docs/connect-widget"
        target="_blank">Connect Widget</a> para manejar la creación de enlaces y
        las actualizaciones de estado de los enlaces.


        Para facilitar las cosas, hemos incluido ejemplos personalizados para
        los enlaces que puedes crear para cada uno de nuestros productos.
        Simplemente haz clic en el tipo de enlace que deseas crear en la sección
        **Body Params** a continuación.
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/LinksRequestEmploymentBrazil'
                - $ref: '#/components/schemas/LinksRequestEmploymentMexico'
                - $ref: '#/components/schemas/LinksRequestFiscalMexico'
      responses:
        '201':
          description: Creado
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Link'
        '400':
          $ref: '#/components/responses/400_bad_request_error'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '428':
          $ref: '#/components/responses/428_token_required_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
    patch:
      tags:
        - Links
      operationId: PatchLinks
      summary: Completar una solicitud de enlaces
      description: >-
        Se utiliza para reanudar una sesión de registro de Link que se pausó
        porque la institución requería un token MFA.
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchBody'
      responses:
        '200':
          description: De acuerdo
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Link'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '428':
          $ref: '#/components/responses/428_token_required_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
  /api/links/{id}/:
    get:
      tags:
        - Links
      operationId: DetailLink
      summary: Obtener los detalles de un enlace
      description: Obtén los detalles de un enlace específico.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: El `link.id` sobre el cual deseas obtener información detallada.
      responses:
        '200':
          description: De acuerdo
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Link'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '428':
          $ref: '#/components/responses/428_token_required_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
    patch:
      tags:
        - Links
      operationId: ModifyLinkDataRetrieval
      summary: Modificar la recuperación de datos de un enlace
      description: >-
        Modifique la configuración de recuperación de datos para un enlace
        específico. Actualmente puede:

          - Cambiar el modo de acceso de un enlace de `single` a `recurrent` o de `recurrent` a `single`.
          - Modificar el período `stale_in` para el enlace.
          - Modificar los recursos históricos que desea recuperar para el enlace (`fetch_resources`).

        ## Cambiando el `access_mode` de un enlace


        Cuando cambia un enlace de `single` a `recurrent`, al día siguiente se
        activa una actualización histórica de los recursos principales para el
        enlace (lo que resulta en que reciba webhooks de `historical_update`
        para el enlace). Se le cobrará por estas actualizaciones históricas.


        ## Modificando `stale_in`


        Si solo modifica el período `stale_in` para un enlace, esto no activará
        una actualización histórica. Para activar una actualización histórica
        para el enlace, debe cambiar el `access_mode`.


        ## Modificando `fetch_resources`


        Si solo modifica los `fetch_resources` para un enlace, esto no activará
        una actualización histórica. Para activar una actualización histórica
        para el enlace, debe cambiar el `access_mode`.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            example: e4bb1afb-4a4f-4dd6-8be0-e615d233185b
          description: >-
            El `link.id` para el que deseas cambiar el `access_mode`, `stale_in`
            o `fetch_resources`.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangeAccessMode'
      responses:
        '200':
          description: De acuerdo
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Link'
        '400':
          $ref: '#/components/responses/400_bad_request_error'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '428':
          $ref: '#/components/responses/428_token_required_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
    put:
      tags:
        - Links
      operationId: UpdateLink
      summary: Actualizar las credenciales de un enlace
      description: >-
        Actualiza las credenciales de un enlace específico. Si el enlace
        actualizado con éxito es recurrente, automáticamente activamos una
        actualización del enlace. Si encontramos datos nuevos, recibirás
        webhooks de <a href="https://developers.belvo.com/docs/webhooks"
        target="_blank">actualización histórica</a>.


        > 👍 Usa nuestro Connect Widget

        >

        > Recomendamos usar nuestro <a
        href="https://developers.belvo.com/docs/connect-widget"
        target="_blank">Connect Widget</a> para manejar la actualización de
        enlaces <code>invalid</code> o <code>token_required</code>.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: El `link.id` que deseas actualizar.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LinksPutRequest'
      responses:
        '200':
          description: De acuerdo
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Link'
        '400':
          $ref: '#/components/responses/400_bad_request_error'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '428':
          $ref: '#/components/responses/428_token_required_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
    delete:
      tags:
        - Links
      operationId: DestroyLink
      summary: Eliminar un enlace
      description: >-
        Elimina un enlace específico y todos los datos asociados (por ejemplo:
        transacciones, cuentas, facturas, declaraciones de impuestos, empleos,
        etc.) de ese enlace de tu cuenta de Belvo. Esta acción es irreversible y
        no podrás recuperar los datos eliminados.


        {% admonition type="success" name="Usa el encabezado
        X-Belvo-Request-Mode: async" %}
          Recomendamos encarecidamente establecer el encabezado `X-Belvo-Request-Mode` a `async` para habilitar la eliminación asincrónica. De esta manera, evitarás el límite de tasa de 5 eliminaciones por minuto. Cuando se establece, el endpoint responderá con un estado `202 Accepted` y proporcionará un ID de solicitud para rastrear el proceso de eliminación. Una vez que el proceso esté completo, recibirás una notificación webhook `link_deleted`.
          
          Si no configuras este encabezado, el endpoint responderá con un estado `204 No Content`, pero estarás sujeto al límite de tasa de 5 eliminaciones por minuto. Si excedes este límite, recibirás un error `429 Too Many Requests`.
        {% /admonition %}
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: El `link.id` que deseas eliminar.
        - name: X-Belvo-Request-Mode
          in: header
          required: false
          schema:
            type: string
            enum:
              - async
          description: >-
            Configura a `async` para habilitar la eliminación asincrónica, lo
            que evita la limitación de tasa. Cuando se establece, el endpoint
            devuelve una respuesta `202 Accepted` con un ID de solicitud. Más
            tarde recibirás una notificación de webhook cuando la eliminación
            esté completa.
      responses:
        '202':
          description: Aceptado
          content:
            application/json:
              schema:
                type: object
                properties:
                  request_id:
                    type: string
                    format: uuid
                    description: >-
                      El identificador único para rastrear la solicitud de
                      eliminación asíncrona.
                required:
                  - request_id
        '204':
          description: No hay contenido
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '428':
          $ref: '#/components/responses/428_token_required_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
  /api/links/{id}/refresh/:
    post:
      tags:
        - Links
      operationId: RefreshHistoricalDataForLink
      summary: Activar una actualización histórica para un enlace
      description: >-
        {% admonition type="warning" name="Límite de Solicitudes Concurrentes"
        %}
          Para prevenir solicitudes duplicadas, este endpoint tiene un período de enfriamiento de 10 minutos por enlace. Si intentas actualizar el mismo enlace dentro de los 10 minutos de una solicitud previa, recibirás un error `409 Conflict` con el mensaje `"The link has already been refreshed. Please wait X minutes before trying again."`.
        {% /admonition %}


        Usa este método para desencadenar una actualización histórica para un
        enlace específico (único o recurrente). Utiliza el parámetro
        `fetch_resources` para especificar qué recursos deseas actualizar. Si no
        especificas este parámetro, la actualización histórica se realizará para
        todos los recursos soportados por la institución con la que está
        asociado el enlace.


        En una solicitud exitosa, nuestra API responderá con un código de estado
        `202` y un `request_id` que podrás usar posteriormente para asociar un
        webhook de `historical_update` a esta solicitud.


        {% admonition type="info" name="No actualiza la definición del enlace"
        %}
          Este endpoint no actualiza la definición del enlace en sí, solo los datos históricos para los recursos especificados. Si deseas cambiar permanentemente el `fetch_resources` del enlace, deberías usar el método **Modificar la recuperación de datos de un enlace** en su lugar.
        {% /admonition %}
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            example: e4bb1afb-4a4f-4dd6-8be0-e615d233185b
          description: El `link.id` que deseas actualizar.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                fetch_resources:
                  type: array
                  description: >-
                    Un arreglo de recursos para los que te gustaría recibir una
                    actualización histórica. Si no especificas este campo, la
                    actualización histórica se realizará para todos los recursos
                    compatibles con la institución.


                    {% admonition type="warning" name="Recursos No Soportados
                    para un Enlace" %}
                      Si especificas un recurso que no es compatible con la institución, devolvemos un error `400 Bad Request`, especificando qué recursos son compatibles para el enlace dado.
                    {% /admonition %}
                  items:
                    type: string
                    description: Un recurso de Belvo que la institución admite.
                    example: ACCOUNTS
                  example:
                    - ACCOUNTS
                    - TRANSACTIONS
                    - OWNERS
      responses:
        '202':
          description: Solicitud de actualización histórica aceptada
          content:
            application/json:
              schema:
                type: object
                properties:
                  request_id:
                    type: string
                    description: >-
                      El ID único para esta solicitud. Recomendamos que almacene
                      este valor para identificar más tarde qué evento de
                      webhook se relaciona con una solicitud asincrónica.
                    example: b5d0106ac9cc43d5b36199fe831f6bbe
                required:
                  - request_id
        '400':
          $ref: '#/components/responses/400_bad_request_error'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '409':
          $ref: '#/components/responses/409_link_already_refreshed'
        '428':
          $ref: '#/components/responses/428_token_required_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
  /api/consents/:
    get:
      tags:
        - Consents
      operationId: ListConsents
      summary: Listar consentimientos
      description: >-
        ## ▶️ Uso


        Con el método Consents, puedes:


        1. Listar todos los consentimientos 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 `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 <a
        href="https://developers.belvo.com/docs/belvo-pagination-tips"
        target="_blank">Consejos de Paginación</a>.


        ## 🔦 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 <a
        href="https://developers.belvo.com/docs/searching-and-filtering"
        target="_blank">Filtrando respuestas</a>.
      parameters:
        - $ref: '#/components/parameters/pageSize_query'
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/document_number'
      responses:
        '200':
          description: De acuerdo
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - $ref: '#/components/schemas/common_pagination_properties'
                  - properties:
                      results:
                        type: array
                        description: Matriz de objetos de consentimiento.
                        items:
                          $ref: '#/components/schemas/Consents'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
  /api/consents/{id}/:
    get:
      tags:
        - Consents
      operationId: DetailConsent
      summary: Obtener los detalles de un consentimiento
      description: Obtén los detalles de un consentimiento específico.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: El `consent.id` sobre el cual deseas obtener información detallada.
      responses:
        '200':
          description: De acuerdo
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Consents'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
  /api/token/:
    post:
      tags:
        - Widget Access Token
      summary: Generar un token de acceso para el widget
      operationId: GenerateWidgetAccessToken
      description: >-
        Generar un token de acceso para el widget de OFDA o el widget de Banking
        Aggregation.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/WidgetTokenRequestOFDA'
                - $ref: '#/components/schemas/WidgetTokenRequestBankingAggregation'
      responses:
        '200':
          description: Operación exitosa
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WidgetToken'
        '400':
          $ref: '#/components/responses/400_bad_request_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
  /api/accounts/:
    get:
      tags:
        - Accounts
      operationId: ListAccounts
      summary: Listar cuentas
      description: >-
        ## ▶️ Uso


        Con el método List Accounts, puedes:


        1. Listar cuentas relacionadas con un `link.id` específico (usando el
        parámetro de consulta `link`).

        2. Obtener los detalles de un `account.id` específico (usando el
        parámetro de consulta `id`).

        3. **[No Recomendado]** Listar todas las cuentas relacionadas con tu
        cuenta de Belvo (sin usar ningún parámetro de consulta).


        ## 🔦 Filtrado de Respuestas


        Consulta la lista de campos a continuación para ver por cuáles puedes
        filtrar tus respuestas. Para más información sobre cómo usar filtros,
        consulta nuestro artículo <a
        href="https://developers.belvo.com/docs/searching-and-filtering"
        target="_blank">Filtrado de respuestas</a>.


        ## 📖 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 <a
        href="https://developers.belvo.com/docs/belvo-pagination-tips"
        target="_blank">Consejos de Paginación</a>.


        ## 🚨 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.
      parameters:
        - $ref: '#/components/parameters/link'
        - $ref: '#/components/parameters/page_size'
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/link__in'
        - $ref: '#/components/parameters/balance__available'
        - $ref: '#/components/parameters/balance__available__lt'
        - $ref: '#/components/parameters/balance__available__lte'
        - $ref: '#/components/parameters/balance__available__gt'
        - $ref: '#/components/parameters/balance__available__gte'
        - $ref: '#/components/parameters/balance__available__range'
        - $ref: '#/components/parameters/balance__current'
        - $ref: '#/components/parameters/balance__current__lt'
        - $ref: '#/components/parameters/balance__current__lte'
        - $ref: '#/components/parameters/balance__current__gt'
        - $ref: '#/components/parameters/balance__current__gte'
        - $ref: '#/components/parameters/balance__current__range'
        - $ref: '#/components/parameters/category'
        - $ref: '#/components/parameters/category__in'
        - $ref: '#/components/parameters/created_at'
        - $ref: '#/components/parameters/created_at__gt'
        - $ref: '#/components/parameters/created_at__gte'
        - $ref: '#/components/parameters/created_at__lt'
        - $ref: '#/components/parameters/created_at__lte'
        - $ref: '#/components/parameters/created_at__range'
        - $ref: '#/components/parameters/currency'
        - $ref: '#/components/parameters/currency__in'
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/id__in'
        - $ref: '#/components/parameters/institution'
        - $ref: '#/components/parameters/institution__in'
        - $ref: '#/components/parameters/name_accounts'
        - $ref: '#/components/parameters/name__icontains'
        - $ref: '#/components/parameters/number_accounts'
        - $ref: '#/components/parameters/number__in_accounts'
        - $ref: '#/components/parameters/public_identification_name'
        - $ref: '#/components/parameters/public_identification_value'
        - $ref: '#/components/parameters/type_accounts'
      responses:
        '200':
          description: De acuerdo
          content:
            application/json:
              schema:
                type: object
                title: Cuentas (OFDA Brazil)
                allOf:
                  - $ref: '#/components/schemas/common_pagination_properties'
                  - properties:
                      results:
                        type: array
                        description: Un arreglo de objetos de cuenta.
                        items:
                          $ref: '#/components/schemas/AccountOpenFinanceBrazil'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
    post:
      tags:
        - Accounts
      operationId: RetrieveAccounts
      summary: Recuperar cuentas para un enlace
      description: |-
        Recuperar cuentas de un enlace existente.

        {% admonition type="info" %}
          Este recurso puede devolver campos obsoletos. Por favor, consulte la documentación de la respuesta para más información.
        {% /admonition %}
      parameters:
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - link
              properties:
                link:
                  $ref: '#/components/schemas/link_request'
                token:
                  $ref: '#/components/schemas/token'
                save_data:
                  $ref: '#/components/schemas/save_data'
      responses:
        '200':
          description: Ok (cuando `save_data=false`)
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AccountOpenFinanceBrazil'
              examples:
                AccountsOfdaChecking:
                  $ref: '#/components/examples/AccountsOfdaChecking'
                AccountsOfdaCreditCard:
                  $ref: '#/components/examples/AccountsOfdaCreditCard'
                AccountsOfdaLoanData:
                  $ref: '#/components/examples/AccountsOfdaLoanData'
        '201':
          description: Creado (cuando `save_data=true`)
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AccountOpenFinanceBrazil'
              examples:
                AccountsOfdaChecking:
                  $ref: '#/components/examples/AccountsOfdaChecking'
                AccountsOfdaCreditCard:
                  $ref: '#/components/examples/AccountsOfdaCreditCard'
                AccountsOfdaLoanData:
                  $ref: '#/components/examples/AccountsOfdaLoanData'
        '400':
          $ref: '#/components/responses/400_bad_request_error'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '428':
          $ref: '#/components/responses/428_token_required_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
    patch:
      tags:
        - Accounts
      operationId: PatchAccounts
      summary: Completar una solicitud de cuentas
      description: >-
        Se utiliza para reanudar una sesión de recuperación de Cuenta que se
        pausó porque la institución requirió un token MFA.


        {% admonition type="info" %}
          Este recurso puede devolver campos obsoletos. Por favor, consulte la documentación de la respuesta para obtener más información.
        {% /admonition %}
      parameters:
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchBody'
      responses:
        '200':
          description: Ok (cuando `save_data=false`)
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AccountOpenFinanceBrazil'
              examples:
                AccountsOfdaChecking:
                  $ref: '#/components/examples/AccountsOfdaChecking'
                AccountsOfdaCreditCard:
                  $ref: '#/components/examples/AccountsOfdaCreditCard'
                AccountsOfdaLoanData:
                  $ref: '#/components/examples/AccountsOfdaLoanData'
        '201':
          description: Creado (cuando `save_data=true`)
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AccountOpenFinanceBrazil'
              examples:
                AccountsOfdaChecking:
                  $ref: '#/components/examples/AccountsOfdaChecking'
                AccountsOfdaCreditCard:
                  $ref: '#/components/examples/AccountsOfdaCreditCard'
                AccountsOfdaLoanData:
                  $ref: '#/components/examples/AccountsOfdaLoanData'
        '400':
          $ref: '#/components/responses/400_bad_request_error'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '428':
          $ref: '#/components/responses/428_token_required_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
  /api/accounts/{id}/:
    get:
      tags:
        - Accounts
      operationId: DetailAccount
      summary: Obtener los detalles de una cuenta
      description: |-
        Obtener los detalles de una cuenta específica.

        {% admonition type="info" %}
          Este recurso puede devolver campos obsoletos. Por favor, consulte la documentación de la respuesta para más información.
        {% /admonition %}
      parameters:
        - name: id
          in: path
          required: true
          description: El `account.id` sobre el cual deseas obtener información detallada.
          schema:
            type: string
            format: uuid
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: De acuerdo
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountOpenFinanceBrazil'
              examples:
                AccountsOfdaChecking:
                  $ref: '#/components/examples/AccountsOfdaCheckingDetail'
                AccountsOfdaCreditCard:
                  $ref: '#/components/examples/AccountsOfdaCreditCardDetail'
                AccountsOfdaLoanData:
                  $ref: '#/components/examples/AccountsOfdaLoanDataDetail'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
    delete:
      tags:
        - Accounts
      operationId: DestroyAccount
      summary: Eliminar una cuenta
      description: |-
        Eliminar una cuenta específica de tu cuenta de Belvo.

        {% admonition type="danger" name="Rate Limited" %}
          Este endpoint tiene un límite de tasa. Solo puedes eliminar 5 elementos por minuto. Si excedes este límite, recibirás un código de estado `429`.
        {% /admonition %}

        {% admonition type="info" %}
          Cuando eliminas una cuenta, todas las transacciones asociadas y la información del propietario para esa cuenta también se eliminan.
        {% /admonition %}
      parameters:
        - name: id
          in: path
          required: true
          description: El `account.id` que deseas eliminar.
          schema:
            type: string
            format: uuid
      responses:
        '204':
          description: No hay contenido
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
  /api/br/balances/:
    get:
      tags:
        - Balances
      operationId: ListBalances
      summary: Listar saldos
      description: >-
        ## ▶️ 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 <a
        href="https://developers.belvo.com/docs/searching-and-filtering"
        target="_blank">Filtrado de respuestas</a>.


        ## 📖 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 <a
        href="https://developers.belvo.com/docs/belvo-pagination-tips"
        target="_blank">Consejos de Paginación</a>.


        ## 🚨 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.
      parameters:
        - $ref: '#/components/parameters/link__required'
        - $ref: '#/components/parameters/account'
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/link__in'
        - $ref: '#/components/parameters/account__in'
        - $ref: '#/components/parameters/id__in'
        - $ref: '#/components/parameters/page_size'
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/collected_at'
        - $ref: '#/components/parameters/collected_at__gt'
        - $ref: '#/components/parameters/collected_at__gte'
        - $ref: '#/components/parameters/collected_at__lt'
        - $ref: '#/components/parameters/collected_at__lte'
        - $ref: '#/components/parameters/collected_at__range'
        - $ref: '#/components/parameters/created_at'
        - $ref: '#/components/parameters/created_at__gt'
        - $ref: '#/components/parameters/created_at__gte'
        - $ref: '#/components/parameters/created_at__lt'
        - $ref: '#/components/parameters/created_at__lte'
        - $ref: '#/components/parameters/created_at__range'
      responses:
        '200':
          description: OK - Saldos Recuperados
          content:
            application/json:
              schema:
                type: object
                title: Saldos (OFDA Brasil)
                allOf:
                  - $ref: '#/components/schemas/common_pagination_properties'
                  - properties:
                      results:
                        type: array
                        description: Un arreglo de objetos de balance.
                        items:
                          $ref: '#/components/schemas/BalanceOFDA'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
    post:
      tags:
        - Balances
      operationId: RetrieveBalances
      summary: Recuperar el saldo actual de un enlace
      description: >-
        Recupere el saldo actual de todas las cuentas corrientes y de ahorros
        para un enlace existente. Recomendamos también enviar el `account.id`
        para que reciba los saldos de una cuenta específica.
      parameters:
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - link
              properties:
                link:
                  $ref: '#/components/schemas/link_request'
                account_id:
                  $ref: '#/components/schemas/account_id'
                save_data:
                  $ref: '#/components/schemas/save_data'
      responses:
        '200':
          description: OK - Balance Recuperado (cuando `save_data=false`)
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/BalanceOFDA'
        '201':
          description: OK - Balance Recuperado (cuando `save_data=true`)
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/BalanceOFDA'
        '400':
          $ref: '#/components/responses/400_bad_request_error'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '428':
          $ref: '#/components/responses/428_token_required_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
  /api/br/balances/{id}/:
    get:
      tags:
        - Balances
      operationId: DetailBalance
      summary: Obtener los detalles de un balance
      description: Obtén los detalles de un saldo específico.
      parameters:
        - name: id
          in: path
          required: true
          description: El `balance.id` sobre el cual deseas obtener información detallada.
          schema:
            type: string
            format: uuid
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: De acuerdo
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BalanceOFDA'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
  /api/transactions/:
    get:
      tags:
        - Transactions
      operationId: ListTransactions
      summary: Listar transacciones
      description: >-
        ## ▶️ Uso


        Con el método List Transactions, puedes:


        1. **[Requerido]** Listar transacciones relacionadas con un `link.id`
        específico (usando el parámetro de consulta `link`).

        2. Filtrar las transacciones devueltas usando parámetros de consulta
        (ver la sección de Filtrado de respuestas a continuación).

        3. Obtener los detalles de un `transaction.id` específico (usando el
        parámetro de consulta `id` junto con el parámetro de consulta `link`).


        ## 📖 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 <a
        href="https://developers.belvo.com/docs/belvo-pagination-tips"
        target="_blank">Consejos de Paginación</a>.


        ## 🔦 Filtrado de Respuestas


        Consulta la lista de campos a continuación para ver por cuáles puedes
        filtrar tus respuestas. Para más información sobre cómo usar filtros,
        consulta nuestro artículo <a
        href="https://developers.belvo.com/docs/searching-and-filtering"
        target="_blank">Filtrado de respuestas</a>.
      parameters:
        - $ref: '#/components/parameters/link__required'
        - $ref: '#/components/parameters/page_size'
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/link__in'
        - $ref: '#/components/parameters/account'
        - $ref: '#/components/parameters/account__in'
        - $ref: '#/components/parameters/account__balance__available'
        - $ref: '#/components/parameters/account__balance__available__lt'
        - $ref: '#/components/parameters/account__balance__available__lte'
        - $ref: '#/components/parameters/account__balance__available__gt'
        - $ref: '#/components/parameters/account__balance__available__gte'
        - $ref: '#/components/parameters/account__balance__available__range'
        - $ref: '#/components/parameters/account__balance__current'
        - $ref: '#/components/parameters/account__balance__current__gt'
        - $ref: '#/components/parameters/account__balance__current__gte'
        - $ref: '#/components/parameters/account__balance__current__lt'
        - $ref: '#/components/parameters/account__balance__current__lte'
        - $ref: '#/components/parameters/account__balance__current__range'
        - $ref: '#/components/parameters/account_type'
        - $ref: '#/components/parameters/account_type__in'
        - $ref: '#/components/parameters/accounting_date'
        - $ref: '#/components/parameters/accounting_date__gt'
        - $ref: '#/components/parameters/accounting_date__gte'
        - $ref: '#/components/parameters/accounting_date__lt'
        - $ref: '#/components/parameters/accounting_date__lte'
        - $ref: '#/components/parameters/accounting_date__range'
        - $ref: '#/components/parameters/amount'
        - $ref: '#/components/parameters/amount__gt'
        - $ref: '#/components/parameters/amount__gte'
        - $ref: '#/components/parameters/amount__lt'
        - $ref: '#/components/parameters/amount__lte'
        - $ref: '#/components/parameters/amount__range'
        - $ref: '#/components/parameters/collected_at'
        - $ref: '#/components/parameters/collected_at__gt'
        - $ref: '#/components/parameters/collected_at__gte'
        - $ref: '#/components/parameters/collected_at__lt'
        - $ref: '#/components/parameters/collected_at__lte'
        - $ref: '#/components/parameters/collected_at__range'
        - $ref: '#/components/parameters/created_at'
        - $ref: '#/components/parameters/created_at__gt'
        - $ref: '#/components/parameters/created_at__gte'
        - $ref: '#/components/parameters/created_at__lt'
        - $ref: '#/components/parameters/created_at__lte'
        - $ref: '#/components/parameters/created_at__range'
        - $ref: '#/components/parameters/currency'
        - $ref: '#/components/parameters/currency__in'
        - $ref: '#/components/parameters/credit_card_data__bill_name__in'
        - $ref: '#/components/parameters/reference'
        - $ref: '#/components/parameters/reference__in'
        - $ref: '#/components/parameters/status_transactions'
        - $ref: '#/components/parameters/status__in_transactions'
        - $ref: '#/components/parameters/type_transactions'
        - $ref: '#/components/parameters/type__in_transactions'
        - $ref: '#/components/parameters/value_date'
        - $ref: '#/components/parameters/value_date__gt'
        - $ref: '#/components/parameters/value_date__gte'
        - $ref: '#/components/parameters/value_date__lt'
        - $ref: '#/components/parameters/value_date__lte'
        - $ref: '#/components/parameters/value_date__range'
      responses:
        '200':
          description: De acuerdo
          content:
            application/json:
              schema:
                type: object
                title: Transacciones (OFDA Brazil)
                allOf:
                  - $ref: '#/components/schemas/common_pagination_properties'
                  - properties:
                      results:
                        type: array
                        description: Matriz de objetos de transacción (OFDA Brasil).
                        items:
                          $ref: '#/components/schemas/TransactionOpenFinanceBrazil'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '428':
          $ref: '#/components/responses/428_token_required_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
    post:
      tags:
        - Transactions
      operationId: RetrieveTransactions
      summary: Recuperar transacciones para un enlace
      description: >-
        Recuperar transacciones para una o más cuentas desde un enlace
        específico.


        > 📘 Períodos de Transacciones y Recuperación

        >

        > Al recuperar transacciones, es importante entender que los rangos de
        datos de transacciones disponibles dependen de cada institución. Si
        intentas acceder a información más antigua de la que podemos acceder,
        devolveremos todos los datos que podamos leer dentro de ese rango de
        fechas. Por ejemplo, si solicitas transacciones del último año y solo
        podemos acceder a los últimos seis meses, devolveremos la información
        correspondiente a estos seis meses de datos.
      parameters:
        - $ref: '#/components/parameters/async'
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: Cuerpo de la solicitud para el método Retrieve Transactions.
              required:
                - link
                - date_from
                - date_to
              properties:
                link:
                  $ref: '#/components/schemas/link_request'
                account:
                  type: string
                  format: uuid
                  description: >-
                    Si se proporciona, devolvemos transacciones solo de esta
                    cuenta.
                  example: d4617561-1c01-4b2f-83b6-a594f7b3bc57
                date_from:
                  $ref: '#/components/schemas/date_from'
                date_to:
                  $ref: '#/components/schemas/date_to'
                token:
                  $ref: '#/components/schemas/token'
                save_data:
                  $ref: '#/components/schemas/save_data'
      responses:
        '200':
          description: Ok (cuando `save_data=false`)
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TransactionOpenFinanceBrazil'
        '201':
          description: Creado (cuando `save_data=true`)
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TransactionOpenFinanceBrazil'
        '202':
          $ref: '#/components/responses/202_accepted_response'
        '400':
          $ref: '#/components/responses/400_bad_request_error'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '428':
          $ref: '#/components/responses/428_token_required_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
    patch:
      tags:
        - Transactions
      operationId: PatchTransactions
      summary: Completar una solicitud de transacciones
      description: >-
        Se utiliza para reanudar una sesión de recuperación de Transacción que
        se pausó porque la institución requería un token MFA.
      parameters:
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchBody'
      responses:
        '200':
          description: Ok (cuando `save_data=false`)
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TransactionOpenFinanceBrazil'
        '201':
          description: Creado (cuando `save_data=true`)
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TransactionOpenFinanceBrazil'
        '400':
          $ref: '#/components/responses/400_bad_request_error'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '428':
          $ref: '#/components/responses/428_token_required_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
  /api/transactions/{id}/:
    get:
      tags:
        - Transactions
      operationId: DetailTransaction
      summary: Obtener los detalles de una transacción
      description: Obtén los detalles de una transacción específica.
      parameters:
        - name: id
          in: path
          required: true
          description: >-
            El `transaction.id` sobre el cual deseas obtener información
            detallada.
          schema:
            type: string
            format: uuid
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: De acuerdo
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransactionOpenFinanceBrazil'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '428':
          $ref: '#/components/responses/428_token_required_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
    delete:
      tags:
        - Transactions
      operationId: DestroyTransaction
      summary: Eliminar una transacción
      description: >-
        Eliminar una transacción específica de tu cuenta de Belvo.


        > ❗️ Límite de tasa

        >

        > Este endpoint tiene un límite de tasa. Solo puedes eliminar 5
        elementos por minuto. Si excedes este límite, recibirás un código de
        estado `429`.
      parameters:
        - name: id
          in: path
          required: true
          description: El `transaction.id` que deseas eliminar.
          schema:
            type: string
            format: uuid
      responses:
        '204':
          description: No hay contenido
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '428':
          $ref: '#/components/responses/428_token_required_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
  /api/bills/:
    get:
      tags:
        - Bills
      operationId: ListBills
      summary: Listar facturas
      description: >-
        ## ▶️ Uso


        Con el método List Bills, puedes:


        1. **[Requerido]** Listar facturas relacionadas con un link.id
        específico (usando el parámetro de consulta `link`).

        2. Filtrar las facturas devueltas usando parámetros de consulta (ver la
        sección de Filtrado de respuestas a continuación).

        3. Obtener los detalles de una factura específica usando el parámetro de
        consulta `id`.


        ## 📖 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 <a
        href="https://developers.belvo.com/docs/belvo-pagination-tips"
        target="_blank">Consejos de Paginación</a>.


        ## 🔦 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 <a
        href="https://developers.belvo.com/docs/searching-and-filtering"
        target="_blank">Filtrado de respuestas</a>.
      parameters:
        - $ref: '#/components/parameters/link__required'
        - $ref: '#/components/parameters/page_size'
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/id__in'
        - $ref: '#/components/parameters/account'
        - $ref: '#/components/parameters/account__in'
        - $ref: '#/components/parameters/due_date'
        - $ref: '#/components/parameters/due_date__gt'
        - $ref: '#/components/parameters/due_date__gte'
        - $ref: '#/components/parameters/due_date__lt'
        - $ref: '#/components/parameters/due_date__lte'
        - $ref: '#/components/parameters/due_date__range'
        - $ref: '#/components/parameters/collected_at__gt'
        - $ref: '#/components/parameters/collected_at__gte'
        - $ref: '#/components/parameters/collected_at__lt'
        - $ref: '#/components/parameters/collected_at__lte'
        - $ref: '#/components/parameters/collected_at__range'
        - $ref: '#/components/parameters/created_at'
        - $ref: '#/components/parameters/created_at__gt'
        - $ref: '#/components/parameters/created_at__gte'
        - $ref: '#/components/parameters/created_at__lt'
        - $ref: '#/components/parameters/created_at__lte'
        - $ref: '#/components/parameters/created_at__range'
      responses:
        '200':
          description: De acuerdo
          content:
            application/json:
              schema:
                type: object
                title: Facturas
                allOf:
                  - $ref: '#/components/schemas/common_pagination_properties'
                  - properties:
                      results:
                        type: array
                        description: Un array de objetos Bill.
                        items:
                          $ref: '#/components/schemas/Bill'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
    post:
      tags:
        - Bills
      operationId: RetrieveBills
      summary: Recuperar facturas para un enlace
      description: >-
        Recuperar facturas de una o más cuentas para un enlace específico dentro
        de un rango de fechas especificado.
      parameters:
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - link
              properties:
                link:
                  $ref: '#/components/schemas/link_request'
                save_data:
                  $ref: '#/components/schemas/save_data'
      responses:
        '200':
          description: Ok (cuando `save_data=false`)
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Bill'
        '201':
          description: Creado (cuando `save_data=true`)
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Bill'
        '400':
          $ref: '#/components/responses/400_bad_request_error'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '428':
          $ref: '#/components/responses/428_token_required_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
  /api/bills/{id}/:
    get:
      tags:
        - Bills
      operationId: DetailBills
      summary: Obtener los detalles de una factura
      description: Obtener los detalles de una factura específica.
      parameters:
        - name: id
          in: path
          required: true
          description: El `bill.id` sobre el cual deseas obtener información detallada.
          schema:
            type: string
            format: uuid
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: De acuerdo
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Bill'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
    delete:
      tags:
        - Bills
      operationId: DestroyBills
      summary: Eliminar una factura
      description: Eliminar una factura específica de tu cuenta de Belvo.
      parameters:
        - name: id
          in: path
          required: true
          description: El `bill.id` que deseas eliminar.
          schema:
            type: string
            format: uuid
      responses:
        '204':
          description: No hay contenido
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
  /api/owners/:
    get:
      tags:
        - Owners
      operationId: ListOwners
      summary: Lista de propietarios
      description: >-
        ## ▶️ Uso


        Con el método List Owners, puedes:


        1. Listar propietarios relacionados con un `link.id` específico (usando
        el parámetro de consulta `link`).

        2. Obtener los detalles de un `owners.id` específico (usando el
        parámetro de consulta `id`).

        3. **[No Recomendado]** Listar todos los propietarios 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 `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 <a
        href="https://developers.belvo.com/docs/belvo-pagination-tips"
        target="_blank">Consejos de Paginación</a>.


        ## 🔦 Filtrado de Respuestas


        Consulta la lista de campos 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 <a
        href="https://developers.belvo.com/docs/searching-and-filtering"
        target="_blank">Filtrando respuestas</a>.


        ## 🚨 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.
      parameters:
        - $ref: '#/components/parameters/link'
        - $ref: '#/components/parameters/page_size'
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/link__in'
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/id__in'
        - $ref: '#/components/parameters/created_at'
        - $ref: '#/components/parameters/created_at__gt'
        - $ref: '#/components/parameters/created_at__gte'
        - $ref: '#/components/parameters/created_at__lt'
        - $ref: '#/components/parameters/created_at__lte'
        - $ref: '#/components/parameters/created_at__range'
        - $ref: '#/components/parameters/email'
        - $ref: '#/components/parameters/display_name__icontains'
      responses:
        '200':
          description: De acuerdo
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - $ref: '#/components/schemas/common_pagination_properties'
                  - properties:
                      results:
                        type: array
                        description: |-
                          Una matriz de cualquiera de los siguientes:

                            - Objetos de Owner Individual (OFDA Brazil)
                            - Objetos de Owner Business (OFDA Brazil)
                            - Objetos de Owner Standard (Multi-Region)
                            
                            > 🚧 Un tipo de esquema por respuesta
                            >
                            > La respuesta contendrá una matriz de **uno** de los tipos de esquema descritos anteriormente. En otras palabras, **no habrá** una mezcla de tipos de esquema en la respuesta.
                        items:
                          oneOf:
                            - $ref: >-
                                #/components/schemas/OwnerIndividualOpenFinanceBrazil
                            - $ref: >-
                                #/components/schemas/OwnerBusinessOpenFinanceBrazil
                            - $ref: '#/components/schemas/Owner'
              examples:
                OwnerIndividualOfdaPaginated:
                  $ref: '#/components/examples/OwnerOfdaIndividualPaginated'
                OwnerBusinessOfdaPaginated:
                  $ref: '#/components/examples/OwnerOfdaBusinessPaginated'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '428':
          $ref: '#/components/responses/428_token_required_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
    post:
      tags:
        - Owners
      operationId: RetrieveOwners
      summary: Recuperar propietarios de un enlace
      description: |-
        Recuperar información del propietario desde un enlace específico.

        {% admonition type="info" %}
          Este recurso puede devolver campos obsoletos. Por favor, consulte la documentación de la respuesta para más información.
        {% /admonition %}
      parameters:
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - link
              properties:
                link:
                  $ref: '#/components/schemas/link_request'
                token:
                  $ref: '#/components/schemas/token'
                save_data:
                  $ref: '#/components/schemas/save_data'
      responses:
        '200':
          description: Ok (cuando `save_data=false`)
          content:
            application/json:
              schema:
                type: array
                items:
                  oneOf:
                    - $ref: '#/components/schemas/OwnerIndividualOpenFinanceBrazil'
                    - $ref: '#/components/schemas/OwnerBusinessOpenFinanceBrazil'
                    - $ref: '#/components/schemas/Owner'
              examples:
                OwnerIndividualOfda:
                  $ref: '#/components/examples/OwnerOfdaIndividual'
                OwnerBusinessOfda:
                  $ref: '#/components/examples/OwnerOfdaBusiness'
        '201':
          description: Creado (cuando `save_data=true`)
          content:
            application/json:
              schema:
                type: array
                items:
                  oneOf:
                    - $ref: '#/components/schemas/OwnerIndividualOpenFinanceBrazil'
                    - $ref: '#/components/schemas/OwnerBusinessOpenFinanceBrazil'
                    - $ref: '#/components/schemas/Owner'
              examples:
                OwnerIndividualOfda:
                  $ref: '#/components/examples/OwnerOfdaIndividual'
                OwnerBusinessOfda:
                  $ref: '#/components/examples/OwnerOfdaBusiness'
        '400':
          $ref: '#/components/responses/400_bad_request_error'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '428':
          $ref: '#/components/responses/428_token_required_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
    patch:
      tags:
        - Owners
      operationId: PatchOwners
      summary: Completar una solicitud del propietario
      description: >-
        Se utiliza para reanudar una sesión de recuperación de Owner que se
        pausó porque la institución requería un token MFA.


        {% admonition type="info" %}
          Este recurso puede devolver campos obsoletos. Por favor, consulte la documentación de la respuesta para obtener más información.
        {% /admonition %}
      parameters:
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchBody'
      responses:
        '200':
          description: Ok (cuando `save_data=false`)
          content:
            application/json:
              schema:
                type: array
                items:
                  oneOf:
                    - $ref: '#/components/schemas/OwnerIndividualOpenFinanceBrazil'
                    - $ref: '#/components/schemas/OwnerBusinessOpenFinanceBrazil'
              examples:
                OwnerIndividualOfda:
                  $ref: '#/components/examples/OwnerOfdaIndividual'
                OwnerBusinessOfda:
                  $ref: '#/components/examples/OwnerOfdaBusiness'
        '201':
          description: Creado (cuando `save_data=true`)
          content:
            application/json:
              schema:
                type: array
                items:
                  oneOf:
                    - $ref: '#/components/schemas/OwnerIndividualOpenFinanceBrazil'
                    - $ref: '#/components/schemas/OwnerBusinessOpenFinanceBrazil'
              examples:
                OwnerIndividualOfda:
                  $ref: '#/components/examples/OwnerOfdaIndividual'
                OwnerBusinessOfda:
                  $ref: '#/components/examples/OwnerOfdaBusiness'
        '400':
          $ref: '#/components/responses/400_bad_request_error'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '428':
          $ref: '#/components/responses/428_token_required_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
  /api/owners/{id}/:
    get:
      tags:
        - Owners
      operationId: DetailOwner
      summary: Obtener los detalles de un propietario
      description: |-
        Obtener los detalles de un propietario específico.

        {% admonition type="info" %}
          Este recurso puede devolver campos obsoletos. Por favor, consulte la documentación de la respuesta para más información.
        {% /admonition %}
      parameters:
        - name: id
          in: path
          required: true
          description: El `owner.id` sobre el cual deseas obtener información detallada.
          schema:
            type: string
            format: uuid
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: De acuerdo
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/OwnerIndividualOpenFinanceBrazil'
                  - $ref: '#/components/schemas/OwnerBusinessOpenFinanceBrazil'
                  - $ref: '#/components/schemas/Owner'
              examples:
                OwnerIndividualOfdaDetails:
                  $ref: '#/components/examples/OwnerOfdaIndividuaDetail'
                OwnerBusinessOfdaDetails:
                  $ref: '#/components/examples/OwnerOfdaBusinessDetail'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
    delete:
      tags:
        - Owners
      operationId: DestroyOwner
      summary: Eliminar un propietario
      description: Eliminar un propietario específico de tu cuenta de Belvo.
      parameters:
        - name: id
          in: path
          required: true
          description: El `owner.id` que deseas eliminar.
          schema:
            type: string
            format: uuid
      responses:
        '204':
          description: No hay contenido
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '428':
          $ref: '#/components/responses/428_token_required_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
  /api/br/investments/:
    get:
      tags:
        - Investments Brazil
      operationId: ListInvestmentsBrazil
      summary: Lista de inversiones
      description: >-
        ## ▶️ Uso


        Con el método List Investments, puedes:


        1. **[Requerido]** Listar inversiones relacionadas con un `link.id`
        específico (usando el parámetro de consulta `link`).

        2. Obtener los detalles de un `investment.id` específico (usando el
        parámetro de consulta `id`).


        ## 📖 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 <a
        href="https://developers.belvo.com/docs/belvo-pagination-tips"
        target="_blank">Consejos de Paginación</a>.


        ## 🔦 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 <a
        href="https://developers.belvo.com/docs/searching-and-filtering"
        target="_blank">Filtrando respuestas</a>.
      parameters:
        - $ref: '#/components/parameters/link__required'
        - $ref: '#/components/parameters/pageSize_query'
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/id__in'
        - $ref: '#/components/parameters/link__in'
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/type_investments'
        - $ref: '#/components/parameters/type__in_investments'
        - $ref: '#/components/parameters/created_at'
        - $ref: '#/components/parameters/created_at__gt'
        - $ref: '#/components/parameters/created_at__gte'
        - $ref: '#/components/parameters/created_at__lt'
        - $ref: '#/components/parameters/created_at__lte'
        - $ref: '#/components/parameters/created_at__range'
      responses:
        '200':
          description: De acuerdo
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - $ref: '#/components/schemas/common_pagination_properties'
                  - properties:
                      results:
                        type: array
                        description: Matriz de objetos de inversión.
                        items:
                          $ref: '#/components/schemas/InvestmentBrazil'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
    post:
      tags:
        - Investments Brazil
      operationId: RetrieveInvestmentsBrazil
      summary: Recuperar inversiones para un enlace
      description: Recuperar inversiones para un enlace existente.
      parameters:
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - link
              properties:
                link:
                  $ref: '#/components/schemas/link_request'
                save_data:
                  $ref: '#/components/schemas/save_data'
      responses:
        '200':
          description: Ok (cuando `save_data=false`)
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/InvestmentBrazil'
        '201':
          description: Creado (cuando `save_data=true`)
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/InvestmentBrazil'
        '202':
          $ref: '#/components/responses/202_accepted_response'
        '400':
          $ref: '#/components/responses/400_bad_request_error'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
  /api/br/investments/{id}/:
    get:
      tags:
        - Investments Brazil
      operationId: DetailInvestmentBrazil
      summary: Obtener los detalles de una inversión
      description: Obtén los detalles de una inversión específica.
      parameters:
        - name: id
          in: path
          required: true
          description: >-
            El `investment.id` sobre el cual deseas obtener información
            detallada.
          schema:
            type: string
            format: uuid
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: De acuerdo
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvestmentBrazil'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
    delete:
      tags:
        - Investments Brazil
      operationId: DestroyInvestmentBrazil
      summary: Eliminar una inversión
      description: Elimina una inversión específica de tu cuenta de Belvo.
      parameters:
        - name: id
          in: path
          required: true
          description: El `investment.id` que deseas eliminar.
          schema:
            type: string
            format: uuid
      responses:
        '204':
          description: No hay contenido
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
  /api/br/investment-transactions/:
    get:
      tags:
        - Investment Transactions Brazil
      operationId: ListInvestmentTransactionsBrazil
      summary: Listar transacciones de inversión
      description: >-
        ## ▶️ Uso


        Con el método List Investment Transactions, puedes:


        1. **[Requerido]** Listar transacciones de inversión relacionadas con un
        `link.id` específico (usando el parámetro de consulta `link`).

        2. Obtener los detalles de un `investment-transaction.id` específico
        (usando el parámetro de consulta `id`).


        ## 📖 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 <a
        href="https://developers.belvo.com/docs/belvo-pagination-tips"
        target="_blank">Consejos de Paginación</a>.


        ## 🔦 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 <a
        href="https://developers.belvo.com/docs/searching-and-filtering"
        target="_blank">Filtrado de respuestas</a>.
      parameters:
        - $ref: '#/components/parameters/link__required'
        - $ref: '#/components/parameters/pageSize_query'
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/id__in'
        - $ref: '#/components/parameters/link__in'
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/type_investments'
        - $ref: '#/components/parameters/type__in_investments'
        - $ref: '#/components/parameters/created_at'
        - $ref: '#/components/parameters/created_at__gt'
        - $ref: '#/components/parameters/created_at__gte'
        - $ref: '#/components/parameters/created_at__lt'
        - $ref: '#/components/parameters/created_at__lte'
        - $ref: '#/components/parameters/created_at__range'
      responses:
        '200':
          description: De acuerdo
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - $ref: '#/components/schemas/common_pagination_properties'
                  - properties:
                      results:
                        type: array
                        description: Matriz de objetos de transacciones de inversión.
                        items:
                          $ref: '#/components/schemas/InvestmentTransactionBrazil'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
    post:
      tags:
        - Investment Transactions Brazil
      operationId: RetrieveInvestmentTransactionsBrazil
      summary: Recuperar inversiones para un enlace
      description: Recuperar inversiones para un enlace existente.
      parameters:
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: >-
                El cuerpo de la solicitud para transacciones de inversión en
                Brasil.
              required:
                - link
              properties:
                link:
                  $ref: '#/components/schemas/link_request'
                date_from:
                  $ref: '#/components/schemas/date_from'
                date_to:
                  $ref: '#/components/schemas/date_to'
                save_data:
                  $ref: '#/components/schemas/save_data'
      responses:
        '200':
          description: Ok (cuando `save_data=false`)
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/InvestmentTransactionBrazil'
        '201':
          description: Creado (cuando `save_data=true`)
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/InvestmentTransactionBrazil'
        '202':
          $ref: '#/components/responses/202_accepted_response'
        '400':
          $ref: '#/components/responses/400_bad_request_error'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
  /api/br/investment-transactions/{id}/:
    get:
      tags:
        - Investment Transactions Brazil
      operationId: DetailInvestmentTransactionBrazil
      summary: Obtener los detalles de una transacción de inversión
      description: Obtén los detalles de una transacción de inversión específica.
      parameters:
        - name: id
          in: path
          required: true
          description: >-
            El `investment-transaction.id` sobre el cual deseas obtener
            información detallada.
          schema:
            type: string
            format: uuid
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: De acuerdo
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvestmentTransactionBrazil'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
    delete:
      tags:
        - Investment Transactions Brazil
      operationId: DestroyInvestmentTransactionBrazil
      summary: Eliminar una transacción de inversión
      description: Eliminar una transacción de inversión específica de tu cuenta de Belvo.
      parameters:
        - name: id
          in: path
          required: true
          description: El `investment-transaction.id` que deseas eliminar.
          schema:
            type: string
            format: uuid
      responses:
        '204':
          description: No hay contenido
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
  /api/employment-records/:
    get:
      tags:
        - Employment Records Mexico
      operationId: ListEmploymentRecords
      summary: Listar registros de empleo
      description: >-
        ## ▶️ Uso


        Con el método List Employment Records, puedes:


        1. Listar registros de empleo relacionados con un `link.id` específico
        (usando el parámetro de consulta `link`).

        2. Obtener los detalles de un `employment-record.id` específico (usando
        el parámetro de consulta `id`).

        3. **[No Recomendado]** Listar todos los registros de empleo
        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 `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 <a
        href="https://developers.belvo.com/docs/belvo-pagination-tips"
        target="_blank">Consejos de Paginación</a>.


        ## 🔦 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 <a
        href="https://developers.belvo.com/docs/searching-and-filtering"
        target="_blank">Filtrado de respuestas</a>.
      parameters:
        - $ref: '#/components/parameters/link'
        - $ref: '#/components/parameters/page_size'
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/id__in'
        - $ref: '#/components/parameters/link__in'
        - $ref: '#/components/parameters/internal_identification'
        - $ref: '#/components/parameters/internal_identification__in'
        - $ref: '#/components/parameters/collected_at'
        - $ref: '#/components/parameters/collected_at__gt'
        - $ref: '#/components/parameters/collected_at__gte'
        - $ref: '#/components/parameters/collected_at__lt'
        - $ref: '#/components/parameters/collected_at__lte'
        - $ref: '#/components/parameters/collected_at__range'
        - $ref: '#/components/parameters/created_at'
        - $ref: '#/components/parameters/created_at__gt'
        - $ref: '#/components/parameters/created_at__gte'
        - $ref: '#/components/parameters/created_at__lt'
        - $ref: '#/components/parameters/created_at__lte'
        - $ref: '#/components/parameters/created_at__range'
      responses:
        '200':
          description: De acuerdo
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - $ref: '#/components/schemas/common_pagination_properties'
                  - properties:
                      results:
                        type: array
                        description: Matriz de objetos de registros de empleo.
                        items:
                          $ref: '#/components/schemas/EmploymentRecord'
              examples:
                IMSS:
                  $ref: '#/components/examples/imss_example_paginated'
                ISSSTE:
                  $ref: '#/components/examples/issste_example_paginated'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
    post:
      tags:
        - Employment Records Mexico
      operationId: RetrieveEmploymentRecordDetails
      summary: Recuperar detalles del registro de empleo
      description: Recuperar los detalles del registro de empleo de un individuo.
      parameters:
        - $ref: '#/components/parameters/async'
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - link
              properties:
                link:
                  $ref: '#/components/schemas/link_request'
                attach_pdf:
                  $ref: '#/components/schemas/attach_pdf'
                save_data:
                  $ref: '#/components/schemas/save_data'
      responses:
        '200':
          description: De acuerdo
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/EmploymentRecord'
              examples:
                IMSS:
                  $ref: '#/components/examples/imss_example'
                ISSSTE:
                  $ref: '#/components/examples/issste_example'
        '201':
          description: Creado (cuando `save_data=true`)
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/EmploymentRecord'
              examples:
                IMSS:
                  $ref: '#/components/examples/imss_example'
                ISSSTE:
                  $ref: '#/components/examples/issste_example'
        '202':
          $ref: '#/components/responses/202_accepted_response'
        '400':
          $ref: '#/components/responses/400_bad_request_error'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '428':
          $ref: '#/components/responses/428_token_required_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
  /api/employment-records/{id}/:
    get:
      tags:
        - Employment Records Mexico
      operationId: DetailEmploymentRecord
      summary: Obtener los detalles de un registro de empleo
      description: Obtén los detalles de un registro de empleo específico.
      parameters:
        - name: id
          in: path
          required: true
          description: >-
            El `employment-record.id` sobre el cual deseas obtener información
            detallada.
          schema:
            type: string
            format: uuid
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: De acuerdo
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmploymentRecord'
              examples:
                IMSS:
                  $ref: '#/components/examples/imss_example_detail'
                ISSSTE:
                  $ref: '#/components/examples/issste_example_detail'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
    delete:
      tags:
        - Employment Records Mexico
      operationId: DestroyEmploymentRecord
      summary: Eliminar un registro de empleo
      description: >-
        Eliminar un registro de empleo específico de tu cuenta de Belvo.


        > ❗️ Límite de tasa

        >

        > Este endpoint tiene un límite de tasa. Solo puedes eliminar 5
        elementos por minuto. Si excedes este límite, recibirás un código de
        estado `429`.
      parameters:
        - name: id
          in: path
          required: true
          description: El `employment-record.id` que deseas eliminar.
          schema:
            type: string
            format: uuid
      responses:
        '204':
          description: No hay contenido
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
  /api/mx/current-employments/:
    get:
      tags:
        - Current Employments Mexico
      summary: Enumere los empleos actuales.
      x-badges:
        - name: Coming Soon
          position: before
          color: '#d97e1c'
      operationId: ListCurrentEmployments
      description: >-
        {% admonition type="success" name="¡Próximamente!" %}
          Este recurso está actualmente en desarrollo y, como tal, ciertos nombres de campos o valores pueden cambiar.
        {% /admonition %}


        ## ▶️ Uso


        Con el método List Current Employments, puedes:


        1. Listar los empleos actuales relacionados con un `link.id` específico
        (usando el parámetro de consulta `link`).

        2. Obtener los detalles de un `current-employment.id` específico (usando
        el parámetro de consulta `id`).

        3. **[No Recomendado]** Listar todos los empleos actuales 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 `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 <a
        href="https://developers.belvo.com/docs/belvo-pagination-tips"
        target="_blank">Consejos de Paginación</a>.


        ## 🔦 Filtrado de Respuestas


        Consulta la lista de campos 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 <a
        href="https://developers.belvo.com/docs/searching-and-filtering"
        target="_blank">Filtrando respuestas</a>.
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/id__in'
        - $ref: '#/components/parameters/link'
        - $ref: '#/components/parameters/link__in'
        - $ref: '#/components/parameters/page_size'
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/collected_at'
        - $ref: '#/components/parameters/collected_at__gt'
        - $ref: '#/components/parameters/collected_at__gte'
        - $ref: '#/components/parameters/collected_at__lt'
        - $ref: '#/components/parameters/collected_at__lte'
        - $ref: '#/components/parameters/collected_at__range'
        - $ref: '#/components/parameters/created_at'
        - $ref: '#/components/parameters/created_at__gt'
        - $ref: '#/components/parameters/created_at__gte'
        - $ref: '#/components/parameters/created_at__lt'
        - $ref: '#/components/parameters/created_at__lte'
        - $ref: '#/components/parameters/created_at__range'
      responses:
        '200':
          description: De acuerdo
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/common_pagination_properties'
                  - type: object
                    properties:
                      results:
                        type: array
                        items:
                          $ref: '#/components/schemas/CurrentEmployment'
        '400':
          $ref: '#/components/responses/400_bad_request_error'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '428':
          $ref: '#/components/responses/428_token_required_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
    post:
      tags:
        - Current Employments Mexico
      summary: Recuperar empleos actuales
      x-badges:
        - name: Coming Soon
          position: before
          color: '#d97e1c'
      description: |-
        {% admonition type="success" name="¡Próximamente!" %}
          Este recurso está actualmente en desarrollo y, como tal, ciertos nombres de campos o valores pueden cambiar.
        {% /admonition %}

        Recuperar la información de empleo actual para un `link.id` específico.
      operationId: RetrieveCurrentEmployments
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - link
              properties:
                link:
                  $ref: '#/components/schemas/link_request'
                save_data:
                  $ref: '#/components/schemas/save_data'
      responses:
        '200':
          description: Ok (cuando exista)
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CurrentEmployment'
        '201':
          description: Creado (cuando es nuevo)
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CurrentEmployment'
        '400':
          $ref: '#/components/responses/400_bad_request_error'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '428':
          $ref: '#/components/responses/428_token_required_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
  /api/mx/current-employments/{id}/:
    get:
      tags:
        - Current Employments Mexico
      summary: Obtener detalles actuales de empleo
      x-badges:
        - name: Coming Soon
          position: before
          color: '#d97e1c'
      description: |-
        {% admonition type="success" name="¡Próximamente!" %}
          Este recurso está actualmente en desarrollo y, como tal, ciertos nombres de campos o valores pueden cambiar.
        {% /admonition %}

        Obtén los detalles de un registro de empleo actual específico.
      operationId: getCurrentEmploymentDetails
      parameters:
        - name: id
          in: path
          required: true
          description: El ID del registro de empleo actual.
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: De acuerdo
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CurrentEmployment'
        '400':
          $ref: '#/components/responses/400_bad_request_error'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '428':
          $ref: '#/components/responses/428_token_required_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
    delete:
      tags:
        - Current Employments Mexico
      summary: Eliminar empleo actual
      x-badges:
        - name: Coming Soon
          position: before
          color: '#d97e1c'
      description: |-
        {% admonition type="success" name="¡Próximamente!" %}
          Este recurso está actualmente en desarrollo y, como tal, ciertos nombres de campos o valores pueden cambiar.
        {% /admonition %}

        Elimina un registro de empleo actual específico de tu cuenta de Belvo.
      operationId: deleteCurrentEmployment
      parameters:
        - name: id
          in: path
          required: true
          description: El ID del registro de empleo actual para eliminar.
          schema:
            type: string
            format: uuid
      responses:
        '204':
          description: No hay contenido
        '400':
          $ref: '#/components/responses/400_bad_request_error'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '428':
          $ref: '#/components/responses/428_token_required_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
  /api/br/employments/:
    get:
      tags:
        - Employments Brazil
      operationId: ListEmploymentsBrazil
      summary: Lista de empleos
      description: >-
        ## ▶️ Uso


        Con el método List Employments, puedes:


        1. **[Requerido]** Listar empleos relacionados con un `link.id`
        específico (usando el parámetro de consulta `link`).

        2. Obtener los detalles de un `employment.id` específico (usando el
        parámetro de consulta `id`).


        ## 📖 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 <a
        href="https://developers.belvo.com/docs/belvo-pagination-tips"
        target="_blank">Consejos de Paginación</a>.


        ## 🔦 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 <a
        href="https://developers.belvo.com/docs/searching-and-filtering"
        target="_blank">Filtrado de respuestas</a>.
      parameters:
        - $ref: '#/components/parameters/link__required'
        - $ref: '#/components/parameters/pageSize_query'
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/id__in'
        - $ref: '#/components/parameters/link__in'
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/start_date'
        - $ref: '#/components/parameters/start_date__gt'
        - $ref: '#/components/parameters/start_date__gte'
        - $ref: '#/components/parameters/start_date__lt'
        - $ref: '#/components/parameters/start_date__lte'
        - $ref: '#/components/parameters/start_date__range'
        - $ref: '#/components/parameters/end_date'
        - $ref: '#/components/parameters/end_date__gt'
        - $ref: '#/components/parameters/end_date__gte'
        - $ref: '#/components/parameters/end_date__lt'
        - $ref: '#/components/parameters/end_date__lte'
        - $ref: '#/components/parameters/end_date__range'
        - $ref: '#/components/parameters/created_at'
        - $ref: '#/components/parameters/created_at__gt'
        - $ref: '#/components/parameters/created_at__gte'
        - $ref: '#/components/parameters/created_at__lt'
        - $ref: '#/components/parameters/created_at__lte'
        - $ref: '#/components/parameters/created_at__range'
      responses:
        '200':
          description: De acuerdo
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - $ref: '#/components/schemas/common_pagination_properties'
                  - properties:
                      results:
                        type: array
                        description: Matriz de objetos de empleo.
                        items:
                          $ref: '#/components/schemas/EmploymentBrazil'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
    post:
      tags:
        - Employments Brazil
      operationId: RetrieveEmploymentsBrazil
      summary: Recuperar empleos para un enlace
      description: Recuperar empleos de un enlace existente.
      parameters:
        - $ref: '#/components/parameters/async'
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: >-
                Cuerpo de la solicitud para recuperar información de empleo del
                INSS de Brasil.
              required:
                - link
              properties:
                link:
                  $ref: '#/components/schemas/link_request'
                date_from:
                  $ref: '#/components/schemas/date_from'
                date_to:
                  $ref: '#/components/schemas/date_to'
                save_data:
                  $ref: '#/components/schemas/save_data'
      responses:
        '200':
          description: Ok (cuando `save_data=false`)
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/EmploymentBrazil'
        '201':
          description: Creado (cuando `save_data=true`)
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/EmploymentBrazil'
        '202':
          $ref: '#/components/responses/202_accepted_response'
        '400':
          $ref: '#/components/responses/400_bad_request_error'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '428':
          $ref: '#/components/responses/428_token_required_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
  /api/br/employments/{id}/:
    get:
      tags:
        - Employments Brazil
      operationId: DetailEmploymentBrazil
      summary: Obtener los detalles de un empleo
      description: Obtén los detalles de un empleo específico.
      parameters:
        - name: id
          in: path
          required: true
          description: >-
            El `employment.id` sobre el cual deseas obtener información
            detallada.
          schema:
            type: string
            format: uuid
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: De acuerdo
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmploymentBrazil'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
    delete:
      tags:
        - Employments Brazil
      operationId: DestroyEmploymentBrazil
      summary: Eliminar un empleo
      description: Eliminar un empleo específico de tu cuenta de Belvo.
      parameters:
        - name: id
          in: path
          required: true
          description: El `employment.id` que deseas eliminar.
          schema:
            type: string
            format: uuid
      responses:
        '204':
          description: No hay contenido
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
  /api/incomes/:
    get:
      tags:
        - Incomes
      operationId: ListIncomes
      summary: Enumerar ingresos
      description: >-
        ## ▶️ Uso


        Con el método List Incomes, puedes:


        1. Listar ingresos relacionados con un `link.id` específico (usando el
        parámetro de consulta `link`).

        2. Obtener los detalles de un `income.id` específico (usando el
        parámetro de consulta `id`).

        3. **[No Recomendado]** Listar todos los ingresos 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 `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 <a
        href="https://developers.belvo.com/docs/belvo-pagination-tips"
        target="_blank">Consejos de Paginación</a>.


        ## 🔦 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 <a
        href="https://developers.belvo.com/docs/searching-and-filtering"
        target="_blank">Filtrado de respuestas</a>.
      parameters:
        - $ref: '#/components/parameters/link'
        - $ref: '#/components/parameters/page_size'
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/link__in'
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/account'
        - $ref: '#/components/parameters/account__in'
      responses:
        '200':
          description: De acuerdo
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - $ref: '#/components/schemas/common_pagination_properties'
                  - properties:
                      results:
                        type: array
                        description: Matriz de objetos de ingresos.
                        items:
                          $ref: '#/components/schemas/Income'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
    post:
      tags:
        - Incomes
      operationId: RetrieveIncome
      summary: Recuperar ingresos para un enlace
      description: >-
        Recupera información sobre ingresos para <b>cuentas corrientes y de
        ahorros</b> desde un enlace específico. Puedes recibir información para
        un período de hasta 365 días, dependiendo del historial de transacciones
        disponible para cada institución.
      parameters:
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - link
              properties:
                link:
                  $ref: '#/components/schemas/link_request'
                allowed_income_types:
                  type: array
                  description: >-
                    Las categorías de los ingresos para las que deseas obtener
                    información.
                  items:
                    $ref: '#/components/schemas/EnumInvoiceAllowedIncomeTypesRequest'
                minimum_confidence_level:
                  $ref: '#/components/schemas/EnumIncomeMinimumConfidenceLevelRequest'
                date_from:
                  $ref: '#/components/schemas/date_from'
                date_to:
                  $ref: '#/components/schemas/date_to'
                token:
                  $ref: '#/components/schemas/token'
                save_data:
                  $ref: '#/components/schemas/save_data'
      responses:
        '200':
          description: Ok (cuando `save_data=false`)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Income'
        '201':
          description: Creado (cuando `save_data=true`)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Income'
        '400':
          $ref: '#/components/responses/400_bad_request_error'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
    patch:
      tags:
        - Incomes
      operationId: PatchIncomes
      summary: Completar una solicitud de ingresos
      description: >-
        Se utiliza para reanudar una sesión de recuperación de ingresos que se
        pausó porque la institución requería un token MFA.
      parameters:
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchBody'
      responses:
        '200':
          description: Ok (cuando `save_data=false`)
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Income'
        '201':
          description: Creado (cuando `save_data=true`)
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Income'
        '400':
          $ref: '#/components/responses/400_bad_request_error'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '428':
          $ref: '#/components/responses/428_token_required_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
  /api/incomes/{id}/:
    get:
      tags:
        - Incomes
      operationId: DetailIncome
      summary: Obtener los detalles de un ingreso
      description: Obtén los detalles de un ingreso específico.
      parameters:
        - name: id
          in: path
          required: true
          description: El `income.id` sobre el cual deseas obtener información detallada.
          schema:
            type: string
            format: uuid
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: De acuerdo
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Income'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
    delete:
      tags:
        - Incomes
      operationId: DestroyIncomes
      summary: Eliminar un ingreso
      description: Elimina un ingreso específico de tu cuenta de Belvo.
      parameters:
        - name: id
          in: path
          required: true
          description: el `income.id` que deseas eliminar
          schema:
            type: string
            format: uuid
      responses:
        '204':
          description: No hay contenido
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
  /api/recurring-expenses/:
    get:
      tags:
        - Recurring Expenses
      operationId: ListRecurringExpenses
      summary: Enumera los gastos recurrentes.
      description: >-
        ## ▶️ Uso


        Con el método List Recurring Expenses, puedes:


        1. Listar los gastos recurrentes relacionados con un `link.id`
        específico (usando el parámetro de consulta `link`).

        2. Obtener los detalles de un `recurring-expense.id` específico (usando
        el parámetro de consulta `id`).

        3. **[No Recomendado]** 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 `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 <a
        href="https://developers.belvo.com/docs/belvo-pagination-tips"
        target="_blank">Consejos de Paginación</a>.


        ## 🔦 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 <a
        href="https://developers.belvo.com/docs/searching-and-filtering"
        target="_blank">Filtrado de respuestas</a>.
      parameters:
        - $ref: '#/components/parameters/link'
        - $ref: '#/components/parameters/page_size'
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/link__in'
        - $ref: '#/components/parameters/account'
        - $ref: '#/components/parameters/account__in'
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/id__in'
      responses:
        '200':
          description: De acuerdo
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - $ref: '#/components/schemas/common_pagination_properties'
                  - properties:
                      results:
                        type: array
                        description: Matriz de objetos de gastos recurrentes.
                        items:
                          $ref: '#/components/schemas/RecurringExpenses'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '428':
          $ref: '#/components/responses/428_token_required_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
    post:
      tags:
        - Recurring Expenses
      operationId: RetrieveRecurringExpenses
      summary: Recuperar gastos recurrentes para un enlace
      description: >-
        Recupera información sobre gastos recurrentes para <b>cuentas corrientes
        y de ahorros</b> desde un enlace específico. Puedes recibir información
        para un período de hasta 365 días, dependiendo del historial de
        transacciones disponible para cada institución.
      parameters:
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: >-
                Cuerpo de la solicitud para el método Retrieve Recurring
                Expenses.
              required:
                - link
              properties:
                link:
                  $ref: '#/components/schemas/link_request'
                token:
                  $ref: '#/components/schemas/token'
                save_data:
                  $ref: '#/components/schemas/save_data'
                date_from:
                  $ref: '#/components/schemas/date_from'
                date_to:
                  $ref: '#/components/schemas/date_to'
      responses:
        '200':
          description: Ok (cuando save_data=false)
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RecurringExpenses'
        '201':
          description: Creado (cuando save_data=true)
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RecurringExpenses'
        '400':
          $ref: '#/components/responses/400_bad_request_error'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '428':
          $ref: '#/components/responses/428_token_required_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
    patch:
      tags:
        - Recurring Expenses
      operationId: PatchRecurringExpenses
      summary: Completar una solicitud de gastos recurrentes
      description: >-
        Se utiliza para reanudar una sesión de recuperación de Gastos
        Recurrentes que se pausó porque la institución requería un token MFA.
      parameters:
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchBody'
      responses:
        '200':
          description: Ok (cuando save_data=false)
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RecurringExpenses'
        '201':
          description: Creado (cuando save_data=true)
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RecurringExpenses'
        '400':
          $ref: '#/components/responses/400_bad_request_error'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '428':
          $ref: '#/components/responses/428_token_required_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
  /api/recurring-expenses/{id}/:
    get:
      tags:
        - Recurring Expenses
      operationId: DetailRecurringExpense
      summary: Obtener los detalles de un gasto recurrente
      description: Obtén los detalles de un gasto recurrente específico.
      parameters:
        - name: id
          in: path
          required: true
          description: >-
            El `recurring-expenses.id` sobre el cual deseas obtener información
            detallada.
          schema:
            type: string
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: De acuerdo
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RecurringExpenses'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '428':
          $ref: '#/components/responses/428_token_required_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
    delete:
      tags:
        - Recurring Expenses
      operationId: DestroyRecurringExpense
      summary: Eliminar un gasto recurrente
      description: Eliminar un gasto recurrente específico de tu cuenta de Belvo.
      parameters:
        - name: id
          in: path
          required: true
          description: El `recurring-expenses.id` que deseas eliminar
          schema:
            type: string
      responses:
        '204':
          description: No hay contenido
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '428':
          $ref: '#/components/responses/428_token_required_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
  /api/risk-insights/:
    get:
      tags:
        - Risk Insights
      operationId: ListRiskInsights
      summary: Enumere las perspectivas de riesgo.
      description: >-
        ## ▶️ Uso


        Con el método List Risk Insights, puedes:


        1. Listar las perspectivas de riesgo relacionadas con un `link.id`
        específico (usando el parámetro de consulta `link`).

        2. Obtener los detalles de un `risk-insight.id` específico (usando el
        parámetro de consulta `id`).

        3. **[No Recomendado]** Listar todas las perspectivas de riesgo
        relacionadas 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 `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 <a
        href="https://developers.belvo.com/docs/belvo-pagination-tips"
        target="_blank">Consejos de Paginación</a>.


        ## 🔦 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 <a
        href="https://developers.belvo.com/docs/searching-and-filtering"
        target="_blank">Filtrado de respuestas</a>.
      parameters:
        - $ref: '#/components/parameters/link'
        - $ref: '#/components/parameters/page_size'
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/link__in'
        - $ref: '#/components/parameters/account'
        - $ref: '#/components/parameters/account__in'
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/id__in'
      responses:
        '200':
          description: De acuerdo
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - $ref: '#/components/schemas/common_pagination_properties'
                  - properties:
                      results:
                        type: array
                        description: Matriz de objetos de insights de riesgo.
                        items:
                          $ref: '#/components/schemas/RiskInsights'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '428':
          $ref: '#/components/responses/428_token_required_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
    post:
      tags:
        - Risk Insights
      operationId: RetrieveRiskInsights
      summary: Recuperar información sobre riesgos para un enlace
      description: >-
        Solicitar las perspectivas de riesgo para un ID de enlace dado.


        Si necesitas saber la moneda de la cuenta, simplemente realiza un GET
        Details en el endpoint de cuentas (usando el ID que recibes de la
        respuesta de cuentas).
      parameters:
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - link
              properties:
                link:
                  $ref: '#/components/schemas/link_request'
                token:
                  $ref: '#/components/schemas/token'
                save_data:
                  $ref: '#/components/schemas/save_data'
      responses:
        '200':
          description: Ok (cuando save_data=false)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RiskInsights'
        '201':
          description: Creado (cuando save_data=true)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RiskInsights'
        '400':
          $ref: '#/components/responses/400_bad_request_error'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '428':
          $ref: '#/components/responses/428_token_required_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
    patch:
      tags:
        - Risk Insights
      operationId: PatchRiskInsights
      summary: Completar una solicitud de información sobre riesgos
      description: >-
        Se utiliza para reanudar una sesión de recuperación de información de
        riesgos que se pausó porque la institución requería un token MFA.
      parameters:
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchBody'
      responses:
        '200':
          description: Ok (cuando save_data=false)
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RiskInsights'
        '201':
          description: Creado (cuando save_data=true)
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RiskInsights'
        '400':
          $ref: '#/components/responses/400_bad_request_error'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '428':
          $ref: '#/components/responses/428_token_required_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
  /api/risk-insights/{id}/:
    get:
      tags:
        - Risk Insights
      operationId: DetailRiskInsights
      summary: Obtener los detalles de una perspectiva de riesgo
      description: Obtén los detalles de una perspectiva de riesgo específica.
      parameters:
        - name: id
          in: path
          required: true
          description: >-
            El `risk-insights.id` sobre el que deseas obtener información
            detallada.
          schema:
            type: string
            format: uuid
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: De acuerdo
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RiskInsights'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '428':
          $ref: '#/components/responses/428_token_required_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
    delete:
      tags:
        - Risk Insights
      operationId: DestroyRiskInsights
      summary: Eliminar una perspectiva de riesgo
      description: Eliminar una percepción de riesgo específica de tu cuenta de Belvo.
      parameters:
        - name: id
          in: path
          required: true
          description: El `risk-insights.id` que deseas eliminar
          schema:
            type: string
            format: uuid
      responses:
        '204':
          description: No hay contenido
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '428':
          $ref: '#/components/responses/428_token_required_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
  /api/employment-metrics/:
    get:
      tags:
        - Employment Metrics
      operationId: ListEmploymentMetrics
      summary: Enumere las métricas de empleo.
      description: >-
        ## ▶️ Uso


        Con el método List Employment Metrics, puedes:


        1. Listar métricas de empleo relacionadas con un `link.id` específico
        (usando el parámetro de consulta `link`).

        2. Obtener los detalles de un `employment-metric.id` específico (usando
        el parámetro de consulta `id`).

        3. **[No Recomendado]** Listar todas las métricas de empleo relacionadas
        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 `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 <a
        href="https://developers.belvo.com/docs/belvo-pagination-tips"
        target="_blank">Consejos de Paginación</a>.


        ## 🔦 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 <a
        href="https://developers.belvo.com/docs/searching-and-filtering"
        target="_blank">Filtrado de respuestas</a>.
      parameters:
        - $ref: '#/components/parameters/link'
        - $ref: '#/components/parameters/page_size'
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/link__in'
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: De acuerdo
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - $ref: '#/components/schemas/common_pagination_properties'
                  - properties:
                      results:
                        type: array
                        description: Matriz de objetos de métricas de empleo.
                        items:
                          $ref: '#/components/schemas/EmploymentMetric'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
    post:
      tags:
        - Employment Metrics
      operationId: RetrieveEmploymentMetricDetails
      summary: Recuperar métricas de empleo
      description: >-
        Recuperar métricas de empleo para un individuo.


        > **Nota:** Antes de solicitar métricas de empleo, asegúrate de realizar
        primero una solicitud <a
        href="https://developers.belvo.com/reference/retrieveemploymentrecorddetails"
        target="_blank">POST Retrieve employment record details</a>.
      parameters:
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - link
              properties:
                link:
                  $ref: '#/components/schemas/link_request'
                reference_date:
                  type: string
                  format: date
                  description: >-
                    La fecha hasta la cual deseas que se calculen las métricas
                    de empleo, en formato `YYYY-MM-DD`. Por ejemplo, si no
                    deseas calcular las métricas de empleo para todo el 2023,
                    agrega `2022-12-31` como `reference_date`.


                    Si no proporcionas un `reference_date`, realizamos los
                    cálculos hasta la fecha en que haces la solicitud.


                    **Nota:** Todos los cálculos serán relativos a esta fecha.
                  example: '2023-03-01'
                save_data:
                  $ref: '#/components/schemas/save_data'
      responses:
        '200':
          description: De acuerdo
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmploymentMetric'
        '201':
          description: Creado (cuando `save_data=true`)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmploymentMetric'
        '400':
          $ref: '#/components/responses/400_bad_request_error'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
  /api/employment-metrics/{id}/:
    get:
      tags:
        - Employment Metrics
      operationId: DetailEmploymentMetric
      summary: Obtener los detalles de una métrica de empleo
      description: Obtén los detalles de una métrica de empleo específica.
      parameters:
        - name: id
          in: path
          required: true
          description: >-
            El `employment-metric.id` sobre el cual deseas obtener información
            detallada.
          schema:
            type: string
            format: uuid
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: De acuerdo
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmploymentMetric'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
    delete:
      tags:
        - Employment Metrics
      operationId: DestroyEmploymentMetric
      summary: Eliminar una métrica de empleo
      description: Elimina una métrica de empleo específica de tu cuenta de Belvo.
      parameters:
        - name: id
          in: path
          required: true
          description: El `employment-metric.id` que deseas eliminar.
          schema:
            type: string
            format: uuid
      responses:
        '204':
          description: No hay contenido
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
  /api/financial-statements/:
    get:
      tags:
        - Financial Statements
      operationId: ListFinancialStatements
      summary: Lista de Estados Financieros
      description: >-
        ## ▶️ Uso


        Con el método Listar Estados Financieros, puedes:


        1. Listar estados financieros relacionados con un `link.id` específico
        (usando el parámetro de consulta `link`).

        2. Obtener los detalles de un `financial-statement.id` específico
        (usando el parámetro de consulta `id`).

        3. **[No Recomendado]** Listar todos los estados financieros
        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 `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 <a
        href="https://developers.belvo.com/docs/belvo-pagination-tips"
        target="_blank">Consejos de Paginación</a>.


        ## 🔦 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 <a
        href="https://developers.belvo.com/docs/searching-and-filtering"
        target="_blank">Filtrado de respuestas</a>.
      parameters:
        - $ref: '#/components/parameters/link'
        - $ref: '#/components/parameters/page_size'
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/link__in'
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/id__in'
        - $ref: '#/components/parameters/created_at'
        - $ref: '#/components/parameters/created_at__gt'
        - $ref: '#/components/parameters/created_at__gte'
        - $ref: '#/components/parameters/created_at__lt'
        - $ref: '#/components/parameters/created_at__lte'
        - $ref: '#/components/parameters/created_at__range'
      responses:
        '200':
          description: De acuerdo
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - $ref: '#/components/schemas/common_pagination_properties'
                  - properties:
                      results:
                        type: array
                        description: Matriz de objetos de estado de cumplimiento fiscal.
                        items:
                          $ref: '#/components/schemas/FinancialStatement'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
    post:
      tags:
        - Financial Statements
      operationId: RetrieveFinancialStatements
      summary: Recuperar estados financieros para un enlace
      description: >-
        Recuperar la información de los Estados Financieros para un enlace
        fiscal específico.
      parameters:
        - $ref: '#/components/parameters/async'
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - link
              properties:
                link:
                  $ref: '#/components/schemas/link_request'
                save_data:
                  $ref: '#/components/schemas/save_data'
      responses:
        '200':
          description: Ok (cuando `save_data=false`)
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/FinancialStatement'
        '201':
          description: Creado (cuando `save_data=true`)
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/FinancialStatement'
        '400':
          $ref: '#/components/responses/400_bad_request_error'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
  /api/financial-statements/{id}/:
    get:
      tags:
        - Financial Statements
      operationId: DetailFinancialStatement
      summary: Obtener los detalles de un Estado Financiero
      description: Obtén los detalles de un Estado Financiero específico.
      parameters:
        - name: id
          in: path
          required: true
          description: >-
            El `financial-statement.id` sobre el que deseas obtener información
            detallada.
          schema:
            type: string
            format: uuid
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: De acuerdo
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FinancialStatement'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
    delete:
      tags:
        - Financial Statements
      operationId: DestroyFinancialStatement
      summary: Eliminar un estado financiero
      description: Eliminar un Estado Financiero específico de tu cuenta de Belvo.
      parameters:
        - name: id
          in: path
          required: true
          description: El `financial-statement.id` que deseas eliminar.
          schema:
            type: string
            format: uuid
      responses:
        '204':
          description: No hay contenido
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
  /api/invoices/:
    get:
      tags:
        - Invoices
      operationId: ListInvoices
      description: >-
        ## ▶️ Uso


        Con el método Listar Facturas, puedes:


        1. Listar facturas relacionadas con un `link.id` específico (usando el
        parámetro de consulta `link`).

        2. Obtener los detalles de un `invoice.id` específico (usando el
        parámetro de consulta `id`).

        3. **[No Recomendado]** Listar todas las facturas relacionadas 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 `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 <a
        href="https://developers.belvo.com/docs/belvo-pagination-tips"
        target="_blank">Consejos de Paginación</a>.


        ## 🔦 Filtrado de Respuestas


        Consulta la lista de campos 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 <a
        href="https://developers.belvo.com/docs/searching-and-filtering"
        target="_blank">Filtrado de respuestas</a>.


        ## 🚨 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.
      summary: Listar facturas
      parameters:
        - $ref: '#/components/parameters/link'
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/page_size'
        - $ref: '#/components/parameters/link__in'
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/id__in'
        - $ref: '#/components/parameters/created_at'
        - $ref: '#/components/parameters/created_at__gt'
        - $ref: '#/components/parameters/created_at__gte'
        - $ref: '#/components/parameters/created_at__lt'
        - $ref: '#/components/parameters/created_at__lte'
        - $ref: '#/components/parameters/created_at__range'
        - $ref: '#/components/parameters/invoice_date'
        - $ref: '#/components/parameters/invoice_date__lt'
        - $ref: '#/components/parameters/invoice_date__lte'
        - $ref: '#/components/parameters/invoice_date__gt'
        - $ref: '#/components/parameters/invoice_date__gte'
        - $ref: '#/components/parameters/invoice_date__range'
        - $ref: '#/components/parameters/invoice_identification'
        - $ref: '#/components/parameters/invoice_identification__in'
        - $ref: '#/components/parameters/status_invoice'
        - $ref: '#/components/parameters/status__in_invoice'
        - $ref: '#/components/parameters/type_invoice'
        - $ref: '#/components/parameters/type__in_invoice'
        - $ref: '#/components/parameters/total_amount'
        - $ref: '#/components/parameters/total_amount__lt'
        - $ref: '#/components/parameters/total_amount__lte'
        - $ref: '#/components/parameters/total_amount__gt'
        - $ref: '#/components/parameters/total_amount__gte'
        - $ref: '#/components/parameters/total_amount__range'
      responses:
        '200':
          description: De acuerdo
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - $ref: '#/components/schemas/common_pagination_properties'
                  - properties:
                      results:
                        type: array
                        description: Array de objetos de invoice.
                        items:
                          $ref: '#/components/schemas/InvoiceWithIdSat'
              examples:
                InvoiceIngresso:
                  $ref: '#/components/examples/InvoiceIngresoPaginated'
                InvoicePago:
                  $ref: '#/components/examples/InvoicePagoPaginated'
                InvoiceNomina:
                  $ref: '#/components/examples/InvoiceNominaPaginated'
                InvoiceEgreso:
                  $ref: '#/components/examples/InvoiceEgresoPaginated'
                InvoiceTraslado:
                  $ref: '#/components/examples/InvoiceTrasladoPaginated'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
    post:
      tags:
        - Invoices
      operationId: RetrieveInvoices
      summary: Recuperar facturas para un enlace
      description: >-
        Recuperar información de la factura desde un enlace fiscal específico.


        > 📘 Información

        >

        > Puedes solicitar hasta **un** año (365 días) de facturas por
        solicitud. Si necesitas facturas por más de un año, simplemente realiza
        otra solicitud.


        > 🚧 Advertencia

        >

        > Este recurso puede devolver campos obsoletos. Por favor, consulta la
        documentación de la respuesta para más información.
      parameters:
        - $ref: '#/components/parameters/async'
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - date_from
                - date_to
                - link
                - type
              properties:
                link:
                  $ref: '#/components/schemas/link_request'
                date_from:
                  $ref: '#/components/schemas/date_from'
                date_to:
                  $ref: '#/components/schemas/date_to'
                type:
                  $ref: '#/components/schemas/EnumInvoiceType'
                attach_xml:
                  $ref: '#/components/schemas/attach_xml'
                save_data:
                  $ref: '#/components/schemas/save_data'
      responses:
        '200':
          description: Ok (cuando `save_data=false`)
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/InvoiceWithIdSat'
              examples:
                InvoiceIngresso:
                  $ref: '#/components/examples/InvoiceIngreso'
                InvoicePago:
                  $ref: '#/components/examples/InvoicePago'
                InvoiceNomina:
                  $ref: '#/components/examples/InvoiceNomina'
                InvoiceEgreso:
                  $ref: '#/components/examples/InvoiceEgreso'
                InvoiceTraslado:
                  $ref: '#/components/examples/InvoiceTraslado'
        '201':
          description: Creado (cuando `save_data=true`)
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/InvoiceWithIdSat'
              examples:
                InvoiceIngresso:
                  $ref: '#/components/examples/InvoiceIngreso'
                InvoicePago:
                  $ref: '#/components/examples/InvoicePago'
                InvoiceNomina:
                  $ref: '#/components/examples/InvoiceNomina'
                InvoiceEgreso:
                  $ref: '#/components/examples/InvoiceEgreso'
                InvoiceTraslado:
                  $ref: '#/components/examples/InvoiceTraslado'
        '202':
          $ref: '#/components/responses/202_accepted_response'
        '400':
          $ref: '#/components/responses/400_bad_request_error'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
    patch:
      tags:
        - Invoices
      operationId: PatchInvoices
      summary: Completar una solicitud de facturas
      description: >-
        Se utiliza para reanudar una sesión de recuperación de Factura que se
        pausó porque la institución requería un token MFA.


        {% admonition type="info" %}
          Este recurso puede devolver campos obsoletos. Por favor, consulte la documentación de la respuesta para obtener más información.
        {% /admonition %}
      parameters:
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchBody'
      responses:
        '200':
          description: Ok (cuando `save_data=false`)
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/InvoiceWithIdSat'
        '201':
          description: Creado (cuando `save_data=true`)
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/InvoiceWithIdSat'
        '400':
          $ref: '#/components/responses/400_bad_request_error'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
  /api/invoices/{id}/:
    get:
      tags:
        - Invoices
      operationId: DetailInvoice
      summary: Obtener los detalles de una factura
      description: |-
        Obtener los detalles de una factura específica.

        {% admonition type="info" %}
          Este recurso puede devolver campos obsoletos. Por favor, consulte la documentación de la respuesta para más información.
        {% /admonition %}
      parameters:
        - name: id
          in: path
          required: true
          description: El `invoice.id` sobre el cual deseas obtener información detallada.
          schema:
            type: string
            format: uuid
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: De acuerdo
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvoiceWithIdSat'
              examples:
                InvoiceIngresso:
                  $ref: '#/components/examples/InvoiceIngresoDetail'
                InvoicePago:
                  $ref: '#/components/examples/InvoicePagoDetail'
                InvoiceNomina:
                  $ref: '#/components/examples/InvoiceNominaDetail'
                InvoiceEgreso:
                  $ref: '#/components/examples/InvoiceEgresoDetail'
                InvoiceTraslado:
                  $ref: '#/components/examples/InvoiceTrasladoDetail'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
    delete:
      tags:
        - Invoices
      operationId: DestroyInvoice
      summary: Eliminar una factura
      description: Eliminar una factura específica de tu cuenta de Belvo.
      parameters:
        - name: id
          in: path
          required: true
          description: El `invoice.id` que deseas eliminar.
          schema:
            type: string
            format: uuid
      responses:
        '204':
          description: No hay contenido
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
  /api/tax-compliance-status/:
    get:
      tags:
        - Tax compliance status
      operationId: ListTaxComplianceStatus
      summary: Enumere los estados de cumplimiento fiscal
      description: >-
        ## ▶️ Uso


        Con el método Listar Estados de Cumplimiento Fiscal, puedes:


        1. Listar los estados de cumplimiento fiscal relacionados con un
        `link.id` específico (usando el parámetro de consulta `link`).

        2. Obtener los detalles de un `tax-compliance-status.id` específico
        (usando el parámetro de consulta `id`).

        3. **[No Recomendado]** Listar todos los estados de cumplimiento fiscal
        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 `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 <a
        href="https://developers.belvo.com/docs/belvo-pagination-tips"
        target="_blank">Consejos de Paginación</a>.


        ## 🔦 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 <a
        href="https://developers.belvo.com/docs/searching-and-filtering"
        target="_blank">Filtrado de respuestas</a>.
      parameters:
        - $ref: '#/components/parameters/link'
        - $ref: '#/components/parameters/page_size'
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/link__in'
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/id__in'
        - $ref: '#/components/parameters/created_at'
        - $ref: '#/components/parameters/created_at__gt'
        - $ref: '#/components/parameters/created_at__gte'
        - $ref: '#/components/parameters/created_at__lt'
        - $ref: '#/components/parameters/created_at__lte'
        - $ref: '#/components/parameters/created_at__range'
      responses:
        '200':
          description: De acuerdo
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - $ref: '#/components/schemas/common_pagination_properties'
                  - properties:
                      results:
                        type: array
                        description: Matriz de objetos de estado de cumplimiento fiscal.
                        items:
                          $ref: '#/components/schemas/TaxComplianceStatus'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '428':
          $ref: '#/components/responses/428_token_required_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
    post:
      tags:
        - Tax compliance status
      operationId: RetrieveTaxComplianceStatus
      summary: Recuperar los estados de cumplimiento fiscal para un enlace
      description: >-
        Recuperar la información del estado de cumplimiento fiscal para un
        enlace fiscal específico.
      parameters:
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - link
              properties:
                link:
                  $ref: '#/components/schemas/link_request'
                attach_pdf:
                  $ref: '#/components/schemas/attach_pdf'
                save_data:
                  $ref: '#/components/schemas/save_data'
      responses:
        '200':
          description: Ok (cuando `save_data=false`)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaxComplianceStatus'
        '201':
          description: Creado (cuando `save_data=true`)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaxComplianceStatus'
        '400':
          $ref: '#/components/responses/400_bad_request_error'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '428':
          $ref: '#/components/responses/428_token_required_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
  /api/tax-compliance-status/{id}/:
    get:
      tags:
        - Tax compliance status
      operationId: DetailTaxComplianceStatus
      summary: Obtener los detalles del estado de cumplimiento fiscal
      description: Obtén los detalles de un estado específico de cumplimiento fiscal.
      parameters:
        - name: id
          in: path
          required: true
          description: >-
            El `tax-compliance-status.id` sobre el cual deseas obtener
            información detallada.
          schema:
            type: string
            format: uuid
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: De acuerdo
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaxComplianceStatus'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '428':
          $ref: '#/components/responses/428_token_required_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
    delete:
      tags:
        - Tax compliance status
      operationId: DestroyTaxComplianceStatus
      summary: Eliminar un estado de cumplimiento fiscal
      description: >-
        Eliminar un estado de cumplimiento fiscal específico de tu cuenta de
        Belvo.
      parameters:
        - name: id
          in: path
          required: true
          description: El `tax-compliance-status.id` que deseas eliminar.
          schema:
            type: string
            format: uuid
      responses:
        '204':
          description: No hay contenido
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '428':
          $ref: '#/components/responses/428_token_required_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
  /api/tax-returns/:
    get:
      tags:
        - Tax returns
      operationId: ListTaxReturns
      summary: Listar declaraciones de impuestos
      description: >-
        ## ▶️ Uso


        Con el método List Tax Returns, puedes:


        1. Listar las declaraciones de impuestos relacionadas con un `link.id`
        específico (usando el parámetro de consulta `link`).

        2. Obtener los detalles de un `tax-return.id` específico (usando el
        parámetro de consulta `id`).

        3. **[No Recomendado]** Listar todas las declaraciones de impuestos
        relacionadas 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 `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 <a
        href="https://developers.belvo.com/docs/belvo-pagination-tips"
        target="_blank">Consejos de Paginación</a>.


        ## 🔦 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 <a
        href="https://developers.belvo.com/docs/searching-and-filtering"
        target="_blank">Filtrado de respuestas</a>.


        ## 🔔 Múltiples Esquemas


        Como un enlace puede tener tanto declaraciones de impuestos anuales como
        mensuales, la respuesta incluirá una mezcla de estos dos tipos de
        declaraciones de impuestos (y por lo tanto diferentes esquemas).
      parameters:
        - $ref: '#/components/parameters/link'
        - $ref: '#/components/parameters/page_size'
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/link__in'
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/id__in'
        - $ref: '#/components/parameters/created_at'
        - $ref: '#/components/parameters/created_at__gt'
        - $ref: '#/components/parameters/created_at__gte'
        - $ref: '#/components/parameters/created_at__lt'
        - $ref: '#/components/parameters/created_at__lte'
        - $ref: '#/components/parameters/created_at__range'
        - $ref: '#/components/parameters/ejercicio'
        - $ref: '#/components/parameters/ejercicio__lt'
        - $ref: '#/components/parameters/ejercicio__lte'
        - $ref: '#/components/parameters/ejercicio__gt'
        - $ref: '#/components/parameters/ejercicio__gte'
        - $ref: '#/components/parameters/ejercicio__range'
        - $ref: '#/components/parameters/tipo_declaracion'
        - $ref: '#/components/parameters/tipo_declaracion__in'
      responses:
        '200':
          description: De acuerdo
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - $ref: '#/components/schemas/common_pagination_properties'
                  - properties:
                      results:
                        type: array
                        description: |-
                          Una matriz de:

                            - Objetos de Declaración de Impuestos Personal (Anual)
                            - Objetos de Declaración de Impuestos Personal (Mensual)
                            - Objetos de Declaración de Impuestos Empresarial (Anual)
                            - Objetos de Declaración de Impuestos Empresarial (Mensual)
                            
                            > 🚧 Múltiples Esquemas
                            >
                            > Como un enlace puede tener declaraciones de impuestos tanto anuales como mensuales, la respuesta incluirá una mezcla de estos dos tipos de declaraciones de impuestos (y por lo tanto diferentes esquemas).
                        items:
                          anyOf:
                            - $ref: '#/components/schemas/TaxReturnPersonal'
                            - $ref: '#/components/schemas/TaxReturnPersonalMonthly'
                            - $ref: '#/components/schemas/TaxReturnBusiness'
                            - $ref: '#/components/schemas/TaxReturnBusinessMonthly'
              examples:
                TaxReturnPersonal:
                  $ref: '#/components/examples/TaxReturnPersonalListPaginated'
                TaxReturnPersonalMonthlyPFAE:
                  $ref: >-
                    #/components/examples/TaxReturnPersonalListMonthlyPaginatedPFAE
                TaxReturnPersonalMonthlyPFAI:
                  $ref: >-
                    #/components/examples/TaxReturnPersonalListMonthlyPaginatedPFAI
                TaxReturnBusiness:
                  $ref: '#/components/examples/TaxReturnBusinessListPaginated'
                TaxReturnBusinessMonthly:
                  $ref: '#/components/examples/TaxReturnBusinessListMonthlyPaginated'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '428':
          $ref: '#/components/responses/428_token_required_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
    post:
      tags:
        - Tax returns
      operationId: RetrieveTaxReturns
      summary: Recuperar declaraciones de impuestos para un enlace
      description: >-
        Recuperar información de la declaración de impuestos para un enlace
        fiscal específico.
      parameters:
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/TaxReturnsMonthlyRequest'
                - $ref: '#/components/schemas/TaxReturnsYearlyRequest'
      responses:
        '200':
          description: Ok (cuando `save_data=false`)
          content:
            application/json:
              schema:
                type: array
                items:
                  oneOf:
                    - $ref: '#/components/schemas/TaxReturnPersonal'
                    - $ref: '#/components/schemas/TaxReturnPersonalMonthly'
                    - $ref: '#/components/schemas/TaxReturnBusiness'
                    - $ref: '#/components/schemas/TaxReturnBusinessMonthly'
              examples:
                TaxReturnPersonal:
                  $ref: '#/components/examples/TaxReturnPersonalList'
                TaxReturnPersonalMonthlyPFAE:
                  $ref: '#/components/examples/TaxReturnPersonalListMonthlyPFAE'
                TaxReturnPersonalMonthlyPFAI:
                  $ref: '#/components/examples/TaxReturnPersonalListMonthlyPFAI'
                TaxReturnBusiness:
                  $ref: '#/components/examples/TaxReturnBusinessList'
                TaxReturnBusinessMonthly:
                  $ref: '#/components/examples/TaxReturnBusinessListMonthly'
        '201':
          description: Creado (cuando `save_data=true`)
          content:
            application/json:
              schema:
                type: array
                items:
                  oneOf:
                    - $ref: '#/components/schemas/TaxReturnPersonal'
                    - $ref: '#/components/schemas/TaxReturnPersonalMonthly'
                    - $ref: '#/components/schemas/TaxReturnBusiness'
                    - $ref: '#/components/schemas/TaxReturnBusinessMonthly'
              examples:
                TaxReturnPersonal:
                  $ref: '#/components/examples/TaxReturnPersonalList'
                TaxReturnPersonalMonthlyPFAE:
                  $ref: '#/components/examples/TaxReturnPersonalListMonthlyPFAE'
                TaxReturnPersonalMonthlyPFAI:
                  $ref: '#/components/examples/TaxReturnPersonalListMonthlyPFAI'
                TaxReturnBusiness:
                  $ref: '#/components/examples/TaxReturnBusinessList'
                TaxReturnBusinessMonthly:
                  $ref: '#/components/examples/TaxReturnBusinessListMonthly'
        '400':
          $ref: '#/components/responses/400_bad_request_error'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '428':
          $ref: '#/components/responses/428_token_required_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
  /api/tax-returns/{id}/:
    get:
      tags:
        - Tax returns
      operationId: DetailTaxReturn
      summary: Obtener los detalles de una declaración de impuestos
      description: Obtén los detalles de una declaración de impuestos específica.
      parameters:
        - name: id
          in: path
          required: true
          description: >-
            El `tax-return.id` sobre el cual deseas obtener información
            detallada.
          schema:
            type: string
            format: uuid
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: De acuerdo
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/TaxReturnPersonal'
                  - $ref: '#/components/schemas/TaxReturnPersonalMonthly'
                  - $ref: '#/components/schemas/TaxReturnBusiness'
                  - $ref: '#/components/schemas/TaxReturnBusinessMonthly'
              examples:
                TaxReturnPersonal:
                  $ref: '#/components/examples/TaxReturnPersonalListDetail'
                TaxReturnPersonalMonthlyPFAE:
                  $ref: '#/components/examples/TaxReturnPersonalListMonthlyPFAEDetail'
                TaxReturnPersonalMonthlyPFAI:
                  $ref: '#/components/examples/TaxReturnPersonalListMonthlyPFAIDetail'
                TaxReturnBusiness:
                  $ref: '#/components/examples/TaxReturnBusinessListDetail'
                TaxReturnBusinessMonthly:
                  $ref: '#/components/examples/TaxReturnBusinessListMonthlyDetail'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '428':
          $ref: '#/components/responses/428_token_required_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
    delete:
      tags:
        - Tax returns
      operationId: DestroyTaxReturn
      summary: Eliminar una declaración de impuestos
      description: Eliminar una declaración de impuestos específica de tu cuenta de Belvo.
      parameters:
        - name: id
          in: path
          required: true
          description: El ID de la declaración de impuestos que deseas eliminar.
          schema:
            type: string
            format: uuid
      responses:
        '204':
          description: No hay contenido
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '428':
          $ref: '#/components/responses/428_token_required_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
  /api/tax-retentions/:
    get:
      tags:
        - Tax retentions
      operationId: ListTaxRetentions
      summary: Enumera las retenciones fiscales.
      description: >-
        ## ▶️ Uso


        Con el método List Tax Retentions, puedes:


        1. Listar las retenciones fiscales relacionadas con un `link.id`
        específico (usando el parámetro de consulta `link`).

        2. Obtener los detalles de un `tax-retention.id` específico (usando el
        parámetro de consulta `id`).

        3. **[No Recomendado]** Listar todas las retenciones fiscales
        relacionadas 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 `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 <a
        href="https://developers.belvo.com/docs/belvo-pagination-tips"
        target="_blank">Consejos de Paginación</a>.


        ## 🔦 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 <a
        href="https://developers.belvo.com/docs/searching-and-filtering"
        target="_blank">Filtrado de respuestas</a>.
      parameters:
        - $ref: '#/components/parameters/link'
        - $ref: '#/components/parameters/page_size'
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/link__in'
        - $ref: '#/components/parameters/created_at'
        - $ref: '#/components/parameters/created_at__gt'
        - $ref: '#/components/parameters/created_at__gte'
        - $ref: '#/components/parameters/created_at__lt'
        - $ref: '#/components/parameters/created_at__lte'
        - $ref: '#/components/parameters/created_at__range'
      responses:
        '200':
          description: De acuerdo
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - $ref: '#/components/schemas/common_pagination_properties'
                  - properties:
                      results:
                        type: array
                        description: Matriz de objetos de retenciones fiscales.
                        items:
                          $ref: '#/components/schemas/TaxRetentions'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '428':
          $ref: '#/components/responses/428_token_required_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
    post:
      tags:
        - Tax retentions
      operationId: RetrieveTaxRetentions
      summary: Recuperar retenciones de impuestos para un enlace
      description: >-
        Recuperar información de retención de impuestos desde un enlace
        específico. El número máximo de retenciones de impuestos que se pueden
        devolver para un período es 500.
      parameters:
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - link
                - date_from
                - date_to
                - type
              properties:
                link:
                  $ref: '#/components/schemas/link_request'
                date_from:
                  $ref: '#/components/schemas/date_from'
                date_to:
                  $ref: '#/components/schemas/date_to'
                type:
                  $ref: '#/components/schemas/EnumTaxRetentionType'
                attach_xml:
                  $ref: '#/components/schemas/attach_xml'
                save_data:
                  $ref: '#/components/schemas/save_data'
      responses:
        '200':
          description: Ok (cuando `save_data=false`)
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TaxRetentions'
        '201':
          description: Creado (cuando `save_data=true`)
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TaxRetentions'
        '400':
          $ref: '#/components/responses/400_bad_request_error'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '428':
          $ref: '#/components/responses/428_token_required_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
  /api/tax-retentions/{id}/:
    get:
      tags:
        - Tax retentions
      operationId: DetailTaxRetentions
      summary: Obtener los detalles de una retención de impuestos
      description: Obtén los detalles de una retención de impuestos específica.
      parameters:
        - name: id
          in: path
          required: true
          description: >-
            El `tax-retention.id` sobre el cual deseas obtener información
            detallada.
          schema:
            type: string
            format: uuid
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: De acuerdo
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaxRetentions'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '428':
          $ref: '#/components/responses/428_token_required_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
    delete:
      tags:
        - Tax retentions
      operationId: DestroyTaxRetention
      summary: Eliminar una retención de impuestos
      description: Elimina una retención de impuestos específica de tu cuenta de Belvo.
      parameters:
        - name: id
          in: path
          required: true
          description: El `tax-retention.id` que deseas eliminar.
          schema:
            type: string
            format: uuid
      responses:
        '204':
          description: No hay contenido
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '428':
          $ref: '#/components/responses/428_token_required_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
  /api/tax-status/:
    get:
      tags:
        - Tax status
      operationId: ListTaxStatus
      summary: Enumera los estados fiscales
      description: >-
        ## ▶️ Uso


        Con el método Listar Estados Fiscales, puedes:


        1. Listar estados fiscales relacionados con un `link.id` específico
        (usando el parámetro de consulta `link`).

        2. Obtener los detalles de un `tax-status.id` específico (usando el
        parámetro de consulta `id`).

        3. **[No Recomendado]** Listar todos los estados fiscales 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 `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 <a
        href="https://developers.belvo.com/docs/belvo-pagination-tips"
        target="_blank">Consejos de Paginación</a>.


        ## 🔦 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 <a
        href="https://developers.belvo.com/docs/searching-and-filtering"
        target="_blank">Filtrado de respuestas</a>.
      parameters:
        - $ref: '#/components/parameters/link'
        - $ref: '#/components/parameters/page_size'
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/link__in'
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/id__in'
        - $ref: '#/components/parameters/created_at'
        - $ref: '#/components/parameters/created_at__gt'
        - $ref: '#/components/parameters/created_at__gte'
        - $ref: '#/components/parameters/created_at__lt'
        - $ref: '#/components/parameters/created_at__lte'
        - $ref: '#/components/parameters/created_at__range'
      responses:
        '200':
          description: De acuerdo
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - $ref: '#/components/schemas/common_pagination_properties'
                  - properties:
                      results:
                        type: array
                        description: Matriz de objetos de estado fiscal.
                        items:
                          $ref: '#/components/schemas/TaxStatusSat'
              examples:
                TaxStatusPersonalListPaginated:
                  $ref: '#/components/examples/TaxStatusPersonalListPaginated'
                TaxStatusBusinessListPaginated:
                  $ref: '#/components/examples/TaxStatusBusinessListPaginated'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '428':
          $ref: '#/components/responses/428_token_required_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
    post:
      tags:
        - Tax status
      operationId: RetrieveTaxStatus
      summary: Recuperar estados fiscales para un enlace
      description: >-
        Recuperar información sobre el estado fiscal para un enlace fiscal
        específico.
      parameters:
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: Cuerpo de la solicitud para el método Retrieve Tax Status.
              required:
                - link
              properties:
                link:
                  $ref: '#/components/schemas/link_request'
                attach_pdf:
                  $ref: '#/components/schemas/attach_pdf'
                save_data:
                  $ref: '#/components/schemas/save_data'
      responses:
        '200':
          description: Ok (cuando `save_data=false`)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaxStatusSat'
              examples:
                TaxStatusPersonal:
                  $ref: '#/components/examples/TaxStatusPersonalList'
                TaxStatusBusiness:
                  $ref: '#/components/examples/TaxStatusBusinessList'
        '201':
          description: Creado (cuando `save_data=true`)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaxStatusSat'
              examples:
                TaxStatusPersonal:
                  $ref: '#/components/examples/TaxStatusPersonalList'
                TaxStatusBusiness:
                  $ref: '#/components/examples/TaxStatusBusinessList'
        '400':
          $ref: '#/components/responses/400_bad_request_error'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '428':
          $ref: '#/components/responses/428_token_required_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
  /api/tax-status/{id}/:
    get:
      tags:
        - Tax status
      operationId: DetailTaxStatus
      summary: Obtener los detalles de un estado fiscal
      description: Obtén los detalles de un estado fiscal específico.
      parameters:
        - name: id
          in: path
          required: true
          description: >-
            El `tax-status.id` sobre el cual deseas obtener información
            detallada.
          schema:
            type: string
            format: uuid
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: De acuerdo
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaxStatusSat'
              examples:
                TaxStatusPersonal:
                  $ref: '#/components/examples/TaxStatusPersonalList'
                TaxStatusBusiness:
                  $ref: '#/components/examples/TaxStatusBusinessList'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '428':
          $ref: '#/components/responses/428_token_required_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
    delete:
      tags:
        - Tax status
      operationId: DestroyTaxStatus
      summary: Eliminar un estado fiscal
      description: Eliminar un estado fiscal específico de tu cuenta de Belvo.
      parameters:
        - name: id
          in: path
          required: true
          description: el `tax-status.id` que deseas eliminar
          schema:
            type: string
            format: uuid
      responses:
        '204':
          description: No hay contenido
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '428':
          $ref: '#/components/responses/428_token_required_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
  /api/cl/invoices/:
    get:
      tags:
        - Invoices Chile
      operationId: ListInvoicesChile
      description: >-
        ## ▶️ Uso


        Con el método List Invoices, puedes:


        1. Listar facturas relacionadas con un `link.id` específico (usando el
        parámetro de consulta `link`).

        2. Obtener los detalles de un `invoice.id` específico (usando el
        parámetro de consulta `id`).

        3. **[No Recomendado]** Listar todas las facturas relacionadas 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 `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 <a
        href="https://developers.belvo.com/docs/belvo-pagination-tips"
        target="_blank">Consejos de Paginación</a>.


        ## 🔦 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 <a
        href="https://developers.belvo.com/docs/searching-and-filtering"
        target="_blank">Filtrado de respuestas</a>.
      summary: Listar facturas
      parameters:
        - $ref: '#/components/parameters/link'
        - $ref: '#/components/parameters/page_size'
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/link__in'
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/id__in'
        - $ref: '#/components/parameters/created_at'
        - $ref: '#/components/parameters/created_at__gt'
        - $ref: '#/components/parameters/created_at__gte'
        - $ref: '#/components/parameters/created_at__lt'
        - $ref: '#/components/parameters/created_at__lte'
        - $ref: '#/components/parameters/created_at__range'
      responses:
        '200':
          description: De acuerdo
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - $ref: '#/components/schemas/common_pagination_properties'
                  - properties:
                      results:
                        type: array
                        description: Array de objetos de invoice.
                        items:
                          $ref: '#/components/schemas/invoice_chile'
              examples:
                ChileInvoicesAll:
                  $ref: '#/components/examples/ChileInvoicesAll'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
    post:
      tags:
        - Invoices Chile
      operationId: RetrieveInvoicesChile
      summary: Recuperar facturas para un enlace
      description: >-
        Recuperar información de facturas desde un enlace fiscal específico de
        Chile.

        Puedes solicitar hasta <b>un</b> año (365 días) de facturas por
        solicitud. Si necesitas facturas por más de un año, simplemente realiza
        otra solicitud.

        > 📘 Altamente Recomendado > > Recomendamos encarecidamente que utilices
        el parámetro de encabezado `X-Belvo-Request-Mode` de Belvo e implementes
        un flujo de trabajo asincrónico. Esto garantizará que no recibas errores
        de tiempo de espera al recuperar datos de facturas.
      parameters:
        - $ref: '#/components/parameters/async'
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - date_from
                - date_to
                - link
              properties:
                link:
                  $ref: '#/components/schemas/link_request'
                date_from:
                  $ref: '#/components/schemas/date_from'
                date_to:
                  $ref: '#/components/schemas/date_to'
                type:
                  $ref: '#/components/schemas/EnumInvoiceType'
                save_data:
                  $ref: '#/components/schemas/save_data'
      responses:
        '200':
          description: Ok (cuando `save_data=false`)
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/invoice_chile'
              examples:
                PurchaseInvoiceArray:
                  $ref: '#/components/examples/PurchaseInvoiceArray'
                SummaryInvoiceArray:
                  $ref: '#/components/examples/SummaryInvoiceArray'
                SaleInvoiceArray:
                  $ref: '#/components/examples/SaleInvoiceArray'
        '201':
          description: Creado (cuando `save_data=true`)
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/invoice_chile'
              examples:
                PurchaseInvoiceArray:
                  $ref: '#/components/examples/PurchaseInvoiceArray'
                SummaryInvoiceArray:
                  $ref: '#/components/examples/SummaryInvoiceArray'
                SaleInvoiceArray:
                  $ref: '#/components/examples/SaleInvoiceArray'
        '202':
          $ref: '#/components/responses/202_accepted_response'
        '400':
          $ref: '#/components/responses/400_bad_request_error'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
  /api/cl/invoices/{id}/:
    get:
      tags:
        - Invoices Chile
      operationId: DetailInvoiceChile
      summary: Obtener los detalles de una factura
      description: Obtén los detalles de una factura específica.
      parameters:
        - name: id
          in: path
          required: true
          description: El `invoice.id` sobre el cual deseas obtener información detallada.
          schema:
            type: string
            format: uuid
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: De acuerdo
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/invoice_chile'
              examples:
                PurchaseInvoiceDetails:
                  $ref: '#/components/examples/PurchaseInvoiceDetails'
                SummaryInvoiceDetails:
                  $ref: '#/components/examples/SummaryInvoiceDetails'
                SaleInvoiceDetails:
                  $ref: '#/components/examples/SaleInvoiceDetails'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
    delete:
      tags:
        - Invoices Chile
      operationId: DestroyInvoiceChile
      summary: Eliminar una factura
      description: Eliminar una factura específica de tu cuenta de Belvo.
      parameters:
        - name: id
          in: path
          required: true
          description: El `invoice.id` que deseas eliminar.
          schema:
            type: string
            format: uuid
      responses:
        '204':
          description: No hay contenido
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
  /api/cl/tax-status/:
    get:
      tags:
        - Tax Status Chile
      operationId: ListTaxStatusChile
      summary: Enumera los estados fiscales
      description: >-
        ## ▶️ Uso


        Con el método de Estado Fiscal, puedes:


        1. Listar los estados fiscales relacionados con un `link.id` específico
        (usando el parámetro de consulta `link`).

        2. Obtener los detalles de un `tax-status.id` específico (usando el
        parámetro de consulta `id`).

        3. **[No Recomendado]** Listar todos los estados fiscales 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 `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 <a
        href="https://developers.belvo.com/docs/belvo-pagination-tips"
        target="_blank">Consejos de Paginación</a>.


        ## 🔦 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 <a
        href="https://developers.belvo.com/docs/searching-and-filtering"
        target="_blank">Filtrado de respuestas</a>.
      parameters:
        - $ref: '#/components/parameters/link'
        - $ref: '#/components/parameters/page_size'
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/link__in'
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/id__in'
        - $ref: '#/components/parameters/created_at'
        - $ref: '#/components/parameters/created_at__gt'
        - $ref: '#/components/parameters/created_at__gte'
        - $ref: '#/components/parameters/created_at__lt'
        - $ref: '#/components/parameters/created_at__lte'
        - $ref: '#/components/parameters/created_at__range'
      responses:
        '200':
          description: De acuerdo
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - $ref: '#/components/schemas/common_pagination_properties'
                  - properties:
                      results:
                        type: array
                        description: Matriz de objetos de estado fiscal.
                        items:
                          $ref: '#/components/schemas/tax_status_sii'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
    post:
      tags:
        - Tax Status Chile
      operationId: RetrieveTaxStatusChile
      summary: Recuperar estados fiscales para un enlace
      description: >-
        Recuperar información sobre el estado fiscal para un enlace fiscal
        específico.
      parameters:
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - link
              properties:
                link:
                  $ref: '#/components/schemas/link_request'
                attach_pdf:
                  $ref: '#/components/schemas/attach_pdf'
                save_data:
                  $ref: '#/components/schemas/save_data'
      responses:
        '200':
          description: Ok (cuando `save_data=false`)
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/tax_status_sii'
        '201':
          description: Creado (cuando `save_data=true`)
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/tax_status_sii'
        '400':
          $ref: '#/components/responses/400_bad_request_error'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
  /api/cl/tax-status/{id}/:
    get:
      tags:
        - Tax Status Chile
      operationId: DetailTaxStatusChile
      summary: Obtener los detalles de un estado fiscal
      description: Obtén los detalles de un estado fiscal específico.
      parameters:
        - name: id
          in: path
          required: true
          description: >-
            El `tax-status.id` sobre el cual deseas obtener información
            detallada.
          schema:
            type: string
            format: uuid
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: De acuerdo
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tax_status_sii'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
    delete:
      tags:
        - Tax Status Chile
      operationId: DestroyTaxStatusChile
      summary: Eliminar un estado fiscal
      description: Eliminar un estado fiscal específico de tu cuenta de Belvo.
      parameters:
        - name: id
          in: path
          required: true
          description: el `tax-status.id` que deseas eliminar
          schema:
            type: string
            format: uuid
      responses:
        '204':
          description: No hay contenido
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
  /api/cl/debt-reports/:
    get:
      tags:
        - Debt Reports Chile
      operationId: ListDebtReportChile
      summary: Listar informes de deudas
      description: >-
        ## ▶️ Uso


        Con el método List Debt Reports, puedes:


        1. Listar informes de deuda relacionados con un `link.id` específico
        (usando el parámetro de consulta `link`).

        2. Obtener los detalles de un `debt-report.id` específico (usando el
        parámetro de consulta `id`).

        3. **[No Recomendado]** Listar todos los informes de deuda 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 `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 <a
        href="https://developers.belvo.com/docs/belvo-pagination-tips"
        target="_blank">Consejos de Paginación</a>.


        ## 🔦 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 <a
        href="https://developers.belvo.com/docs/searching-and-filtering"
        target="_blank">Filtrado de respuestas</a>.
      parameters:
        - $ref: '#/components/parameters/link'
        - $ref: '#/components/parameters/page_size'
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/link__in'
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/id__in'
        - $ref: '#/components/parameters/created_at'
        - $ref: '#/components/parameters/created_at__gt'
        - $ref: '#/components/parameters/created_at__gte'
        - $ref: '#/components/parameters/created_at__lt'
        - $ref: '#/components/parameters/created_at__lte'
        - $ref: '#/components/parameters/created_at__range'
      responses:
        '200':
          description: De acuerdo
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - $ref: '#/components/schemas/common_pagination_properties'
                  - properties:
                      results:
                        type: array
                        description: Matriz de objetos de informe de deuda.
                        items:
                          $ref: '#/components/schemas/debt_chile'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
    post:
      tags:
        - Debt Reports Chile
      operationId: RetrieveDebtReportChile
      summary: Recuperar detalles de deuda para un enlace
      description: >-
        Recuperar información de los informes de deuda para un enlace fiscal
        específico.
      parameters:
        - $ref: '#/components/parameters/async'
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - link
              properties:
                link:
                  $ref: '#/components/schemas/link_request'
                attach_pdf:
                  $ref: '#/components/schemas/attach_pdf'
                save_data:
                  $ref: '#/components/schemas/save_data'
      responses:
        '200':
          description: Ok (cuando `save_data=false`)
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/debt_chile'
        '201':
          description: Creado (cuando `save_data=true`)
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/debt_chile'
        '400':
          $ref: '#/components/responses/400_bad_request_error'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
  /api/cl/debt-reports/{id}/:
    get:
      tags:
        - Debt Reports Chile
      operationId: DetailDebtReportChile
      summary: Obtener los detalles de una deuda
      description: Obtén los detalles de una deuda específica.
      parameters:
        - name: id
          in: path
          required: true
          description: >-
            El `debt-report.id` sobre el que deseas obtener información
            detallada.
          schema:
            type: string
            format: uuid
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: De acuerdo
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/debt_chile'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
    delete:
      tags:
        - Debt Reports Chile
      operationId: DestroyDebtReportChile
      summary: Eliminar un informe de deuda
      description: Eliminar un informe de deuda específico de tu cuenta de Belvo.
      parameters:
        - name: id
          in: path
          required: true
          description: el `debt-report.id` que deseas eliminar
          schema:
            type: string
            format: uuid
      responses:
        '204':
          description: No hay contenido
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
  /payments/br/institutions/:
    get:
      tags:
        - Payment Institutions (Brazil)
      operationId: ListPaymentInstitutionsBrazil
      summary: Enumere todas las instituciones de pago.
      description: Enumere todas las instituciones de pago disponibles.
      parameters:
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/page_size'
        - $ref: '#/components/parameters/name__payments'
        - $ref: '#/components/parameters/institution_type'
        - $ref: '#/components/parameters/institution_id__in'
      responses:
        '200':
          description: De acuerdo
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - $ref: '#/components/schemas/payments_common_pagination_properties'
                  - properties:
                      results:
                        type: array
                        description: Matriz de objetos de institución.
                        items:
                          $ref: '#/components/schemas/paymentInstitutionBR'
        '401':
          $ref: '#/components/responses/401_payments_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
  /payments/br/customers/:
    post:
      tags:
        - Customers (Brazil)
      operationId: CreateCustomerBrazil
      summary: Crear un nuevo cliente
      description: Cree un nuevo cliente para enviar o solicitar fondos.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCustomerOfpi'
      responses:
        '201':
          description: OK (Creado)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerOfpi'
              examples:
                OfpiPixIndividual:
                  $ref: '#/components/examples/ResponseCustomerOfpiIndividual'
                OfpiPixBusiness:
                  $ref: '#/components/examples/ResponseCustomerOfpiBusiness'
        '400':
          description: Error de validación
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/400ValidationError'
        '401':
          $ref: '#/components/responses/401_payments_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
    get:
      tags:
        - Customers (Brazil)
      operationId: ListCustomersBrazil
      summary: Listar todos los clientes
      description: Enumere todos los clientes asociados con su cuenta de Belvo.
      parameters:
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/page_size'
        - $ref: '#/components/parameters/id__in'
        - $ref: '#/components/parameters/created_at'
        - $ref: '#/components/parameters/created_at__gt'
        - $ref: '#/components/parameters/created_at__gte'
        - $ref: '#/components/parameters/created_at__lt'
        - $ref: '#/components/parameters/created_at__lte'
        - $ref: '#/components/parameters/created_at__range'
        - $ref: '#/components/parameters/customer__type'
        - $ref: '#/components/parameters/external_id__payments'
        - $ref: '#/components/parameters/external_id__in__payments'
        - $ref: '#/components/parameters/search'
      responses:
        '200':
          description: De acuerdo
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - $ref: '#/components/schemas/payments_common_pagination_properties'
                  - properties:
                      results:
                        type: array
                        description: Matriz de objetos de cliente.
                        items:
                          $ref: '#/components/schemas/CustomerOfpi'
              examples:
                OfpiPixIndividual:
                  $ref: >-
                    #/components/examples/ResponseCustomerOfpiIndividualPaginated
                OfpiPixBusiness:
                  $ref: '#/components/examples/ResponseCustomerOfpiBusinessPaginated'
        '401':
          $ref: '#/components/responses/401_payments_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
  /payments/br/customers/{id}/:
    get:
      tags:
        - Customers (Brazil)
      operationId: DetailCustomerBrazil
      summary: Obtener detalles sobre un cliente
      description: Obtener los detalles sobre un cliente específico
      parameters:
        - name: id
          required: true
          in: path
          description: El `customer.id` sobre el cual deseas obtener información detallada.
          schema:
            type: string
            format: uuid
            example: a3b92311-1888-449f-acaa-49ae28d68fcd
      responses:
        '200':
          description: De acuerdo
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerOfpi'
              examples:
                OfpiPixIndividual:
                  $ref: '#/components/examples/ResponseCustomerOfpiIndividual'
                OfpiPixBusiness:
                  $ref: '#/components/examples/ResponseCustomerOfpiBusiness'
        '401':
          $ref: '#/components/responses/401_payments_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
  /payments/br/bank-accounts/:
    post:
      tags:
        - Bank Accounts (Brazil)
      operationId: RegisterBankAccountBrazil
      summary: Registrar una nueva cuenta bancaria
      description: >-
        Registrar una nueva cuenta bancaria desde la cual enviar o solicitar
        fondos.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/CreateBankAccountOfpiBusiness'
                - $ref: '#/components/schemas/CreateBankAccountOfpiIndividual'
            examples:
              OfpiBusinessPixInfo:
                $ref: '#/components/examples/CreateBankAccountBusinessPixInfo'
              OfpiIndividualPixInfo:
                $ref: '#/components/examples/CreateBankAccountIndividualPixInfo'
      responses:
        '201':
          description: OK (Creado)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankAccountOfpiResponse'
              examples:
                OfpiPixInfo:
                  $ref: '#/components/examples/ResponseBankAccountBusinessPixInfo'
                OfpiIndividualPixInfo:
                  $ref: '#/components/examples/ResponseBankAccountIndividualPixInfo'
        '400':
          description: Error de validación
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/400ValidationError'
        '401':
          $ref: '#/components/responses/401_payments_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
    get:
      tags:
        - Bank Accounts (Brazil)
      operationId: ListBankAccountBrazil
      summary: Enumere todas las cuentas bancarias.
      description: Enumere todas las cuentas bancarias asociadas con su cuenta de Belvo.
      parameters:
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/page_size'
        - $ref: '#/components/parameters/id__in'
        - $ref: '#/components/parameters/created_at'
        - $ref: '#/components/parameters/created_at__gt'
        - $ref: '#/components/parameters/created_at__gte'
        - $ref: '#/components/parameters/created_at__lt'
        - $ref: '#/components/parameters/created_at__lte'
        - $ref: '#/components/parameters/created_at__range'
        - $ref: '#/components/parameters/number'
        - $ref: '#/components/parameters/number__in'
        - $ref: '#/components/parameters/customer'
        - $ref: '#/components/parameters/external_id__payments'
        - $ref: '#/components/parameters/external_id__in__payments'
        - $ref: '#/components/parameters/institution'
        - $ref: '#/components/parameters/holder__type'
        - $ref: '#/components/parameters/holder__type__in'
      responses:
        '200':
          description: De acuerdo
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - $ref: '#/components/schemas/payments_common_pagination_properties'
                  - properties:
                      results:
                        type: array
                        description: Matriz de objetos de cuenta bancaria.
                        items:
                          $ref: '#/components/schemas/BankAccountOfpiResponse'
              examples:
                OfpiBusinessPixInfo:
                  $ref: >-
                    #/components/examples/ResponseBankAccountBusinessPixInfoPaginated
                OfpiIndividualPixInfo:
                  $ref: >-
                    #/components/examples/ResponseBankAccountIndividualPixInfoPaginated
        '401':
          $ref: '#/components/responses/401_payments_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
  /payments/br/bank-accounts/{id}/:
    get:
      tags:
        - Bank Accounts (Brazil)
      operationId: DetailBankAccountBrazil
      summary: Obtener detalles sobre una cuenta bancaria
      description: Obtener los detalles sobre una cuenta bancaria específica.
      parameters:
        - name: id
          required: true
          in: path
          description: >-
            El `bank-account.id` sobre el cual deseas obtener información
            detallada.
          schema:
            type: string
            format: uuid
            example: a3b92311-1888-449f-acaa-49ae28d68fcd
      responses:
        '200':
          description: De acuerdo
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankAccountOfpiResponse'
              examples:
                OfpiPixInfo:
                  $ref: '#/components/examples/ResponseBankAccountBusinessPixInfo'
                OfpiIndividualPixInfo:
                  $ref: '#/components/examples/ResponseBankAccountIndividualPixInfo'
        '401':
          $ref: '#/components/responses/401_payments_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
  /payments/br/payment-links/:
    post:
      tags:
        - Payment Links (Brazil)
      operationId: CreatePaymentLinkBrazil
      summary: Crear un enlace de pago
      description: Crea un nuevo enlace de pago para iniciar un pago con el widget alojado.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePaymentLinkOfpi'
      responses:
        '201':
          description: OK (Creado)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentLinkOfpi'
        '400':
          description: Error de validación
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/400ValidationError'
        '401':
          $ref: '#/components/responses/401_payments_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
    get:
      tags:
        - Payment Links (Brazil)
      operationId: ListPaymentLinksBrazil
      summary: Enumere todos los enlaces de pago.
      description: >-
        Enumere todos los enlaces de pago asociados con su cuenta de Belvo. De
        forma predeterminada, devolvemos hasta 100 resultados por página.
      parameters:
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/page_size'
        - $ref: '#/components/parameters/created_at'
        - $ref: '#/components/parameters/created_at__gt'
        - $ref: '#/components/parameters/created_at__gte'
        - $ref: '#/components/parameters/created_at__lt'
        - $ref: '#/components/parameters/created_at__lte'
        - $ref: '#/components/parameters/created_at__range'
        - $ref: '#/components/parameters/status_payment-links'
        - $ref: '#/components/parameters/ordering__payment-links'
        - $ref: '#/components/parameters/search'
      responses:
        '200':
          description: De acuerdo
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - $ref: '#/components/schemas/payments_common_pagination_properties'
                  - properties:
                      results:
                        type: array
                        description: Matriz de objetos de cuenta bancaria.
                        items:
                          $ref: '#/components/schemas/PaymentLinkListOfpi'
        '401':
          $ref: '#/components/responses/401_payments_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
  /payments/br/payment-links/{access_token}/:
    get:
      tags:
        - Payment Links (Brazil)
      operationId: DetailCreatePaymentlinkBrazil
      summary: Obtener detalles sobre un enlace de pago
      description: Obtén los detalles sobre un enlace de pago.
      parameters:
        - name: access_token
          required: true
          in: path
          description: >-
            El `access_token` del enlace de pago sobre el cual deseas obtener
            información detallada.


            **Nota:** Puedes recuperar el `access_token` de un enlace de pago
            realizando una solicitud <a
            href="https://developers.belvo.com/reference/listpaymentlinks"
            target="_blank">GET List all payment links</a>.
          schema:
            type: string
            example: YggaKvPbM5aJhksu1BEwDI5FKTcUc5wZqNB-wH7MFGU
      responses:
        '200':
          description: OK (Creado)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentLinkOfpi'
        '401':
          $ref: '#/components/responses/401_payments_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
  /payments/br/payment-intents/:
    post:
      tags:
        - Payment Intents (Brazil)
      operationId: CreatePaymentIntentBrazil
      summary: Crear una nueva intención de pago
      description: >-
        Crear una intención de pago.


        **Nota**: Puedes usar este método para crear adicionalmente un cliente y
        una intención de pago en una sola solicitud (consulta la opción de
        Cliente e Intención de Pago).
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/CreatePaymentIntentOfpi'
                - $ref: '#/components/schemas/CreatePaymentIntentAndCustomerOfpi'
      responses:
        '201':
          description: OK (Creado). Haz clic para ver los detalles de la respuesta.
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/PaymentIntentOfpi'
        '400':
          description: Error de validación
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/400ValidationError'
        '401':
          $ref: '#/components/responses/401_payments_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
    get:
      tags:
        - Payment Intents (Brazil)
      operationId: ListPaymentIntentsBrazil
      summary: Enumere todas las intenciones de pago.
      description: Enumere todas las intenciones de pago asociadas con su cuenta de Belvo.
      parameters:
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/page_size'
        - $ref: '#/components/parameters/id__in'
        - $ref: '#/components/parameters/amount'
        - $ref: '#/components/parameters/amount__gt'
        - $ref: '#/components/parameters/amount__gte'
        - $ref: '#/components/parameters/amount__lt'
        - $ref: '#/components/parameters/amount__lte'
        - $ref: '#/components/parameters/amount__range'
        - $ref: '#/components/parameters/created_at'
        - $ref: '#/components/parameters/created_at__gt'
        - $ref: '#/components/parameters/created_at__gte'
        - $ref: '#/components/parameters/created_at__lt'
        - $ref: '#/components/parameters/created_at__lte'
        - $ref: '#/components/parameters/created_at__range'
        - $ref: '#/components/parameters/customer'
        - $ref: '#/components/parameters/customer__in'
        - $ref: '#/components/parameters/external_id__payments'
        - $ref: '#/components/parameters/external_id__in__payments'
        - $ref: '#/components/parameters/ordering__payment-intents'
        - $ref: '#/components/parameters/provider'
        - $ref: '#/components/parameters/payment_method_type'
        - $ref: '#/components/parameters/search'
        - $ref: '#/components/parameters/status_payment-intents'
        - $ref: '#/components/parameters/status__in_payment-intents'
        - $ref: '#/components/parameters/updated_at'
        - $ref: '#/components/parameters/updated_at__gt'
        - $ref: '#/components/parameters/updated_at__gte'
        - $ref: '#/components/parameters/updated_at__lt'
        - $ref: '#/components/parameters/updated_at__lte'
        - $ref: '#/components/parameters/updated_at__range'
      responses:
        '200':
          description: De acuerdo
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - $ref: '#/components/schemas/payments_common_pagination_properties'
                  - properties:
                      results:
                        type: array
                        description: Matriz de objetos de intención de pago.
                        items:
                          $ref: '#/components/schemas/PaymentIntentOfpi'
        '401':
          $ref: '#/components/responses/401_payments_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
  /payments/br/payment-intents/{id}/:
    patch:
      tags:
        - Payment Intents (Brazil)
      operationId: PatchPaymentIntentBrazil
      summary: Completar una intención de pago
      description: Completar una nueva intención de pago.
      parameters:
        - name: id
          required: true
          in: path
          description: >-
            El `payment-intent.id` sobre el cual deseas obtener información
            detallada.
          schema:
            type: string
            format: uuid
            example: a3b92311-1888-449f-acaa-49ae28d68fcd
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchPaymentIntentOfpi'
      responses:
        '200':
          description: OK (Creado)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentIntentOfpi'
        '400':
          description: Error de validación
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/400ValidationError'
        '401':
          $ref: '#/components/responses/401_payments_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
    get:
      tags:
        - Payment Intents (Brazil)
      operationId: DetailPaymentIntentBrazil
      summary: Obtener detalles sobre una intención de pago
      description: Obtén los detalles sobre una intención de pago específica.
      parameters:
        - name: id
          required: true
          in: path
          description: >-
            El `payment-intent.id` sobre el cual deseas obtener información
            detallada.
          schema:
            type: string
            format: uuid
            example: a3b92311-1888-449f-acaa-49ae28d68fcd
      responses:
        '200':
          description: De acuerdo
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentIntentOfpi'
        '401':
          $ref: '#/components/responses/401_payments_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
  /payments/br/payment-intents/{id}/cancel/:
    post:
      tags:
        - Payment Intents (Brazil)
      operationId: CancelPaymentIntentBrazil
      summary: Cancelar una intención de pago programada
      description: >-
        Cancelar una intención de pago programada (única).


        Respondemos con un `204 - No Content` y te informaremos a través de un
        webhook que la intención de pago fue cancelada exitosamente.


        > **Nota**: El último momento en que puedes cancelar una intención de
        pago programada es a las **23:59:00 (GMT-3)** del día **anterior** a la
        fecha de pago programada.
      parameters:
        - name: id
          required: true
          in: path
          description: El `payment-intent.id` programado que deseas cancelar.
          schema:
            type: string
            format: uuid
            example: a3b92311-1888-449f-acaa-49ae28d68fcd
      responses:
        '204':
          description: No hay contenido
        '400':
          description: Error de validación
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/400ValidationError'
        '401':
          $ref: '#/components/responses/401_payments_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
  /payments/br/payment-intents/{payment_intent_id}/charges/:
    get:
      tags:
        - Payment Intents (Brazil)
      operationId: ListChargesBrazil
      summary: Enumere todos los cargos para una intención de pago.
      description: Enumere todos los cargos asociados con una intención de pago.
      parameters:
        - name: payment_intent_id
          required: true
          in: path
          description: El `payment-intent.id` al que pertenecen los cargos.
          schema:
            type: string
            format: uuid
            example: a3b92311-1888-449f-acaa-49ae28d68fcd
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/page_size'
        - name: status
          in: query
          description: Devuelve resultados solo para este valor.
          schema:
            type: string
            example: SUCCEEDED
        - name: status__in
          in: query
          description: Devolver resultados para el estado listado.
          schema:
            type: string
            example: PENDING,SUCCEEDED
      responses:
        '200':
          description: De acuerdo
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - $ref: '#/components/schemas/payments_common_pagination_properties'
                  - properties:
                      results:
                        type: array
                        description: Matriz de objetos de charge.
                        items:
                          $ref: '#/components/schemas/ChargeBrazil'
        '401':
          $ref: '#/components/responses/401_payments_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
  /payments/br/payment-intents/{payment_intent_id}/charges/{charge_id}/:
    get:
      tags:
        - Payment Intents (Brazil)
      operationId: DetailChargesBrazil
      summary: Obtener detalles sobre un cargo para una intención de pago
      description: >-
        Obtén los detalles sobre un cargo específico asociado con una intención
        de pago.
      parameters:
        - name: payment_intent_id
          required: true
          in: path
          description: El `payment-intent.id` al que pertenece el cargo.
          schema:
            type: string
            format: uuid
            example: a3b92311-1888-449f-acaa-49ae28d68fcd
        - name: charge_id
          required: true
          in: path
          description: El `charge.id` sobre el cual deseas obtener detalles.
          schema:
            type: string
            format: uuid
            example: a3b92311-1888-449f-acaa-49ae28d68fcd
      responses:
        '200':
          description: De acuerdo
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChargeBrazil'
        '401':
          $ref: '#/components/responses/401_payments_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
  /payments/br/payment-intents/{payment_intent_id}/charges/{charge_id}/cancel/:
    post:
      tags:
        - Payment Intents (Brazil)
      operationId: CancelChargeBrazil
      summary: Cancelar un cargo programado
      description: >-
        Cancelar un cargo programado.


        Respondemos con un `204 - No Content` y te informaremos a través de un
        webhook que el cargo fue cancelado exitosamente.


        > **Nota**: La última hora para cancelar un cargo programado es a las
        **23:59:00 (GMT-3)** del día **anterior** a la fecha de pago programada.
      parameters:
        - name: payment_intent_id
          required: true
          in: path
          description: El `payment-intent.id` programado al que pertenece el cargo.
          schema:
            type: string
            format: uuid
            example: a3b92311-1888-449f-acaa-49ae28d68fcd
        - name: charge_id
          required: true
          in: path
          description: El `charge.id` programado que deseas cancelar.
          schema:
            type: string
            format: uuid
            example: a3b92311-1888-449f-acaa-49ae28d68fcd
      responses:
        '204':
          description: No hay contenido
        '400':
          description: Error de validación
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/400ValidationError'
        '401':
          $ref: '#/components/responses/401_payments_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
  /payments/br/payment-authorizations/:
    post:
      tags:
        - Payment Authorizations (Brazil)
      operationId: CreatePaymentAuthorizationBrazil
      x-badges:
        - name: BETA
          position: before
      summary: Crear una nueva Autorización de Pago
      description: |-
        {% admonition type="warning" name="En BETA" %}
          Este endpoint está en BETA. Por lo tanto, pueden ocurrir cambios menores o errores. Si encuentras algún problema, por favor contacta a tu representante de Belvo.
        {% /admonition %}

        Crear una Autorización de Pago.
      parameters:
        - $ref: '#/components/parameters/header_version'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/CreatePaymentAuthorizationFixed'
                - $ref: '#/components/schemas/CreatePaymentAuthorizationVariable'
      responses:
        '201':
          description: OK - Autorización de Pago creada
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentAuthorization'
        '400':
          description: Error de validación
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/400ValidationError'
        '401':
          $ref: '#/components/responses/401_payments_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
    get:
      tags:
        - Payment Authorizations (Brazil)
      operationId: ListPaymentAuthorizationsBrazil
      x-badges:
        - name: BETA
          position: before
      summary: Enumere todas las Autorizaciones de Pago
      description: |-
        {% admonition type="warning" name="En BETA" %}
          Este endpoint está en BETA. Por lo tanto, pueden ocurrir cambios menores o errores. Si encuentras algún problema, por favor contacta a tu representante de Belvo.
        {% /admonition %}

        Lista todas las Autorizaciones de Pago asociadas con tu cuenta de Belvo.
      parameters:
        - $ref: '#/components/parameters/header_version'
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/page_size'
        - $ref: '#/components/parameters/id__in'
        - $ref: '#/components/parameters/amount'
        - $ref: '#/components/parameters/amount__gt'
        - $ref: '#/components/parameters/amount__gte'
        - $ref: '#/components/parameters/amount__lt'
        - $ref: '#/components/parameters/amount__lte'
        - $ref: '#/components/parameters/amount__range'
        - $ref: '#/components/parameters/created_at'
        - $ref: '#/components/parameters/created_at__gt'
        - $ref: '#/components/parameters/created_at__gte'
        - $ref: '#/components/parameters/created_at__lt'
        - $ref: '#/components/parameters/created_at__lte'
        - $ref: '#/components/parameters/created_at__range'
        - $ref: '#/components/parameters/customer'
        - $ref: '#/components/parameters/customer__in'
        - $ref: '#/components/parameters/external_id__payments'
        - $ref: '#/components/parameters/external_id__in__payments'
        - $ref: '#/components/parameters/search'
        - $ref: '#/components/parameters/updated_at'
        - $ref: '#/components/parameters/updated_at__gt'
        - $ref: '#/components/parameters/updated_at__gte'
        - $ref: '#/components/parameters/updated_at__lt'
        - $ref: '#/components/parameters/updated_at__lte'
        - $ref: '#/components/parameters/updated_at__range'
      responses:
        '200':
          description: De acuerdo
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - $ref: '#/components/schemas/payments_common_pagination_properties'
                  - properties:
                      results:
                        type: array
                        description: Matriz de objetos de Payment Authorization.
                        items:
                          $ref: '#/components/schemas/PaymentAuthorization'
        '401':
          $ref: '#/components/responses/401_payments_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
  /payments/br/payment-authorizations/{payment_authorization_id}/:
    get:
      tags:
        - Payment Authorizations (Brazil)
      operationId: DetailPaymentAuthorizationBrazil
      x-badges:
        - name: BETA
          position: before
      summary: Obtener detalles sobre una Autorización de Pago
      description: |-
        {% admonition type="warning" name="En BETA" %}
          Este endpoint está en BETA. Por lo tanto, pueden ocurrir cambios menores o errores. Si encuentras algún problema, por favor contacta a tu representante de Belvo.
        {% /admonition %}

        Obtén los detalles sobre una Autorización de Pago específica.
      parameters:
        - $ref: '#/components/parameters/header_version'
        - name: payment_authorization_id
          required: true
          in: path
          description: >-
            El `payment-authorization.id` sobre el cual deseas obtener
            información detallada.
          schema:
            type: string
            format: uuid
            example: a3b92311-1888-449f-acaa-49ae28d68fcd
      responses:
        '200':
          description: De acuerdo
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentAuthorization'
        '401':
          $ref: '#/components/responses/401_payments_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
  /payments/br/payment-authorizations/{payment_authorization_id}/cancel/:
    post:
      tags:
        - Payment Authorizations (Brazil)
      operationId: CancelPaymentAuthorizationBrazil
      x-badges:
        - name: BETA
          position: before
      summary: Cancelar una Autorización de Pago
      description: >-
        {% admonition type="warning" name="En BETA" %}
          Este endpoint está en BETA. Por lo tanto, pueden ocurrir cambios menores o errores. Si encuentras algún problema, por favor contacta a tu representante de Belvo.
        {% /admonition %}


        Cancelar una Autorización de Pago


        Respondemos con un `204 - No Content` y te informaremos a través de un
        webhook que la Autorización de Pago fue cancelada exitosamente.


        {% admonition type="warning" name="Restricciones de Tiempo para
        Cancelación" %}

        El último momento en que puedes cancelar una Autorización de Pago es
        hasta las 22:00:00 (GMT-3) del día anterior a la fecha del próximo
        Cargo. Si no cumples con el tiempo límite, la Autorización de Pago será
        cancelada, **pero el Cargo aún será procesado**.

        {% /admonition %}
      parameters:
        - $ref: '#/components/parameters/header_version'
        - name: payment_authorization_id
          required: true
          in: path
          description: El `payment-authorization.id` programado que deseas cancelar.
          schema:
            type: string
            format: uuid
            example: a3b92311-1888-449f-acaa-49ae28d68fcd
      responses:
        '204':
          description: No hay contenido
        '400':
          description: Error de validación
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/400ValidationError'
        '401':
          $ref: '#/components/responses/401_payments_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
  /payments/br/payment-authorizations/{payment_authorization_id}/charges/:
    post:
      tags:
        - Payment Authorizations (Brazil)
      operationId: CreatePaymentAuthorizationChargeBrazil
      x-badges:
        - name: BETA
          position: before
      summary: Crear un nuevo Charge
      description: |-
        {% admonition type="warning" name="En BETA" %}
          Este endpoint está en BETA. Por lo tanto, pueden ocurrir cambios menores o errores. Si encuentras algún problema, por favor contacta a tu representante de Belvo.
        {% /admonition %}

        Crea un nuevo Charge para una Payment Authorization.
      parameters:
        - $ref: '#/components/parameters/header_version'
        - name: payment_authorization_id
          required: true
          in: path
          description: El `payment-authorization.id` al que pertenece el Charge.
          schema:
            type: string
            format: uuid
            example: a3b92311-1888-449f-acaa-49ae28d68fcd
      requestBody:
        required: true
        content:
          application/json:
            schema:
              oneOf:
                - $ref: >-
                    #/components/schemas/CreateChargePixAutomaticoDefaultBankAccount
                - $ref: >-
                    #/components/schemas/CreateChargePixAutomaticoDifferentBankAccount
      responses:
        '201':
          description: OK - Cargo Creado
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChargeV2'
        '400':
          description: Error de validación
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/400ValidationError'
        '401':
          $ref: '#/components/responses/401_payments_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
    get:
      tags:
        - Payment Authorizations (Brazil)
      operationId: ListPaymentAuthorizationChargesBrazil
      x-badges:
        - name: BETA
          position: before
      summary: Enumere todos los Cargos para una Autorización de Pago.
      description: |-
        {% admonition type="warning" name="En BETA" %}
          Este endpoint está en BETA. Por lo tanto, pueden ocurrir cambios menores o errores. Si encuentras algún problema, por favor contacta a tu representante de Belvo.
        {% /admonition %}

        Lista todos los Charges asociados con una Payment Authorization.
      parameters:
        - name: payment_authorization_id
          required: true
          in: path
          description: El `payment-authorization.id` al que pertenecen los cargos.
          schema:
            type: string
            format: uuid
            example: a3b92311-1888-449f-acaa-49ae28d68fcd
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/page_size'
        - name: status
          in: query
          description: Devuelve resultados solo para este valor.
          schema:
            type: string
            example: SUCCEEDED
        - name: status__in
          in: query
          description: Devolver resultados para el estado listado.
          schema:
            type: string
            example: PENDING,SUCCEEDED
      responses:
        '200':
          description: De acuerdo
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - $ref: '#/components/schemas/payments_common_pagination_properties'
                  - properties:
                      results:
                        type: array
                        description: Matriz de objetos de charge.
                        items:
                          $ref: '#/components/schemas/ChargeV2'
        '401':
          $ref: '#/components/responses/401_payments_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
  /payments/br/payment-authorizations/{payment_authorization_id}/charges/{charge_id}/:
    get:
      tags:
        - Payment Authorizations (Brazil)
      operationId: DetailPaymentAuthorizationChargeBrazil
      x-badges:
        - name: BETA
          position: before
      summary: Obtener detalles sobre un Cargo para una Autorización de Pago
      description: >-
        {% admonition type="warning" name="En BETA" %}
          Este endpoint está en BETA. Por lo tanto, pueden ocurrir cambios menores o errores. Si encuentras algún problema, por favor contacta a tu representante de Belvo.
        {% /admonition %}


        Obtén los detalles sobre un Cargo específico asociado con una
        Autorización de Pago.
      parameters:
        - $ref: '#/components/parameters/header_version'
        - name: payment_authorization_id
          required: true
          in: path
          description: El `payment-authorization.id` al que pertenece el Charge.
          schema:
            type: string
            format: uuid
            example: a3b92311-1888-449f-acaa-49ae28d68fcd
        - name: charge_id
          required: true
          in: path
          description: El `charge.id` sobre el cual deseas obtener detalles.
          schema:
            type: string
            format: uuid
            example: a3b92311-1888-449f-acaa-49ae28d68fcd
      responses:
        '200':
          description: De acuerdo
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChargeV2'
        '401':
          $ref: '#/components/responses/401_payments_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
  /payments/br/payment-authorizations/{payment_authorization_id}/charges/{charge_id}/retry/:
    post:
      tags:
        - Payment Authorizations (Brazil)
      operationId: RetryPaymentAuthorizationChargeBrazil
      x-badges:
        - name: BETA
          position: before
      summary: Reintentar un Cargo fallido para una Autorización de Pago
      description: |-
        {% admonition type="warning" name="En BETA" %}
          Este endpoint está en BETA. Por lo tanto, pueden ocurrir cambios menores o errores. Si encuentras algún problema, por favor contacta a tu representante de Belvo.
        {% /admonition %}

        Reintentar un Cargo fallido para una Autorización de Pago dada.

        {% admonition type="warning" name="Documentación adicional" %}
          Por favor, asegúrate de leer la documentación dedicada a Reintentar Cargos y Cargos Vinculados antes de intentar reintentar un cargo.
        {% /admonition %}
      parameters:
        - $ref: '#/components/parameters/header_version'
        - name: payment_authorization_id
          required: true
          in: path
          description: El `payment-authorization.id` al que pertenece el Charge.
          schema:
            type: string
            format: uuid
            example: a3b92311-1888-449f-acaa-49ae28d68fcd
        - name: charge_id
          required: true
          in: path
          description: El `charge.id` sobre el cual deseas obtener detalles.
          schema:
            type: string
            format: uuid
            example: a3b92311-1888-449f-acaa-49ae28d68fcd
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                date:
                  type: string
                  format: date
                  description: >-
                    La fecha en la que deseas reintentar el Cargo, en formato
                    `YYYY-MM-DD`. Debe ser al menos un día en el futuro.
                  example: '2025-06-30'
      responses:
        '201':
          description: De acuerdo
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChargeV2'
        '401':
          $ref: '#/components/responses/401_payments_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
  /payments/br/payment-authorizations/{payment_authorization_id}/charges/{charge_id}/cancel/:
    post:
      tags:
        - Payment Authorizations (Brazil)
      operationId: CancelPaymentAuthorizationChargeBrazil
      x-badges:
        - name: BETA
          position: before
      summary: Cancelar un Cargo programado
      description: >-
        {% admonition type="warning" name="En BETA" %}
          Este endpoint está en BETA. Como tal, pueden ocurrir cambios menores o errores. Si encuentras algún problema, por favor contacta a tu representante de Belvo.
        {% /admonition %}


        Cancela un Cargo programado.


        Respondemos con un `204 - No Content` y te informaremos a través de un
        webhook que el cargo fue cancelado exitosamente.


        {% admonition type="warning" name="Restricción de Tiempo para
        Cancelación" %}
          La última hora para cancelar un Cargo programado es a las 22:00:00 (GMT-3) del día anterior a la fecha del Cargo. Si no cumples con el tiempo límite, recibirás un error de API de Belvo y el pago se procesará.
        {% /admonition %}
      parameters:
        - $ref: '#/components/parameters/header_version'
        - name: payment_authorization_id
          required: true
          in: path
          description: El `payment-authorization.id` programado al que pertenece el Charge.
          schema:
            type: string
            format: uuid
            example: a3b92311-1888-449f-acaa-49ae28d68fcd
        - name: charge_id
          required: true
          in: path
          description: El `charge.id` programado que deseas cancelar.
          schema:
            type: string
            format: uuid
            example: a3b92311-1888-449f-acaa-49ae28d68fcd
      responses:
        '204':
          description: No hay contenido
        '400':
          description: Error de validación
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/400ValidationError'
        '401':
          $ref: '#/components/responses/401_payments_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
  /payments/br/transactions/:
    get:
      tags:
        - Payment Transactions (Brazil)
      operationId: ListPaymentTransactionsBrazil
      summary: Enumere todas las transacciones de pago.
      description: >-
        Enumere todas las transacciones de pago asociadas con su cuenta de
        Belvo.
      parameters:
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/page_size'
        - $ref: '#/components/parameters/id__in'
        - $ref: '#/components/parameters/created_at'
        - $ref: '#/components/parameters/created_at__gt'
        - $ref: '#/components/parameters/created_at__gte'
        - $ref: '#/components/parameters/created_at__lt'
        - $ref: '#/components/parameters/created_at__lte'
        - $ref: '#/components/parameters/created_at__range'
        - $ref: '#/components/parameters/charge'
        - $ref: '#/components/parameters/charge__in'
        - $ref: '#/components/parameters/beneficiary'
        - $ref: '#/components/parameters/beneficiary__in'
        - $ref: '#/components/parameters/payer'
        - $ref: '#/components/parameters/payer__in'
        - $ref: '#/components/parameters/customer'
        - $ref: '#/components/parameters/customer__in'
        - $ref: '#/components/parameters/payment_intent'
        - $ref: '#/components/parameters/payment_intent__in'
        - $ref: '#/components/parameters/transaction__type'
        - $ref: '#/components/parameters/currency'
        - $ref: '#/components/parameters/description'
        - $ref: '#/components/parameters/amount'
        - $ref: '#/components/parameters/amount__gt'
        - $ref: '#/components/parameters/amount__gte'
        - $ref: '#/components/parameters/amount__lt'
        - $ref: '#/components/parameters/amount__lte'
        - $ref: '#/components/parameters/amount__range'
      responses:
        '200':
          description: De acuerdo
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - $ref: '#/components/schemas/payments_common_pagination_properties'
                  - properties:
                      results:
                        type: array
                        description: Matriz de objetos de transacción.
                        items:
                          $ref: '#/components/schemas/paymentTransaction'
        '401':
          $ref: '#/components/responses/401_payments_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
  /payments/br/transactions/{id}/:
    get:
      tags:
        - Payment Transactions (Brazil)
      operationId: DetailPaymentTransactionsBrazil
      summary: Obtener detalles sobre una transacción de pago
      description: Obtén los detalles sobre una transacción de pago específica.
      parameters:
        - name: id
          required: true
          in: path
          description: >-
            El `transaction.id` sobre el cual deseas obtener información
            detallada.
          schema:
            type: string
            format: uuid
            example: a3b92311-1888-449f-acaa-49ae28d68fcd
      responses:
        '200':
          description: De acuerdo
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/paymentTransaction'
        '401':
          $ref: '#/components/responses/401_payments_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
  /payments/br/enrollments/:
    get:
      tags:
        - Enrollments (Brazil)
      operationId: ListEnrollmentsBrazil
      summary: Listar inscripciones
      description: >-
        ## ▶️ Uso


        Con el método List Enrollments, puedes:


        1. (Recomendado) Listar inscripciones relacionadas con un CPF específico
        (usando el parámetro de consulta `customer__identifier`).

        2. Listar inscripciones relacionadas con un `customer.id` y
        `institution.id` específicos (usando los parámetros de consulta
        `customer` e `institution`).

        3. Listar inscripciones según un estado específico (usando el parámetro
        de consulta `status`).

        4. **[No Recomendado]** Listar todas las inscripciones relacionadas con
        tu cuenta de Belvo (sin usar ningún parámetro de consulta).


        ## 🔦 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 <a
        href="https://developers.belvo.com/docs/searching-and-filtering"
        target="_blank">Filtrado de respuestas</a>.


        ## 📖 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 <a
        href="https://developers.belvo.com/docs/belvo-pagination-tips"
        target="_blank">Consejos de Paginación</a>.
      parameters:
        - $ref: '#/components/parameters/customer_identifier'
        - $ref: '#/components/parameters/customer'
        - $ref: '#/components/parameters/external_id__payments'
        - $ref: '#/components/parameters/external_id__in__payments'
        - $ref: '#/components/parameters/institution'
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/page_size'
        - $ref: '#/components/parameters/status_enrollments'
        - $ref: '#/components/parameters/status__in_enrollments'
      responses:
        '200':
          description: De acuerdo
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - $ref: '#/components/schemas/payments_common_pagination_properties'
                  - properties:
                      results:
                        type: array
                        description: Matriz de objetos de enrollment.
                        items:
                          $ref: '#/components/schemas/EnrollmentBiometricPix'
        '401':
          $ref: '#/components/responses/401_payments_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
  /payments/br/enrollments/{enrollment_id}/:
    get:
      tags:
        - Enrollments (Brazil)
      operationId: DetailEnrollmentBrazil
      summary: Obtener detalles sobre una inscripción
      description: Obtener detalles sobre una inscripción de dispositivo específica.
      parameters:
        - name: enrollment_id
          required: true
          in: path
          description: El `enrollment.id` para el que deseas obtener detalles.
          schema:
            type: string
            format: uuid
            example: a3b92311-1888-449f-acaa-49ae28d68fcd
      responses:
        '200':
          description: De acuerdo
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnrollmentBiometricPix'
        '400':
          description: Error de validación
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/400ValidationError'
        '401':
          $ref: '#/components/responses/401_payments_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
  /payments/br/token/:
    post:
      tags:
        - Biometric Pix Widget Access Token (Brazil)
      summary: Generar un token de acceso para el widget de pago
      operationId: GeneratePaymentWidgetAccessToken
      description: >-
        Genere un token de acceso para el widget de pago para el proceso de
        inscripción o pago con Biometric Pix.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BiometricPaymentWidgetRequest'
      responses:
        '200':
          description: Operación exitosa
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WidgetToken'
        '400':
          $ref: '#/components/responses/400_bad_request_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
components:
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: >-
        Belvo emplea **autenticación básica** utilizando tus claves secretas
        (puedes encontrar tus claves secretas de API en tu Panel de Control de
        Belvo, en la sección de **Desarrolladores**).


        Para autenticarte, necesitas usar tu `secretId` de API como `username` y
        tu `secretPassword` de API como `password`. Estas credenciales deben ser
        codificadas en **Base64** e incluidas en el encabezado `Authorization`
        de tus solicitudes HTTP. Por ejemplo:


        ```shell

        curl -X GET https://sandbox.belvo.com/api/ \
          -H "Authorization: Basic $(echo -n 'YOUR_SECRET_ID:YOUR_SECRET_PASSWORD' | base64)"
        ```


        Reemplaza `YOUR_SECRET_ID` y `YOUR_SECRET_PASSWORD` con tus credenciales
        reales. **Nunca expongas tus credenciales en código del lado del cliente
        o en repositorios públicos**.
  parameters:
    page_size:
      name: page_size
      in: query
      description: >-
        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).
      schema:
        type: integer
        format: int32
        default: 100
        minimum: 1
        maximum: 1000
        example: 100
    page:
      name: page
      in: query
      description: Un número de página dentro del conjunto de resultados paginados.
      schema:
        type: integer
        format: int32
        minimum: 1
        example: 1
    display_name:
      name: display_name
      in: query
      description: >-
        Devuelve las instituciones que coinciden parcialmente con este nombre
        para mostrar.
      schema:
        type: string
        maxLength: 30
        example: Erebor Bank
    country_code:
      name: country_code
      in: query
      description: Devuelve instituciones solo para este código de país de dos letras.
      schema:
        type: string
        pattern: ^[A-Z]{2}$
        example: MX
    country_code__in:
      name: country_code__in
      in: query
      description: Devuelve instituciones solo para estos códigos de país de dos letras.
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
          pattern: ^[A-Z]{2}$
          example: BR
    resources__allin:
      name: resources__allin
      in: query
      description: Devuelve las instituciones que apoyan esta combinación de recursos.
      style: form
      explode: false
      schema:
        type: array
        minimum: 2
        items:
          type: string
          example: OWNERS
    name:
      name: name
      in: query
      description: Devuelve una institución con este nombre designado por Belvo.
      schema:
        type: string
        pattern: ^[a-z_]{1,40}$
        minLength: 1
        maxLength: 40
        example: planet_mx_retail
    name__in:
      name: name__in
      in: query
      description: >-
        Devuelve instituciones con uno o más de estos nombres designados por
        Belvo.
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
          pattern: ^[a-z_]{1,40}$
          minLength: 1
          maxLength: 40
          example: planet_mx_retail
    status_institutions:
      name: status
      in: query
      description: >-
        Devuelve las instituciones con el estado dado. Puedes elegir entre
        `healthy` o `down`.
      schema:
        type: string
        example: healthy
    status__in_institutions:
      name: status__in
      in: query
      description: >-
        Devolver instituciones con uno de los estados dados. Puedes elegir entre
        `healthy` o `down`.
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
          example: healthy
    type_institutions:
      name: type
      in: query
      description: >-
        Devolver instituciones de este tipo. Puede elegir entre `bank`, `fiscal`
        o `employment`.
      schema:
        type: string
        enum:
          - bank
          - fiscal
          - employment
        example: fiscal
    type__in_institutions:
      name: type__in
      in: query
      description: >-
        Devuelve instituciones de uno de estos tipos. Puedes elegir entre
        `bank`, `fiscal` o `employment`.
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
          enum:
            - bank
            - fiscal
            - employment
          example: fiscal
    website:
      name: website
      in: query
      description: Devuelve instituciones con esta URL de sitio web.
      schema:
        type: string
        example: https://www.erebor.mx
    omit:
      name: omit
      in: query
      description: >-
        Omite ciertos campos para que no se devuelvan en la respuesta. Para más
        información, consulta nuestro artículo del DevPortal <a
        href="https://developers.belvo.com/docs/searching-and-filtering"
        target="_blank">Filtrando respuestas</a>.
      schema:
        type: string
    fields:
      name: fields
      in: query
      description: >-
        Devuelve solo los campos especificados en la respuesta. Para obtener más
        información, consulta nuestro artículo del DevPortal <a
        href="https://developers.belvo.com/docs/searching-and-filtering"
        target="_blank">Filtrando respuestas</a>.
      schema:
        type: string
    id:
      name: id
      in: query
      description: Devuelve información solo para este recurso `id`.
      schema:
        type: string
        format: uuid
        example: 24ccab1d-3a86-4136-a6eb-e04bf52b356f
    id__in:
      name: id__in
      in: query
      description: Devuelve información para estos `id`s de recursos.
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
          format: uuid
          example: 6b3dea0f-be29-49d1-aabe-1a6d588642e6
    institution:
      name: institution
      in: query
      description: >-
        Devuelve resultados solo para esta institución (usa el nombre designado
        por Belvo, como `planet_mx_employment`).
      schema:
        type: string
        pattern: ^[a-z_]{1,40}$
        minLength: 1
        maxLength: 40
        example: planet_mx_retail
    institution__in:
      name: institution__in
      in: query
      description: >-
        Devuelve resultados solo para estas instituciones (utiliza los nombres
        designados por Belvo, como `ofmockbank_br_retail` y
        `planet_mx_employment`).
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
          pattern: ^[a-z_]{1,40}$
          minLength: 1
          maxLength: 40
          example: planet_mx_retail
    access_mode:
      name: access_mode
      in: query
      description: >-
        Devuelve enlaces solo con este modo de acceso. Puede ser `single` o
        `recurrent`.
      example: single
      schema:
        type: string
        enum:
          - single
          - recurrent
        example: single
    created_at:
      name: created_at
      in: query
      description: >-
        Devuelve los elementos que se actualizaron por última vez en la base de
        datos de Belvo en esta fecha (en formato `YYYY-MM-DD`).
      schema:
        type: string
        format: date
        example: '2022-05-05'
    created_at__gt:
      name: created_at__gt
      in: query
      description: >-
        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`).
      schema:
        type: string
        format: date
        example: '2022-05-05'
    created_at__gte:
      name: created_at__gte
      in: query
      description: >-
        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`).
      schema:
        type: string
        format: date
        example: '2022-05-04'
    created_at__lt:
      name: created_at__lt
      in: query
      description: >-
        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`).
      schema:
        type: string
        format: date
        example: '2022-04-01'
    created_at__lte:
      name: created_at__lte
      in: query
      description: >-
        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`).
      schema:
        type: string
        format: date
        example: '2022-03-30'
    created_at__range:
      name: created_at__range
      in: query
      description: >-
        Devolver cuentas que fueron actualizadas por última vez en la base de
        datos de Belvo entre dos fechas (en formato `YYYY-MM-DD`).
      style: form
      explode: false
      schema:
        type: array
        maxItems: 2
        items:
          type: string
          format: date
          example: '2022-03-03'
    created_by__not_in:
      name: created_by__not_in
      in: query
      description: Devolver enlaces que no fueron creados por estos usuarios de Belvo.
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
          format: uuid
          example: d9475f4d-c511-4732-9ef0-93b5672f43d3
    external_id:
      name: external_id
      in: query
      description: Devuelve enlaces con este ID externo.
      schema:
        type: string
        minLength: 3
        maxLength: 256
        example: InternalUser4000
    external_id__in:
      name: external_id__in
      in: query
      description: Devuelve enlaces con estos IDs externos.
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
          minLength: 3
          maxLength: 256
          example: InternalUser4001
    institution_user_id:
      name: institution_user_id
      in: query
      description: Devuelve enlaces con este ID de usuario de institución específico.
      schema:
        type: string
        example: ezFoxjPDr7YnASnOaft5F3zt7D0kurgDNlLtZFjxUo0=
    institution_user_id__in:
      name: institution_user_id__in
      in: query
      description: Devuelve enlaces con estos IDs de usuario de la institución.
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
          example: ezFoxjPDr7YnASnOaft5F3zt7D0kurgDNlLtZFjxUo0=
    refresh_rate:
      name: refresh_rate
      in: query
      description: >-
        Devuelve enlaces con esta frecuencia de actualización. Elige entre `6h`,
        `12h`, `24h`, `7d`, `30d` o `null` (para enlaces únicos).
      schema:
        type: string
        pattern: ^((\d{1,3}h)?(\d{1,3}m)?(\d{1,3}d)?|null)$
        example: 24h
    status_links:
      name: status
      in: query
      description: >-
        Devolver enlaces con este estado. Elija entre `valid`, `invalid`,
        `unconfirmed` o `token_required`.
      schema:
        type: string
        example: invalid
    status__in_links:
      name: status__in
      in: query
      description: >-
        Devuelve enlaces con estos estados. Elige entre `valid`, `invalid`,
        `unconfirmed` o `token_required`.
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
          example: invalid
    pageSize_query:
      name: page_size
      in: query
      description: >-
        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).
      schema:
        type: integer
        format: int32
        default: 100
        minimum: 1
        maximum: 1000
        example: 100
    document_number:
      name: user_document
      required: true
      in: query
      description: >-
        El número de CPF o CNPJ del usuario para el que deseas obtener
        información de consentimiento.
      schema:
        type: string
        minLength: 11
        maxLength: 14
        example: '12345678900'
    link:
      name: link
      in: query
      description: >-
        El `link.id` por el que deseas filtrar.


        ℹ️ Recomendamos encarecidamente añadir el filtro `link.id` para mejorar
        tu rendimiento.
      schema:
        type: string
        format: uuid
        example: 8848bd0c-9c7e-4f53-a732-ec896b11d4c4
    link__in:
      name: link__in
      in: query
      description: Devuelve resultados solo para estos `link.id`s.
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
          format: uuid
          example: 5722d0ba-69d7-42dc-8ff5-33767b83c5d6
    balance__available:
      name: balance__available
      in: query
      description: >-
        Devuelve las cuentas que tienen un `balance.available` que coincide
        exactamente con este valor.
      schema:
        type: number
        format: float
        pattern: ^\d{1,15}\.\d{2,4}$
        example: 4000.02
    balance__available__lt:
      name: balance__available__lt
      in: query
      description: >-
        Devuelve las cuentas que tienen un `balance.available` menor que este
        valor.
      schema:
        type: number
        format: float
        pattern: ^\d{1,15}\.\d{2,4}$
        example: 6000.02
    balance__available__lte:
      name: balance__available__lte
      in: query
      description: >-
        Devuelve las cuentas que tienen un `balance.available` menor o igual a
        este valor.
      schema:
        type: number
        format: float
        pattern: ^\d{1,15}\.\d{2,4}$
        example: 5999.02
    balance__available__gt:
      name: balance__available__gt
      in: query
      description: >-
        Devuelve las cuentas que tienen un `balance.available` mayor que este
        valor.
      schema:
        type: number
        format: float
        pattern: ^\d{1,15}\.\d{2,4}$
        example: 2000.02
    balance__available__gte:
      name: balance__available__gte
      in: query
      description: >-
        Devuelve las cuentas que tienen un `balance.available` mayor o igual a
        este valor.
      schema:
        type: number
        format: float
        pattern: ^\d{1,15}\.\d{2,4}$
        example: 1999.02
    balance__available__range:
      name: balance__available__range
      in: query
      description: >-
        Devolver cuentas que tienen un `balance.available` dentro de un rango de
        dos valores.
      style: form
      explode: false
      schema:
        type: array
        maxItems: 2
        items:
          type: number
          format: float
          pattern: ^\d{1,15}\.\d{2,4}$
          example: 4350.02
    balance__current:
      name: balance__current
      in: query
      description: >-
        Devuelve las cuentas que tienen un `balance.current` que coincide
        exactamente con este valor.
      schema:
        type: number
        format: float
        pattern: ^\d{1,15}\.\d{2,4}$
        example: 4000.02
    balance__current__lt:
      name: balance__current__lt
      in: query
      description: >-
        Devuelve las cuentas que tienen un `balance.current` menor que este
        valor.
      schema:
        type: number
        format: float
        pattern: ^\d{1,15}\.\d{2,4}$
        example: 6000.02
    balance__current__lte:
      name: balance__current__lte
      in: query
      description: >-
        Devuelve las cuentas que tienen un `balance.available` menor o igual a
        este valor.
      schema:
        type: number
        format: float
        pattern: ^\d{1,15}\.\d{2,4}$
        example: 5999.02
    balance__current__gt:
      name: balance__current__gt
      in: query
      description: >-
        Devuelve las cuentas que tienen un `balance.current` mayor que este
        valor.
      schema:
        type: number
        format: float
        pattern: ^\d{1,15}\.\d{2,4}$
        example: 2000.02
    balance__current__gte:
      name: balance__current__gte
      in: query
      description: >-
        Devuelve las cuentas que tienen un `balance.available` mayor o igual a
        este valor.
      schema:
        type: number
        format: float
        pattern: ^\d{1,15}\.\d{2,4}$
        example: 1999.02
    balance__current__range:
      name: balance__current__range
      in: query
      description: >-
        Devolver cuentas que tienen un `balance.current` dentro de un rango de
        dos valores.
      style: form
      explode: false
      schema:
        type: array
        maxItems: 2
        items:
          type: number
          format: float
          pattern: ^\d{1,15}\.\d{2,4}$
          example: 4350.02
    category:
      name: category
      in: query
      description: >-
        Devuelve cuentas solo para la categoría dada (por ejemplo,
        `CHECKING_ACCOUNT` y `SAVINGS_ACCOUNT`).
      schema:
        type: string
        example: CREDIT_ACCOUNT
    category__in:
      name: category__in
      in: query
      description: >-
        Devuelve cuentas solo para las categorías dadas (por ejemplo,
        `CHECKING_ACCOUNT` y `SAVINGS_ACCOUNT`).
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
          example: SAVINGS_ACCOUNT
    currency:
      name: currency
      in: query
      description: >-
        Devuelve resultados que contengan finanzas o saldos solo en este código
        de moneda de tres letras.
      schema:
        type: string
        pattern: ^[A-Z]{3}$
        example: BRA
    currency__in:
      name: currency__in
      in: query
      description: >-
        Devuelve resultados que tengan fondos o saldos en uno de estos códigos
        de moneda de tres letras.
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
          pattern: ^[A-Z]{3}$
          example: BRA
    name_accounts:
      name: name
      in: query
      description: >-
        Devuelve cuentas con exactamente este nombre interno (especificado por
        la institución).
      schema:
        type: string
        example: Cuenta Perfiles- M.N. - MXN-666
    name__icontains:
      name: name__icontains
      in: query
      description: >-
        Devolver cuentas que coincidan parcialmente con este nombre interno
        (especificado por la institución).
      schema:
        type: string
        minLength: 3
        example: Perfiles
    number_accounts:
      name: number
      in: query
      description: >-
        Devuelva información solo para este número de cuenta (según lo
        especificado por la institución).
      schema:
        type: string
        example: '4057068115181'
    number__in_accounts:
      name: number__in
      in: query
      description: >-
        Devuelva información para estos números de cuenta (según lo especificado
        por la institución).
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
          example: '4057068115181'
    public_identification_name:
      name: public_identification_name
      in: query
      description: >-
        Devuelve información solo para este tipo de ID de cuenta. Por ejemplo,
        cuentas CLABE.
      schema:
        example: CLABE
        type: string
    public_identification_value:
      name: public_identification_value
      in: query
      description: >-
        Devuelve información solo para este ID de cuenta. Por ejemplo, el número
        de cuenta para una cuenta CLABE.
      schema:
        example: '150194683119900273'
        type: string
    type_accounts:
      name: type
      in: query
      description: >-
        Devuelve información solo para las cuentas que coincidan con este tipo
        de cuenta, según lo designado por la institución.
      schema:
        type: string
        example: Cuentas de efectivo
    link__required:
      name: link
      in: query
      required: true
      description: El `link.id` por el que deseas filtrar.
      schema:
        type: string
        format: uuid
        example: 8848bd0c-9c7e-4f53-a732-ec896b11d4c4
    account:
      name: account
      in: query
      description: >-
        El `account.id` por el que deseas filtrar.


        ℹ️ Recomendamos encarecidamente agregar filtros de `link.id` o
        `account.id` para mejorar tu rendimiento.
      schema:
        type: string
        format: uuid
        example: 8848bd0c-9c7e-4f53-a732-ec896b11d4c4
    account__in:
      name: account__in
      in: query
      description: Devuelve resultados solo para estos `account.id`s.
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
          format: uuid
          example: 85b77707-90ef-46fd-9059-5a757f24247a
    collected_at:
      name: collected_at
      in: query
      description: >-
        Devuelve los elementos que fueron recuperados de la institución en esta
        fecha (`YYYY-MM-DD` o marca de tiempo completa `ISO-8601`).
      schema:
        type: string
        format: date
        example: '2022-05-01'
    collected_at__gt:
      name: collected_at__gt
      in: query
      description: >-
        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`).
      schema:
        type: string
        format: date
        example: '2022-05-05'
    collected_at__gte:
      name: collected_at__gte
      in: query
      description: >-
        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`).
      schema:
        type: string
        format: date
        example: '2022-05-04'
    collected_at__lt:
      name: collected_at__lt
      in: query
      description: >-
        Devolver los elementos que fueron recuperados de la institución antes de
        esta fecha (`YYYY-MM-DD` o marca de tiempo completa `ISO-8601`).
      schema:
        type: string
        format: date
        example: '2022-04-01'
    collected_at__lte:
      name: collected_at__lte
      in: query
      description: >-
        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`).
      schema:
        type: string
        format: date
        example: '2022-03-30'
    collected_at__range:
      name: collected_at__range
      in: query
      description: >-
        Devolver los elementos que fueron recuperados de la institución entre
        dos fechas (`YYYY-MM-DD` o una marca de tiempo completa en formato
        `ISO-8601`).
      style: form
      explode: false
      schema:
        type: array
        maxItems: 2
        items:
          type: string
          format: date
          example: '2022-05-04'
    account__balance__available:
      name: account__balance__available
      in: query
      description: >-
        Devuelve transacciones que tengan un `account.balance.available` que
        coincida exactamente con este valor.
      schema:
        type: number
        format: float
        pattern: ^\d{1,15}\.\d{2,4}$
        example: 4000.02
    account__balance__available__lt:
      name: account__balance__available__lt
      in: query
      description: >-
        Devuelve las transacciones que tienen un `account.balance.available`
        menor que este valor.
      schema:
        type: number
        format: float
        pattern: ^\d{1,15}\.\d{2,4}$
        example: 6000.02
    account__balance__available__lte:
      name: account__balance__available__lte
      in: query
      description: >-
        Devuelve las transacciones que tienen un `account.balance.available`
        menor o igual a este valor.
      schema:
        type: number
        format: float
        pattern: ^\d{1,15}\.\d{2,4}$
        example: 5999.02
    account__balance__available__gt:
      name: account__balance__available__gt
      in: query
      description: >-
        Devolver transacciones que tengan un `account.balance.available` mayor
        que este valor.
      schema:
        type: number
        format: float
        pattern: ^\d{1,15}\.\d{2,4}$
        example: 6000.02
    account__balance__available__gte:
      name: account__balance__available__gte
      in: query
      description: >-
        Devuelve las transacciones que tienen un `account.balance.available`
        mayor o igual a este valor.
      schema:
        type: number
        format: float
        pattern: ^\d{1,15}\.\d{2,4}$
        example: 5999.02
    account__balance__available__range:
      name: account__balance__available__range
      in: query
      description: >-
        Devolver transacciones que tengan un `account.balance.available` dentro
        de un rango de dos valores.
      style: form
      explode: false
      schema:
        type: array
        maxItems: 2
        items:
          type: number
          format: float
          pattern: ^\d{1,15}\.\d{2,4}$
          example: 4350.02
    account__balance__current:
      name: account__balance__current
      in: query
      description: >-
        Devuelve transacciones que tengan un `account.balance.current` que
        coincida exactamente con este valor.
      schema:
        type: number
        format: float
        pattern: ^\d{1,15}\.\d{2,4}$
        example: 4000.02
    account__balance__current__gt:
      name: account__balance__current__gt
      in: query
      description: >-
        Devuelve las transacciones que tienen un `account.balance.current` mayor
        que este valor.
      schema:
        type: number
        format: float
        pattern: ^\d{1,15}\.\d{2,4}$
        example: 4020.02
    account__balance__current__gte:
      name: account__balance__current__gte
      in: query
      description: >-
        Devuelve transacciones que tengan un `account.balance.current` mayor o
        igual a este valor.
      schema:
        type: number
        format: float
        pattern: ^\d{1,15}\.\d{2,4}$
        example: 4019.02
    account__balance__current__lt:
      name: account__balance__current__lt
      in: query
      description: >-
        Devuelve las transacciones que tienen un `account.balance.current` menor
        que este valor.
      schema:
        type: number
        format: float
        pattern: ^\d{1,15}\.\d{2,4}$
        example: 3000.02
    account__balance__current__lte:
      name: account__balance__current__lte
      in: query
      description: >-
        Devuelve transacciones que tengan un `account.balance.current` menor o
        igual a este valor.
      schema:
        type: number
        format: float
        pattern: ^\d{1,15}\.\d{2,4}$
        example: 2999.02
    account__balance__current__range:
      name: account__balance__current__range
      in: query
      description: >-
        Devuelve transacciones que tienen un `account.balance.current` dentro de
        un rango de dos valores.
      style: form
      explode: false
      schema:
        type: array
        maxItems: 2
        items:
          type: number
          example: 4350
    account_type:
      name: account_type
      in: query
      description: >-
        Devuelve información solo para las transacciones que coincidan con este
        tipo de cuenta, según lo designado por la institución.
      schema:
        type: string
        example: Cuentas de efectivo
    account_type__in:
      name: account_type__in
      in: query
      description: >-
        Devuelve información solo para transacciones que coincidan con estos
        tipos de cuenta, según lo designado por la institución.
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
          example: Depositos Ahorro
    accounting_date:
      name: accounting_date
      in: query
      description: >-
        Devolver transacciones que fueron procesadas por la institución
        exactamente en esta fecha (`YYYY-MM-DD`).
      schema:
        type: string
        format: date
        example: '2022-05-05'
    accounting_date__gt:
      name: accounting_date__gt
      in: query
      description: >-
        Devolver transacciones que fueron procesadas por la institución después
        de esta fecha (`YYYY-MM-DD`).
      schema:
        type: string
        format: date
        example: '2022-05-06'
    accounting_date__gte:
      name: accounting_date__gte
      in: query
      description: >-
        Devuelve las transacciones que fueron procesadas por la institución en
        esta fecha (`YYYY-MM-DD`) o posteriormente.
      schema:
        type: string
        format: date
        example: '2022-05-04'
    accounting_date__lt:
      name: accounting_date__lt
      in: query
      description: >-
        Devolver transacciones que fueron procesadas por la institución antes de
        esta fecha (`YYYY-MM-DD`).
      schema:
        type: string
        format: date
        example: '2022-03-02'
    accounting_date__lte:
      name: accounting_date__lte
      in: query
      description: >-
        Devuelve las transacciones que fueron procesadas por la institución en
        esta fecha (`YYYY-MM-DD`) o antes.
      schema:
        type: string
        format: date
        example: '2022-03-01'
    accounting_date__range:
      name: accounting_date__range
      in: query
      description: >-
        Devolver transacciones que fueron procesadas por la institución en este
        rango de fechas (`YYYY-MM-DD`).
      style: form
      explode: false
      schema:
        type: array
        maxItems: 2
        items:
          type: string
          format: date
          example: '2022-05-06'
    amount:
      name: amount
      in: query
      description: Devuelve resultados solo para este valor.
      schema:
        type: number
        format: float
        pattern: ^\d{1,15}\.\d{2,4}$
        example: 1000.02
    amount__gt:
      name: amount__gt
      in: query
      description: Devolver resultados solo para más de esta cantidad.
      schema:
        type: number
        format: float
        pattern: ^\d{1,15}\.\d{2,4}$
        example: 1000.02
    amount__gte:
      name: amount__gte
      in: query
      description: Devuelve resultados solo para y más de esta cantidad.
      schema:
        type: number
        format: float
        pattern: ^\d{1,15}\.\d{2,4}$
        example: 1000.02
    amount__lt:
      name: amount__lt
      in: query
      description: Devolver resultados solo por menos de esta cantidad.
      schema:
        type: number
        format: float
        pattern: ^\d{1,15}\.\d{2,4}$
        example: 1000.02
    amount__lte:
      name: amount__lte
      in: query
      description: Devuelve resultados solo para esta cantidad o menos.
      schema:
        type: number
        format: float
        pattern: ^\d{1,15}\.\d{2,4}$
        example: 1000.02
    amount__range:
      name: amount__range
      in: query
      description: Devolver resultados dentro de este rango de cantidades.
      style: form
      explode: false
      schema:
        type: array
        maxItems: 2
        items:
          type: number
          format: float
          pattern: ^\d{1,15}\.\d{2,4}$
          example: 2000.02
    credit_card_data__bill_name__in:
      name: credit_card_data__bill_name__in
      in: query
      description: Devolver transacciones para uno de estos nombres de factura.
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
          maxLength: 50
          example: feb-2022
    reference:
      name: reference
      in: query
      description: >-
        Devuelve transacciones con este número de referencia asignado por la
        institución.
      schema:
        type: string
        example: 85904452810319230
    reference__in:
      name: reference__in
      in: query
      description: >-
        Devuelve transacciones con estos números de referencia asignados por la
        institución.
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
          example: 85904452810319230
    status_transactions:
      name: status
      in: query
      description: >-
        Devolver transacciones con este estado. Puede ser `PENDING`, `PROCESSED`
        o `UNCATEGORIZED`.
      schema:
        type: string
        example: PENDING
    status__in_transactions:
      name: status__in
      in: query
      description: >-
        Devuelve transacciones con estos estados. Puede ser `PENDING`,
        `PROCESSED` o `UNCATEGORIZED`.
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
          example: PROCESSED
    type_transactions:
      name: type
      in: query
      description: Devolver transacciones con este tipo. Puede ser `INFLOW` o `OUTFLOW`.
      schema:
        type: string
        enum:
          - OUTFLOW
          - INFLOW
        example: OUTFLOW
    type__in_transactions:
      name: type__in
      in: query
      description: Devolver transacciones con estos tipos. Puede ser `INFLOW` o `OUTFLOW`.
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
          enum:
            - OUTFLOW
            - INFLOW
          example: INFLOW
    value_date:
      name: value_date
      in: query
      description: Devolver resultados exactamente para esta fecha (`YYYY-MM-DD`).
      schema:
        type: string
        format: date
        example: '2022-05-05'
    value_date__gt:
      name: value_date__gt
      in: query
      description: Devolver resultados que ocurrieron después de esta fecha (`YYYY-MM-DD`).
      schema:
        type: string
        format: date
        example: '2022-05-06'
    value_date__gte:
      name: value_date__gte
      in: query
      description: Devolver resultados para esta fecha (`YYYY-MM-DD`) o posterior.
      schema:
        type: string
        format: date
        example: '2022-05-04'
    value_date__lt:
      name: value_date__lt
      in: query
      description: Devolver resultados para antes de esta fecha (`YYYY-MM-DD`).
      schema:
        type: string
        format: date
        example: '2022-03-02'
    value_date__lte:
      name: value_date__lte
      in: query
      description: Devolver resultados para esta fecha (`YYYY-MM-DD`) o anterior.
      schema:
        type: string
        format: date
        example: '2022-03-01'
    value_date__range:
      name: value_date__range
      in: query
      description: Devolver resultados para este rango de fechas (`YYYY-MM-DD`).
      style: form
      explode: false
      schema:
        type: array
        maxItems: 2
        items:
          type: string
          format: date
          example: '2022-05-06'
    async:
      name: X-Belvo-Request-Mode
      in: header
      description: >-
        Parámetro de encabezado recomendado para hacer que tu solicitud POST sea
        asincrónica (evitando así tiempos de espera y mejorando el flujo de
        datos).


        Cuando realizas una solicitud asincrónica, Belvo responde con un payload
        `202 - Accepted`, que incluye el `request_id`. Una vez que hayamos
        recuperado la información solicitada, recibirás un webhook con el enlace
        y los IDs de solicitud.
      schema:
        type: string
        enum:
          - async
        example: async
    due_date:
      name: due_date
      in: query
      description: >-
        Devolver elementos que tienen una `due_date` en esta fecha
        (`YYYY-MM-DD`).
      schema:
        type: string
        format: date
        example: '2022-05-01'
    due_date__gt:
      name: due_date__gt
      in: query
      description: >-
        Devolver elementos que tengan una `due_date` posterior a esta fecha
        (`YYYY-MM-DD`).
      schema:
        type: string
        format: date
        example: '2022-05-05'
    due_date__gte:
      name: due_date__gte
      in: query
      description: >-
        Devolver elementos que tengan una `due_date` en o después de esta fecha
        (`YYYY-MM-DD`).
      schema:
        type: string
        format: date
        example: '2022-05-05'
    due_date__lt:
      name: due_date__lt
      in: query
      description: >-
        Devolver elementos que tengan una `due_date` anterior a esta fecha
        (`YYYY-MM-DD`).
      schema:
        type: string
        format: date
        example: '2022-05-05'
    due_date__lte:
      name: due_date__lte
      in: query
      description: >-
        Devolver elementos que tengan una `due_date` anterior o en esta fecha
        (`YYYY-MM-DD`).
      schema:
        type: string
        format: date
        example: '2022-05-05'
    due_date__range:
      name: due_date__range
      in: query
      description: >-
        Devolver elementos que tienen una `due_date` entre dos fechas
        (`YYYY-MM-DD`).
      style: form
      explode: false
      schema:
        type: array
        maxItems: 2
        items:
          type: string
          format: date
          example: '2022-05-04'
    email:
      name: email
      in: query
      description: >-
        Devuelve los propietarios cuya dirección de correo electrónico coincide
        con tu consulta.
      schema:
        type: string
        format: email
        example: lopes.d@gmail.com
    display_name__icontains:
      name: display_name__icontains
      in: query
      description: >-
        Devuelve propietarios cuyo nombre completo de visualización coincida
        parcialmente con tu consulta. Por ejemplo, `mar` devolverá resultados
        para Mark, Maria, Neymar, Remarque, etc.
      schema:
        type: string
        minLength: 3
        example: Daniela
    type_investments:
      name: type
      in: query
      description: >-
        Devuelve inversiones con este tipo. Puede ser `BANCARIA`, `CREDITO`,
        `VARIABLE`, `FUND` o `BOND`.
      schema:
        type: string
        example: VARIABLE
    type__in_investments:
      name: type__in
      in: query
      description: >-
        Devolución de inversiones de este tipo. Puede ser `BANCARIA`, `CREDITO`,
        `VARIABLE`, `FUND` o `BOND`.
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
          example: VARIABLE
    internal_identification:
      name: internal_identification
      in: query
      description: El `internal_identification` por el que deseas filtrar.
      schema:
        type: string
        example: BLPM951331IONVGR54
    internal_identification__in:
      name: internal_identification__in
      in: query
      description: Uno o más `internal_identification`s por los que deseas filtrar.
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
          example: BLPM951331IONVGR54
    start_date:
      name: start_date
      in: query
      description: >-
        Devuelve los empleos que comenzaron en esta fecha, en formato
        `YYYY-MM-DD`.
      schema:
        type: string
        format: date
        example: '2022-05-05'
    start_date__gt:
      name: start_date__gt
      in: query
      description: >-
        Devuelve los empleos que comenzaron después de esta fecha, en formato
        `YYYY-MM-DD`.
      schema:
        type: string
        format: date
        example: '2022-05-06'
    start_date__gte:
      name: start_date__gte
      in: query
      description: >-
        Devuelve los empleos que comenzaron en o después de esta fecha, en
        formato `YYYY-MM-DD`.
      schema:
        type: string
        format: date
        example: '2022-05-04'
    start_date__lt:
      name: start_date__lt
      in: query
      description: >-
        Devuelve los empleos que comenzaron antes de esta fecha, en formato
        `YYYY-MM-DD`.
      schema:
        type: string
        format: date
        example: '2022-03-02'
    start_date__lte:
      name: start_date__lte
      in: query
      description: >-
        Devuelve los empleos que comenzaron en o antes de esta fecha, en formato
        `YYYY-MM-DD`.
      schema:
        type: string
        format: date
        example: '2022-03-01'
    start_date__range:
      name: start_date__range
      in: query
      description: >-
        Devuelve los empleos que comenzaron entre estas dos fechas, en formato
        `YYYY-MM-DD,YYYY-MM-DD`.
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
          format: date
          example: '2022-05-06'
    end_date:
      name: end_date
      in: query
      description: >-
        Devuelve los empleos que finalizaron en esta fecha, en formato
        `YYYY-MM-DD`.
      schema:
        type: string
        format: date
        example: '2022-05-05'
    end_date__gt:
      name: end_date__gt
      in: query
      description: >-
        Devuelve los empleos que finalizaron después de esta fecha, en formato
        `YYYY-MM-DD`.
      schema:
        type: string
        format: date
        example: '2022-05-06'
    end_date__gte:
      name: end_date__gte
      in: query
      description: >-
        Devuelve los empleos que finalizaron en o después de esta fecha, en
        formato `YYYY-MM-DD`.
      schema:
        type: string
        format: date
        example: '2022-05-04'
    end_date__lt:
      name: end_date__lt
      in: query
      description: >-
        Devuelve los empleos que finalizaron antes de esta fecha, en formato
        `YYYY-MM-DD`.
      schema:
        type: string
        format: date
        example: '2022-03-02'
    end_date__lte:
      name: end_date__lte
      in: query
      description: >-
        Devuelve los empleos que finalizaron en o antes de esta fecha, en
        formato `YYYY-MM-DD`.
      schema:
        type: string
        format: date
        example: '2022-03-01'
    end_date__range:
      name: end_date__range
      in: query
      description: >-
        Devuelve los empleos que finalizaron entre estas dos fechas, en formato
        `YYYY-MM-DD,YYYY-MM-DD`.
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
          format: date
          example: '2022-05-06'
    invoice_date:
      name: invoice_date
      in: query
      description: Devolver facturas emitidas exactamente en esta fecha (`YYYY-MM-DD`).
      schema:
        type: string
        format: date
        example: '2022-05-05'
    invoice_date__lt:
      name: invoice_date__lt
      in: query
      description: Devuelve los saldos emitidos antes de esta fecha (`YYYY-MM-DD`).
      schema:
        type: string
        format: date
        example: '2022-03-02'
    invoice_date__lte:
      name: invoice_date__lte
      in: query
      description: Devuelve los saldos emitidos en esta fecha o antes (`YYYY-MM-DD`).
      schema:
        type: string
        format: date
        example: '2022-03-01'
    invoice_date__gt:
      name: invoice_date__gt
      in: query
      description: Devolver facturas emitidas después de esta fecha (`YYYY-MM-DD`).
      schema:
        type: string
        format: date
        example: '2022-05-06'
    invoice_date__gte:
      name: invoice_date__gte
      in: query
      description: Devolver facturas emitidas en esta fecha o posterior (`YYYY-MM-DD`)
      schema:
        type: string
        format: date
        example: '2022-05-04'
    invoice_date__range:
      name: invoice_date__range
      in: query
      description: >-
        Devolver facturas emitidas dentro de este rango de fechas
        (`YYYY-MM-DD`).
      style: form
      explode: false
      schema:
        type: array
        maxItems: 2
        items:
          type: string
          format: date
          example: '2022-05-06'
    invoice_identification:
      name: invoice_identification
      in: query
      description: >-
        Devuelve una factura con este ID (según lo proporcionado por la
        institución).
      schema:
        type: string
        example: 862B9918-3K6H-4E0B-NAI9-2BE2D833B840
    invoice_identification__in:
      name: invoice_identification__in
      in: query
      description: >-
        Devuelve las facturas con estos IDs (según lo proporcionado por la
        institución).
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
          example: 992B9918-3G6H-4E0B-DAI9-2BE2D833B833
    status_invoice:
      name: status
      in: query
      description: >-
        Devuelve las facturas con este estado. Puede ser `Vigente` (válido) o
        `Cancelado` (cancelado).
      schema:
        type: string
        example: Vigente
    status__in_invoice:
      name: status__in
      in: query
      description: >-
        Devolver facturas con estos estados. Pueden ser `Vigente` (válido) o
        `Cancelado` (cancelado).
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
          example: Cancelado
    type_invoice:
      name: type
      in: query
      description: Devolver facturas de este tipo. Puede ser `OUTFLOW` o `INFLOW`.
      schema:
        type: string
        enum:
          - OUTFLOW
          - INFLOW
        example: OUTFLOW
    type__in_invoice:
      name: type__in
      in: query
      description: Devolver facturas de estos tipos. Puede ser `OUTFLOW` o `INFLOW`.
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
          enum:
            - OUTFLOW
            - INFLOW
          example: OUTFLOW
    total_amount:
      name: total_amount
      in: query
      description: Devolver facturas que coincidan exactamente con este valor.
      schema:
        type: number
        format: float
        pattern: ^\d{1,15}\.\d{2,4}$
        example: 1000.02
    total_amount__lt:
      name: total_amount__lt
      in: query
      description: Devolver facturas menores que este valor.
      schema:
        type: number
        format: float
        pattern: ^\d{1,15}\.\d{2,4}$
        example: 540.02
    total_amount__lte:
      name: total_amount__lte
      in: query
      description: Devolver facturas menores o iguales a este valor.
      schema:
        type: number
        format: float
        pattern: ^\d{1,15}\.\d{2,4}$
        example: 541.02
    total_amount__gt:
      name: total_amount__gt
      in: query
      description: Devolver facturas mayores que este valor.
      schema:
        type: number
        format: float
        pattern: ^\d{1,15}\.\d{2,4}$
        example: 520.02
    total_amount__gte:
      name: total_amount__gte
      in: query
      description: Devolver facturas mayores o iguales a este valor.
      schema:
        type: number
        format: float
        pattern: ^\d{1,15}\.\d{2,4}$
        example: 519.02
    total_amount__range:
      name: total_amount__range
      in: query
      description: Devolver facturas entre estos dos valores.
      style: form
      explode: false
      schema:
        type: array
        maxItems: 2
        items:
          type: number
          format: float
          pattern: ^\d{1,15}\.\d{2,4}$
          example: 541.02
    ejercicio:
      name: ejercicio
      in: query
      description: Devolver declaraciones de impuestos exactamente para este año (`YYYY`).
      schema:
        type: integer
        pattern: ^[0-9]{4}$
        minimum: 1900
        minLength: 4
        maxLength: 4
        example: 2017
    ejercicio__lt:
      name: ejercicio__lt
      in: query
      description: Devolver declaraciones de impuestos de antes de este año (`YYYY`).
      schema:
        type: integer
        pattern: ^[0-9]{4}$
        minimum: 1900
        minLength: 4
        maxLength: 4
        example: 2017
    ejercicio__lte:
      name: ejercicio__lte
      in: query
      description: Devolver declaraciones de impuestos para este año y anteriores (`YYYY`).
      schema:
        type: integer
        pattern: ^[0-9]{4}$
        minimum: 1900
        minLength: 4
        maxLength: 4
        example: 2017
    ejercicio__gt:
      name: ejercicio__gt
      in: query
      description: Devolver declaraciones de impuestos para después de este año (`YYYY`).
      schema:
        type: integer
        pattern: ^[0-9]{4}$
        minimum: 1900
        minLength: 4
        maxLength: 4
        example: 2017
    ejercicio__gte:
      name: ejercicio__gte
      in: query
      description: >-
        Devolver declaraciones de impuestos para este año o posteriores
        (`YYYY`).
      schema:
        type: integer
        pattern: ^[0-9]{4}$
        minimum: 1900
        minLength: 4
        maxLength: 4
        example: 2017
    ejercicio__range:
      name: ejercicio__range
      in: query
      description: Devolver declaraciones de impuestos para este rango de años (`YYYY`).
      style: form
      explode: false
      schema:
        type: array
        maxItems: 2
        items:
          type: integer
          pattern: ^[0-9]{4}$
          minimum: 1900
          minLength: 4
          maxLength: 4
          example: 2017
    tipo_declaracion:
      name: tipo_declaracion
      in: query
      description: Devuelve las declaraciones de impuestos con este tipo de declaración.
      schema:
        type: string
        example: Normal
    tipo_declaracion__in:
      name: tipo_declaracion__in
      in: query
      description: Devuelve las declaraciones de impuestos con estos tipos de declaración.
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
          example: Commercial
    name__payments:
      name: name
      in: query
      description: >-
        Devuelve una institución con este nombre designado por Belvo.


        **Nota:**


        Este filtro admite consultas de búsqueda tanto completas como parciales,
        con un mínimo de tres caracteres requeridos.


        Por ejemplo, buscar `itau` puede coincidir con los siguientes valores:

          - `itau_unibanco_retail`
          - `itau_unibanco_business`
          - `itau_retail`
          - `itau_business`
          - `superdigital_retail`
          - `superdigital_business`
      schema:
        type: string
        minLength: 3
        example: itau
    institution_type:
      name: institution_type
      in: query
      description: >-
        Devuelve resultados solo para este tipo de institución. Puede ser
        `INDIVIDUAL` o `BUSINESS`.
      schema:
        type: string
        enum:
          - INDIVIDUAL
          - BUSINESS
        example: INDIVIDUAL
    institution_id__in:
      name: id__in
      in: query
      description: Devuelve información para estos `id` de institución.
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
          format: uuid
          example: 6b3dea0f-be29-49d1-aabe-1a6d588642e6
    customer__type:
      name: customer__type
      in: query
      description: >-
        Devuelve resultados solo para este tipo de cliente (ya sea `INDIVIDUAL`
        o `BUSINESS`).
      schema:
        type: string
        enum:
          - INDIVIDUAL
          - BUSINESS
        example: INDIVIDUAL
    external_id__payments:
      name: external_id
      in: query
      description: Devuelve objetos con este ID externo.
      schema:
        type: string
        format: uuid
        example: 295ebb46-65b8-47de-85cd-34ffbc327c09
    external_id__in__payments:
      name: external_id__in
      in: query
      description: Devuelve objetos con estos IDs externos.
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
          format: uuid
          example: 446bdd9f-5b3e-4c05-9159-7a5c87cfc810
    search:
      name: search
      in: query
      description: >-
        Devuelve resultados que coincidan con la descripción que buscaste.


        **Nota:**


        Este filtro admite consultas de búsqueda completas y parciales, con un
        mínimo de tres caracteres requeridos.


        Por ejemplo, buscar `trai` puede coincidir con los siguientes valores:

          - `Awesome training sneakers` 
          - `Training equipment`

        Buscar `car` puede coincidir con los siguientes valores:

          - `Carlos Vives`
          - `Carmen Domínguez` 
          - `carlos.vives@musicabrazil.br`
      schema:
        type: string
        minLength: 3
        example: trai
    number:
      name: number
      in: query
      description: Devolver resultados que coincidan exactamente con este valor.
      schema:
        type: string
        example: '1231564526'
    number__in:
      name: number__in
      in: query
      description: Devuelve los resultados para estos números de cuenta bancaria.
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
          example: '1231564526'
    customer:
      name: customer
      in: query
      description: El `customer.id` para el que deseas obtener resultados.
      schema:
        type: string
        format: uuid
        example: 24e5b3a5-19aa-40fe-91e5-4db7f22ecc2d
    holder__type:
      name: holder__type
      in: query
      description: Devolver resultados para el tipo de titular proporcionado.
      schema:
        type: string
        enum:
          - INDIVIDUAL
          - BUSINESS
        example: INDIVIDUAL
    holder__type__in:
      name: holder__type__in
      in: query
      description: Devolver resultados para los tipos de titulares enumerados.
      schema:
        type: array
        items:
          type: string
          enum:
            - INDIVIDUAL
            - BUSINESS
          example: INDIVIDUAL
    status_payment-links:
      name: status
      in: query
      description: >-
        Devolver enlaces de pago con este estado. Puede ser `ACTIVE` o
        `INACTIVE`.
      schema:
        type: string
        enum:
          - ACTIVE
          - INACTIVE
        example: ACTIVE
    ordering__payment-links:
      name: ordering
      in: query
      description: |-
        Devolver resultados en un orden de tiempo especificado.

        Puede ser:
          - `created_at`: devuelve enlaces de pago del más nuevo al más antiguo (en orden ascendente).
          - `-created_at`: devuelve enlaces de pago del más antiguo al más nuevo (en orden descendente).
      schema:
        enum:
          - created_at
          - '-created_at'
        example: '-created_at'
        type: string
    customer__in:
      name: customer__in
      in: query
      description: Uno o más `customer.id`s para los que deseas obtener resultados.
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
          format: uuid
          example: cb320adc-9a6b-4224-933a-5b08cf771ac7
    ordering__payment-intents:
      name: ordering
      in: query
      description: |-
        Devolver resultados en un orden de tiempo especificado.

        Puede ser:
          - `updated_at`: devuelve los intentos de pago desde el más recientemente actualizado hasta el último (en orden ascendente).
          - `-updated_at`: devuelve los intentos de pago desde el último actualizado hasta el más recientemente actualizado (en orden descendente).
      schema:
        enum:
          - updated_at
          - '-updated_at'
        example: updated_at
        type: string
    provider:
      name: provider
      in: query
      description: >-
        Devuelve resultados solo para este proveedor. Actualmente, solo puedes
        ser `belvo`.
      schema:
        type: string
        enum:
          - belvo
        example: belvo
    payment_method_type:
      name: payment_method_type
      in: query
      description: >-
        Devuelve resultados solo para este tipo de método de pago. Puede ser
        `open_finance` o `open_finance_biometric_pix`.
      schema:
        type: string
        enum:
          - open_finance
          - open_finance_biometric_pix
        example: open_finance
    status_payment-intents:
      name: status
      in: query
      description: Devuelve resultados solo para este valor.
      schema:
        type: string
        example: SUCCEEDED
    status__in_payment-intents:
      name: status__in
      in: query
      description: Devuelve los 'payment intents' con uno de estos estados.
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
          example: PROCESSING
    updated_at:
      name: updated_at
      in: query
      description: >-
        Devuelve los elementos que se actualizaron por última vez en la base de
        datos de Belvo en esta fecha (en formato `YYYY-MM-DD`).
      schema:
        type: string
        format: date
        example: '2022-05-05'
    updated_at__gt:
      name: updated_at__gt
      in: query
      description: >-
        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`).
      schema:
        type: string
        format: date
        example: '2022-05-05'
    updated_at__gte:
      name: updated_at__gte
      in: query
      description: >-
        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`).
      schema:
        type: string
        format: date
        example: '2022-05-04'
    updated_at__lt:
      name: updated_at__lt
      in: query
      description: >-
        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`).
      schema:
        type: string
        format: date
        example: '2022-04-01'
    updated_at__lte:
      name: updated_at__lte
      in: query
      description: >-
        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`).
      schema:
        type: string
        format: date
        example: '2022-03-30'
    updated_at__range:
      name: updated_at__range
      in: query
      description: >-
        Devolver cuentas que fueron actualizadas por última vez en la base de
        datos de Belvo entre dos fechas (en formato `YYYY-MM-DD`).
      style: form
      explode: false
      schema:
        type: array
        maxItems: 2
        items:
          type: string
          format: date
          example: '2022-03-03'
    header_version:
      name: X-Belvo-API-Resource-Version
      in: header
      required: true
      description: >-
        Encabezado requerido que indica qué versión de la API de Pagos deseas
        utilizar. Actualmente, esto solo es aplicable para Autorizaciones de
        Pago en Brasil y debe establecerse en `Payments-BR.V2`.


        {% admonition type="warning" name="En BETA" %}
          Esta versión está en BETA. Por lo tanto, pueden ocurrir cambios menores o errores. Si encuentras algún problema, por favor contacta a tu representante de Belvo.
        {% /admonition %}
      schema:
        type: string
        enum:
          - Payments-BR.V2
        example: Payments-BR.V2
    charge:
      name: charge
      in: query
      description: El `charge.id` para el que deseas obtener resultados.
      schema:
        type: string
        format: uuid
        example: 24e5b3a5-19aa-40fe-91e5-4db7f22ecc2d
    charge__in:
      name: charge__in
      in: query
      description: Uno o más `charge.id`s para los que deseas obtener resultados.
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
          format: uuid
          example: 2f122ae2-fc09-4c6d-9940-b6220e8d191d
    beneficiary:
      name: beneficiary
      in: query
      description: El `beneficiary.id` para el que deseas obtener resultados.
      schema:
        type: string
        format: uuid
        example: 24e5b3a5-19aa-40fe-91e5-4db7f22ecc2d
    beneficiary__in:
      name: beneficiary__in
      in: query
      description: Uno o más `beneficiary.id`s para los que deseas obtener resultados.
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
          format: uuid
          example: ee43f030-4feb-4a06-95e7-d8d8afe5b16e
    payer:
      name: payer
      in: query
      description: El `bank-account.id` del pagador para el que deseas obtener resultados.
      schema:
        type: string
        format: uuid
        example: 24e5b3a5-19aa-40fe-91e5-4db7f22ecc2d
    payer__in:
      name: payer__in
      in: query
      description: >-
        Uno o más `bank-account.id` del pagador para los que deseas obtener
        resultados.
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
          format: uuid
          example: 901bc024-be57-4972-b4cf-31664b369d6e
    payment_intent:
      name: payment_intent
      in: query
      description: El `payment-intent.id` para el que deseas obtener resultados.
      schema:
        type: string
        format: uuid
        example: 24e5b3a5-19aa-40fe-91e5-4db7f22ecc2d
    payment_intent__in:
      name: payment_intent__in
      in: query
      description: Uno o más `payment-intent.id`s para los que deseas obtener resultados.
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
          format: uuid
          example: cb320adc-9a6b-4224-933a-5b08cf771ac7
    transaction__type:
      name: transaction__type
      in: query
      description: >-
        Devuelve resultados para este tipo de transacción. Puede ser `INFLOW` o
        `OUTFLOW`.
      schema:
        type: string
        enum:
          - INFLOW
          - OUTFLOW
        example: INFLOW
    description:
      name: description
      in: query
      description: Devolver resultados para artículos con esta descripción.
      schema:
        type: string
        example: Training shoes
    customer_identifier:
      name: customer__identifier
      in: query
      description: El CPF del cliente para el que deseas obtener resultados.
      schema:
        type: string
        minLength: 11
        maxLength: 14
        example: 23100299900
    status_enrollments:
      name: status
      in: query
      description: >-
        Devuelve las inscripciones con el estado dado. Puede ser uno de los
        siguientes:
          - `PENDING`
          - `SUCCEEDED`
          - `CANCELED`
          - `FAILED`
      schema:
        type: string
        example: PENDING
    status__in_enrollments:
      name: status__in
      in: query
      description: |-
        Devuelve las inscripciones con estos estados:
          - `PENDING`
          - `SUCCEEDED`
          - `CANCELED`
          - `FAILED`
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
          example: PENDING
  schemas:
    common_pagination_properties:
      type: object
      properties:
        count:
          type: integer
          format: int32
          description: El número total de resultados en tu cuenta de Belvo.
          example: 130
        next:
          type: string
          nullable: true
          format: uri
          description: >-
            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:
          type: string
          nullable: true
          format: uri
          description: >-
            La URL a la página anterior de resultados. Si no hay una página
            anterior, el valor es `null`.
          example: null
    EnumInstitutionType:
      type: string
      enum:
        - bank
        - fiscal
        - employment
      description: |-
        El tipo de institución. Devolvemos uno de los siguientes valores:

          - `bank`
          - `fiscal`
          - `employment`
    InstitutionsFormFieldValues:
      type: object
      properties:
        code:
          type: string
          description: El código del documento.
          example: '001'
        label:
          type: string
          description: |-
            La etiqueta para el campo. Por ejemplo:
            - Cédula de Ciudadanía
            - Cédula de Extranjería
            - Pasaporte
          example: Cédula de Ciudadanía
        validation:
          type: string
          description: El tipo de validación de entrada utilizada para el campo.
          example: ^.{1,}$
        validation_message:
          type: string
          description: >-
            El mensaje que se muestra cuando se proporciona una entrada no
            válida en el campo del formulario.
          example: Invalid document number
        placeholder:
          type: string
          description: El texto del marcador de posición en el campo del formulario.
          example: DEF4444908M22
    InstitutionsFormField:
      type: object
      properties:
        name:
          type: string
          description: >-
            El campo de nombre de usuario, contraseña o tipo de nombre de
            usuario.
          example: username
        type:
          type: string
          description: >-
            El tipo de entrada para el campo del formulario. Por ejemplo,
            string.
          example: text
        label:
          type: string
          description: |-
            La etiqueta del campo del formulario. Por ejemplo:
            - Client number
            - Key Bancanet
            - Document
          example: Client number
        validation:
          type: string
          description: El tipo de validación de entrada utilizada para el campo.
          example: ^.{1,}$
        placeholder:
          type: string
          description: El texto del marcador de posición en el campo del formulario.
          example: ABC333333A33
        validation_message:
          type: string
          description: >-
            El mensaje que se muestra cuando se proporciona una entrada no
            válida en el campo del formulario.
          example: Invalid client number
        values:
          type: array
          description: >-
            Si el campo del formulario es para documentos, la institución puede
            requerir información adicional sobre el tipo de documento.
          items:
            $ref: '#/components/schemas/InstitutionsFormFieldValues'
    InstitutionsFeature:
      type: object
      properties:
        name:
          type: string
          description: El nombre de la característica.
          example: token_required
        description:
          type: string
          description: La descripción de la característica.
          example: The institution may require a token during link creation or login
    EnumInstitutionIntegrationType:
      type: string
      enum:
        - credentials
        - openfinance
      description: >-
        El tipo de tecnología utilizada para acceder a la institución.
        Devolvemos uno de los siguientes valores:


        - `credentials`: Utiliza la tecnología de scraping de Belvo, combinada
        con las credenciales del usuario, para realizar solicitudes.

        - `openfinance`: Utiliza la API de open finance del banco para realizar
        solicitudes.
      example: credentials
    EnumInstitutionStatus:
      type: string
      enum:
        - healthy
        - down
      description: >-
        Indica si la integración de Belvo con la institución está actualmente
        activa (`healthy`) o en mantenimiento (`down`).
      example: healthy
    InstitutionPublicApi:
      type: object
      title: Objeto de Institución
      description: Objeto que detalla la institución de agregación.
      x-tags:
        - Institutions
      properties:
        id:
          type: integer
          format: int32
          description: El ID de la institución según lo designado por Belvo.
          example: 1003
        name:
          type: string
          example: erebor_mx_retail
          description: El nombre de la institución, según lo designado por Belvo.
        type:
          $ref: '#/components/schemas/EnumInstitutionType'
        website:
          type: string
          nullable: true
          example: https://www.erebor.com/
          description: La URL del sitio web de la institución.
        display_name:
          type: string
          example: Erebor Mexico
          description: El nombre de cara al cliente de la institución.
        country_codes:
          type: array
          description: >-
            Los códigos de país donde la institución está disponible, por
            ejemplo:

            - 🇧🇷 BR (Brasil)

            - 🇨🇴 CO (Colombia)

            - 🇲🇽 MX (México)
          items:
            type: string
            example: MX
        primary_color:
          type: string
          example: '#056dae'
          description: El color primario en el sitio web de la institución.
        logo:
          type: string
          nullable: true
          example: https://belvo-api-media.s3.amazonaws.com/logos/erebor_logo.png
          description: La URL del logotipo de la institución.
        icon_logo:
          type: string
          nullable: true
          example: https://statics.belvo.io/widget/images/institutions/erebor.svg
          description: La URL del logotipo del icono de la institución.
        text_logo:
          type: string
          nullable: true
          example: https://statics.belvo.io/widget/images/institutions/erebor.svg
          description: La URL del logotipo de texto de la institución.
        form_fields:
          type: array
          items:
            $ref: '#/components/schemas/InstitutionsFormField'
        features:
          type: array
          description: >-
            Las características que la institución admite. Si la institución no
            tiene características especiales, entonces Belvo devuelve un array
            vacío.


            Aquí hay una lista de las características disponibles:

            - `token_required` indica que la institución puede requerir un token
            durante la creación del enlace o al realizar cualquier otra
            solicitud.
          items:
            $ref: '#/components/schemas/InstitutionsFeature'
        resources:
          type: array
          description: >-
            Una lista de recursos de Belvo que puedes usar con la institución.
            Esta lista incluye uno o más de los siguientes recursos:

              - `ACCOUNTS`
              - `BALANCES`
              - `BILLS`
              - `EMPLOYMENTS`
              - `EMPLOYMENT_RECORDS`
              - `FINANCIAL_STATEMENTS`
              - `INCOMES`
              - `INVESTMENTS`
              - `INVESTMENT_TRANSACTIONS`
              - `INVOICES`
              - `OWNERS`
              - `RECURRING_EXPENSES`
              - `RISK_INSIGHTS`
              - `TRANSACTIONS`
              - `TAX_COMPLIANCE_STATUS`
              - `TAX_RETENTIONS`
              - `TAX_RETURNS`
              - `TAX_STATUS`
          items:
            type: string
            description: Un recurso de Belvo que la institución admite.
            example: ACCOUNTS
          example:
            - ACCOUNTS
            - BALANCES
            - INCOMES
            - OWNERS
            - RECURRING_EXPENSES
            - RISK_INSIGHTS
            - TRANSACTIONS
        integration_type:
          $ref: '#/components/schemas/EnumInstitutionIntegrationType'
        status:
          $ref: '#/components/schemas/EnumInstitutionStatus'
    request_id:
      type: string
      pattern: '[a-f0-9]{32}'
      description: >-
        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
    UnauthorizedError:
      type: object
      title: Error no autorizado
      description: >-
        Este error ocurre cuando intentas realizar una llamada API utilizando
        credenciales incorrectas de la API de Belvo (ya sea tu clave secreta o
        contraseña secreta, o ambas, son incorrectas).
      properties:
        code:
          type: string
          description: >-
            Un código de error único (`authentication_failed`) 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 <a
            href="https://developers.belvo.com/docs/belvo-api-errors#401-authentication_failed"
            target="_blank">errores 401 authentication_failed</a>.
          example: authentication_failed
        message:
          type: string
          description: |-
            Una breve descripción del error.

            Para los errores `authentication_failed`, la descripción es:

              - `Invalid Secret Keys`.
          example: Invalid Secret Keys
        request_id:
          $ref: '#/components/schemas/request_id'
    401_consent_without_accounts_error:
      type: object
      title: Consentimiento sin cuentas
      description: >-
        Este error ocurre cuando tu usuario ha eliminado cuentas asociadas con
        el consentimiento que proporcionaron. Por ejemplo, cuando tu usuario
        generó su consentimiento por primera vez, tenía una cuenta corriente y
        una cuenta de préstamo en la institución, pero ha cerrado esas cuentas
        desde entonces.
      properties:
        code:
          type: string
          description: >-
            Un código de error único (`consent_without_accounts`) 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 <a
            href="https://developers.belvo.com/docs/belvo-api-errors#401-consent_without_accounts"
            target="_blank">errores 401 consent_without_accounts</a>.
          example: consent_without_accounts
        message:
          type: string
          description: >-
            Una breve descripción del error.


            Para errores `invalid` relacionados con `fetch_resources`, la
            descripción es:

              - `The institution only supports the following resources: (lista de recursos compatibles separada por comas)`.
          example: >-
            The institution only supports the following resources:
            EMPLOYMENT_RECORDS, OWNERS
        request_id:
          $ref: '#/components/schemas/request_id'
    AccessToResourceDenied:
      type: object
      title: Acceso a la API de Belvo denegado
      description: >-
        Este error ocurre cuando intentas acceder al recurso de Belvo sin los
        permisos correctos.
      properties:
        code:
          type: string
          description: >-
            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 <a
            href="https://developers.belvo.com/docs/belvo-api-errors#403-access_to_resource_denied"
            target="_blank">403 access_to_resource_denied</a>.
          example: access_to_resource_denied
        message:
          type: string
          description: |-
            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:
          $ref: '#/components/schemas/request_id'
    404NotFoundError:
      type: object
      title: No encontrado
      properties:
        code:
          type: string
          description: >-
            Un código de error único (`not_found`) que te permite clasificar y
            manejar el error de manera programática.
          example: not_found
        message:
          type: string
          description: |-
            Una breve descripción del error.

            Para errores `not_found`, la descripción es:

              - `Not found`
          example: Not found
        request_id:
          $ref: '#/components/schemas/request_id'
    RequestTimeoutError:
      type: object
      title: Tiempo de espera de la solicitud agotado
      description: >-
        Belvo tiene un límite en cuanto al tiempo que toma iniciar sesión,
        recuperar datos de la cuenta y cerrar sesión. Se produce un tiempo de
        espera cuando hay una cantidad muy alta de datos y no se puede obtener
        todo dentro del tiempo asignado.
      properties:
        code:
          type: string
          description: >-
            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 <a
            href="https://developers.belvo.com/docs/belvo-api-errors#408-request_timeout"
            target="_blank">errores 408 request_timeout</a>.
          example: request_timeout
        message:
          type: string
          description: |-
            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:
          $ref: '#/components/schemas/request_id'
    UnexpectedError:
      type: object
      title: Error inesperado
      description: >-
        Este error ocurre cuando nosotros (Belvo) hemos encontrado un error
        interno del sistema (lo sentimos) o debido a una respuesta no compatible
        de la institución.
      properties:
        code:
          type: string
          description: >-
            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 <a
            href="https://developers.belvo.com/docs/belvo-api-errors#500-unexpected_error"
            target="_blank">errores 500 unexpected_error</a>.
          example: unexpected_error
        message:
          type: string
          description: >-
            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:
          $ref: '#/components/schemas/request_id'
    id:
      type: string
      format: uuid
      description: Identificador único de Belvo para el elemento actual.
      example: 0d3ffb69-f83b-456e-ad8e-208d0998d71d
    EnumLinkAccessModeResponse:
      type: string
      nullable: true
      enum:
        - single
        - recurrent
        - null
      description: >-
        El tipo de enlace.

        Para más información, consulta nuestro artículo de <a
        href="https://developers.belvo.com/docs/links-and-institutions#links"
        target="_blank">Enlaces</a>.

        Devolvemos uno de los siguientes valores de enum:
          - `single`
          - `recurrent`
          - `null`
      example: recurrent
    last_accessed_at:
      type: string
      nullable: true
      format: date-time
      description: >-
        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'
    created_at:
      type: string
      format: date-time
      description: >-
        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'
    external_id:
      type: string
      minLength: 3
      maxLength: 256
      description: >-
        Un identificador adicional para el enlace, proporcionado por usted, para
        almacenar en la base de datos de Belvo. **No puede** incluir ninguna
        Información Personal Identificable (PII). **Debe** tener al menos tres
        caracteres de longitud.


        Si identificamos que el identificador contiene PII, forzaremos un valor
        `null`. Para más información, consulte nuestro <a
        href="https://developers.belvo.com/docs/link-creation-best-practices#adding-your-own-identifier"
        target="_blank">artículo sobre la creación de enlaces</a>.
      example: 56ab5706-6e00-48a4-91c9-ca55968678d9
    EnumLinkStatus:
      type: string
      enum:
        - valid
        - invalid
        - unconfirmed
        - token_required
      description: >-
        El estado actual del enlace. Para más información, consulta nuestro
        artículo de <a
        href="https://developers.belvo.com/docs/links-and-institutions#links"
        target="_blank">Link</a> en el devportal. Devolvemos uno de los
        siguientes valores:
          - `valid`
          - `invalid`
          - `unconfirmed`
          - `token_required`
      example: valid
    created_by:
      type: string
      format: uuid
      description: El ID único para el usuario que creó este elemento.
      example: bcef7f35-67f2-4b19-b009-cb38795faf09
    EnumLinkRefreshRate:
      type: string
      nullable: true
      default: 7d
      enum:
        - 6h
        - 12h
        - 24h
        - 7d
        - 30d
        - null
      description: >-
        La frecuencia de actualización para el enlace recurrente. Para más
        información, consulta nuestra <a
        href="https://developers.belvo.com/docs/links-and-institutions#recurrent-links"
        target="_blank">documentación sobre enlaces recurrentes</a> en nuestro
        DevPortal.

        Devolvemos uno de los siguientes valores de enum:
          - `6h`
          - `12h`
          - `24h`
          - `7d` (predeterminado)
          - `30d` (una vez al mes)
          - `null` (para enlaces únicos)
      example: 7d
    credentials_storage:
      type: string
      pattern: ^(store|nostore|\d{1,3}d)$
      description: >-
        Indica si se deben almacenar las credenciales (y la duración durante la
        cual se almacenarán las credenciales).


        - Para enlaces recurrentes, esto se establece en `store` por defecto (y
        no se puede cambiar).

        - Para enlaces únicos, esto se establece en `365d` por defecto.


        Puede ser:
          - `store` para almacenar credenciales (hasta que se elimine el enlace)
          - `nostore` para no almacenar credenciales
          - Cualquier valor entre `1d` y `365d` para indicar el número de días que deseas que se almacenen las credenciales.

        Para más información, consulta la sección <a
        href="https://developers.belvo.com/docs/data-retention-controls#credentials_storage"
        target="_blank">credentials_storage</a> de nuestro artículo sobre
        controles de retención de datos.
      example: 27d
    stale_in:
      type: string
      pattern: ^\d{1,3}d$
      description: >-
        Indica cuánto tiempo se debe almacenar cualquier dato derivado del
        usuario en la base de datos de Belvo para el enlace (tanto único como
        recurrente). Por ejemplo, si envías `90d`, Belvo eliminará cualquier
        dato relacionado con el usuario de su base de datos después de 90 días.
        Para más información, consulta la sección <a
        href="https://developers.belvo.com/docs/data-retention-controls#stale_in"
        target="_blank">stale_in</a> de nuestro artículo sobre controles de
        retención de datos.


        > 📘 Info

        >

        > Belvo solo eliminará datos para enlaces que no se hayan actualizado en
        el período que proporciones en `stale_in`. Belvo solo eliminará datos
        para enlaces que no se hayan actualizado en el período que proporciones
        en `stale_in`.


        Por defecto, Belvo almacena los datos del usuario durante 365 días, a
        menos que el enlace sea eliminado.
      example: 42d
    Link:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/id'
        institution:
          type: string
          description: Nombre de la institución de Belvo.
          example: erebor_mx_retail
        access_mode:
          $ref: '#/components/schemas/EnumLinkAccessModeResponse'
        last_accessed_at:
          $ref: '#/components/schemas/last_accessed_at'
        created_at:
          $ref: '#/components/schemas/created_at'
        external_id:
          $ref: '#/components/schemas/external_id'
        institution_user_id:
          type: string
          pattern: '[A-Za-z0-9\-=_]{44}'
          description: >-
            > 📘 Información

            >

            > Solo aplicable para enlaces creados **después del 08-02-2022**.


            Una cadena única de 44 caracteres que se puede usar para identificar
            a un usuario en una institución determinada.


            📚 Consulta nuestro artículo del DevPortal <a
            href="https://developers.belvo.com/docs/link-creation-best-practices#avoiding-duplicated-links"
            target="_blank">Evitar enlaces duplicados</a> para obtener más
            información y consejos sobre cómo usarlo.
          example: sooE7XJWEKypZJR603ecaWYk-8Ap0oD8Nr1pBQ4eG9c=
        status:
          $ref: '#/components/schemas/EnumLinkStatus'
        created_by:
          $ref: '#/components/schemas/created_by'
        refresh_rate:
          $ref: '#/components/schemas/EnumLinkRefreshRate'
        credentials_storage:
          $ref: '#/components/schemas/credentials_storage'
        fetch_resources:
          type: array
          description: >-
            Un conjunto de recursos para los que recibirás una actualización
            histórica.
          items:
            type: string
            description: Un recurso de Belvo que la institución admite.
            example: ACCOUNTS
          example:
            - ACCOUNTS
            - TRANSACTIONS
        stale_in:
          $ref: '#/components/schemas/stale_in'
    EnumLinkAccessModeRequest:
      type: string
      enum:
        - single
        - recurrent
      description: >-
        El tipo de enlace a crear.


        - Usa `single` para realizar solicitudes POST ad hoc de una sola vez
        para cuentas, propietarios y transacciones.

        - Usa `recurrent` para que Belvo acceda a la información de manera
        recurrente, de modo que siempre tengas datos actualizados de cuentas,
        propietarios, saldos y transacciones.


        Para más información, consulta nuestro artículo de <a
        href="https://developers.belvo.com/docs/links-and-institutions#links"
        target="_blank">Enlaces</a>.
      default: recurrent
    LinksRequestEmploymentBrazil:
      type: object
      title: Enlaces de Empleo (Brasil)
      description: >-
        El cuerpo de la solicitud para crear un enlace para instituciones de
        empleo en Brasil.
      required:
        - institution
        - username
        - password
      properties:
        institution:
          type: string
          pattern: '[a-z]+_[a-z]{2}_[a-z]+'
          description: >-
            El nombre de Belvo para la institución. Para instituciones de empleo
            en Brasil, puedes seleccionar las siguientes instituciones:


            - `inss_br_employment`
          example: inss_br_employment
        username:
          type: string
          pattern: ^^(\d{11}$)|(\d{3}\.){2}\d{3}(-\d{2})$
          description: >-
            El CPF (ID) del usuario utilizado para iniciar sesión en la
            institución. Puedes proporcionarlo ya sea como 11 caracteres o con
            el formato `XXX.XXX.XXX-XX`.
          example: 231.002.999-00
        password:
          type: string
          format: password
          pattern: ^.{8,70}$
          description: >-
            La contraseña del usuario utilizada para iniciar sesión en la
            institución.
          example: 1234B789C234AGH
        external_id:
          $ref: '#/components/schemas/external_id'
        access_mode:
          $ref: '#/components/schemas/EnumLinkAccessModeRequest'
        fetch_resources:
          type: array
          description: >-
            Una matriz de recursos para los que le gustaría recibir una
            actualización histórica.


            Para las instituciones de empleo, puede seleccionar los siguientes
            recursos:
              - `OWNERS`
              - `EMPLOYMENTS`
          items:
            type: string
            description: Un recurso de Belvo que la institución admite.
            example: EMPLOYMENTS
          example:
            - OWNERS
            - EMPLOYMENTS
        credentials_storage:
          $ref: '#/components/schemas/credentials_storage'
        stale_in:
          $ref: '#/components/schemas/stale_in'
    LinksRequestEmploymentMexico:
      type: object
      title: Enlaces de Empleo (México)
      description: >-
        El cuerpo de la solicitud para crear un enlace para instituciones de
        empleo en México.
      required:
        - institution
        - username
      properties:
        institution:
          type: string
          pattern: '[a-z]+_[a-z]{2}_[a-z]+'
          description: >-
            El nombre de Belvo para la institución. Para instituciones de empleo
            en México, puedes seleccionar las siguientes instituciones:


            - `imss_mx_employment`

            - `issste_mx_employment`

            - `planet_mx_employment` (institución Sandbox)
          example: imss_mx_employment
        username:
          type: string
          pattern: ^([A-Z]{4})([0-9]{6})([A-Z]{6})([A-Z0-9]{2})$
          description: >-
            La CURP (ID) del usuario utilizada para iniciar sesión en la
            institución.
          example: BLPM951331IONVGR54
        username2:
          type: string
          description: >-
            La dirección de correo electrónico del usuario utilizada para
            iniciar sesión en la institución. Nota requerida para
            `issste_mx_employment`.
          example: carlos@bex.com
        external_id:
          $ref: '#/components/schemas/external_id'
        access_mode:
          $ref: '#/components/schemas/EnumLinkAccessModeRequest'
        fetch_resources:
          type: array
          description: >-
            Una matriz de recursos para los que le gustaría recibir una
            actualización histórica.


            Para instituciones de empleo, puede seleccionar los siguientes
            recursos:
              - `EMPLOYMENT_RECORDS`
              - `EMPLOYMENT_METRICS` (Solo para el IMSS de México)
          items:
            type: string
            description: Un recurso de Belvo que la institución admite.
            example: EMPLOYMENT_RECORDS
          example:
            - EMPLOYMENT_RECORDS
            - EMPLOYMENT_METRICS
        credentials_storage:
          $ref: '#/components/schemas/credentials_storage'
        stale_in:
          $ref: '#/components/schemas/stale_in'
    LinksRequestFiscalMexico:
      type: object
      title: Enlaces Fiscales (México)
      description: >-
        El cuerpo de la solicitud para crear un enlace para instituciones
        fiscales en México.
      required:
        - institution
        - username
        - password
      properties:
        institution:
          type: string
          pattern: '[a-z]+_[a-z]{2}_[a-z]+'
          description: >-
            El nombre de Belvo para la institución. Para instituciones fiscales
            en México, puedes seleccionar las siguientes instituciones:


            - `sat_mx_fiscal`

            - `tatooine_mx_fiscal` (Institución Sandbox)
          example: sat_mx_fiscal
        username:
          type: string
          pattern: ^.{12,13}$
          description: >-
            El RFC (ID fiscal) del usuario utilizado para iniciar sesión en la
            institución.
          example: 123456789101
        password:
          type: string
          format: password
          pattern: ^[a-zA-Z0-9]{8}
          description: >-
            La contraseña del usuario utilizada para iniciar sesión en la
            institución.
          example: passw0rd
        external_id:
          $ref: '#/components/schemas/external_id'
        access_mode:
          $ref: '#/components/schemas/EnumLinkAccessModeRequest'
        fetch_resources:
          type: array
          description: >-
            Una matriz de recursos para los que le gustaría recibir una
            actualización histórica.


            Para las instituciones fiscales, puede seleccionar los siguientes
            recursos:
              - `FINANCIAL_STATEMENTS`
              - `INVOICES`
              - `TAX_COMPLIANCE_STATUS`
              - `TAX_RETENTIONS`
              - `TAX_RETURNS`
              - `TAX_STATUS`
          items:
            type: string
            description: Un recurso de Belvo que la institución admite.
            example: FINANCIAL_STATEMENTS
          example:
            - FINANCIAL_STATEMENTS
            - INVOICES
            - TAX_COMPLIANCE_STATUS
            - TAX_RETENTIONS
            - TAX_RETURNS
            - TAX_STATUS
        credentials_storage:
          $ref: '#/components/schemas/credentials_storage'
        stale_in:
          $ref: '#/components/schemas/stale_in'
    TooManySessionsError:
      type: object
      title: Demasiadas sesiones
      description: |-
        Este error ocurre cuando:

          - un usuario está intentando iniciar sesión en su institución a través de Belvo mientras ya está conectado a su institución en un navegador web o aplicación móvil.
          - realizas una solicitud de información mientras Belvo está extrayendo datos de la institución para ese usuario.
      properties:
        code:
          type: string
          description: >-
            Un código de error único (`too_many_sessions`) 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 los <a
            href="https://developers.belvo.com/docs/belvo-api-errors#400-too_many_sessions"
            target="_blank">errores 400 too_many_sessions</a>.
          example: too_many_sessions
        message:
          type: string
          description: |-
            Una breve descripción del error.

            Para los errores `too_many_sessions`, la descripción es:

              - `Imposible iniciar sesión, ya hay una sesión abierta con la institución para estas credenciales`.
          example: >-
            Impossible to login, a session is already opened with the
            institution for these credentials
        request_id:
          $ref: '#/components/schemas/request_id'
    LoginError:
      type: object
      title: Error de inicio de sesión
      description: |-
        Este error puede ocurrir cuando:

          - las credenciales que proporciona su usuario son incorrectas o están ausentes.
          - el token MFA que proporciona su usuario no es compatible con Belvo.
          - hay un problema con la institución que impide los inicios de sesión.
          - la cuenta del usuario está bloqueada o el usuario no tiene permiso para acceder a su banca por internet.
      properties:
        code:
          type: string
          description: >-
            Un código de error único (`login_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 <a
            href="https://developers.belvo.com/docs/belvo-api-errors#400-login_error"
            target="_blank">errores 400 login_error</a>.
          example: login_error
        message:
          type: string
          description: >-
            Una breve descripción del error.


            Para errores de `login_error`, la descripción puede ser una de las
            siguientes:

              - `Invalid credentials provided to login to the institution`
              - `A MFA token is required by the institution, but it's not supported yet by Belvo.`
              - `Impossible to login, something unexpected happened while logging into the institution. Try again later.`
              - `Login not attempted due to invalid credentials`
              - `Missing credentials to login to the institution`
              - `The user account access was forbidden by the institution`
              - `The user account is locked, user needs to contact the institution to unlock it`
          example: Invalid credentials provided to login to the institution
        request_id:
          $ref: '#/components/schemas/request_id'
    SessionExpiredError:
      type: object
      title: Sesión Expirada
      description: >-
        Este error ocurre cuando intentas reanudar una sesión de solicitud que
        ya ha expirado. Esto suele suceder porque el usuario tardó demasiado en
        proporcionar su token de autenticación.
      properties:
        code:
          type: string
          description: >-
            Un código de error único (`session_expired`) 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 <a
            href="https://developers.belvo.com/docs/belvo-api-errors#400-session_expired"
            target="_blank">errores 400 session_expired</a>.
          example: session_expired
        message:
          type: string
          description: |-
            Una breve descripción del error.

            Para los errores `session_expired`, la descripción es:

              - `The session you are trying to resume has expired, please start again from register/retrieve endpoint`.
          example: >-
            The session you are trying to resume has expired, please start again
            from register/retrieve endpoint
        request_id:
          $ref: '#/components/schemas/request_id'
    ValidationError:
      type: object
      title: Error de validación
      description: >-
        Este error ocurre cuando se realiza una solicitud que no incluye todos
        los campos requeridos o incluye datos no válidos.
      properties:
        code:
          type: string
          description: >-
            Un código de error único (`null`, `does_not_exist`, `required`) 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:
              - <a href="https://developers.belvo.com/docs/belvo-api-errors#400-blank" target="_blank">Errores 400 blank</a>
              - <a href="https://developers.belvo.com/docs/belvo-api-errors#400-null" target="_blank">Errores 400 null</a>
              - <a href="https://developers.belvo.com/docs/belvo-api-errors#400-does_not_exist" target="_blank">Errores 400 does_not_exist</a>
              - <a href="https://developers.belvo.com/docs/belvo-api-errors#400-required" target="_blank">Errores 400 required</a>
          example: required
        message:
          type: string
          description: |-
            Una breve descripción del error.

            Para errores de validación, la descripción puede ser (entre otros):

              - `Este campo es obligatorio.`
              - `El objeto con name=narnia no existe.`
              - `Este campo no puede ser nulo.`
              - `Este campo no puede estar en blanco.`
          example: This field is required.
        request_id:
          $ref: '#/components/schemas/request_id'
        field:
          type: string
          nullable: true
          description: Nombre del campo donde se encontró el error.
          example: link
    InstitutionDownError:
      type: object
      title: Institución caída
      description: >-
        Este error ocurre cuando el sitio web de la institución al que estás
        intentando acceder está inactivo debido a mantenimiento u otros
        problemas, lo que significa que Belvo no puede crear nuevos enlaces o
        recuperar nuevos datos.
      properties:
        code:
          type: string
          description: >-
            Un código de error único (`institution_down`) 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 <a
            href="https://developers.belvo.com/docs/belvo-api-errors#400-institution_down"
            target="_blank">errores 400 institution_down</a>.
          example: institution_down
        message:
          type: string
          description: |-
            Una breve descripción del error.

            Para los errores `institution_down`, la descripción es:

              - `The financial institution is down, try again later`.
          example: The financial institution is down, try again later
        request_id:
          $ref: '#/components/schemas/request_id'
    InstitutionUnavailableError:
      type: object
      title: Institución no disponible
      description: >-
        Este error ocurre cuando el sitio web de la institución al que estás
        intentando acceder está inactivo debido a mantenimiento u otros
        problemas, lo que significa que Belvo no puede crear nuevos enlaces o
        recuperar nuevos datos.
      properties:
        code:
          type: string
          description: >-
            Un código de error único (`institution_unavailable`) 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 <a
            href="https://developers.belvo.com/docs/belvo-api-errors#400-institution_unavailable"
            target="_blank">errores 400 institution_unavailable</a>.
          example: institution_unavailable
        message:
          type: string
          description: |-
            Una breve descripción del error.

            Para los errores `institution_unavailable`, la descripción es:

              - `The financial institution is unavailable`.
          example: The financial institution is unavailable
        request_id:
          $ref: '#/components/schemas/request_id'
    InstitutionInactiveError:
      type: object
      title: Institución Inactiva
      description: >-
        Este error ocurre cuando nosotros (Belvo) hemos desactivado la
        institución en nuestra API.
      properties:
        code:
          type: string
          description: >-
            Un código de error único (`institution_inactive`) 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 <a
            href="https://developers.belvo.com/docs/belvo-api-errors#400-institution_inactive"
            target="_blank">errores 400 institution_inactive</a>.
          example: institution_inactive
        message:
          type: string
          description: |-
            Una breve descripción del error.

            Para los errores `institution_inactive`, la descripción es:

              - `The institution has been temporarily deactivated`.
          example: The institution has been temporarily deactivated
        request_id:
          $ref: '#/components/schemas/request_id'
    InvalidLinkError:
      type: object
      title: Enlace no válido
      description: >-
        Este error ocurre cuando intentas acceder a una cuenta pero las
        credenciales de usuario ya no son válidas, lo que provoca un error por
        parte de la institución.
      properties:
        code:
          type: string
          description: >-
            Un código de error único (`invalid_link`) 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 <a
            href="https://developers.belvo.com/docs/belvo-api-errors#400-invalid_link"
            target="_blank">errores 400 invalid_link</a>.
          example: invalid_link
        message:
          type: string
          description: |-
            Una breve descripción del error.

            Para los errores `invalid_link`, la descripción es:

              - `The link has been invalidated. You may need to update link credentials`.
          example: >-
            The link has been invalidated. You may need to update link
            credentials
        request_id:
          $ref: '#/components/schemas/request_id'
    400InvalidCredentialsStorageError:
      type: object
      title: Almacenamiento de Credenciales Inválidas
      description: >-
        Este error ocurre cuando intentaste crear un enlace **recurrente** donde
        configuraste `credentials_storage` a `nostore` o a un rango de fechas
        entre `1d` y `365d`.
      properties:
        code:
          type: string
          description: >-
            Un código de error único (`invalid_credentials_storage`) 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 <a
            href="https://developers.belvo.com/docs/belvo-api-errors#400-invalid_credentials_storage"
            target="_blank">errores 400 invalid_credentials_storage</a>.
          example: login_error
        message:
          type: string
          description: >-
            Una breve descripción del error.


            Para los errores `invalid_credentials_storage`, la descripción puede
            ser una de las siguientes:

              - `Recurrent links must store the credentials`
          example: Recurrent links must store the credentials
        request_id:
          $ref: '#/components/schemas/request_id'
    400InvalidFetchHistorical:
      type: object
      title: Recursos de obtención no válidos
      description: >-
        Este error ocurre cuando intentaste crear un enlace donde configuraste
        `credentials_storage` a `nostore` y no enviaste ningún recurso en
        `fetch_resources`. Para enlaces donde no almacenamos credenciales, debes
        enviar un array de recursos en `fetch_resources`.
      properties:
        code:
          type: string
          description: >-
            Un código de error único (`invalid_fetch_resources`) 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 <a
            href="https://developers.belvo.com/docs/belvo-api-errors#400-invalid_fetch_resources"
            target="_blank">errores 400 invalid_fetch_resources</a>.
          example: invalid_fetch_resources
        message:
          type: string
          description: >-
            Una breve descripción del error.


            Para los errores `invalid_fetch_resources`, la descripción puede ser
            una de las siguientes:

              - `Single links without stored credentials must fetch resources`
          example: Single links without stored credentials must fetch resources
        request_id:
          $ref: '#/components/schemas/request_id'
    400InvalidResourcesError:
      type: object
      title: Recursos no válidos
      description: >-
        Este error ocurre cuando intentaste crear un enlace donde agregaste
        recursos en `fetch_resources` que no son compatibles con la institución.
      properties:
        field:
          type: string
          description: >-
            El parámetro de solicitud que está causando el error. Para recursos
            no válidos, esto se establecerá en `resources`.
          example: resources
        code:
          type: string
          description: >-
            Un código de error único (`invalid`) 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 los <a
            href="https://developers.belvo.com/docs/belvo-api-errors#400-invalid"
            target="_blank">errores 400 invalid_period</a>.
          example: invalid
        message:
          type: string
          description: >-
            Una breve descripción del error.


            Para errores `invalid` relacionados con `fetch_resources`, la
            descripción es:

              - `The institution only supports the following resources: (lista de recursos compatibles separada por comas)`.
          example: >-
            The institution only supports the following resources:
            EMPLOYMENT_RECORDS, OWNERS
        request_id:
          $ref: '#/components/schemas/request_id'
    UnconfirmedLinkError:
      type: object
      title: Enlace no confirmado
      description: >-
        Este error ocurre cuando intentas acceder a un enlace que fue pausado
        previamente (y, por lo tanto, no está activo ahora).


        El estado de un enlace se establece en `unconfirmed_link` cuando tu
        usuario no ha completado con éxito el proceso de creación del enlace
        (por ejemplo, podrían no proporcionar un token MFA válido).
      properties:
        code:
          type: string
          description: >-
            Un código de error único (`unconfirmed_link`) 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 <a
            href="https://developers.belvo.com/docs/belvo-api-errors#400-unconfirmed_link"
            target="_blank">errores 400 unconfirmed_link</a>.
          example: unconfirmed_link
        message:
          type: string
          description: |-
            Una breve descripción del error.

            Para los errores `unconfirmed_link`, la descripción es:

              - `The link creation has not been completed yet`.
          example: The link creation has not been completed yet
        request_id:
          $ref: '#/components/schemas/request_id'
    UnsupportedOperationError:
      type: object
      title: Operación no compatible
      description: >-
        Este error ocurre cuando intentas acceder a una operación de datos que
        Belvo no admite para una institución. Por ejemplo, intentar acceder al
        recurso Balances para instituciones fiscales.
      properties:
        code:
          type: string
          description: >-
            Un código de error único (`unsupported_operation`) 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 <a
            href="https://developers.belvo.com/docs/belvo-api-errors#400-unsupported_operation"
            target="_blank">errores 400 unsupported_operation</a>.
          example: unsupported_operation
        message:
          type: string
          description: |-
            Una breve descripción del error.

            Para los errores de `unsupported_operation`, la descripción es:

              - `The resource you are trying to access is not supported by this institution`.
          example: >-
            The resource you are trying to access is not supported by this
            institution
        request_id:
          type: string
          pattern: '[a-f0-9]{32}'
          description: >-
            Un ID único de 32 caracteres de la solicitud (que coincide con un
            patrón de regex: `[a-f0-9]{32}`). Proporcione este ID al contactar
            al equipo de soporte de Belvo para acelerar las investigaciones.
          example: 9e7b283c6efa449c9c028a16b5c249fb
    InvalidPeriodError:
      type: object
      title: Período no válido
      description: >-
        Este error ocurre cuando solicitas ingresos para un enlace dentro de un
        rango de fechas dado; sin embargo, el período entre `date_from` y
        `date_to` es menor de 90 días.
      properties:
        code:
          type: string
          description: >-
            Un código de error único (`invalid_period`) 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 <a
            href="https://developers.belvo.com/docs/belvo-api-errors#400-invalid_period"
            target="_blank">errores 400 invalid_period</a>.
          example: invalid_period
        message:
          type: string
          description: |-
            Una breve descripción del error.

            Para los errores `invalid_period`, la descripción es:

              - `The number of days between date_from and date_to must be at least 90 days`.
          example: >-
            The number of days between date_from and date_to must be at least 90
            days
        request_id:
          $ref: '#/components/schemas/request_id'
    TokenRequiredResponse:
      type: object
      description: Se requiere token MFA
      properties:
        code:
          type: string
          description: >-
            Un código de error único (`token_required`) 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 <a
            href="https://developers.belvo.com/docs/belvo-api-errors#428-token_required"
            target="_blank">errores 428 token_required</a>.
          example: token_required
        message:
          type: string
          description: |-
            Una breve descripción del error. 
            Para los errores `token_required`, la descripción es:

              - `A MFA token is required by the institution to login`.
          example: A MFA token is required by the institution to login
        request_id:
          $ref: '#/components/schemas/request_id'
        session:
          type: string
          pattern: '[a-f0-9]{32}'
          description: >-
            Un ID único de 32 caracteres de la sesión de inicio de sesión (que
            coincide con un patrón de regex de: `[a-f0-9]{32}`).
          example: 2675b703b9d4451f8d4861a3eee54449
        expiry:
          type: integer
          format: int32
          description: Tiempo de duración de la sesión en segundos.
          example: 9600
        link:
          type: string
          format: uuid
          description: >-
            Identificador único creado por Belvo, utilizado para referenciar el
            Link actual.
          example: 30cb4806-6e00-48a4-91c9-ca55968576c8
        token_generation_data:
          type: object
          description: Detalles sobre cómo generar el token.
          properties:
            instructions:
              type: string
              description: Instrucciones para la generación de tokens.
              example: Use this code to generate the token
            type:
              type: string
              description: >-
                Tipo de datos para generar el token (código QR, desafío
                numérico).
              example: numeric
            value:
              type: string
              description: Valor a utilizar para generar el token.
              example: '12345'
            expects_user_input:
              type: boolean
              description: >-
                Indica si el usuario necesita proporcionar información para
                completar la autenticación. Cuando se establece en `false`, 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
              default: true
    token:
      type: string
      description: >-
        El token MFA generado por la institución que se requiere para continuar
        una sesión.
      example: 1234ab
    save_data:
      type: boolean
      default: true
      description: >-
        Indica si se debe o no persistir los datos en Belvo. Por defecto, esto
        está configurado en `true` y devolvemos una respuesta 201 Created.


        Cuando se establece en `false`, los datos no se persistirán y devolvemos
        una respuesta 200 OK.
      example: true
    PatchBody:
      type: object
      description: Un objeto JSON que contiene un UUID de sesión y un token MFA.
      required:
        - session
        - link
      properties:
        session:
          type: string
          pattern: '[a-f0-9]{32}'
          description: >-
            La sesión que deseas reanudar. Necesitas usar el valor de `session`
            que se proporciona en la respuesta 428 Token Required que recibes
            después de realizar tu solicitud POST.
          example: 6e7b283c6efa449c9c028a16b5c249fa
        token:
          $ref: '#/components/schemas/token'
        link:
          type: string
          format: uuid
          description: >-
            El `link.id` que deseas reanudar. Debe ser el mismo `link.id` que
            recibes en la respuesta 428 Token Required que contiene el ID de
            `session`.
          example: 683005d6-f45c-4adb-b289-f1a12f50f80c
        save_data:
          $ref: '#/components/schemas/save_data'
    LinksPutRequest:
      type: object
      required:
        - institution
        - username
        - password
      properties:
        password:
          type: string
          description: >-
            La contraseña del usuario final utilizada para iniciar sesión en la
            institución.
          example: password
        password2:
          type: string
          description: >-
            La segunda contraseña del usuario final utilizada para iniciar
            sesión en la institución.


            > 📘 Info

            >

            > Esto solo es requerido por algunas instituciones. Para saber qué
            instituciones requieren una segunda contraseña, consulta nuestra
            solicitud de List institution y verifica el array `form_fields` en
            la respuesta.
          example: pin
        token:
          $ref: '#/components/schemas/token'
    ChangeAccessMode:
      type: object
      description: >-
        Solicitud de cuerpo para cambiar el modo de acceso, stale_in o
        fetch_resources de un enlace.
      properties:
        access_mode:
          $ref: '#/components/schemas/EnumLinkAccessModeRequest'
        stale_in:
          $ref: '#/components/schemas/stale_in'
        fetch_resources:
          type: array
          description: >-
            Una matriz de recursos para los que te gustaría recibir una
            actualización histórica.


            Para instituciones bancarias, puedes seleccionar los siguientes
            recursos:
              - `ACCOUNTS`
              - `OWNERS`
              - `TRANSACTIONS`
              - `BILLS`
              - `INVESTMENTS`
              - `INVESTMENT_TRANSACTIONS`
              - `INCOMES`
              - `RECURRING_EXPENSES`
              - `RISK_INSIGHTS`

            Para instituciones fiscales, puedes seleccionar los siguientes
            recursos:
              - `FINANCIAL_STATEMENTS`
              - `INVOICES`
              - `TAX_COMPLIANCE_STATUS`
              - `TAX_RETENTIONS`
              - `TAX_RETURNS`
              - `TAX_STATUS`

            Para instituciones de empleo, puedes seleccionar los siguientes
            recursos:
              - `EMPLOYMENT_RECORDS` (Solo para el IMSS e ISSTE de México)
              - `EMPLOYMENT_METRICS` (Solo para el IMSS de México)
              - `EMPLOYMENTS` (Solo para el INSS de Brasil)
          items:
            type: string
            description: Un recurso de Belvo que la institución admite.
            example: ACCOUNTS
          example:
            - ACCOUNTS
            - TRANSACTIONS
    EnumConsentStatus:
      type: string
      nullable: true
      enum:
        - AUTHORISED
        - AWAITING_AUTHORISATION_CONFIRMATION
        - AWAITING_AUTHORISATION
        - REJECTED
        - EXPIRED
        - null
      description: |-
        El estado del consentimiento en la red de finanzas abiertas. Puede ser:

          - `AUTHORISED`: El consentimiento sigue siendo válido para su uso hasta la fecha de `expired_at`.
          - `AWAITING_AUTHORISATION_CONFIRMATION`: El usuario debe confirmar dentro de su institución.
          - `AWAITING_AUTHORISATION`: El usuario ha sido redirigido a su institución para otorgar consentimiento.
          - `REJECTED`: El usuario no ha otorgado consentimiento dentro de su institución.
          - `EXPIRED`: El consentimiento ha expirado a partir de la fecha de `expired_at`.
          - `null`
      example: AUTHORISED
    Consents:
      type: object
      description: El esquema de consentimientos de OFDA
      title: Objeto de Consentimientos (Brasil)
      x-tags:
        - Consents
      properties:
        id:
          $ref: '#/components/schemas/id'
        display_name:
          type: string
          nullable: true
          maxLength: 128
          pattern: ^[\w\W]{0,128}$
          description: >-
            El nombre completo de la persona que inició el consentimiento, según
            lo proporcionado por la institución.
          example: Jack Oswald White
        document_number:
          type: string
          description: El número de documento (CPF) del individuo.
          example: '76109277673'
        belvo_institution_name:
          type: string
          description: >-
            Nombre de Belvo para la institución de finanzas abiertas a la que
            está relacionado el consentimiento.
          example: ofmockbank_br_retail
        expired_at:
          type: string
          format: date-time
          description: >-
            La marca de tiempo ISO-8601 cuando el consentimiento expirará. En el
            caso de que `undefined_consent_expiration` sea `true`, este campo
            será `null`.
          example: '2021-02-27T13:01:41.941Z'
        undefined_consent_expiration:
          type: boolean
          description: >-
            Indique si el consentimiento es por un período indefinido, es decir,
            que no hay vencimiento para el consentimiento.
          example: false
        created_at:
          $ref: '#/components/schemas/created_at'
        status:
          $ref: '#/components/schemas/EnumConsentStatus'
        permissions:
          type: object
          description: Detalles sobre los permisos adjuntos al consentimiento.
          properties:
            ACCOUNTS:
              type: array
              description: >-
                Una lista de permisos de banca abierta relacionados con el
                acceso a la información de la cuenta.
              items:
                type: string
                example: ACCOUNTS_OVERDRAFT_LIMITS_READ
              example:
                - ACCOUNTS_OVERDRAFT_LIMITS_READ
                - ACCOUNTS_READ
                - ACCOUNTS_TRANSACTIONS_READ
                - ACCOUNTS_BALANCES_READ
            CREDIT_CARDS:
              type: array
              description: >-
                Una lista de permisos de banca abierta relacionados con el
                acceso a la información de tarjetas de crédito.
              items:
                type: string
                example: CREDIT_CARDS_ACCOUNTS_LIMITS_READ
              example:
                - CREDIT_CARDS_ACCOUNTS_LIMITS_READ
                - CREDIT_CARDS_ACCOUNTS_BILLS_READ
                - CREDIT_CARDS_ACCOUNTS_TRANSACTIONS_READ
                - CREDIT_CARDS_ACCOUNTS_BILLS_TRANSACTIONS_READ
                - CREDIT_CARDS_ACCOUNTS_READ
            CREDIT_OPERATIONS:
              type: array
              description: >-
                Una lista de permisos de banca abierta relacionados con el
                acceso a la información de productos de crédito.
              items:
                type: string
                example: LOANS_READ
              example:
                - LOANS_READ
                - LOANS_WARRANTIES_READ
                - LOANS_SCHEDULED_INSTALMENTS_READ
                - LOANS_PAYMENTS_READ
                - FINANCINGS_READ
                - FINANCINGS_WARRANTIES_READ
                - FINANCINGS_SCHEDULED_INSTALMENTS_READ
                - FINANCINGS_PAYMENTS_READ
                - UNARRANGED_ACCOUNTS_OVERDRAFT_READ
                - UNARRANGED_ACCOUNTS_OVERDRAFT_WARRANTIES_READ
                - UNARRANGED_ACCOUNTS_OVERDRAFT_SCHEDULED_INSTALMENTS_READ
                - UNARRANGED_ACCOUNTS_OVERDRAFT_PAYMENTS_READ
                - INVOICE_FINANCINGS_READ
                - INVOICE_FINANCINGS_WARRANTIES_READ
                - INVOICE_FINANCINGS_SCHEDULED_INSTALMENTS_READ
                - INVOICE_FINANCINGS_PAYMENTS_READ
            REGISTER:
              type: array
              description: >-
                Una lista de permisos de banca abierta relacionados con el
                acceso a información personal.
              items:
                type: string
                example: CUSTOMERS_PERSONAL_IDENTIFICATIONS_READ
              example:
                - CUSTOMERS_PERSONAL_IDENTIFICATIONS_READ
                - CUSTOMERS_PERSONAL_ADITTIONALINFO_READ
            RESOURCES:
              type: array
              description: >-
                Una lista de permisos funcionales necesarios para interactuar
                con los permisos.
              items:
                type: string
                example: RESOURCES_READ
              example:
                - RESOURCES_READ
    WidgetTokenRequestOFDA:
      type: object
      title: Token de Acceso de OFDA Brasil
      required:
        - id
        - password
        - scopes
        - stale_in
        - fetch_resources
        - widget
      properties:
        id:
          type: string
          description: Tu Belvo secretId.
        password:
          type: string
          description: Tu Belvo secretPassword.
        scopes:
          type: string
          description: >-
            El parámetro scopes contiene una lista de permisos que te permiten
            crear un enlace para el usuario. Este es un parámetro obligatorio y
            debe enviarse exactamente como se muestra.
          example: >-
            read_institutions,write_links,read_consents,write_consents,write_consent_callback,delete_consents
        stale_in:
          $ref: '#/components/schemas/stale_in'
        fetch_resources:
          type: array
          description: >-
            Una matriz de recursos para los que le gustaría recibir una
            actualización histórica.


            Para las instituciones bancarias, puede seleccionar los siguientes
            recursos:
              - `ACCOUNTS`
              - `OWNERS`
              - `TRANSACTIONS`
              - `BILLS` (solo para instituciones de Brasil OFDA)
              - `INCOMES`
              - `RECURRING_EXPENSES`
              - `RISK_INSIGHTS`
          items:
            type: string
            enum:
              - ACCOUNTS
              - TRANSACTIONS
              - OWNERS
              - BILLS
          example:
            - ACCOUNTS
            - TRANSACTIONS
            - OWNERS
            - BILLS
        widget:
          type: object
          description: >-
            El objeto `widget` contiene información adicional sobre cómo
            configurar el widget, incluyendo la personalización de la marca, tus
            términos y condiciones, URLs de callback, e información sobre el
            usuario para el que deseas extraer datos.
          required:
            - purpose
            - openfinance_feature
            - callback_urls
            - branding
            - consent
          properties:
            purpose:
              type: string
              description: >-
                En el parámetro `purpose`, puedes personalizar el mensaje que se
                muestra a tu usuario sobre para qué caso de uso estás
                solicitando sus datos. Para más información, consulta la sección
                de <a
                href="https://developers.belvo.com/docs/hosted-widget-ofda#purpose"
                target="_blank">purpose</a> en nuestra guía del Hosted Widget
                (OFDA).
              example: >-
                Soluções financeiras personalizadas oferecidas por meio de
                recomendações sob medida, visando melhores ofertas de produtos
                financeiros e de crédito.
            openfinance_feature:
              type: string
              description: >-
                El parámetro `openfinance_feature` indica que el usuario final
                pasará por el flujo OFDA. Debe establecerse en
                `consent_link_creation`.
              example: consent_link_creation
            callback_urls:
              type: object
              description: >-
                En el objeto `callback_urls`, **debes** agregar enlaces a donde
                tu usuario debe ser redirigido en los siguientes casos:


                - success (tu usuario conectó sus cuentas exitosamente)

                - exit (tu usuario salió del widget antes de completar el
                proceso)

                - event (ocurrió un error durante el proceso de conexión)


                Para más información, consulta la sección de <a
                href="https://developers.belvo.com/docs/hosted-widget-ofda#callback_urls"
                target="_blank">callback_urls</a> en nuestra guía del Widget
                Alojado (OFDA).


                > 📘 Eventos de Callback

                >

                > Belvo también enviará información adicional sobre el evento
                dependiendo del mismo. Para más información, asegúrate de
                consultar la sección de <a
                href="https://developers.belvo.com/docs/hosted-widget-ofda#3-handling-callback-events"
                target="_blank">Manejo de eventos de callback</a> de la guía del
                Widget Alojado (OFDA).
              required:
                - success
                - exit
                - event
              properties:
                success:
                  type: string
                  description: >-
                    La URL a la que se redirige a su usuario cuando conecta
                    exitosamente su cuenta.
                  example: your_deeplink_here://success
                exit:
                  type: string
                  description: >-
                    La URL a la que se redirige a tu usuario cuando salen del
                    proceso antes de conectar su cuenta.
                  example: your_deeplink_here://exit
                event:
                  type: string
                  description: >-
                    La URL a la que se redirige a tu usuario cuando encuentran
                    un error al conectar su cuenta.
                  example: your_deeplink_here://error
            branding:
              type: object
              description: >-
                En el objeto `branding`, **debes** agregar tu:

                - <a
                href="https://developers.belvo.com/docs/branding-and-customization-ofda#add-a-company-icon"
                target="_blank">company_icon</a>

                - <a
                href="https://developers.belvo.com/docs/branding-and-customization-ofda#add-a-company-logo"
                target="_blank">company_logo</a>

                - <a
                href="https://developers.belvo.com/docs/branding-and-customization-ofda#add-your-company-name"
                target="_blank">company_name</a>

                - <a
                href="https://developers.belvo.com/docs/branding-and-customization-ofda#add-a-link-to-your-privacy-policy"
                target="_blank">company_terms_url</a>


                También puedes opcionalmente agregar un color de fondo
                personalizado para cuando el widget se abra, así como desactivar
                los mensajes de Belvo sobre cuántas cuentas se han conectado.


                Para más información sobre las opciones de personalización y
                branding del widget, consulta nuestra <a
                href="https://developers.belvo.com/docs/branding-and-customization-ofda"
                target="_blank">guía dedicada</a>.
              required:
                - company_icon
                - company_logo
                - company_name
                - company_terms_url
              properties:
                company_icon:
                  type: string
                  format: uri
                  description: >-
                    Puede agregar el ícono de su empresa al widget para que esté
                    más alineado con su marca. Para obtener más información,
                    consulte la sección <a
                    href="https://developers.belvo.com/docs/branding-and-customization-ofda#add-a-company-icon"
                    target="_blank">company_icon</a> de nuestra guía de Branding
                    y personalización (OFDA).
                  example: https://mysite.com/icon.svg
                company_logo:
                  type: string
                  format: uri
                  description: >-
                    Puede agregar el logotipo de su empresa al widget para que
                    esté más alineado con su marca. Para obtener más
                    información, consulte la sección <a
                    href="https://developers.belvo.com/docs/branding-and-customization-ofda#add-a-company-logo"
                    target="_blank">company_icon</a> de nuestra guía de Branding
                    y personalización (OFDA).
                  example: https://mysite.com/logo.svg
                company_name:
                  type: string
                  description: >-
                    Puede agregar el nombre de su empresa para que se muestre
                    cuando el widget se inicie por primera vez. De forma
                    predeterminada, solo mostrará "Link your account". Cuando
                    agregue el nombre de su empresa, el mensaje seguirá el
                    formato "[company_name] uses Belvo to connect your account".
                    Para obtener más información, consulte la sección <a
                    href="https://developers.belvo.com/docs/branding-and-customization-ofda#add-your-company-name"
                    target="_blank">company_name</a> de nuestra guía de Branding
                    y personalización (OFDA).
                  example: ACME
                company_terms_url:
                  type: string
                  format: uri
                  description: >-
                    Puede agregar un enlace a su política de privacidad (o
                    términos y condiciones) en la pantalla inicial del widget
                    que, al hacer clic, redirigirá a sus usuarios a la página
                    web vinculada. Esto ayuda a sus usuarios a comprender mejor
                    cuál es su caso de uso con respecto a los datos que está
                    solicitando. Para obtener más información, consulte la
                    sección <a
                    href="https://developers.belvo.com/docs/branding-and-customization-ofda#add-a-link-to-your-privacy-policy"
                    target="_blank">company_terms_url</a> de nuestra guía de
                    Branding y personalización (OFDA).
                  example: https://belvo.com/terms-service/
                overlay_background_color:
                  type: string
                  description: >-
                    Puede agregar un color de superposición personalizado para
                    cuando el widget se carga en su aplicación de escritorio.
                    Para obtener más información, consulte la sección <a
                    href="https://developers.belvo.com/docs/branding-and-customization-ofda#add-a-custom-overlay-color"
                    target="_blank">overlay_background_color</a> de nuestra guía
                    de Branding y personalización (OFDA).
                  example: '#F0F2F4'
                social_proof:
                  type: boolean
                  description: >-
                    Puede optar por ocultar el mensaje "Mais de 5 milhões de
                    usuários já conectaram com segurança suas contas." que
                    aparece cuando su usuario selecciona su institución en el
                    widget. Para obtener más información, consulte la sección <a
                    href="https://developers.belvo.com/docs/branding-and-customization-ofda#hide-messaging-in-the-institution-select-screen"
                    target="_blank">social_proof</a> de nuestra guía de Branding
                    y personalización (OFDA).
                  example: true
            theme:
              type: array
              description: >-
                Puede agregar opcionalmente los colores de su marca al widget
                utilizando el parámetro `theme`.


                Para obtener más información sobre dónde aparecerán estos
                colores en el widget, consulte la sección dedicada <a
                href="https://developers.belvo.com/docs/branding-and-customization-ofda#add-custom-colors-to-the-widget"
                target="_blank">Agregar colores personalizados al widget</a> de
                nuestra guía de Branding.
              items:
                type: object
                required:
                  - css_key
                  - value
                properties:
                  css_key:
                    type: string
                    description: |-
                      Nombre de variable CSS. Los valores posibles incluyen:
                      - `--color-primary-base`
                      - `--nav-bar-title-color`
                      - `--nav-bar-icon-color`
                    example: '--color-primary-base'
                  value:
                    type: string
                    description: El código HEX para el `css_key`.
                    example: '#907AD6'
            consent:
              type: object
              description: >-
                El objeto `consent` es exclusivo del widget OFDA y debe ser
                enviado.
              required:
                - terms_and_conditions_url
                - permissions
                - identification_info
              properties:
                terms_and_conditions_url:
                  type: string
                  format: uri
                  description: >-
                    En el parámetro `terms_and_conditions_url`, **debe**
                    proporcionar un enlace a los términos y condiciones de su
                    empresa.
                  example: https://www.your_terms_and_conditions.com
                permissions:
                  type: array
                  minItems: 4
                  maxItems: 4
                  uniqueItems: true
                  description: >-
                    El parámetro `permissions` contiene los recursos que deseas
                    extraer de la Red de Finanzas Abiertas de Brasil para el
                    usuario. Este valor **debe** establecerse en `["REGISTER",
                    "ACCOUNTS", "CREDIT_CARDS", "CREDIT_OPERATIONS"]`.
                  items:
                    type: string
                    enum:
                      - REGISTER
                      - ACCOUNTS
                      - CREDIT_CARDS
                      - CREDIT_OPERATIONS
                  example:
                    - REGISTER
                    - ACCOUNTS
                    - CREDIT_CARDS
                    - CREDIT_OPERATIONS
                identification_info:
                  type: array
                  minItems: 1
                  maxItems: 2
                  description: >-
                    En el array `identification_info`, necesitas proporcionar la
                    información de identificación del usuario para el cual
                    deseas recuperar información. La información que
                    proporciones aquí debe coincidir con la información que la
                    institución regulada tiene para el usuario (por ejemplo,
                    para empresas, el CPF y el nombre deben ser de un usuario
                    con acceso a la cuenta empresarial).


                    - Para individuos, solo necesitas proporcionar el CPF y el
                    nombre.

                    - Para empresas, necesitas proporcionar tanto la información
                    del CPF como del CNPJ.


                    Para más información, consulta la sección <a
                    href="https://developers.belvo.com/docs/hosted-widget-ofda#identification_info"
                    target="_blank">identification_info</a> de nuestra guía del
                    Hosted Widget (OFDA).
                  items:
                    type: object
                    required:
                      - type
                      - number
                      - name
                    properties:
                      type:
                        type: string
                        description: El tipo de identificador. Puede ser `CPF` o `CNPJ`.
                        example: CPF
                      number:
                        type: string
                        description: >-
                          El número de CPF o CNPJ de la persona o empresa
                          asociada con la identificación.
                        example: 76109277673
                      name:
                        type: string
                        description: >-
                          Nombre de la persona o empresa asociada con la
                          identificación.
                        example: Ralph Bragg
    WidgetTokenRequestBankingAggregation:
      type: object
      title: Token de Acceso de Agregación (Empleo y Fiscal)
      required:
        - id
        - password
        - scopes
        - stale_in
        - fetch_resources
        - widget
      properties:
        id:
          type: string
          description: Tu Belvo secretId.
        password:
          type: string
          description: Tu Belvo secretPassword.
        scopes:
          type: string
          description: >-
            El parámetro scopes contiene una lista de permisos que te permiten
            crear un enlace para el usuario. Este es un parámetro obligatorio y
            debe enviarse exactamente como se muestra.
          example: >-
            read_institutions,write_links,read_consents,write_consents,write_consent_callback,delete_consents
        stale_in:
          $ref: '#/components/schemas/stale_in'
        credentials_storage:
          $ref: '#/components/schemas/credentials_storage'
        fetch_resources:
          type: array
          description: >-
            Una matriz de recursos para los que te gustaría recibir una
            actualización histórica.


            Para instituciones bancarias, puedes seleccionar los siguientes
            recursos:
              - `ACCOUNTS`
              - `BALANCES`
              - `BILLS`
              - `OWNERS`
              - `INVESTMENTS`
              - `INVESTMENT_TRANSACTIONS`
              - `TRANSACTIONS`
              - `INCOMES`
              - `RECURRING_EXPENSES`
              - `RISK_INSIGHTS`

            Para instituciones fiscales, puedes seleccionar los siguientes
            recursos:
              - `FINANCIAL_STATEMENTS`
              - `INVOICES`
              - `TAX_COMPLIANCE_STATUS`
              - `TAX_RETENTIONS`
              - `TAX_RETURNS`
              - `TAX_STATUS`

            Para instituciones de empleo, puedes seleccionar los siguientes
            recursos:
              - `OWNERS`
              - `EMPLOYMENT_RECORDS` (Solo para el IMSS de México)
              - `EMPLOYMENT_METRICS` (Solo para el IMSS de México)
              - `EMPLOYMENTS` (Solo para el INSS de Brasil)
          items:
            type: string
            enum:
              - ACCOUNTS
              - TRANSACTIONS
              - OWNERS
              - BILLS
          example:
            - ACCOUNTS
            - TRANSACTIONS
            - OWNERS
            - BILLS
        widget:
          type: object
          description: >-
            El objeto `widget` contiene información adicional sobre cómo
            configurar el widget, incluyendo la personalización de la marca, tus
            términos y condiciones, URLs de callback, e información sobre el
            usuario para el que deseas extraer datos.
          required:
            - branding
            - consent
          properties:
            callback_urls:
              type: object
              description: >-
                > 📘 Solo es necesario para el Widget Alojado.


                En el objeto `callback_urls`, **debes** agregar enlaces a donde
                tu usuario debe ser redirigido en los siguientes casos:


                - success (tu usuario conectó sus cuentas exitosamente)

                - exit (tu usuario salió del widget antes de completar el
                proceso)

                - event (ocurrió un error durante el proceso de conexión)


                Para más información, consulta la sección de <a
                href="https://developers.belvo.com/docs/widget-for-webviews#3-handling-callback-events"
                target="_blank">callback_urls</a> en nuestra guía del Widget
                Alojado (Multi-Region).


                > 📘 Eventos de Callback

                >

                > Belvo también enviará información adicional del evento
                dependiendo del evento. Para más información, asegúrate de
                consultar la sección de <a
                href="https://developers.belvo.com/docs/widget-for-webviews#3-handling-callback-events"
                target="_blank">Manejo de eventos de callback</a> de la guía del
                Widget Alojado (Multi-Region).
              required:
                - success
                - exit
                - event
              properties:
                success:
                  type: string
                  description: >-
                    La URL a la que se redirige a su usuario cuando conecta
                    exitosamente su cuenta.
                  example: your_deeplink_here://success
                exit:
                  type: string
                  description: >-
                    La URL a la que se redirige a tu usuario cuando salen del
                    proceso antes de conectar su cuenta.
                  example: your_deeplink_here://exit
                event:
                  type: string
                  description: >-
                    La URL a la que se redirige a tu usuario cuando encuentran
                    un error al conectar su cuenta.
                  example: your_deeplink_here://error
            branding:
              type: object
              description: >-
                En el objeto `branding`, **debes** agregar tu:

                - <a
                href="https://developers.belvo.com/docs/widget-branding-and-customization#add-a-company-icon"
                target="_blank">company_icon</a>

                - <a
                href="https://developers.belvo.com/docs/widget-branding-and-customization#add-a-company-logo"
                target="_blank">company_logo</a>

                - <a
                href="https://developers.belvo.com/docs/widget-branding-and-customization#add-your-company-name"
                target="_blank">company_name</a>

                - <a
                href="https://developers.belvo.com/docs/widget-branding-and-customization#add-a-link-to-your-privacy-policy"
                target="_blank">company_terms_url</a>


                También puedes opcionalmente agregar un color de fondo
                personalizado para cuando el widget se abra, así como desactivar
                el mensaje de Belvo sobre cuántas cuentas se han conectado.


                Para más información sobre las opciones de personalización y
                branding del widget, consulta nuestra <a
                href="https://developers.belvo.com/docs/widget-branding-and-customization"
                target="_blank">guía dedicada</a>.
              required:
                - company_icon
                - company_logo
                - company_name
                - company_terms_url
              properties:
                company_icon:
                  type: string
                  format: uri
                  description: >-
                    Puede agregar el ícono de su empresa al widget para que esté
                    más alineado con su marca. Para obtener más información,
                    consulte la sección <a
                    href="https://developers.belvo.com/docs/widget-branding-and-customization#add-a-company-icon"
                    target="_blank">company_icon</a> de nuestra guía de Branding
                    y personalización (Multi-Region).
                  example: https://mysite.com/icon.svg
                company_logo:
                  type: string
                  format: uri
                  description: >-
                    Puede agregar el logotipo de su empresa al widget para que
                    esté más alineado con su marca. Para obtener más
                    información, consulte la sección <a
                    href="https://developers.belvo.com/docs/widget-branding-and-customization#add-a-company-logo"
                    target="_blank">company_icon</a> de nuestra guía de Branding
                    y personalización (Multi-Region).
                  example: https://mysite.com/logo.svg
                company_name:
                  type: string
                  description: >-
                    Puede agregar el nombre de su empresa para que se muestre
                    cuando el widget se inicie por primera vez. De forma
                    predeterminada, solo mostrará "Link your account". Cuando
                    agregue el nombre de su empresa, el mensaje seguirá el
                    formato "[company_name] uses Belvo to connect your account".
                    Para obtener más información, consulte la sección <a
                    href="https://developers.belvo.com/docs/widget-branding-and-customization#add-your-company-name"
                    target="_blank">company_name</a> de nuestra guía de Branding
                    y personalización (Multi-Region).
                  example: ACME
                company_terms_url:
                  type: string
                  format: uri
                  description: >-
                    Puede agregar un enlace a su política de privacidad (o
                    términos y condiciones) en la pantalla inicial del widget
                    que, al hacer clic, redirigirá a sus usuarios a la página
                    web vinculada. Esto ayuda a sus usuarios a comprender mejor
                    cuál es su caso de uso con respecto a los datos que está
                    solicitando. Para obtener más información, consulte la
                    sección <a
                    href="https://developers.belvo.com/docs/widget-branding-and-customization#add-a-link-to-your-privacy-policy"
                    target="_blank">company_terms_url</a> de nuestra guía de
                    Branding y personalización (Multi-Region).
                  example: https://belvo.com/terms-service/
                overlay_background_color:
                  type: string
                  description: >-
                    Puede agregar un color de superposición personalizado para
                    cuando el widget se carga en su aplicación de escritorio.
                    Para obtener más información, consulte la sección <a
                    href="https://developers.belvo.com/docs/widget-branding-and-customization#add-a-custom-overlay-color"
                    target="_blank">overlay_background_color</a> de nuestra guía
                    de Branding y personalización (Multi-Region).
                  example: '#F0F2F4'
                social_proof:
                  type: boolean
                  description: >-
                    Puede optar por ocultar el mensaje "Mais de 5 milhões de
                    usuários já conectaram com segurança suas contas." que
                    aparece cuando su usuario selecciona su institución en el
                    widget. Para obtener más información, consulte la sección <a
                    href="https://developers.belvo.com/docs/widget-branding-and-customization#hide-messaging-in-the-account-connect-screen"
                    target="_blank">social_proof</a> de nuestra guía de Branding
                    y personalización (Multi-Region).
                  example: true
            theme:
              type: array
              description: >-
                Puede agregar opcionalmente los colores de su marca al widget
                utilizando el parámetro `theme`.


                Para obtener más información sobre dónde aparecerán estos
                colores en el widget, consulte la sección dedicada <a
                href="https://developers.belvo.com/docs/widget-branding-and-customization#add-custom-colors-to-the-widget"
                target="_blank">Agregar colores personalizados al widget</a> de
                nuestra guía de Branding.
              items:
                type: object
                required:
                  - css_key
                  - value
                properties:
                  css_key:
                    type: string
                    description: |-
                      Nombre de variable CSS. Los valores posibles incluyen:
                      - `--color-primary-base`
                      - `--nav-bar-title-color`
                      - `--nav-bar-icon-color`
                    example: '--color-primary-base'
                  value:
                    type: string
                    description: El código HEX para el `css_key`.
                    example: '#907AD6'
    WidgetToken:
      type: object
      properties:
        access:
          type: string
          description: El token de acceso que se utilizará para autenticar el widget.
          example: >-
            eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNzI3MzYwMTk1LCJpYXQiOjE3MjczNTg5OTUsImp0aSI6ImRhN2Q3OTM1ZDZlZTQ0MTBhYTMwYTc3NWQ1OWMxZWIzIiwidXNlcl9pZCI6IjZlOWJlODg0LTQ3ODEtNDE0My1iNjczLWFjYTAyNDc1ZWU4YyIsIm9yZ2FuaXphdGlvbl9uYW1lIjoiRG9taW5payBDaG9sZXdza2kncyB0ZWFtIiwib3JnYW5pemF0aW9uX2lkIjoiNmU5YmU4ODQtNDc4MS00MTQzLWI2NzMtYWNhMDI0NzVlZThjIiwic2NvcGVzIjpbInJlYWRfaW5zdGl0dXRpb25zIiwid3JpdGVfbGlua3MiXSwiZW52aXJvbm1lbnQiOiJzYW5kYm94IiwiYXBpX3VybCI6InNhbmRib3guYmVsdm8uY29tIiwiY3JlZGVudGlhbHNfc3RvcmFnZSI6IjMwZCIsInN0YWxlX2luIjoiMzY1ZCIsImZldGNoX3Jlc291cmNlcyI6WyJPV05FUlMiLCJFTVBMT1lNRU5UUyJdLCJpc3MiOiJzYW5kYm94LmJlbHZvLmNvbSJ9.DaQ8xVTEjA4BD-0SbBCQDylO3NrjhsHiWXTaoPdKWRucS2E0jxNUHC5lwrejrz73-GytgcXTeiI1fhZBYW719A
        refresh:
          type: string
          description: >-
            El token de actualización que se utilizará para autenticar el
            widget.
          example: >-
            eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoicmVmcmVzaCIsImV4cCI6MjM0OTQzODk5NSwiaWF0IjoxNzI3MzU4OTk1LCJqdGkiOiI2YmUyMGFmNTcxZDU0NjQzYjA0Y2U3YTVhNjI5ZDRiMSIsInVzZXJfaWQiOiI2ZTliZTg4NC00NzgxLTQxNDMtYjY3My1hY2EwMjQ3NWVlOGMiLCJvcmdhbml6YXRpb25fbmFtZSI6IkRvbWluaWsgQ2hvbGV3c2tpJ3MgdGVhbSIsIm9yZ2FuaXphdGlvbl9pZCI6IjZlOWJlODg0LTQ3ODEtNDE0My1iNjczLWFjYTAyNDc1ZWU4YyIsInNjb3BlcyI6WyJyZWFkX2luc3RpdHV0aW9ucyIsIndyaXRlX2xpbmtzIl0sImVudmlyb25tZW50Ijoic2FuZGJveCIsImFwaV91cmwiOiJzYW5kYm94LmJlbHZvLmNvbSIsImNyZWRlbnRpYWxzX3N0b3JhZ2UiOiIzMGQiLCJzdGFsZV9pbiI6IjM2NWQiLCJmZXRjaF9yZXNvdXJjZXMiOlsiT1dORVJTIiwiRU1QTE9ZTUVOVFMiXSwiaXNzIjoic2FuZGJveC5iZWx2by5jb20ifQ.T-tnX2BwAjQI0MaYCO686bZD6H7EMIgi_CbOWtHDexGIiTKLer0d7RJGisXJqM6oA_L4y_A_774LEj8NNb7YXQ
    link:
      type: string
      nullable: true
      format: uuid
      description: El `link.id` al que pertenecen los datos.
      example: 30cb4806-6e00-48a4-91c9-ca55968576c8
    InstitutionAccount:
      type: object
      description: Detalles sobre la institución.
      properties:
        name:
          type: string
          example: erebor_mx_retail
          description: El nombre de la institución, según lo designado por Belvo.
        type:
          $ref: '#/components/schemas/EnumInstitutionType'
    collected_at:
      type: string
      format: date-time
      description: La marca de tiempo ISO-8601 cuando se recopiló el punto de datos.
      example: '2022-02-09T08:45:50.406032Z'
    EnumAccountCategoryOpenFinance:
      type: string
      nullable: true
      enum:
        - ADVANCE_DEPOSIT_ACCOUNT
        - CHECKING_ACCOUNT
        - CREDIT_CARD
        - FINANCING_ACCOUNT
        - INVESTMENT_ACCOUNT
        - INVOICE_FINANCING_ACCOUNT
        - LOAN_ACCOUNT
        - PENSION_FUND_ACCOUNT
        - SAVINGS_ACCOUNT
        - UNCATEGORIZED
      description: |-
        El tipo de cuenta.  
        Devolvemos uno de los siguientes valores de enum:  
          - `ADVANCE_DEPOSIT_ACCOUNT`
          - `CHECKING_ACCOUNT`
          - `CREDIT_CARD`
          - `FINANCING_ACCOUNT`
          - `INVESTMENT_ACCOUNT`
          - `INVOICE_FINANCING_ACCOUNT`
          - `LOAN_ACCOUNT`
          - `PENSION_FUND_ACCOUNT`
          - `SAVINGS_ACCOUNT`
          - `UNCATEGORIZED`
      example: CHECKING_ACCOUNT
    AccountOverdraftOpenFinanceBrazil:
      type: object
      nullable: true
      required:
        - arranged
        - used
        - unarranged
      properties:
        arranged:
          type: number
          format: float
          pattern: ^\d{1,15}\.\d{2,4}$
          description: >-
            El límite de sobregiro acordado entre el titular de la cuenta y la
            institución.


            > **No anulable:** Se debe devolver un valor por la red de finanzas
            abiertas de Brasil si el campo `overdraft` está disponible.
          example: 5000.5
        used:
          type: number
          format: float
          pattern: ^\d{1,15}\.\d{2,4}$
          description: >-
            El valor del sobregiro utilizado.


            > **No anulable:** La red de finanzas abiertas de Brasil debe
            devolver un valor si el campo `overdraft` está disponible.
          example: 1000.5
        unarranged:
          type: number
          format: float
          pattern: ^\d{1,15}\.\d{2,4}$
          description: >-
            El sobregiro utilizado que no fue acordado entre el titular de la
            cuenta y la institución.


            > **No anulable:** Se debe devolver un valor por la red de finanzas
            abiertas de Brasil si el campo `overdraft` está disponible.
          example: 300.1
    AccountBalanceOpenFinanceBrazil:
      type: object
      required:
        - current
      description: Detalles sobre los saldos actual y disponible de la cuenta.
      properties:
        current:
          type: number
          nullable: true
          format: float
          pattern: ^\d{1,15}\.\d{2,4}$
          description: >-
            El saldo actual se calcula de manera diferente según el tipo de
            cuenta.


            - **💰 Cuentas corrientes y de ahorro**:


            El saldo de la cuenta del usuario en el momento del timestamp
            `collected_at`.


            - **💳 Tarjetas de crédito**:


            La cantidad que el usuario ha gastado en el período de facturación
            actual de la tarjeta (consulte `credit_data.cutting_date` para
            obtener información sobre cuándo finaliza el período de facturación
            actual).


            - **🏡 Cuentas de préstamo**:


            La cantidad restante por pagar en el préstamo del usuario.
          example: 5874.13
        available:
          type: number
          nullable: true
          format: float
          pattern: ^\d{1,15}\.\d{2,4}$
          description: >-
            El saldo que el titular de la cuenta puede utilizar.


            - **💰 Cuentas corrientes y de ahorro**:


            El saldo disponible puede ser diferente al saldo `current` debido a
            transacciones pendientes.


            - **💳 Tarjetas de crédito**:


            El monto de crédito que el usuario aún tiene disponible para el
            período actual. El monto se calcula como `credit_data.credit_limit`
            menos `balance.current`.


            - **🏡 Cuentas de préstamo**:


            El valor presente requerido para liquidar el préstamo, según lo
            proporcionado por la institución.


            **Nota:** Si la institución no proporciona este valor, devolvemos
            `null`.
          example: 5621.12
        blocked:
          type: number
          format: float
          pattern: ^\d{1,15}\.\d{2,4}$
          description: >-
            La cantidad que está actualmente bloqueada debido a transacciones
            pendientes.


            > **No anulable:** Se debe devolver un valor por la red de finanzas
            abiertas de Brasil si el campo `balances` está disponible.
          example: 60.32
        automatically_invested:
          type: number
          format: float
          pattern: ^\d{1,15}\.\d{2,4}$
          description: >-
            La cantidad que se invierte automáticamente (según lo acordado con
            la institución).


            > **No anulable:** Se debe devolver un valor por la red de finanzas
            abiertas de Brasil si el campo `balances` está disponible.
          example: 131.5
    EnumCreditCardLimitType:
      type: string
      enum:
        - TOTAL_LIMIT
        - MODAL_LIMIT
      description: |-
        El tipo de límite. Devolvemos uno de los siguientes valores:

          - `TOTAL_LIMIT`
          - `MODAL_LIMIT`

          > **No anulable:** La red de finanzas abiertas de Brasil debe devolver un valor.
      example: TOTAL_LIMIT
    AccountCreditDataLimitsOpenFinanceBrazil:
      type: object
      description: >-
        Información detallada sobre los límites de crédito para las tarjetas de
        crédito.


        > **Non-nullable:** La red de finanzas abiertas de Brasil debe devolver
        un valor.
      required:
        - identification_number
        - credit_limit
        - used_amount
        - available_amount
        - is_limit_flexible
        - type
        - consolidation_type
        - line_name
        - line_name_additional_info
      properties:
        identification_number:
          type: string
          nullable: true
          minLength: 1
          maxLength: 100
          pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{0,99}$
          description: >-
            El número de la tarjeta de crédito.


            **Nota:** A menudo, esto es solo los últimos cuatro dígitos de la
            tarjeta de crédito.


            > **No anulable:** La red de finanzas abiertas de Brasil debe
            devolver un valor.
          example: '4453'
        credit_limit:
          type: number
          nullable: true
          format: float
          pattern: ^\d{1,15}\.\d{2,4}$
          description: El límite de la tarjeta de crédito.
          example: 1000.04
        used_amount:
          type: number
          nullable: true
          format: float
          pattern: ^\d{1,15}\.\d{2,4}$
          description: La cantidad utilizada.
          example: 400.04
        available_amount:
          type: number
          format: float
          pattern: ^\d{1,15}\.\d{2,4}$
          description: >-
            El monto aún disponible.


            > **No anulable:** La red de finanzas abiertas de Brasil debe
            devolver un valor.
          example: 600
        is_limit_flexible:
          type: boolean
          description: >-
            Boolean para indicar si el `credit_limit` es flexible.


            > **No anulable:** La red de finanzas abiertas de Brasil debe
            devolver un valor.
          example: false
        type:
          $ref: '#/components/schemas/EnumCreditCardLimitType'
        consolidation_type:
          type: string
          description: >-
            Indica si el límite de crédito es consolidado o individual.


            > **No anulable:** La red de finanzas abiertas de Brasil debe
            devolver un valor.
          example: INDIVIDUAL
        line_name:
          type: string
          nullable: true
          description: El nombre de la línea de límite de crédito.
          example: CREDITO_A_VISTA
        line_name_additional_info:
          type: string
          nullable: true
          maxLength: 100
          pattern: '[\w\W\s]*'
          description: Información adicional sobre el nombre de la línea.
          example: Informações adicionais e complementares
    EnumAccountCreditCardNetwork:
      type: string
      enum:
        - VISA
        - MASTERCARD
        - AMERICAN_EXPRESS
        - DINERS_CLUB
        - HIPERCARD
        - BANDEIRA_PROPRIA
        - CHEQUE_ELETRONICO
        - ELO
        - OTHER
      description: >-
        La red de crédito con la que está asociada la tarjeta. Devolvemos uno de
        los siguientes valores:

          - `VISA`
          - `MASTERCARD`
          - `AMERICAN_EXPRESS`
          - `DINERS_CLUB`
          - `HIPERCARD`
          - `BANDEIRA_PROPRIA`
          - `CHEQUE_ELETRONICO`
          - `ELO`
          - `OTHER`

          > **No anulable:** La red de finanzas abiertas de Brasil debe devolver un valor.
      example: MASTERCARD
    AccountCreditDataCardsOpenFinanceBrazil:
      type: object
      required:
        - is_multiple
        - identification_number
      description: Detalles sobre todas las tarjetas asociadas con la cuenta.
      properties:
        is_multiple:
          type: boolean
          description: >-
            Boolean para indicar si esta cuenta tiene múltiples tarjetas de
            crédito.


            > **No anulable:** La red de finanzas abiertas de Brasil debe
            devolver un valor.
          example: false
        identification_number:
          type: string
          minLength: 1
          maxLength: 100
          pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{0,99}$
          description: >-
            El número de la tarjeta de crédito.


            **Nota:** A menudo, esto es solo los últimos cuatro dígitos de la
            tarjeta de crédito.


            > **No anulable:** La red de finanzas abiertas de Brasil debe
            devolver un valor.
          example: '4453'
    AccountCreditDataOpenFinanceBrazil:
      type: object
      nullable: true
      required:
        - collected_at
        - credit_limit
      description: Detalles sobre las tarjetas de crédito asociadas con esta cuenta.
      properties:
        collected_at:
          $ref: '#/components/schemas/collected_at'
        credit_limit:
          type: number
          nullable: true
          format: float
          maxLength: 20
          pattern: ^\d{1,15}\.\d{2,4}$
          description: >-
            El límite de crédito superior de la tarjeta.


            > **No anulable:** La red de finanzas abiertas de Brasil debe
            devolver un valor.
          example: 192000.9
        limits:
          type: array
          items:
            $ref: '#/components/schemas/AccountCreditDataLimitsOpenFinanceBrazil'
        cutting_date:
          type: string
          nullable: true
          format: date
          maxLength: 10
          pattern: ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])$
          description: La fecha de vencimiento de la factura de la tarjeta de crédito.
          example: '2019-12-11'
        minimum_payment:
          type: number
          nullable: true
          format: float
          maxLength: 20
          pattern: ^\d{1,15}\.\d{2,4}$
          description: >-
            La cantidad mínima que el titular de la cuenta necesita pagar en el
            período de crédito actual.
          example: 2400.3
        network:
          $ref: '#/components/schemas/EnumAccountCreditCardNetwork'
        network_additional_info:
          type: string
          nullable: true
          maxLength: 100
          pattern: '[\w\W\s]*'
          description: Información adicional sobre la red de tarjetas de crédito.
          example: It's an orange card.
        cards:
          type: array
          minItems: 1
          description: Detalles sobre las tarjetas asociadas con la cuenta.
          items:
            $ref: '#/components/schemas/AccountCreditDataCardsOpenFinanceBrazil'
        next_payment_date:
          type: string
          nullable: true
          description: >-
            **Nota:** Este campo no es aplicable para OF Brazil y devolverá
            null.
          example: null
        no_interest_payment:
          type: number
          nullable: true
          format: float
          description: >-
            **Nota:** Este campo no es aplicable para OF Brazil y devolverá
            null.
          example: null
        interest_rate:
          type: number
          nullable: true
          format: float
          description: >-
            **Nota:** Este campo no es aplicable para OF Brazil y devolverá
            null.
          example: null
        monthly_payment:
          type: number
          nullable: true
          deprecated: true
          description: >-
            **Nota:** Este campo no es aplicable para OF Brazil y devolverá
            null.
          example: null
        last_payment_date:
          type: string
          nullable: true
          deprecated: true
          description: >-
            **Nota:** Este campo no es aplicable para OF Brazil y devolverá
            null.
          example: null
    EnumAccountLoanDataInterestRateType:
      type: string
      enum:
        - MONTHLY
        - YEARLY
      description: >-
        El período durante el cual se aplica el interés al préstamo.


        > **No anulable:** La red de finanzas abiertas de Brasil debe devolver
        un valor.
      example: MONTHLY
    EnumAccountLoanDataInterestRateDataTaxType:
      type: string
      enum:
        - NOMINAL
        - EFFECTIVE
      description: >-
        El tipo de impuesto sobre la tasa de interés. Devolvemos uno de los
        siguientes valores:

          - `NOMINAL`
          - `EFFECTIVE`
          
          > **No anulable:** La red de finanzas abiertas de Brasil debe devolver un valor.
      example: NOMINAL
    EnumAccountLoanDataInterestRateDataRateType:
      type: string
      enum:
        - SIMPLE
        - COMPOUND
      description: |-
        El tipo de tasa de interés. Devolvemos uno de los siguientes valores:

          - `SIMPLE`
          - `COMPOUND`

          > **No anulable:** La red de finanzas abiertas de Brasil debe devolver un valor.
      example: SIMPLE
    EnumAccountLoanDataInterestRateDataReferenceIndexType:
      type: string
      enum:
        - WITHOUT_INDEX_TYPE
        - PRE_FIXED
        - POST_FIXED
        - FLOATING
        - INDEXED_PRICE
        - RURAL_CREDIT
        - OTHER_INDEX
      description: >-
        La tasa de índice de referencia. Devolvemos uno de los siguientes
        valores:

          - `WITHOUT_INDEX_TYPE`
          - `PRE_FIXED`
          - `POST_FIXED`
          - `FLOATING`
          - `INDEXED_PRICE`
          - `RURAL_CREDIT`
          - `OTHER_INDEX`

          > **No anulable:** La red de finanzas abiertas de Brasil debe devolver un valor.
      example: FLOATING
    AccountLoanDataInterestRateDataOpenFinanceBrazil:
      type: object
      nullable: true
      required:
        - tax_type
        - rate_type
        - calculation_base
        - reference_index_type
        - reference_index_subtype
        - reference_index_info
        - pre_fixed_rate
        - post_fixed_rate
        - additional_info
      description: Información detallada sobre la tasa de interés.
      properties:
        tax_type:
          $ref: '#/components/schemas/EnumAccountLoanDataInterestRateDataTaxType'
        rate_type:
          $ref: '#/components/schemas/EnumAccountLoanDataInterestRateDataRateType'
        type:
          $ref: '#/components/schemas/EnumAccountLoanDataInterestRateType'
        calculation_base:
          type: string
          pattern: ^[0-9]{2}\/[0-9]{3}$
          description: >-
            El cálculo base para la tasa de interés.


            > **No anulable:** La red de finanzas abiertas de Brasil debe
            devolver un valor.
          example: 30/360
        reference_index_type:
          $ref: >-
            #/components/schemas/EnumAccountLoanDataInterestRateDataReferenceIndexType
        reference_index_subtype:
          type: string
          nullable: true
          description: El subtipo de la tasa de índice de referencia.
          example: TR_TBF
        reference_index_info:
          type: string
          nullable: true
          maxLength: 140
          pattern: ^[\w\W\s]{0,140}$
          description: Información adicional sobre la tasa del índice de referencia.
          example: Additional information
        pre_fixed_rate:
          type: number
          format: float
          pattern: ^[01]\.\d{6}$
          description: >-
            La tasa de interés con porcentaje prefijado.


            > **No anulable:** La red de finanzas abiertas de Brasil debe
            devolver un valor.
          example: 0.062
        post_fixed_rate:
          type: number
          format: float
          pattern: ^[01]\.\d{6}$
          description: >-
            La tasa de porcentaje post-fijada de la tasa de interés.


            > **No anulable:** La red de finanzas abiertas de Brasil debe
            devolver un valor.
          example: 0.062
        additional_info:
          type: string
          nullable: true
          maxLength: 1200
          pattern: '[\w\W\s]*'
          description: Información adicional sobre la tasa de interés.
          example: Additional information
    AccountLoanDataInterestRateOpenFinanceBrazil:
      type: object
      required:
        - name
        - type
        - value
        - interest_rate_data
      description: >-
        Desglose del interés aplicado al préstamo. Con OF Brasil, recomendamos
        encarecidamente utilizar el objeto `interest_rate_data` para obtener
        información detallada.


        > **No anulable:** La red de finanzas abiertas de Brasil debe devolver
        un valor.
      properties:
        name:
          type: string
          nullable: true
          description: >-
            El nombre del tipo de tasa de interés aplicada al préstamo.


            **Nota:** Para OFDA Brasil, recomendamos usar el parámetro
            `interest_date_data.tax_type`.
          example: NOMINAL
        type:
          $ref: '#/components/schemas/EnumAccountLoanDataInterestRateType'
        value:
          type: number
          nullable: true
          format: float
          description: >-
            La tasa de interés (en porcentaje o valor monetario).


            **Nota:** Para OFDA Brasil, recomendamos usar el parámetro
            `interest_date_data.pre_fixed_rate` y
            `interest_date_data.post_fixed_rate`.
          example: 7.85
        interest_rate_data:
          $ref: >-
            #/components/schemas/AccountLoanDataInterestRateDataOpenFinanceBrazil
    EnumAccountLoanDataFeeType:
      type: string
      nullable: true
      enum:
        - OPERATION_FEE
        - INSURANCE_FEE
        - OTHERS
        - null
      description: '**Nota:** Este campo no es aplicable para OF Brazil y devolverá null.'
      example: null
    EnumAccountLoanDataFeeChargeType:
      type: string
      enum:
        - SINGLE
        - PER_INSTALLMENT
      description: |-
        Indica el tipo de cargo. Devolvemos uno de los siguientes valores:

          - `SINGLE`
          - `PER_INSTALLMENT`

           > **No anulable:** Se debe devolver un valor por la red de finanzas abiertas de Brasil si el campo `fees` está disponible.
      example: SINGLE
    EnumAccountLoanDataFeeCharge:
      type: string
      enum:
        - MINIMUM
        - MAXIMUM
        - FIXED
        - PERCENTAGE
      description: >-
        Método de facturación, según lo acordado con la institución. Devolvemos
        uno de los siguientes valores:

          - `MINIMUM`
          - `MAXIMUM`
          - `FIXED`
          - `PERCENTAGE`

           > **No anulable:** Se debe devolver un valor por la red de finanzas abiertas de Brasil si el campo `fees` está disponible.
      example: FIXED
    AccountLoanDataFeesOpenFinanceBrazil:
      type: object
      nullable: true
      required:
        - type
        - value
        - name
        - code
        - fee_charge_type
        - fee_charge
        - rate
      description: Desglose de las tarifas aplicadas al préstamo.
      properties:
        type:
          $ref: '#/components/schemas/EnumAccountLoanDataFeeType'
        value:
          type: number
          nullable: true
          format: float
          pattern: ^\d{1,15}\.\d{2,4}$
          description: El valor total de la tarifa. Misma moneda que el préstamo.
          example: 5.6
        name:
          type: string
          maxLength: 140
          pattern: ^[\w\W\s]{0,140}$
          description: |-
            El nombre de la tarifa.

             > **No anulable:** Se debe devolver un valor por la red de finanzas abiertas de Brasil si el campo `fees` está disponible.
          example: Renovação de cadastro
        code:
          type: string
          maxLength: 140
          pattern: ^[\w\W\s]{0,140}$
          description: |-
            El código de tarifa.

             > **No anulable:** Se debe devolver un valor por la red de finanzas abiertas de Brasil si el campo `fees` está disponible.
          example: CADASTRO
        fee_charge_type:
          $ref: '#/components/schemas/EnumAccountLoanDataFeeChargeType'
        fee_charge:
          $ref: '#/components/schemas/EnumAccountLoanDataFeeCharge'
        rate:
          type: number
          nullable: true
          format: float
          pattern: ^[01]\.\d{6}$
          description: >-
            La tasa porcentual de la tarifa. Requerido cuando `fee_charge` está
            configurado en `PERCENTAGE`.
          example: 0.062
    EnumAccountLoanDataContractedChargeType:
      type: string
      enum:
        - LATE_PAYMENT_INTEREST_FEE
        - LATE_PAYMENT_PENALTY_FEE
        - DEFAULT_INTEREST_FEE
        - LOAN_CONTRACT_TAX
        - LATE_PAYMENT_TAX
        - NO_CHARGE
        - OTHER
      description: |-
        El tipo de cargo contratado. Devolvemos uno de los siguientes valores:

          - `LATE_PAYMENT_INTEREST_FEE`
          - `LATE_PAYMENT_PENALTY_FEE`
          - `DEFAULT_INTEREST_FEE`
          - `LOAN_CONTRACT_TAX`
          - `LATE_PAYMENT_TAX`
          - `NO_CHARGE`
          - `OTHER`

          > **No anulable:** Se debe devolver un valor por la red de finanzas abiertas de Brasil si el campo `contracted_charges` está disponible.
      example: LATE_PAYMENT_INTEREST_FEE
    AccountLoanDataContractedChargesOpenFinanceBrazil:
      type: object
      nullable: true
      description: Detalles sobre cualquier cargo contratado.
      properties:
        type:
          $ref: '#/components/schemas/EnumAccountLoanDataContractedChargeType'
        info:
          type: string
          nullable: true
          maxLength: 140
          pattern: ^[\w\W\s]{0,140}$
          description: Información adicional sobre el cargo contratado.
          example: Late fee
        rate:
          type: number
          nullable: true
          format: float
          pattern: ^[01]\.\d{6}$
          description: >-
            La tasa porcentual del cargo, calculada en función del monto del
            préstamo.
          example: 0.062
    AccountLoanDataCollateralsOpenFinanceBrazil:
      type: object
      nullable: true
      description: >-
        Detalles sobre cualquier garantía de préstamo que el individuo o negocio
        haya proporcionado.
      required:
        - type
        - subtype
        - currency
        - amount
      properties:
        type:
          type: string
          description: >-
            El tipo de garantía, según lo definido por la institución.


            > **No anulable:** Se debe devolver un valor por la red de finanzas
            abiertas de Brasil si el campo `collaterals` está disponible.
          example: OPERACOES_GARANTIDAS_PELO_GOVERNO
        subtype:
          type: string
          description: >-
            El subtipo de la garantía, según lo definido por la institución.


            > **No anulable:** Se debe devolver un valor por la red de finanzas
            abiertas de Brasil si el campo `collaterals` está disponible.
          example: CCR_CONVENIO_CREDITOS_RECIPROCOS
        currency:
          type: string
          maxLength: 3
          pattern: ^[A-Z]{3}$
          description: >-
            El código de moneda de tres letras (ISO-4217).


            > **No anulable:** Se debe devolver un valor por la red de finanzas
            abiertas de Brasil si el campo `collaterals` está disponible.
          example: BRL
        amount:
          type: number
          format: float
          pattern: ^\d{1,15}\.\d{2,4}$
          description: >-
            El monto total de la factura.


            > **No anulable:** Se debe devolver un valor por la red de finanzas
            abiertas de Brasil si el campo `collaterals` está disponible.
          example: 45391.89
    AccountLoanDataBalloonPaymentsOpenFinanceBrazil:
      type: object
      nullable: true
      description: >-
        Información detallada sobre cualquier pago global para el préstamo, si
        corresponde.
      required:
        - due_date
        - currency
        - amount
      properties:
        due_date:
          type: string
          nullable: true
          format: date
          maxLength: 10
          pattern: ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])$
          description: >-
            La fecha en que se debe pagar el balloon payment, en formato
            `YYYY-MM-DD`.
          example: '2021-09-06'
        currency:
          type: string
          nullable: true
          maxLength: 3
          pattern: ^[A-Z]{3}$
          description: El código de moneda de tres letras (ISO-4217).
          example: BRL
        amount:
          type: number
          nullable: true
          format: float
          pattern: ^\d{1,15}\.\d{2,4}$
          description: El monto total del pago global.
          example: 45391.89
    EnumAccountsLoanDataContractInstallmentFrequency:
      type: string
      nullable: true
      enum:
        - DAY
        - WEEK
        - MONTH
        - YEAR
        - NO_DEADLINE_REMAINING
        - null
      description: >-
        La frecuencia de los pagos a plazos contratados, tal como se definió
        cuando se firmó el contrato por primera vez. Devolvemos uno de los
        siguientes:

          - `DAY`
          - `WEEK`
          - `MONTH`
          - `YEAR`
          - `NO_DEADLINE_REMAINING`
          - `null`
      example: MONTH
    EnumAccountLoanDataInstallmentFrequency:
      type: string
      enum:
        - IRREGULAR
        - WEEKLY
        - FORTNIGHTLY
        - MONTHLY
        - BIMONTHLY
        - QUARTERLY
        - BIANNUALLY
        - ANNUALLY
        - OTHER
      description: >-
        La frecuencia con la que se pagan las cuotas. Devolvemos uno de los
        siguientes valores:

          - `IRREGULAR`
          - `WEEKLY`
          - `FORTNIGHTLY`
          - `MONTHLY`
          - `BIMONTHLY`
          - `QUARTERLY`
          - `BIANNUALLY`
          - `ANNUALLY`
          - `OTHER`

          > **No anulable:** La red de finanzas abiertas de Brasil debe devolver un valor.
      example: MONTHLY
    EnumAccountLoanDataContractRemainingFrequency:
      type: string
      nullable: true
      enum:
        - DAY
        - WEEK
        - MONTH
        - YEAR
        - NO_DEADLINE_REMAINING
        - null
      description: >-
        La frecuencia de los pagos de las cuotas restantes contratadas, tal como
        se definió cuando se firmó el contrato por primera vez. Devolvemos uno
        de los siguientes valores:

        - `DAY`

        - `WEEK`

        - `MONTH`

        - `YEAR`

        - `NO_DEADLINE_REMAINING`

        - `null`
      example: MONTH
    AccountLoanDataOpenFinanceBrazil:
      type: object
      nullable: true
      required:
        - collected_at
        - loan_code
        - contract_amount
        - total_effectove_cost
        - loan_type
        - outstanding_balance
        - interest_rates
        - fees
        - collaterals
        - balloon_payments
        - installments_contract_term_frequency
        - installment_frequency
        - installment_frequency_info
        - first_installment_due_date
        - number_of_installments_total
        - number_of_installments_outstanding
        - number_of_installments_paid
        - number_of_installments_past_due
        - disbursement_dates
        - settlement_date
        - contract_start_date
        - contract_end_date
        - contract_remaining_frequency
        - contract_remaining_total
        - amortization_schedule
        - amortization_schedule_info
        - consignee_id
        - contract_number
        - monthly_payment
        - principal
        - payment_day
        - outstanding_principal
        - credit_limit
        - last_period_balance
        - interest_rate
        - limit_day
        - cutting_day
        - cutting_date
        - last_payment_date
        - no_interest_payment
      description: Las opciones de préstamo asociadas con esta cuenta.
      properties:
        collected_at:
          $ref: '#/components/schemas/collected_at'
        loan_code:
          type: string
          minLength: 22
          maxLength: 67
          pattern: ^\d{22,67}$
          description: >-
            El número de contrato estandarizado específico del país.


            > **No anulable:** La red de finanzas abiertas de Brasil debe
            devolver un valor.
          example: '92792126019929279212650822221989319252576'
        contract_amount:
          type: number
          nullable: true
          format: float
          pattern: ^\d{1,15}\.\d{2,4}$
          description: >-
            El monto total inicial del préstamo cuando se firmó el contrato,
            calculado por la institución. Este monto incluye el principal +
            intereses + impuestos + tarifas.
          example: 202000
        total_effective_cost:
          type: number
          nullable: true
          format: float
          pattern: ^\d{1,15}\.\d{2,4}$
          description: El costo total efectivo inicial del préstamo.
          example: 209000
        loan_type:
          type: string
          description: >-
            El tipo de préstamo, según la institución.


            > **No anulable:** La red de finanzas abiertas de Brasil debe
            devolver un valor.
          example: HOME_EQUITY
        outstanding_balance:
          type: number
          nullable: true
          format: float
          minLength: 4
          maxLength: 20
          pattern: ^\d{1,15}\.\d{2,4}$
          description: El monto restante a pagar en total, incluidos los intereses.
          example: 182000
        interest_rates:
          type: array
          description: >-
            Desglose del interés aplicado al préstamo. Con OF Brasil,
            recomendamos encarecidamente utilizar la información en
            `interest_rate_data` para obtener información detallada.


            > **No anulable:** La red de finanzas abiertas de Brasil debe
            devolver un valor.
          items:
            $ref: '#/components/schemas/AccountLoanDataInterestRateOpenFinanceBrazil'
        fees:
          type: array
          nullable: true
          description: Desglose de las tarifas aplicadas al préstamo.
          items:
            $ref: '#/components/schemas/AccountLoanDataFeesOpenFinanceBrazil'
        contracted_charges:
          type: array
          nullable: true
          description: >-
            Lo siento, no hay texto proporcionado para traducir. Por favor,
            proporciona el texto que necesitas que traduzca.
          items:
            $ref: >-
              #/components/schemas/AccountLoanDataContractedChargesOpenFinanceBrazil
        collaterals:
          type: array
          nullable: true
          description: >-
            Detalles sobre cualquier garantía de préstamo que el individuo o
            negocio haya proporcionado.
          items:
            $ref: '#/components/schemas/AccountLoanDataCollateralsOpenFinanceBrazil'
        balloon_payments:
          type: array
          nullable: true
          description: >-
            Información detallada sobre cualquier pago global del préstamo, si
            corresponde.
          items:
            $ref: >-
              #/components/schemas/AccountLoanDataBalloonPaymentsOpenFinanceBrazil
        installments_contract_term_frequency:
          $ref: >-
            #/components/schemas/EnumAccountsLoanDataContractInstallmentFrequency
        installment_frequency:
          $ref: '#/components/schemas/EnumAccountLoanDataInstallmentFrequency'
        installment_frequency_info:
          type: string
          nullable: true
          maxLength: 100
          pattern: ^[\w\W\s]{0,99}$$
          description: Información adicional sobre el `installment_frequency`.
          example: Both the term and requency are the same.
        first_installment_due_date:
          type: string
          nullable: true
          format: date
          maxLength: 10
          pattern: ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])$
          description: >-
            La fecha en la que debe pagarse la primera cuota del préstamo, en
            formato `YYYY-MM-DD`.
          example: '2020-03-01'
        number_of_installments_total:
          type: integer
          nullable: true
          format: int32
          maximum: 999999999
          description: El número total de cuotas necesarias para pagar el préstamo.
          example: 60
        number_of_installments_outstanding:
          type: integer
          nullable: true
          format: int32
          maximum: 999999999
          description: El número de cuotas restantes por pagar.
          example: 48
        number_of_installments_paid:
          type: integer
          nullable: true
          format: int32
          maximum: 999999999
          description: El número de cuotas ya pagadas.
          example: 32
        number_of_installments_past_due:
          type: integer
          nullable: true
          format: int32
          maximum: 999
          description: El número de cuotas que están vencidas.
          example: 2
        disbursement_dates:
          type: array
          nullable: true
          minItems: 1
          description: Un array de fechas cuando se desembolsó el préstamo.
          items:
            type: string
            nullable: true
            maxLength: 10
            pattern: ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])$
            description: >-
              La fecha en que se desembolsó el préstamo, en formato
              `YYYY-MM-DD`.
            example: '2021-09-23'
        settlement_date:
          type: string
          nullable: true
          maxLength: 10
          pattern: ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])$
          description: La fecha en que se liquidó el préstamo, en formato `YYYY-MM-DD`.
          example: '2021-09-23'
        contract_start_date:
          type: string
          format: date
          maxLength: 10
          pattern: ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])$
          description: >-
            La fecha en que se firmó el contrato de préstamo, en formato
            `YYYY-MM-DD`.


            > **No anulable:** Se debe devolver un valor por la red de finanzas
            abiertas de Brasil.
          example: '2020-03-01'
        contract_end_date:
          type: string
          nullable: true
          format: date
          maxLength: 10
          pattern: ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])$
          description: >-
            La fecha en la que se espera que el préstamo se complete, en formato
            `YYYY-MM-DD`.
          example: '2027-10-01'
        contract_remaining_frequency:
          $ref: '#/components/schemas/EnumAccountLoanDataContractRemainingFrequency'
        contract_remaining_total:
          type: integer
          nullable: true
          format: int32
          maximum: 999999999
          description: El número total de cuotas restantes del préstamo.
          example: 20
        amortization_schedule:
          type: string
          description: >-
            El calendario de amortización del préstamo.


            > **No anulable:** La red de finanzas abiertas de Brasil debe
            devolver un valor.
          example: SEM_SISTEMA_AMORTIZACAO
        amortization_schedule_info:
          type: string
          nullable: true
          maxLength: 200
          pattern: '[\w\W\s]*'
          description: Información adicional sobre el `amortization_schedule`.
          example: No need for a schedule.
        consignee_id:
          type: string
          nullable: true
          maxLength: 14
          pattern: ^\d{14}$
          description: El ID del consignatario del préstamo.
          example: '60500998000135'
        contract_number:
          type: string
          nullable: true
          minLength: 1
          maxLength: 100
          pattern: ^\d{1,100}$
          description: >-
            El número de contrato del préstamo, tal como lo proporciona la
            institución.
          example: '1324926521496'
        monthly_payment:
          type: number
          nullable: true
          format: float
          description: >-
            **Nota:** Este campo no es aplicable para OF Brazil y devolverá
            null.
          example: null
        principal:
          type: number
          nullable: true
          format: float
          description: >-
            **Nota:** Este campo no es aplicable para OF Brazil y devolverá
            null.
          example: null
        payment_day:
          type: string
          nullable: true
          description: >-
            **Nota:** Este campo no es aplicable para OF Brazil y devolverá
            null.
          example: null
        outstanding_principal:
          type: number
          nullable: true
          format: float
          description: >-
            **Nota:** Este campo no es aplicable para OF Brazil y devolverá
            null.
          example: null
        credit_limit:
          type: number
          nullable: true
          deprecated: true
          description: >-
            **Nota:** Este campo no es aplicable para OF Brazil y devolverá
            null.
          example: null
        last_period_balance:
          type: number
          nullable: true
          deprecated: true
          description: >-
            **Nota:** Este campo no es aplicable para OF Brazil y devolverá
            null.
          example: null
        interest_rate:
          type: number
          nullable: true
          deprecated: true
          description: >-
            **Nota:** Este campo no es aplicable para OF Brazil y devolverá
            null.
          example: null
        limit_day:
          type: string
          nullable: true
          deprecated: true
          description: >-
            **Nota:** Este campo no es aplicable para OF Brazil y devolverá
            null.
          example: null
        cutting_day:
          type: string
          nullable: true
          deprecated: true
          description: >-
            **Nota:** Este campo no es aplicable para OF Brazil y devolverá
            null.
          example: null
        cutting_date:
          type: string
          nullable: true
          deprecated: true
          description: >-
            **Nota:** Este campo no es aplicable para OF Brazil y devolverá
            null.
          example: null
        last_payment_date:
          type: string
          nullable: true
          deprecated: true
          description: >-
            **Nota:** Este campo no es aplicable para OF Brazil y devolverá
            null.
          example: null
        no_interest_payment:
          type: number
          nullable: true
          deprecated: true
          description: >-
            **Nota:** Este campo no es aplicable para OF Brazil y devolverá
            null.
          example: null
    AccountOpenFinanceBrazil:
      type: object
      nullable: true
      title: Objeto de Cuenta (OFDA Brasil)
      x-tags:
        - Accounts
      description: Detalles sobre la cuenta.
      required:
        - id
        - link
        - institution
        - collected_at
        - created_at
        - last_accessed_at
        - category
        - balance_type
        - type
        - subtype
        - name
        - number
        - agency
        - check_digit
        - balance
        - currency
        - public_identification_name
        - public_identification_value
        - internal_identification
        - credit_data
        - loan_data
        - funds_data
      properties:
        id:
          $ref: '#/components/schemas/id'
        link:
          $ref: '#/components/schemas/link'
        institution:
          $ref: '#/components/schemas/InstitutionAccount'
        collected_at:
          $ref: '#/components/schemas/collected_at'
        created_at:
          $ref: '#/components/schemas/created_at'
        last_accessed_at:
          $ref: '#/components/schemas/last_accessed_at'
        category:
          $ref: '#/components/schemas/EnumAccountCategoryOpenFinance'
        balance_type:
          type: string
          nullable: true
          description: >-
            Indica si esta cuenta es un `ASSET` o un `LIABILITY`. Puedes
            considerar el saldo de un `ASSET` como positivo, mientras que el
            saldo de un `LIABILITY` como negativo.
          example: ASSET
        overdraft:
          $ref: '#/components/schemas/AccountOverdraftOpenFinanceBrazil'
        type:
          type: string
          description: >-
            El tipo de cuenta, según lo designado por la institución.


            > **No anulable:** La red de finanzas abiertas de Brasil debe
            devolver un valor.
          example: STANDARD_NACIONAL
        subtype:
          type: string
          description: >-
            El subtipo de cuenta, según lo designado por la institución.


            > **No anulable:** La red de finanzas abiertas de Brasil debe
            devolver un valor.
          example: FINANCIAMENTO_HABITACIONAL_SFH
        name:
          type: string
          nullable: true
          description: El nombre de la cuenta, tal como lo proporciona la institución.
          example: Cuenta Perfiles- M.N. - MXN-666
        number:
          type: string
          nullable: true
          description: El número de cuenta, tal como lo designa la institución.
          example: '4057068115181'
        agency:
          type: string
          nullable: true
          maxLength: 4
          pattern: ^\d{1,4}$
          description: El código de sucursal donde se abrió el producto.
          example: '6272'
        check_digit:
          type: string
          nullable: true
          maxLength: 2
          pattern: '[\w\W\s]*'
          description: El dígito de control del número del producto, si corresponde.
          example: '7'
        balance:
          $ref: '#/components/schemas/AccountBalanceOpenFinanceBrazil'
        currency:
          type: string
          maxLength: 3
          pattern: ^[A-Z]{3}$
          description: >-
            El código de moneda de tres letras (ISO-4217).


            > **No anulable:** Se debe devolver un valor por la red de finanzas
            abiertas de Brasil si el campo `balances` está disponible.
          example: BRL
        public_identification_name:
          type: string
          nullable: true
          description: >-
            El nombre público para el tipo de identificación. Para cuentas de
            ahorro y corrientes en 🇧🇷 Brasil, este campo será
            `AGENCY/ACCOUNT`.
          example: AGENCY/ACCOUNT
        public_identification_value:
          type: string
          nullable: true
          description: >-
            El valor para el `public_identification_name`.


            Para cuentas de ahorro y corriente OFDA brasileñas 🇧🇷, este campo
            será el número de agencia y cuenta bancaria, separados por una
            barra. Por ejemplo: `0444/45722-0`.


            Para cuentas de tarjeta de crédito OFDA brasileñas 🇧🇷,
            devolveremos una cadena de números de tarjeta de crédito
            concatenados asociados con la cuenta. Por ejemplo: "8763,9076,5522"
          example: 0444/45722-0
        internal_identification:
          type: string
          maxLength: 100
          pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{0,99}$
          description: >-
            La identificación interna de la institución para la cuenta.


            > **No anulable:** Se debe devolver un valor por la red de finanzas
            abiertas de Brasil si el campo `balances` está disponible.
          example: '92792126019929279212650822221989319252576'
        credit_data:
          $ref: '#/components/schemas/AccountCreditDataOpenFinanceBrazil'
        loan_data:
          $ref: '#/components/schemas/AccountLoanDataOpenFinanceBrazil'
        funds_data:
          type: string
          nullable: true
          description: >-
            **Nota:** Este campo no es aplicable para OF Brazil y devolverá
            null.
          example: null
    link_request:
      type: string
      format: uuid
      description: El `link.id` para el que deseas recuperar información.
      example: c81a1dea-6dd6-4999-8b9f-541ee8197058
    BalanceOFDA:
      type: object
      title: Objeto de Balance (Brazil OFDA)
      x-tags:
        - Balances
      required:
        - id
        - link
        - account_id
        - account_internal_identification
        - collected_at
        - created_at
        - last_updated_at
        - currency
        - available
        - blocked
        - automatically_invested
      properties:
        id:
          type: string
          format: uuid
          description: >-
            El identificador único creado por Belvo utilizado para referenciar
            el saldo actual.
          example: 0b94bdf9-3719-43a9-81e7-be95d2318595
        link:
          type: string
          format: uuid
          description: El identificador único del enlace al que pertenece este balance.
          example: 0b94bdf9-3719-43a9-81e7-be95d2318595
        account_id:
          type: string
          format: uuid
          description: El `account.id` de Belvo al que pertenece este balance.
          example: c4bfecf9-4eb6-4920-9f9f-e1f1e60ef321
        account_internal_identification:
          type: string
          maxLength: 50
          description: La identificación interna de la institución para la cuenta.
          example: '92792126019929279212650822221989319252576'
        collected_at:
          type: string
          format: date-time
          description: La marca de tiempo ISO-8601 cuando se recopiló el punto de datos.
          example: '2024-05-21T08:32:00Z'
        created_at:
          type: string
          format: date-time
          description: >-
            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'
        last_updated_at:
          type: string
          format: date-time
          description: >-
            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'
        currency:
          type: string
          maxLength: 3
          pattern: ^[A-Z]{3}$
          description: El código de moneda de tres letras (ISO-4217).
          example: USD
        available:
          type: number
          format: float
          pattern: ^\d{1,15}\.\d{2,4}$
          minimum: 0
          description: El saldo disponible de la cuenta.
          example: 1000.02
        blocked:
          type: number
          format: float
          pattern: ^\d{1,15}\.\d{2,4}$
          minimum: 0
          description: >-
            La cantidad que está actualmente bloqueada debido, por ejemplo, a
            transacciones pendientes.
          example: 1000.02
        automatically_invested:
          type: number
          format: float
          pattern: ^\d{1,15}\.\d{2,4}$
          minimum: 0
          description: >-
            La cantidad que se invierte automáticamente (según lo acordado con
            la institución).
          example: 1000.02
    account_id:
      type: string
      format: uuid
      description: El `account.id` de Belvo para el que deseas recuperar información.
      example: e2cdb621-f44a-4558-89f6-8ab2a57add7a
    TransactionMerchantData:
      type: object
      nullable: true
      description: >-
        Datos adicionales sobre el comerciante involucrado en la transacción.

        Solo devolvemos información del comerciante para nuevas transacciones
        realizadas desde cuentas de *cheques* o *tarjeta de crédito*.

        > **Obtener información del comerciante**
         Recuperamos la información del comerciante para una transacción como parte de nuestro producto de <a href="https://developers.belvo.com/docs/banking#categorizing-transactions" target="_blank">Categorización de transacciones</a>, convirtiendo datos en bruto en información procesable. Para habilitar este producto, simplemente <a href="https://belvo.com/contact/?utm_source=documentation" target="_blank">contáctanos</a>, y nos pondremos manos a la obra.
      properties:
        logo:
          type: string
          nullable: true
          description: La URL del logotipo del comerciante.
          example: https://logo.clearbit.com/asesor-contable.es
        website:
          type: string
          nullable: true
          description: La URL al sitio web del comerciante.
          example: https://merchants-r-us.com
        merchant_name:
          type: string
          description: El nombre del comerciante.
          example: Merchants R Us Global
    EnumTransactionCategory:
      type: string
      nullable: true
      enum:
        - Bills & Utilities
        - Credits & Loans
        - Deposits
        - Fees & Charges
        - Food & Groceries
        - Home & Life
        - Income & Payments
        - Insurance
        - Investments & Savings
        - Online Platforms & Leisure
        - Personal Shopping
        - Taxes
        - Transfers
        - Transport & Travel
        - Unknown
        - Withdrawal & ATM
        - null
      description: >-
        El nombre de la categoría de transacción.


        > **Obtener categorización de transacciones**

        Con la <a
        href="https://developers.belvo.com/docs/banking#categorizing-transactions"
        target="_blank">categorización de transacciones</a>, limpiamos y
        categorizamos las transacciones por ti, convirtiendo datos en bruto en
        información procesable. Para habilitar esta función, simplemente <a
        href="https://belvo.com/contact/?utm_source=documentation"
        target="_blank">contáctanos</a> y nos pondremos manos a la obra.


        Devolvemos uno de los siguientes valores de 'enum':

          - `Bills & Utilities`
          - `Credits & Loans`
          - `Deposits`
          - `Fees & Charges`
          - `Food & Groceries`
          - `Home & Life`
          - `Income & Payments`
          - `Insurance`
          - `Investments & Savings`
          - `Online Platforms & Leisure`
          - `Personal Shopping`
          - `Taxes`
          - `Transfers`
          - `Transport & Travel`
          - `Unknown`*
          - `Withdrawal & ATM`
          - `null`


          \* Para los clientes que no utilizan nuestro producto de Categorización de Transacciones, devolvemos `null` en su lugar.
      example: Income & Payments
    EnumTransactionSubcategory:
      type: string
      nullable: true
      enum:
        - Electricity & Energy
        - Rent
        - Telecommunications
        - Water
        - Auto
        - Credit Card
        - Instalment
        - Interest & Charges
        - Mortgage
        - Pay Advance
        - Personal
        - Adjustments
        - Bank Fees
        - Chargeback
        - Refund
        - Blocked Balances
        - Alimony
        - Alcohol & Tobacco
        - Bakery & Coffee
        - Bars & Nightclubs
        - Convenience Store
        - Delivery
        - Groceries
        - Restaurants
        - Education
        - Gyms & Fitness
        - Hair & Beauty
        - Health
        - Home Decor & Appliances
        - Laundry & Dry Cleaning
        - Pharmacies
        - Professional Services
        - Veterinary Services
        - Freelance
        - Interest
        - Retirement
        - Salary
        - Government
        - Home Insurance
        - Auto Insurance
        - Health & Life Insurance
        - Savings
        - Fixed income
        - Equity
        - Investment Funds
        - Derivatives
        - Cryptocurrencies
        - Apps, Software and Cloud Services
        - Events, Parks and Museums
        - Gambling
        - Gaming
        - Lottery
        - Movie & Audio
        - Books & News
        - Clothing & Accessories
        - Department Store
        - Electronics
        - E-commerce
        - Gifts
        - Office Supplies
        - Pet Supplies
        - Auto Tax & Fees
        - Donation
        - Government Fees
        - Income Tax
        - Real Estate Tax & Fees
        - Tax Return
        - Accommodation
        - Auto Expenses
        - Auto Rental
        - Flights
        - Gas
        - Mileage Programs
        - Parking & Tolls
        - Public Transit
        - Taxis & Rideshares
        - Other
        - null
      description: |-
        La subcategoría de la transacción.

          > **Obtener categorización de transacciones**
          Para los clientes que no utilizan nuestra <a href="https://developers.belvo.com/docs/banking#categorizing-transactions" target="_blank">categorización de transacciones</a>, devolvemos `null` en su lugar. Para habilitar esta función, simplemente <a href="https://belvo.com/contact/?utm_source=documentation" target="_blank">contáctanos</a>, y lo activaremos de inmediato.

        Devolvemos uno de los siguientes valores de enum:

          - `Electricity & Energy`
          - `Rent`
          - `Telecommunications`
          - `Water`
          - `Auto`
          - `Credit Card`
          - `Instalment`
          - `Interest & Charges`
          - `Mortgage`
          - `Pay Advance`
          - `Personal`
          - `Adjustments`
          - `Bank Fees`
          - `Chargeback`
          - `Refund`
          - `Blocked Balances`
          - `Alimony`
          - `Alcohol & Tobacco`
          - `Bakery & Coffee`
          - `Bars & Nightclubs`
          - `Convenience Store`
          - `Delivery`
          - `Groceries`
          - `Restaurants`
          - `Education`
          - `Gyms & Fitness`
          - `Hair & Beauty`
          - `Health`
          - `Home Decor & Appliances`
          - `Laundry & Dry Cleaning`
          - `Pharmacies`
          - `Professional Services`
          - `Veterinary Services`
          - `Freelance`
          - `Interest`
          - `Retirement`
          - `Salary`
          - `Government`
          - `Home Insurance`
          - `Auto Insurance`
          - `Health & Life Insurance`
          - `Savings`
          - `Fixed income`
          - `Equity`
          - `Investment Funds`
          - `Derivatives`
          - `Cryptocurrencies`
          - `Apps, Software and Cloud Services`
          - `Events, Parks and Museums`
          - `Gambling`
          - `Gaming`
          - `Lottery`
          - `Movie & Audio`
          - `Books & News`
          - `Clothing & Accessories`
          - `Department Store`
          - `Electronics`
          - `E-commerce`
          - `Gifts`
          - `Office Supplies`
          - `Pet Supplies`
          - `Auto Tax & Fees`
          - `Donation`
          - `Government Fees`
          - `Income Tax`
          - `Real Estate Tax & Fees`
          - `Tax Return`
          - `Accommodation`
          - `Auto Expenses`
          - `Auto Rental`
          - `Flights`
          - `Gas`
          - `Mileage Programs`
          - `Parking & Tolls`
          - `Public Transit`
          - `Taxis & Rideshares`
          - `Other`
          - `null`
      example: Freelance
    EnumTransactionType:
      type: string
      nullable: true
      enum:
        - OUTFLOW
        - INFLOW
        - null
      description: >-
        La dirección de la transacción:

        - `INFLOW` indica dinero que entra en la cuenta.

        - `OUTFLOW` indica dinero que sale de la cuenta.

        - `null` cuando no hay información presente sobre la dirección de la
        transacción.
      example: INFLOW
    EnumTransactionStatus:
      type: string
      nullable: true
      enum:
        - PENDING
        - PROCESSED
        - UNCATEGORIZED
        - null
      description: |-
        El estado de la transacción. Devolvemos uno de los siguientes valores:

          - `PROCESSED` (La transacción ha sido procesada por la institución.)
          - `PENDING` (La institución indica claramente que la transacción aún no ha sido procesada.)
          - `UNCATEGORIZED` (obsoleto)
          - `null` (obsoleto)
      example: PROCESSED
    EnumTransactionCreditCardDataFeeType:
      type: string
      nullable: true
      enum:
        - ANNUAL_FEE
        - NATIONAL_WITHDRAWAL
        - INTERNATIONAL_WITHDRAWAL
        - EMERGENCY_CREDIT_EVALUATION_FEE
        - DUPLICATE_ISSUANCE_FEE
        - PAYMENT_FEE
        - SMS_FEE
        - OTHERS
        - null
      description: >-
        La tarifa que se puede cobrar por una transacción con tarjeta.
        Devolvemos uno de los siguientes valores:

          - `ANNUAL_FEE`
          - `NATIONAL_WITHDRAWAL`
          - `INTERNATIONAL_WITHDRAWAL`
          - `EMERGENCY_CREDIT_EVALUATION_FEE`
          - `DUPLICATE_ISSUANCE_FEE`
          - `PAYMENT_FEE`
          - `SMS_FEE`
          - `OTHERS`
          - `null`
      example: NATIONAL_WITHDRAWAL
    EnumTransactionCreditCardDataCreditType:
      type: string
      nullable: true
      enum:
        - REVOLVING_CREDIT
        - BILL_INSTALLMENT_PAYMENT
        - LOAN
        - OTHERS
        - null
      description: >-
        Otros tipos de crédito que se han contratado en la tarjeta. Devolvemos
        uno de los siguientes valores:

          - `REVOLVING_CREDIT`
          - `BILL_INSTALLMENT_PAYMENT`
          - `LOAN`
          - `OTHERS`
          - `null`
      example: BILL_INSTALLMENT_PAYMENT
    TransactionCreditCardBill:
      type: object
      nullable: true
      description: Información sobre la factura en la que aparece esta transacción.
      properties:
        id:
          type: string
          format: uuid
          description: >-
            El identificador único creado por Belvo utilizado para referenciar
            la factura actual de la tarjeta de crédito.


            > **Nota**: Este campo solo se devuelve para facturas 'closed' (lo
            que significa que el período de facturación ha terminado y la
            factura ha sido emitida). Si el período de facturación aún está en
            curso, devolvemos `null`.
          example: 8e9d13c2-af41-4a49-b43e-2da012bd1d11
        internal_identification:
          type: string
          nullable: true
          minLength: 1
          maxLength: 100
          pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{0,99}$
          description: >-
            El identificador interno de la institución para la factura.


            > **Nota**: Este campo solo se devuelve para facturas 'cerradas' (lo
            que significa que el período de facturación ha terminado y la
            factura ha sido emitida). Si el período de facturación aún está en
            curso, devolvemos `null`.
          example: '92792126019929279212650822221989319252576'
    TransactionCreditCardDataOpenFinanceBrazil:
      type: object
      nullable: true
      required:
        - collected_at
        - bill_name
        - bill_status
        - previous_bill_total
        - bill_amount
        - card_number
        - fee_type
        - fee_type_additional_info
        - credits_type
        - credits_type_additional_info
        - installment_identifier
        - number_of_installments
      description: >-
        Datos adicionales proporcionados por la institución para transacciones
        con tarjeta de crédito.
      properties:
        collected_at:
          $ref: '#/components/schemas/collected_at'
        bill_name:
          type: string
          nullable: true
          description: >-
            El título de la factura mensual de la tarjeta de crédito a la que
            pertenece la transacción. El formato del valor devuelto es
            específico de la institución; sin embargo, algunos ejemplos comunes
            son:


            - diciembre-2021

            - dec-2021

            - dec-21


            > **Nota**: Este campo solo se devuelve para facturas 'cerradas' (lo
            que significa que el período de facturación ha terminado y la
            factura ha sido emitida). Si el período de facturación aún está en
            curso, devolvemos `null`.
          example: apr-2020
        bill_due_date:
          type: string
          nullable: true
          format: date
          description: >-
            La fecha en que se debe pagar la factura, en formato `YYYY-MM-DD`.


            > **Nota**: Este campo solo se devuelve para facturas 'cerradas' (lo
            que significa que el período de facturación ha terminado y la
            factura ha sido emitida). Si el período de facturación aún está en
            curso, devolvemos `null`.
          example: '2023-06-17'
        bill_internal_identification:
          type: string
          nullable: true
          minLength: 1
          maxLength: 100
          pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{0,99}$
          description: >-
            El identificador interno de la institución para la factura.


            > **Nota**: Este campo solo se devuelve para facturas 'cerradas' (lo
            que significa que el período de facturación ha terminado y la
            factura ha sido emitida). Si el período de facturación aún está en
            curso, devolvemos `null`.
          example: 927921260199292792126508222219893192525A6
        bill_status:
          type: string
          nullable: true
          description: >-
            **Nota:** Este campo no es aplicable para OFDA Brasil y devolverá
            `null`.
          example: null
        previous_bill_total:
          type: string
          nullable: true
          description: >-
            **Nota:** Este campo no es aplicable para OFDA Brasil y devolverá
            `null`.
          example: null
        bill_amount:
          type: number
          nullable: true
          format: float
          pattern: ^-?\d{1,15}\.\d{2,4}$
          description: >-
            El monto de la factura, a partir de `collected_at`. Para más
            información, consulta `credit_card_bill`.
          example: 300
        card_number:
          type: string
          minLength: 1
          maxLength: 100
          pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{0,99}$
          description: >-
            El número de la tarjeta de crédito.


            **Nota:** A menudo, esto es solo los últimos cuatro dígitos de la
            tarjeta de crédito.


            > **No anulable:** La red de finanzas abiertas de Brasil debe
            devolver un valor.
          example: '4453'
        fee_type:
          $ref: '#/components/schemas/EnumTransactionCreditCardDataFeeType'
        fee_type_additional_info:
          type: string
          nullable: true
          maxLength: 140
          pattern: ^[\w\W\s]{0,140}$
          description: Información adicional sobre la tarifa.
          example: ATM withdrawal in Curitiba.
        credits_type:
          $ref: '#/components/schemas/EnumTransactionCreditCardDataCreditType'
        credits_type_additional_info:
          type: string
          nullable: true
          maxLength: 140
          pattern: ^[\w\W\s]{0,140}$
          description: Información adicional sobre el tipo de crédito.
          example: Some additional information.
        installment_identifier:
          type: string
          maxLength: 140
          pattern: ^[\w\W\s]{0,140}$
          description: >-
            Un identificador para la cuota, según la institución.


            > **No anulable:** La red de finanzas abiertas de Brasil debe
            devolver un valor.
          example: PARCELA_896
        number_of_installments:
          type: integer
          nullable: true
          maximum: 999
          description: >-
            El número total de cuotas para la transacción con tarjeta, si
            corresponde.
          example: 4
        credit_card_bill:
          $ref: '#/components/schemas/TransactionCreditCardBill'
    EnumTransactionCounterpartyType:
      type: string
      nullable: true
      enum:
        - INDIVIDUAL
        - COMPANY
        - null
      description: >-
        El tipo de contraparte de la transacción. Devolvemos uno de los
        siguientes valores:

          - `INDIVIDUAL`
          - `COMPANY`
          - `null`
      example: INDIVIDUAL
    TransactionCounterparty:
      type: object
      nullable: true
      required:
        - type
        - document_number
        - clearing_code
        - agency
        - check_digit
        - number
      description: Información sobre la otra parte de esta transacción, si está disponible.
      properties:
        type:
          $ref: '#/components/schemas/EnumTransactionCounterpartyType'
        document_number:
          type: string
          nullable: true
          maxLength: 11
          pattern: ^\d{11}$
          description: |-
            El número de documento del representante.

            **Nota**:

            Para Brasil:
              - Cuando el `type` es `INDIVIDUAL`, este es el número de CPF.
              - Cuando el `type` es `COMPANY`, este es el número de CNPJ.
          example: '73677831148'
        clearing_code:
          type: string
          nullable: true
          maxLength: 3
          pattern: ^\d{3}$
          description: El código de compensación bancaria.
          example: '001'
        agency:
          type: string
          nullable: true
          maxLength: 4
          pattern: ^\d{1,4}$
          description: El código de sucursal donde se abrió la cuenta.
          example: '6272'
        check_digit:
          type: string
          nullable: true
          maxLength: 2
          pattern: '[\w\W\s]*'
          description: El dígito de control del número de cuenta, si corresponde.
          example: '7'
        number:
          type: string
          nullable: true
          maxLength: 20
          pattern: ^\d{8,20}$
          description: El número de cuenta del producto.
          example: '24550245'
    TransactionLoanDataFees:
      type: object
      nullable: true
      required:
        - name
        - code
        - amount
      description: >-
        Detalles relacionados con las tarifas asociadas con este pago. Solo
        aplicable cuando `is_detached` = `true`.
      properties:
        name:
          type: string
          maxLength: 140
          pattern: ^[\w\W\s]{0,140}$
          description: >-
            El nombre de la tarifa.


            > **No anulable:** Se debe devolver un valor por la red de finanzas
            abiertas de Brasil cuando el campo `fees` está presente.
          example: Reavaliação periódica do bem
        code:
          type: string
          maxLength: 140
          pattern: ^[\w\W\s]{0,140}$
          description: >-
            El código de la institución para la tarifa.


            > **No anulable:** Se debe devolver un valor por la red de finanzas
            abiertas de Brasil cuando el campo `fees` está presente.
          example: aval_bem
        amount:
          type: number
          nullable: true
          format: float
          pattern: ^-?\d{1,15}\.\d{2,4}$
          description: >-
            El monto de la tarifa.


            > **No anulable:** Se debe devolver un valor por la red de finanzas
            abiertas de Brasil cuando el campo `fees` está presente.
          example: 8903.77
    TransactionLoanDataCharges:
      type: object
      nullable: true
      required:
        - type
        - info
        - amount
      description: >-
        Detalles relacionados con los cargos asociados con este pago. Solo
        aplicable cuando `is_detached` = `true`.
      properties:
        type:
          type: string
          maxLength: 140
          pattern: ^[\w\W\s]{0,140}$
          description: >-
            El tipo de cargo.


            > **No anulable:** Se debe devolver un valor por la red de finanzas
            abiertas de Brasil cuando el campo `charges` está presente.
          example: MULTA_ATRASO_PAGAMENTO
        info:
          type: string
          maxLength: 140
          pattern: ^[\w\W\s]{0,140}$
          description: Información adicional sobre el `type` de cargo.
          example: Late payment charge.
        amount:
          type: number
          format: float
          pattern: ^-?\d{1,15}\.\d{2,4}$
          description: >-
            El monto del cargo.


            > **No anulable:** La red de finanzas abiertas de Brasil debe
            devolver un valor cuando el campo `charges` está presente.
          example: 8903.77
    TransactionLoanDataOpenFinanceBrazil:
      type: object
      nullable: true
      required:
        - is_detached
        - installment_it
        - fees
        - charges
      description: >-
        Información sobre los datos transaccionales del préstamo, si
        corresponde.
      properties:
        is_detached:
          type: boolean
          description: >-
            Boolean para indicar si este pago de préstamo fue parte del
            calendario de pagos original.


            > **No anulable:** La red de finanzas abiertas de Brasil debe
            devolver un valor.
          example: true
        installment_id:
          type: string
          nullable: true
          minLength: 1
          maxLength: 100
          pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{0,99}$
          description: El ID único de la institución para esta cuota de pago.
          example: WGx0aExYcEJMVm93TFRsZFcyRXRla0V0V2pBdE9Wd3RYWH
        fees:
          type: array
          description: >-
            Detalles relacionados con las tarifas asociadas con este pago. Solo
            aplicable cuando `is_detached` = `true`.
          items:
            $ref: '#/components/schemas/TransactionLoanDataFees'
        charges:
          type: array
          minItems: 0
          description: >-
            Detalles relacionados con los cargos asociados con este pago. Solo
            aplicable cuando `is_detached` = `true`.
          items:
            $ref: '#/components/schemas/TransactionLoanDataCharges'
    EnumTransactionPaymentType:
      type: string
      nullable: true
      enum:
        - FULL
        - INSTALLMENT
        - null
      description: >-
        El tipo de pago de la transacción. Devolvemos uno de los siguientes
        valores:

          - `FULL`
          - `INSTALLMENT`
          - `null`
      example: FULL
    TransactionOpenFinanceBrazil:
      type: object
      title: Objeto de Transacción (Brasil)
      x-tags:
        - Transactions
      required:
        - id
        - internal_identification
        - account
        - collected_at
        - created_at
        - value_date
        - accounting_date
        - amount
        - local_currency_amount
        - balance
        - currency
        - description
        - observations
        - merchant
        - category
        - subcategory
        - reference
        - type
        - status
        - credit_card_data
        - counterparty
        - loan_data
        - payment_type
        - operation_type
        - operation_type_additional_info
        - mcc
      properties:
        id:
          $ref: '#/components/schemas/id'
        internal_identification:
          type: string
          minLength: 1
          maxLength: 100
          pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{0,99}$
          description: >-
            La identificación interna de la institución para la transacción.


            > **No anulable:** La red de finanzas abiertas de Brasil debe
            devolver un valor.
          example: TXpRMU9UQTROMWhZV2xSU1FUazJSMDl
        account:
          $ref: '#/components/schemas/AccountOpenFinanceBrazil'
        collected_at:
          $ref: '#/components/schemas/collected_at'
        created_at:
          $ref: '#/components/schemas/created_at'
        value_date:
          type: string
          format: date
          pattern: ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])$
          description: >-
            La fecha en que ocurrió la transacción, en formato `YYYY-MM-DD`.


            > **No anulable:** La red de finanzas abiertas de Brasil debe
            devolver un valor.
          example: '2019-10-23'
        transacted_at:
          type: string
          format: date-time
          pattern: >-
            (^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)\.(?:[0-9]){3}Z$)
          description: >-
            La marca de tiempo ISO-8601 de cuando ocurrió la transacción (en la
            zona horaria UTC).


            > **Nota:** Para transacciones que ocurrieron antes del 31.01.2024,
            la marca de tiempo puede indicar solo el día (por ejemplo,
            `2016-01-29T00:00:00.000Z`). Sin embargo, las transacciones que
            ocurrieron después de esta fecha deben incluir la fecha y la hora
            (`2024-02-20T12:29:03.374Z`).


            > **Instituciones que no cumplen con este formato:**

            > Algunas instituciones pueden no proporcionar la hora exacta de la
            transacción. En este caso, la marca de tiempo se establecerá en
            `00:00:00.000Z`.

            > Belvo ha identificado las siguientes instituciones como no
            cumpliendo con la regulación y ha planteado el problema a los
            reguladores: Bradesco, Itau y Sicoob.


            > **No anulable:** La red de finanzas abiertas de Brasil debe
            devolver un valor para **transacciones de tarjeta de crédito y
            cuenta corriente**.
          example: '2024-02-20T12:29:03.374Z'
        accounting_date:
          type: string
          nullable: true
          description: >-
            La fecha en que la transacción fue procesada y contabilizada por la
            institución, en formato `YYYY-MM-DD`.  

            > **No anulable:** La red de finanzas abiertas de Brasil debe
            devolver un valor para **transacciones con tarjeta de crédito**.
          example: '2019-10-23'
        inferred_accounting_date:
          type: string
          format: date
          description: >-
            En el caso de que la transacción ocurra en un fin de semana o día
            festivo, Belvo inferirá la fecha en que la transacción es
            contabilizada por la institución. Normalmente, este es el siguiente
            día hábil.
          example: '2019-10-23'
        amount:
          type: number
          format: float
          pattern: ^\d{1,15}\.\d{2,4}$
          description: >-
            El monto de la transacción.  

            ℹ️ El monto mostrado siempre es positivo, ya que indicamos la
            dirección de la transacción en el parámetro `type`.  

            > **No anulable:** La red de finanzas abiertas de Brasil debe
            devolver un valor.
          example: 2145.45
        local_currency_amount:
          type: number
          nullable: true
          format: float
          maxLength: 20
          pattern: ^\d{1,15}\.\d{2,4}$
          description: >-
            El valor de la transacción en la moneda local.


            > **No anulable:** La red de finanzas abiertas de Brasil debe
            devolver un valor para las **transacciones con tarjeta de crédito**.
          example: 7623.64
        balance:
          type: number
          nullable: true
          format: float
          description: >-
            **Nota:** Este campo no es aplicable para OF Brazil y devolverá
            null.
          example: null
        currency:
          type: string
          nullable: true
          maxLength: 3
          pattern: ^[A-Z]{3}$
          description: El código de moneda de tres letras (ISO-4217).
          example: BRL
        description:
          type: string
          nullable: true
          description: >-
            La descripción de la transacción proporcionada por la institución.
            Generalmente, este es el texto que el usuario final ve en la
            plataforma en línea.


            > **No anulable:** La red de finanzas abiertas de Brasil debe
            devolver un valor.
          example: SEVEN BUDDHAS RFC:XXXXXXXXXX
        observations:
          type: string
          nullable: true
          description: >-
            **Nota:** Este campo no es aplicable para OF Brazil y devolverá
            null.
          example: null
        merchant:
          $ref: '#/components/schemas/TransactionMerchantData'
        category:
          $ref: '#/components/schemas/EnumTransactionCategory'
        subcategory:
          $ref: '#/components/schemas/EnumTransactionSubcategory'
        reference:
          type: string
          nullable: true
          maxLength: 128
          description: >-
            **Nota:** Este campo no es aplicable para OF Brazil y devolverá
            null.
          example: null
        type:
          $ref: '#/components/schemas/EnumTransactionType'
        status:
          $ref: '#/components/schemas/EnumTransactionStatus'
        credit_card_data:
          $ref: '#/components/schemas/TransactionCreditCardDataOpenFinanceBrazil'
        counterparty:
          $ref: '#/components/schemas/TransactionCounterparty'
        loan_data:
          $ref: '#/components/schemas/TransactionLoanDataOpenFinanceBrazil'
        payment_type:
          $ref: '#/components/schemas/EnumTransactionPaymentType'
        operation_type:
          type: string
          maxLength: 50
          pattern: ^[A-Za-z_]{0,50}$
          description: >-
            El tipo de transacción. Por ejemplo, un pago PIX o un depósito.


            > **No anulable:** La red de finanzas abiertas de Brasil debe
            devolver un valor para **transacciones de cuentas que no sean de
            préstamo**.
          example: TRANSFERENCIA_MESMA_INSTITUICAO
        operation_type_additional_info:
          type: string
          nullable: true
          maxLength: 140
          pattern: ^\S[\s\S]*$
          description: Información adicional sobre el `operation_type`, si corresponde.
          example: Internal transfer.
        mcc:
          type: integer
          nullable: true
          format: int32
          pattern: ^[0-9]{4}$
          description: >-
            El código de categoría de comerciante (MCC) de cuatro dígitos
            (compatible con ISO-18245) para la transacción. Este campo solo es
            aplicable para transacciones con tarjeta de crédito.
          example: 5137
    date_from:
      type: string
      format: date
      pattern: ^\d{4}-\d{2}-\d{2}$
      minLength: 10
      maxLength: 10
      description: >-
        La fecha desde la cual deseas comenzar a obtener datos, en formato
        `YYYY-MM-DD`.


        ⚠️ El valor de `date_from` no puede ser mayor que `date_to`.
      example: '2020-08-05'
    date_to:
      type: string
      format: date
      pattern: ^\d{4}-\d{2}-\d{2}$
      minLength: 10
      maxLength: 10
      description: >-
        La fecha en la que deseas dejar de recibir datos, en formato
        `YYYY-MM-DD`.


        ⚠️ El valor de `date_to` no puede ser mayor que la fecha de hoy (en
        otras palabras, no se permiten fechas futuras).
      example: '2020-10-05'
    EnumBillFinanceChargeType:
      type: string
      nullable: true
      enum:
        - LATE_PAYMENT_INTEREST
        - LATE_FEE
        - ARREARS_INTEREST
        - IOF
        - NO_CHARGE
        - OTHER
        - null
      description: >-
        El tipo de cargo financiero aplicado a la factura. Devolvemos uno de los
        siguientes valores:

          - `LATE_PAYMENT_INTEREST`
          - `LATE_FEE`
          - `ARREARS_INTEREST`
          - `IOF`
          - `NO_CHARGE`
          - `OTHER`
          - `null`
      example: LATE_PAYMENT_INTEREST
    BillFinanceCharges:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/EnumBillFinanceChargeType'
        additional_info:
          type: string
          nullable: true
          maxLength: 140
          pattern: '[\w\W\s]*'
          description: Información adicional sobre el cargo financiero.
          example: Paid 15 days late, fee applied.
        currency:
          type: string
          nullable: true
          maxLength: 3
          pattern: ^[A-Z]{3}$
          description: El código de moneda de tres letras (ISO-4217).
          example: BRL
        amount:
          type: number
          nullable: true
          format: float
          minLength: 1
          maxLength: 20
          pattern: ^\d{1,15}\.\d{2,4}$
          description: El monto del cargo financiero.
          example: 91.89
    EnumBillPaymentType:
      type: string
      nullable: true
      enum:
        - INSTALLMENT
        - FULL
        - OTHER
        - null
      description: |-
        El tipo de pago. Devolvemos uno de los siguientes valores:

          - `INSTALLMENT`
          - `FULL`
          - `OTHER`
          - `null`
      example: INSTALLMENT
    EnumBillPaymentPaymentMode:
      type: string
      nullable: true
      enum:
        - DIRECT_DEBIT
        - BANK_SLIP
        - SALARY_DEDUCTION
        - PIX
        - null
      description: >-
        El método en el cual se realizó el pago. Devolvemos uno de los
        siguientes valores:

          - `DIRECT_DEBIT`
          - `BANK_SLIP`
          - `SALARY_DEDUCTION`
          - `PIX`
          - `null`
      example: DIRECT_DEBIT
    BillPayments:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/EnumBillPaymentType'
        payment_date:
          type: string
          nullable: true
          format: date
          maxLength: 10
          pattern: ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])$
          description: La fecha en que se realizó el pago, en formato `YYYY-MM-DD`.
          example: '2021-09-04'
        payment_mode:
          $ref: '#/components/schemas/EnumBillPaymentPaymentMode'
        currency:
          type: string
          nullable: true
          maxLength: 3
          pattern: ^[A-Z]{3}$
          description: El código de moneda de tres letras (ISO-4217).
          example: BRL
        amount:
          type: number
          nullable: true
          format: float
          minLength: 1
          maxLength: 20
          pattern: ^\d{1,15}\.\d{2,4}$
          description: El monto del pago.
          example: 500.15
    Bill:
      type: object
      title: Objeto de Factura (OFDA Brasil)
      x-tags:
        - Bills
      properties:
        id:
          $ref: '#/components/schemas/id'
        created_at:
          $ref: '#/components/schemas/created_at'
        collected_at:
          $ref: '#/components/schemas/collected_at'
        account:
          $ref: '#/components/schemas/AccountOpenFinanceBrazil'
        internal_identification:
          type: string
          nullable: true
          minLength: 1
          maxLength: 100
          pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{0,99}$
          description: El identificador interno de la institución para la factura.
          example: '92792126019929279212650822221989319252576'
        bill_name:
          type: string
          nullable: true
          description: >-
            El título de la factura mensual de la tarjeta de crédito a la que
            pertenece la transacción. El formato del valor devuelto es
            específico de la institución; sin embargo, algunos ejemplos comunes
            son:


            - diciembre-2021

            - dec-2021

            - dec-21


            > **Nota**: Este campo solo se devuelve para facturas 'cerradas' (lo
            que significa que el período de facturación ha terminado y la
            factura ha sido emitida). Si el período de facturación aún está en
            curso, devolvemos `null`.
          example: apr-2020
        due_date:
          type: string
          nullable: true
          format: date
          maxLength: 10
          pattern: ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])$
          description: La fecha en que se debe pagar la factura, en formato `YYYY-MM-DD`.
          example: '2021-09-06'
        currency:
          type: string
          nullable: true
          maxLength: 3
          pattern: ^[A-Z]{3}$
          description: El código de moneda de tres letras (ISO-4217).
          example: BRL
        total_amount:
          type: number
          nullable: true
          format: float
          minLength: 1
          maxLength: 20
          pattern: ^\d{1,15}\.\d{2,4}$
          description: El monto total de la factura.
          example: 45391.89
        minimum_amount:
          type: number
          nullable: true
          format: float
          minLength: 1
          maxLength: 20
          pattern: ^\d{1,15}\.\d{2,4}$
          description: La cantidad mínima a pagar.
          example: 391.89
        is_installment:
          type: boolean
          nullable: true
          description: Boolean para indicar si esta factura se puede pagar en cuotas.
          example: false
        finance_charges:
          type: array
          minItems: 1
          items:
            $ref: '#/components/schemas/BillFinanceCharges'
        payments:
          type: array
          minItems: 0
          items:
            $ref: '#/components/schemas/BillPayments'
    EnumOwnerMaritalStatus:
      type: string
      nullable: true
      enum:
        - SINGLE
        - MARRIED
        - WIDOWED
        - SEPARATED
        - DIVORCED
        - CIVIL_UNION
        - OTHER
      description: |-
        El estado civil del individuo. Devolvemos uno de los siguientes valores:

          - `SINGLE`
          - `MARRIED`
          - `WIDOWED`
          - `SEPARATED`
          - `DIVORCED`
          - `CIVIL_UNION`
          - `OTHER`
      example: SINGLE
    EnumOwnerGender:
      type: string
      nullable: true
      enum:
        - FEMALE
        - MALE
        - OTHER
      description: |-
        El género del individuo. Devolvemos uno de los siguientes valores:

          - `FEMALE`
          - `MALE`
          - `OTHER`
      example: FEMALE
    OwnerDocumentIdOpenFinanceBrazil:
      type: object
      required:
        - document_type
        - document_number
      description: >-
        Información sobre el documento de identificación que el propietario
        proporcionó al banco.


        > **Non-nullable:** La red de finanzas abiertas de Brasil debe devolver
        un valor.
      properties:
        document_type:
          type: string
          description: >-
            El tipo de documento que el propietario proporcionó a la institución
            para abrir la cuenta. Los tipos de documentos comunes son:


            🇧🇷 Brasil

            - `CPF` (*Cadastro de Pessoas Físicas*)

            - `CNPJ` (*Cadastro Nacional de Pessoas Jurídicas*)


            > **Non-nullable:** La red de finanzas abiertas de Brasil debe
            devolver un valor.
          example: CPF
        document_number:
          type: string
          description: >-
            El número de identificación del documento.


            > **No anulable:** La red de finanzas abiertas de Brasil debe
            devolver un valor.
          example: 235578435-S
    EnumOwnerIndividualDocumentIdType:
      type: string
      nullable: true
      enum:
        - DRIVERS_LICENSE
        - PASSPORT
        - ID_CARD
        - FISCAL_ID
        - FOREIGNER_REGISTRATION_CARD
        - OTHER
        - null
      description: >-
        El tipo de documento de identificación. Devolvemos uno de los siguientes
        valores:

          - `DRIVERS_LICENSE`
          - `PASSPORT`
          - `ID_CARD`
          - `FISCAL_ID`
          - `FOREIGNER_REGISTRATION_CARD`
          - `OTHER`
          - `null`
      example: DRIVERS_LICENSE
    OwnerIndividualDocumentIds:
      type: object
      nullable: true
      required:
        - type
        - type_additional_info
        - number
        - check_digit
        - issue_date
        - expiration_date
        - country_of_issuance
        - additional_info
      description: >-
        Información detallada sobre documentos adicionales proporcionados para
        verificar la identidad de las personas.
      properties:
        type:
          $ref: '#/components/schemas/EnumOwnerIndividualDocumentIdType'
        type_additional_info:
          type: string
          nullable: true
          maxLength: 70
          pattern: ^[\w\W\s]{0,70}$
          description: >-
            Información adicional sobre el tipo de documento.


            > Nota: Para documentos de identificación empresarial, este campo
            debe devolver un valor de la red de finanzas abiertas de Brasil.
          example: Learner's licence
        number:
          type: string
          maxLength: 40
          pattern: ^[\w\W\s]{0,40}$
          description: >-
            El número del documento de identificación.


            > **No anulable:** La red de finanzas abiertas de Brasil debe
            devolver un valor.
          example: DL-7896829-7
        check_digit:
          type: string
          maxLength: 2
          pattern: ^[\w\W\s]{0,2}$
          description: >-
            El dígito de verificación del documento de identificación.


            > **No anulable:** La red de finanzas abiertas de Brasil debe
            devolver un valor.
          example: '7'
        issue_date:
          type: string
          nullable: true
          format: date
          maxLength: 10
          pattern: ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])$
          description: >-
            La fecha en que se emitió el documento de identificación, en formato
            `YYYY-MM-DD`.
          example: '2019-01-01'
        expiration_date:
          type: string
          nullable: true
          format: date
          maxLength: 10
          pattern: ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])$
          description: >-
            La fecha de vencimiento del documento de identificación, en formato
            `YYYY-MM-DD`.
          example: '2019-01-01'
        country_of_issuance:
          type: string
          nullable: true
          maxLength: 3
          pattern: ^[\w]{3}$
          description: >-
            El código de país de tres letras que emitió el documento (en formato
            ISO-3166 Alpha 3).


            Este campo debe ser devuelto cuando el `type` es `PASSPORT`.
          example: CAN
        additional_info:
          type: string
          nullable: true
          maxLength: 100
          pattern: ^[\w\W\s]{0,100}$
          description: Información adicional sobre el documento de identificación.
          example: The document has water damage
    OwnerIndividualNationalityDocumentId:
      type: object
      nullable: true
      required:
        - type
        - type_additional_info
        - number
        - issue_date
        - expiration_date
        - country_of_issuance
        - additional_info
      description: >-
        Información detallada sobre documentos adicionales proporcionados para
        verificar la identidad de las personas.
      properties:
        type:
          $ref: '#/components/schemas/EnumOwnerIndividualDocumentIdType'
        number:
          type: string
          maxLength: 40
          pattern: ^[\w\W\s]{0,40}$
          description: >-
            El número del documento de identificación.


            > **No anulable:** La red de finanzas abiertas de Brasil debe
            devolver un valor.
          example: DL-7896829-7
        issue_date:
          type: string
          nullable: true
          format: date
          maxLength: 10
          pattern: ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])$
          description: >-
            La fecha en que se emitió el documento de identificación, en formato
            `YYYY-MM-DD`.
          example: '2019-01-01'
        expiration_date:
          type: string
          nullable: true
          format: date
          maxLength: 10
          pattern: ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])$
          description: >-
            La fecha de vencimiento del documento de identificación, en formato
            `YYYY-MM-DD`.
          example: '2019-01-01'
        country_of_issuance:
          type: string
          nullable: true
          maxLength: 3
          pattern: ^[\w]{3}$
          description: >-
            El código de país de tres letras que emitió el documento (en formato
            ISO-3166 Alpha 3).


            Este campo debe ser devuelto cuando el `type` es `PASSPORT`.
          example: CAN
        additional_info:
          type: string
          nullable: true
          maxLength: 100
          pattern: ^[\w\W\s]{0,100}$
          description: Información adicional sobre el documento de identificación.
          example: The document has water damage
    OwnerNationalities:
      type: object
      required:
        - info
        - documents
      description: Información detallada sobre las nacionalidades del individuo.
      properties:
        info:
          type: string
          nullable: true
          pattern: ^\S[\s\S]*$
          maxLength: 40
          description: La nacionalidad del individuo.
          example: CAN
        documents:
          type: array
          items:
            $ref: '#/components/schemas/OwnerIndividualNationalityDocumentId'
    OwnerEmails:
      type: object
      nullable: true
      required:
        - is_main
        - email
      description: >-
        Lista adicional de correos electrónicos proporcionada por el
        propietario.
      properties:
        is_main:
          type: boolean
          description: >-
            Boolean para indicar si este es el correo electrónico principal del
            usuario.


            > **No anulable:** La red de finanzas abiertas de Brasil debe
            devolver un valor.
          example: true
        email:
          type: string
          maxLength: 320
          pattern: ^[\w\W\s]{0,320}$
          description: >-
            La dirección de correo electrónico del usuario.


            > **No anulable:** La red de finanzas abiertas de Brasil debe
            devolver un valor.
          example: homen_morcego@gmail.com
    OwnerAddresses:
      type: object
      nullable: true
      required:
        - is_main
        - address
        - additional_info
        - district_name
        - town
        - town_code
        - state
        - postcode
        - country_name
        - country_code
        - latitude
        - longitude
      description: Información detallada sobre las direcciones del propietario.
      properties:
        is_main:
          type: boolean
          description: >-
            Boolean para indicar si esta es la dirección principal del usuario.


            > **No anulable:** La red de finanzas abiertas de Brasil debe
            devolver un valor.
          example: true
        address:
          type: string
          maxLength: 150
          pattern: ^[\w\W\s]{0,150}$
          description: >-
            La dirección del usuario.


            > **No anulable:** La red de finanzas abiertas de Brasil debe
            devolver un valor.
          example: Av Naburo Ykesaki, 1270
        additional_info:
          type: string
          nullable: true
          maxLength: 150
          pattern: ^[\w\W\s]{0,150}$
          description: Información adicional sobre la dirección del usuario.
          example: In between two palm trees
        district_name:
          type: string
          nullable: true
          maxLength: 50
          pattern: ^[\w\W\s]{0,50}$
          description: El distrito de la dirección.
          example: CENTRO
        town:
          type: string
          maxLength: 50
          pattern: ^[\w\W\s]{0,50}$
          description: >-
            La ciudad del usuario.


            > **No anulable:** La red de finanzas abiertas de Brasil debe
            devolver un valor.
          example: Brasilia
        town_code:
          type: string
          nullable: true
          maxLength: 7
          pattern: \d{7}$
          description: |-
            El código de siete dígitos para la ciudad, si corresponde.

            Para Brasil, este es el código de ciudad del IBGE.
          example: '3550308'
        state:
          type: string
          nullable: true
          maxLength: 2
          pattern: ^[\w\W\s]{0,2}$
          description: El estado en el que se encuentra la dirección.
          example: SP
        postcode:
          type: string
          maxLength: 8
          pattern: ^\d{8}$
          description: >-
            El código postal de la dirección.


            > **No anulable:** La red de finanzas abiertas de Brasil debe
            devolver un valor.
          example: '17500001'
        country_name:
          type: string
          maxLength: 80
          pattern: ^[\w\W\s]{0,80}$
          description: >-
            El nombre del país.


            > **No anulable:** Se debe devolver un valor por la red de finanzas
            abiertas de Brasil.
          example: Brasil
        country_code:
          type: string
          nullable: true
          maxLength: 3
          pattern: ^([A-Z]{3})$
          description: El código de país de tres letras (cumple con ISO-3166 Alpha 3).
          example: BRA
        latitude:
          type: string
          nullable: true
          maxLength: 13
          pattern: ^-?\d{1,2}\.\d{1,9}$
          description: La coordenada de latitud geográfica.
          example: '-23.5475000'
        longitude:
          type: string
          nullable: true
          maxLength: 13
          pattern: ^-?\d{1,3}\.\d{1,8}$
          description: La coordenada de longitud geográfica.
          example: '-46.6361100'
    EnumOwnerPhoneNumberType:
      type: string
      nullable: true
      enum:
        - LANDLINE
        - MOBILE
        - OTHER
        - null
      description: |-
        El tipo de número de teléfono. Devolvemos uno de los siguientes valores:

          - `LANDLINE`
          - `MOBILE`
          - `OTHER`
          - `null`
      example: MOBILE
    OwnerPhoneNumbers:
      type: object
      nullable: true
      required:
        - is_main
        - type
        - additional_info
        - number
        - country_code
        - area_code
        - extension
      description: Información detallada sobre los `phone_number`s de los propietarios.
      properties:
        is_main:
          type: boolean
          description: >-
            Boolean para indicar si este es el número de teléfono principal del
            usuario.


            > **No anulable:** La red de finanzas abiertas de Brasil debe
            devolver un valor.
          example: true
        type:
          $ref: '#/components/schemas/EnumOwnerPhoneNumberType'
        additional_info:
          type: string
          nullable: true
          maxLength: 100
          pattern: ^[\w\W\s]{0,100}$
          description: Información adicional sobre el número de teléfono.
          example: This is their work mobile number.
        number:
          type: string
          maxLength: 11
          pattern: ^([0-9]{8,11})$
          description: >-
            El número de teléfono (sin incluir los códigos de país, área o
            extensión).


            > **No anulable:** La red de finanzas abiertas de Brasil debe
            devolver un valor.
          example: '29875132'
        country_code:
          type: string
          nullable: true
          maxLength: 4
          pattern: ^\d{1,4}$
          description: 'El código de marcación del país. Por ejemplo: `351` (sin `+`).'
          example: '351'
        area_code:
          type: string
          nullable: true
          maxLength: 2
          pattern: ^\d{1,2}$
          description: El código de marcación de área.
          example: '21'
        extension:
          type: string
          nullable: true
          maxLength: 5
          pattern: ^\d{1,5}$
          description: El código de la extensión.
          example: '932'
    EnumOwnerFiliationType:
      type: string
      nullable: true
      enum:
        - MOTHER
        - FATHER
        - null
      description: |-
        La relación familiar. Devolvemos uno de los siguientes valores:

          - `MOTHER`
          - `FATHER`
          - `null`
      example: MOTHER
    OwnerFiliations:
      type: object
      required:
        - type
        - civil_name
        - social_name
      description: Información sobre cualquier relación familiar del individuo.
      properties:
        type:
          $ref: '#/components/schemas/EnumOwnerFiliationType'
        civil_name:
          type: string
          maxLength: 70
          pattern: ^[\w\W\s]{0,70}$
          description: >-
            El nombre completo de la persona.


            > **No anulable:** La red de finanzas abiertas de Brasil debe
            devolver un valor.
          example: Bruce Wayne
        social_name:
          type: string
          nullable: true
          maxLength: 70
          pattern: ^[\w\W\s]{0,70}$
          description: El nombre social de la persona.
          example: The Dark Knight
    EnumOwnerIndividualFinancialProfileOccupationCode:
      type: string
      nullable: true
      enum:
        - BRAZIL_PUBLIC_OFFICE
        - BRAZIL_OCCUPATION_CODE
        - OTHER
        - null
      description: >-
        El área de empleo del individuo. Devolvemos uno de los siguientes
        valores:

          - `BRAZIL_PUBLIC_OFFICE`
          - `BRAZIL_OCCUPATION_CODE`
          - `OTHER`
          - `null`
      example: BRAZIL_OCCUPATION_CODE
    EnumOwnerInformedIncomeFrequency:
      type: string
      nullable: true
      enum:
        - DAILY
        - WEEKLY
        - FORTNIGHTLY
        - MONTHLY
        - BIMONTHLY
        - QUARTERLY
        - BIANNUALLY
        - ANNUALLY
        - OTHERS
      description: >-
        Indica con qué frecuencia el individuo recibe su salario. Devolvemos uno
        de los siguientes valores:

          - `DAILY`
          - `WEEKLY`
          - `FORTNIGHTLY`
          - `MONTHLY`
          - `BIMONTHLY`
          - `QUARTERLY`
          - `BIANNUALLY`
          - `ANNUALLY`
          - `OTHERS`
      example: MONTHLY
    OwnerIndividualInformedIncome:
      type: object
      required:
        - frequency
        - amount
        - currency
        - date
      description: >-
        Información sobre los ingresos reportados del individuo.


        > **No anulable:** La red de finanzas abiertas de Brasil debe devolver
        un valor.
      properties:
        frequency:
          $ref: '#/components/schemas/EnumOwnerInformedIncomeFrequency'
        amount:
          type: number
          format: float
          minLength: 1
          maxLength: 20
          pattern: ^\d{1,15}\.\d{2,4}$
          description: >-
            El ingreso reportado que recibe el individuo.


            > **No anulable:** La red de finanzas abiertas de Brasil debe
            devolver un valor.
          example: 45391.89
        currency:
          type: string
          maxLength: 3
          pattern: ^[A-Z]{3}$
          description: >-
            El código de moneda de tres letras (ISO-4217).


            > **No anulable:** La red de finanzas abiertas de Brasil debe
            devolver un valor.
          example: BRL
        date:
          type: string
          format: date
          maxLength: 10
          pattern: ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])$
          description: >-
            Fecha en la que el individuo recibió su salario por última vez.


            > **No anulable:** La red de finanzas abiertas de Brasil debe
            devolver un valor.
          example: '2020-03-19'
    OwnerIndividualPatrimony:
      type: object
      nullable: true
      required:
        - amount
        - currency
        - year
      description: >-
        Información sobre los activos reportados del individuo (si están
        disponibles).
      properties:
        amount:
          type: number
          format: float
          pattern: ^\d{1,15}\.\d{2,4}$
          description: >-
            Los activos reportados del individuo.


            > **No anulable:** Se debe devolver un valor por la red de finanzas
            abiertas de Brasil cuando el objeto `patrimony` está disponible.
          example: 45391.89
        currency:
          type: string
          maxLength: 3
          pattern: ^[A-Z]{3}$
          description: >-
            El código de moneda de tres letras (ISO-4217).


            > **No anulable:** La red de finanzas abiertas de Brasil debe
            devolver un valor cuando el objeto `patrimony` está disponible.
          example: BRL
        year:
          type: integer
          format: int32
          maximum: 2090
          minimum: 1700
          description: >-
            El año al que se aplican los activos reportados.


            > **No anulable:** La red de finanzas abiertas de Brasil debe
            devolver un valor cuando el objeto `patrimony` está disponible.
          example: 2020
    OwnerIndividualFinancialProfile:
      type: object
      nullable: true
      required:
        - company_id
        - occupation_code
        - occupation_description
        - informed_income
        - patrimony
      description: Información sobre el perfil financiero del individuo.
      properties:
        company_id:
          type: string
          nullable: true
          maxLength: 14
          pattern: ^\d{14}$
          description: El identificador de la empresa donde está empleado el individuo.
          example: '50685362000135'
        occuptation_code:
          $ref: >-
            #/components/schemas/EnumOwnerIndividualFinancialProfileOccupationCode
        occupation_description:
          type: string
          nullable: true
          maxLength: 100
          pattern: '[\w\W\s]*'
          description: Información sobre la ocupación del individuo.
          example: '01'
        informed_income:
          $ref: '#/components/schemas/OwnerIndividualInformedIncome'
        patrimony:
          $ref: '#/components/schemas/OwnerIndividualPatrimony'
    EnumOwnerProcuratorType:
      type: string
      nullable: true
      enum:
        - LEGAL_REPRESENTATIVE
        - ATTORNEY
        - null
      description: >-
        El tipo de representante que puede acceder y realizar cambios en la
        cuenta. Devolvemos uno de los siguientes valores:

          - `LEGAL_REPRESENTATIVE`
          - `ATTORNEY`
          - `null`
      example: LEGAL_REPRESENTATIVE
    OwnerProcurators:
      type: object
      nullable: true
      required:
        - type
        - civil_name
        - social_name
        - document_number
      description: >-
        Información sobre cualquier individuo o empresa que pueda actuar en
        nombre del propietario.
      properties:
        type:
          $ref: '#/components/schemas/EnumOwnerProcuratorType'
        civil_name:
          type: string
          maxLength: 70
          pattern: ^[\w\W]*$
          description: >-
            El nombre completo de los representantes.


            > **No anulable:** Se debe devolver un valor por la red de finanzas
            abiertas de Brasil si el campo `procurators` está disponible.
          example: Alfred Thaddeus Pennyworth
        social_name:
          type: string
          nullable: true
          maxLength: 70
          pattern: ^[\w\W]*$
          description: El nombre social de la persona.
          example: Alfred Pennyworth
        document_number:
          type: string
          maxLength: 11
          pattern: ^\d{11}$
          description: >-
            El número de documento del representante.


            **Nota**: Para individuos, este es el número de CPF de Brasil. Para
            empresas, este es el número de CNPJ de Brasil.


            > **Non-nullable:** Se debe devolver un valor por la red de finanzas
            abiertas de Brasil si el campo `procurators` está disponible.
          example: '73677831148'
    EnumOwnerIndividualProductType:
      type: string
      nullable: true
      enum:
        - SAVINGS_ACCOUNT
        - CHECKING_ACCOUNT
        - null
      description: >-
        Los productos adicionales que el individuo tiene en la institución.
        Devolvemos uno de los siguientes valores:

          - `SAVINGS_ACCOUNT`
          - `CHECKING_ACCOUNT`
          - `null`
      example: SAVINGS_ACCOUNT
    OwnerIndividualProducts:
      type: object
      nullable: true
      required:
        - type
        - subtype
        - agency
        - clearing_code
        - number
        - check_digit
      description: >-
        Detalles sobre cualquier producto adicional que la persona tenga con la
        institución.
      properties:
        type:
          $ref: '#/components/schemas/EnumOwnerIndividualProductType'
        subtype:
          type: string
          nullable: true
          description: >-
            El subtipo del producto que el individuo tiene en la institución.


            > **No anulable:** Se debe devolver un valor por la red de finanzas
            abiertas de Brasil si el campo `products` está disponible.
          example: CONJUNTA_SIMPLES
        agency:
          type: string
          nullable: true
          maxLength: 4
          pattern: ^\d{1,4}$
          description: El código de sucursal donde se abrió el producto.
          example: '6272'
        clearing_code:
          type: string
          maxLength: 3
          pattern: ^\d{3}$
          description: >-
            El código de compensación bancaria para el producto.


            > **No anulable:** Se debe devolver un valor por la red de finanzas
            abiertas de Brasil si el campo `products` está disponible.
          example: '001'
        number:
          type: string
          maxLength: 20
          pattern: ^\d{8,20}$
          description: >-
            El número de cuenta del producto.


            > **No anulable:** Se debe devolver un valor por la red de finanzas
            abiertas de Brasil si el campo `procurators` está disponible.
          example: '24550245'
        check_digit:
          type: string
          maxLength: 2
          pattern: '[\w\W\s]*'
          description: >-
            El dígito de control del número del producto.


            > **No anulable:** Se debe devolver un valor por la red de finanzas
            abiertas de Brasil si el campo `products` está disponible.
          example: '7'
    OwnerIndividualSalaryPortabilityRequests:
      type: object
      description: Detalles sobre la solicitud de portabilidad salarial.
      properties:
        employer_name:
          type: string
          maxLength: 80
          pattern: ^(?!\s)[\w\W\s]*[^\s]$
          description: El nombre del empleador.
          example: ACME Inc.
        employer_id_number:
          type: string
          minLength: 11
          maxLength: 14
          pattern: ^\d{14}$|^\d{11}$
          description: El CPF o CNPJ del empleador.
          example: 12345678901
        employer_bank_id_number:
          type: string
          minLength: 14
          maxLength: 14
          pattern: ^\d{14}$
          description: El CNPJ del banco del empleador.
          example: 12345678901234
        employer_bank_code:
          type: string
          minLength: 8
          maxLength: 8
          pattern: ^[0-9]{8}$
          description: >-
            El código ISPB (*Identificador de Sistema de Pagamentos Brasileiro*)
            del banco del empleador.
          example: 12345678
        portability_approval_date:
          type: string
          format: date
          maxLength: 10
          pattern: ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])$
          description: >-
            La fecha en que se aprobó la solicitud de portabilidad, en formato
            `YYYY-MM-DD`.
          example: '2024-04-01'
    OwnerIndividualPayrollAccounts:
      type: object
      description: Detalles sobre la cuenta bancaria de nómina.
      properties:
        employer_name:
          type: string
          maxLength: 80
          pattern: ^(?!\s)[\w\W\s]*[^\s]$
          description: El nombre del empleador.
          example: ACME Inc.
        employer_id_number:
          type: string
          minLength: 11
          maxLength: 14
          pattern: ^\d{14}$|^\d{11}$
          description: El CPF o CNPJ del empleador.
          example: 12345678901
        employer_bank_id_number:
          type: string
          minLength: 14
          maxLength: 14
          pattern: ^\d{14}$
          description: El CNPJ del banco del empleador.
          example: 12345678901234
        employer_bank_code:
          type: string
          minLength: 8
          maxLength: 8
          pattern: ^[0-9]{8}$
          description: >-
            El código ISPB (*Identificador de Sistema de Pagamentos Brasileiro*)
            del banco del empleador.
          example: 12345678
        account_opening_date:
          type: string
          format: date
          maxLength: 10
          pattern: ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])$
          description: >-
            La fecha en que se abrió la cuenta bancaria de salario, en formato
            `YYYY-MM-DD`.
          example: '2024-04-01'
    OwnerIndividualFinancialRelation:
      type: object
      nullable: true
      required:
        - start_date
        - product_services
        - product_services_additional_info
        - procurators
        - products
      description: >-
        Detalles sobre cualquier relación adicional que la persona tenga con la
        institución (por ejemplo, otras cuentas o productos que tenga con la
        institución).
      properties:
        start_date:
          type: string
          format: date-time
          maxLength: 20
          pattern: >-
            ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$
          description: >-
            La marca de tiempo ISO-8601 cuando comenzó la relación financiera
            entre el individuo y la institución.


            > **No anulable:** La red de finanzas abiertas de Brasil debe
            devolver un valor.
          example: '2021-05-21T08:30:00Z'
        product_services:
          type: array
          minItems: 1
          description: >-
            Una lista de productos que el individuo tiene con la institución.


            > **No anulable:** La red de finanzas abiertas de Brasil debe
            devolver un valor.
          items:
            type: string
            description: El nombre del producto, según la institución.
            example: CONTA_DEPOSITO_A_VISTA
        product_services_additional_info:
          type: string
          nullable: true
          maxLength: 100
          pattern: ^[\w\W]*$
          description: Información adicional sobre los productos que tiene la persona.
          example: Joint account with Robin
        procurators:
          type: array
          description: >-
            Información sobre cualquier individuo o empresa que pueda actuar en
            nombre del propietario.
          items:
            $ref: '#/components/schemas/OwnerProcurators'
        products:
          type: array
          description: >-
            Detalles sobre cualquier producto adicional que la persona tenga con
            la institución.
          items:
            $ref: '#/components/schemas/OwnerIndividualProducts'
        salary_portability_requests:
          type: array
          description: >-
            Detalles sobre cualquier solicitud de portabilidad de salario que el
            individuo haya realizado con la institución.


            Una portabilidad de salario es una solicitud para transferir el
            salario del individuo desde la cuenta bancaria de 'nómina' de su
            empleador a otra cuenta bancaria.


            > 📘 

            >

            > Tenga en cuenta que la cuenta bancaria receptora no puede terminar
            una portabilidad de salario (o ser informada de que ha sido
            terminada). Solo el banco de nómina del empleador puede proporcionar
            esta información. Por lo tanto, las portabilidades enumeradas aquí
            pueden no estar actualizadas.
          items:
            $ref: '#/components/schemas/OwnerIndividualSalaryPortabilityRequests'
        payroll_accounts:
          type: array
          description: >-
            Detalles sobre cualquier cuenta bancaria de nómina asociada con el
            individuo. Es decir, cada vez que el individuo tenga un nuevo
            empleador del cual reciba un salario, debe estar listado aquí.


            > 📘

            >

            > Los empleadores anteriores pueden no cerrar la cuenta de nómina
            del individuo. Por lo tanto, las cuentas de nómina listadas aquí
            pueden no estar actualizadas.
          items:
            $ref: '#/components/schemas/OwnerIndividualPayrollAccounts'
    OwnerIndividualOpenFinanceBrazil:
      type: object
      title: Propietario Individual (OFDA Brasil)
      required:
        - id
        - link
        - internal_identification
        - collected_at
        - created_at
        - display_name
        - social_name
        - birth_date
        - marital_status
        - marital_status_additional_info
        - gender
        - companies_id
        - is_local_resident
        - document_id
        - additional_documents
        - nationalities
        - email
        - emails
        - address
        - addresses
        - phone_number
        - phone_numbers
        - filiations
        - financial_profile
        - financial_relation
      properties:
        id:
          $ref: '#/components/schemas/id'
        link:
          $ref: '#/components/schemas/link'
        internal_identification:
          type: string
          nullable: true
          description: El identificador interno de la institución para el propietario.
          example: 7e5838e4
        collected_at:
          $ref: '#/components/schemas/collected_at'
        created_at:
          $ref: '#/components/schemas/created_at'
        display_name:
          type: string
          maxLength: 128
          pattern: ^[\w\W]{0,128}$
          description: >-
            El nombre completo del individuo, tal como lo proporciona la
            institución.


            > **No anulable:** La red de finanzas abiertas de Brasil debe
            devolver un valor.
          example: Jack Oswald White
        social_name:
          type: string
          nullable: true
          maxLength: 128
          pattern: ^[\w\W]{0,128}$
          description: >-
            El nombre social del individuo, tal como es generalmente aceptado
            por el país.
          example: O Piadista
        birth_date:
          type: string
          format: date
          maxLength: 10
          pattern: ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])$
          description: >-
            La fecha de nacimiento del individuo, en formato `YYYY-MM-DD`.


            > **No anulable:** La red de finanzas abiertas de Brasil debe
            devolver un valor.
          example: '1988-07-15'
        marital_status:
          $ref: '#/components/schemas/EnumOwnerMaritalStatus'
        marital_status_additional_info:
          type: string
          nullable: true
          maxLength: 50
          pattern: ^[\w\W]{0,50}$
          description: Información adicional sobre el estado civil del individuo.
          example: It's complicated
        gender:
          $ref: '#/components/schemas/EnumOwnerGender'
        companies_id:
          type: array
          minItems: 1
          description: >-
            Las instituciones responsables de la creación y verificación del
            propietario.


            > **No anulable:** La red de finanzas abiertas de Brasil debe
            devolver un valor.
          items:
            type: string
            maxLength: 14
            pattern: ^\d{14}$
            description: >-
              Las instituciones responsables de la creación y verificación del
              propietario.
            example: '01773247000103'
        is_local_resident:
          type: boolean
          description: >-
            Boolean para indicar si el individuo es residente local del país.


            > **No anulable:** La red de finanzas abiertas de Brasil debe
            devolver un valor.
          example: true
        document_id:
          $ref: '#/components/schemas/OwnerDocumentIdOpenFinanceBrazil'
        additional_documents:
          type: array
          description: >-
            Información detallada sobre documentos adicionales proporcionados
            para verificar la identidad de las personas.


            > **Non-nullable:** La red de finanzas abiertas de Brasil debe
            devolver un valor.
          minItems: 1
          items:
            $ref: '#/components/schemas/OwnerIndividualDocumentIds'
        nationalities:
          type: array
          nullable: true
          minItems: 1
          description: >-
            Información detallada sobre las nacionalidades del individuo.


            Solo se requiere devolver cuando `is_local_resident` está
            configurado como `false`.
          items:
            $ref: '#/components/schemas/OwnerNationalities'
        email:
          type: string
          nullable: true
          format: email
          maxLength: 320
          description: >-
            La dirección de correo electrónico registrada del propietario de la
            cuenta.


            > **No anulable:** La red de finanzas abiertas de Brasil debe
            devolver un valor.
          example: johndoe@belvo.com
        emails:
          type: array
          minItems: 0
          description: >-
            Lista adicional de correos electrónicos proporcionada por el
            propietario.


            > **No anulable:** La red de finanzas abiertas de Brasil debe
            devolver un valor.
          items:
            $ref: '#/components/schemas/OwnerEmails'
        address:
          type: string
          nullable: true
          description: >-
            La dirección registrada del propietario de la cuenta.


            > **No anulable:** La red de finanzas abiertas de Brasil debe
            devolver un valor.
          example: Carrer de la Llacuna, 162, 08018 Barcelona
        addresses:
          type: array
          minItems: 1
          description: >-
            Información detallada sobre las direcciones del propietario.


            > **No anulable:** La red de finanzas abiertas de Brasil debe
            devolver un valor.
          items:
            $ref: '#/components/schemas/OwnerAddresses'
        phone_number:
          type: string
          nullable: true
          description: >-
            El número de teléfono registrado del propietario de la cuenta.


            > **No anulable:** La red de finanzas abiertas de Brasil debe
            devolver un valor.
          example: +52-XXX-XXX-XXXX
        phone_numbers:
          type: array
          minItems: 0
          description: >-
            Información detallada sobre los números de teléfono del propietario.


            > **No anulable:** La red de finanzas abiertas de Brasil debe
            devolver un valor.
          items:
            $ref: '#/components/schemas/OwnerPhoneNumbers'
        filiations:
          type: array
          minItems: 1
          description: >-
            Información sobre cualquier relación familiar del individuo.


            > **No anulable:** La red de finanzas abiertas de Brasil debe
            devolver un valor.
          items:
            $ref: '#/components/schemas/OwnerFiliations'
        financial_profile:
          $ref: '#/components/schemas/OwnerIndividualFinancialProfile'
        financial_relation:
          $ref: '#/components/schemas/OwnerIndividualFinancialRelation'
    OwnerBusinessDocumentIds:
      type: object
      nullable: true
      required:
        - type
        - type_additional_info
        - number
        - check_digit
        - issue_date
        - expiration_date
        - country_of_issuance
        - additional_info
      description: >-
        Información detallada sobre documentos adicionales proporcionados para
        probar la identificación del negocio.
      properties:
        type:
          $ref: '#/components/schemas/EnumOwnerIndividualDocumentIdType'
        type_additional_info:
          type: string
          nullable: true
          maxLength: 70
          pattern: ^[\w\W\s]{0,70}$
          description: >-
            Información adicional sobre el tipo de documento.


            > Nota: Para documentos de identificación empresarial, este campo
            debe devolver un valor de la red de finanzas abiertas de Brasil.
          example: EIN
        number:
          type: string
          maxLength: 40
          pattern: ^[\w\W]{0,40}$
          description: >-
            El número del documento de identificación.


            > **No anulable:** La red de finanzas abiertas de Brasil debe
            devolver un valor.
          example: DL-7896829-7
        check_digit:
          type: string
          maxLength: 2
          pattern: ^[\w\W\s]{0,2}$
          description: >-
            El dígito de verificación del documento de identificación.


            > **Nota**: Este campo no es aplicable para documentos de
            identificación empresarial y devolverá `null`.
          example: null
        issue_date:
          type: string
          nullable: true
          format: date
          maxLength: 10
          pattern: ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])$
          description: >-
            La fecha en que se emitió el documento de identificación, en formato
            `YYYY-MM-DD`.


            > **Nota**: Este campo no es aplicable para documentos de
            identificación empresarial y devolverá `null`.
          example: null
        expiration_date:
          type: string
          nullable: true
          format: date
          maxLength: 10
          pattern: ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])$
          description: >-
            La fecha de vencimiento del documento de identificación, en formato
            `YYYY-MM-DD`.
          example: '2019-01-01'
        country_of_issuance:
          type: string
          nullable: true
          maxLength: 3
          pattern: ^(\w{3}){1}$
          description: >-
            El código de país de tres letras que emitió el documento (en formato
            ISO-3166 Alpha 3).


            > **No anulable:** La red de finanzas abiertas de Brasil debe
            devolver un valor.
          example: CAN
        additional_info:
          type: string
          nullable: true
          maxLength: 100
          pattern: ^[\w\W\s]{0,100}$
          description: >-
            Información adicional sobre el documento de identificación.


            > **Nota**: Este campo no es aplicable para documentos de
            identificación empresarial y devolverá `null`.
          example: null
    EnumOwnerPartyPersonType:
      type: string
      nullable: true
      enum:
        - INDIVIDUAL
        - COMPANY
      description: >-
        El tipo de persona que es parte propietaria de la cuenta. Devolvemos uno
        de los siguientes valores:

          - `INDIVIDUAL`
          - `COMPANY`
      example: INDIVIDUAL
    EnumOwnerPartyType:
      type: string
      nullable: true
      enum:
        - MEMBER
        - ADMINISTRATOR
      description: >-
        El tipo de acceso que el `person_type` tiene a la cuenta. Devolvemos uno
        de los siguientes valores:


        - `MEMBER` indica que el `person_type` tiene acceso de lectura a la
        cuenta.

        - `ADMINISTRATOR` indica que el `person_type` puede realizar todas las
        acciones para la cuenta (incluidas las transferencias).
      example: MEMBER
    EnumOwnerPartyDocumentType:
      type: string
      nullable: true
      enum:
        - CPF
        - CNPJ
        - OTHER_TRAVEL_DOCUMENT
        - PASSPORT
      description: >-
        El tipo de documento de identificación que la parte proporcionó al ser
        añadida a la cuenta. Devolvemos uno de los siguientes valores:

          - `CPF`
          - `CNPJ`
          - `OTHER_TRAVEL_DOCUMENT`
          - `PASSPORT`
      example: CPF
    OwnerParties:
      type: object
      nullable: true
      required:
        - person_type
        - type
        - display_name
        - social_name
        - trade_name
        - start_date
        - percentage_type
        - document_type
        - document_number
        - document_issue_date
        - document_expiration_date
        - document_country
        - document_additional_info
      description: >-
        Información detallada sobre las partes autorizadas para actuar en nombre
        del propietario.
      properties:
        person_type:
          $ref: '#/components/schemas/EnumOwnerPartyPersonType'
        type:
          $ref: '#/components/schemas/EnumOwnerPartyType'
        display_name:
          type: string
          nullable: true
          maxLength: 128
          pattern: ^[\w\W]{0,128}$
          description: >-
            El nombre completo de la persona, tal como lo proporciona la
            institución. Solo aplicable si el `person_type` es `INDIVIDUAL`.
          example: Jack Oswald White
        social_name:
          type: string
          nullable: true
          maxLength: 128
          pattern: ^[\w\W]{0,128}$
          description: >-
            El nombre social del individuo, tal como es generalmente aceptado
            por el país. Solo aplicable si el `person_type` es `INDIVIDUAL`.
          example: O Piadista
        company_name:
          type: string
          nullable: true
          maxLength: 128
          pattern: ^[\w\W]{0,128}$
          description: >-
            El nombre completo (oficial) del negocio. Solo aplicable si el
            `person_type` es `COMPANY`.
          example: Wayne Enterprises
        trade_name:
          type: string
          nullable: true
          maxLength: 128
          pattern: ^[\w\W]{0,128}$
          description: >-
            El nombre comercial del negocio. Solo aplicable si el `person_type`
            es `COMPANY`.
          example: WayneCorp
        start_date:
          type: string
          nullable: true
          format: date
          maxLength: 10
          pattern: ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])$
          description: >-
            La fecha en que la parte fue añadida a la cuenta, en formato
            `YYYY-MM-DD`.
          example: '2021-07-15'
        percentage_type:
          type: number
          nullable: true
          format: float
          minLength: 8
          maxLength: 8
          pattern: ^[01]\.\d{6}$
          description: El interés de capital de la parte.
          example: 0.51
        document_type:
          $ref: '#/components/schemas/EnumOwnerPartyDocumentType'
        document_number:
          type: string
          maxLength: 40
          pattern: ^[\w\W\s]{0,40}$
          description: >-
            El número del documento de identificación.


            > **No anulable:** La red de finanzas abiertas de Brasil debe
            devolver un valor.
          example: DL-7896829-7
        document_issue_date:
          type: string
          nullable: true
          format: date
          maxLength: 10
          pattern: ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])$
          description: >-
            La fecha en que se emitió el documento de identificación, en formato
            `YYYY-MM-DD`.
          example: '2019-01-01'
        document_expiration_date:
          type: string
          nullable: true
          format: date
          maxLength: 10
          pattern: ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])$
          description: >-
            La fecha de vencimiento del documento de identificación, en formato
            `YYYY-MM-DD`.
          example: '2019-01-01'
        document_country:
          type: string
          nullable: true
          maxLength: 3
          pattern: ^(\w{3}){1}$
          description: >-
            El código de país de tres letras que emitió el documento (en formato
            ISO-3166 Alpha 3).
          example: CAN
        document_additional_info:
          type: string
          nullable: true
          maxLength: 100
          pattern: ^[\w\W\s]{0,100}$
          description: Información adicional sobre el documento.
          example: Confirmed CPF with their driver's licence.
    OwnerBusinessEconomicActivies:
      type: object
      nullable: true
      required:
        - is_main
        - code
      description: Detalles sobre las actividades económicas reportadas de la empresa.
      properties:
        is_main:
          type: boolean
          description: >-
            Boolean para indicar si esta es la actividad económica principal del
            negocio.


            > **No anulable:** Se debe devolver un valor por la red de finanzas
            abiertas de Brasil si el campo `economic_activities` está
            disponible.
          example: true
        code:
          type: string
          minLength: 2
          maxLength: 7
          pattern: ^\d{2,7}$
          description: >-
            El código de la actividad económica, según lo proporcionado por el
            país.


            > **Non-nullable:** Se debe devolver un valor por la red de finanzas
            abiertas de Brasil si el campo `economic_activities` está
            disponible.
          example: '8599604'
    EnumOwnerBusinessInformedRevenueFrequency:
      type: string
      nullable: true
      enum:
        - DAILY
        - WEEKLY
        - FORTNIGHTLY
        - MONTHLY
        - BIMONTHLY
        - QUARTERLY
        - BIANNUALLY
        - ANNUALLY
        - OTHERS
        - null
      description: >-
        Indica con qué frecuencia la empresa declara sus ingresos. Devolvemos
        uno de los siguientes valores:

          - `DAILY`
          - `WEEKLY`
          - `FORTNIGHTLY`
          - `MONTHLY`
          - `BIMONTHLY`
          - `QUARTERLY`
          - `BIANNUALLY`
          - `ANNUALLY`
          - `OTHERS`
          - `null`
      example: MONTHLY
    OwnerBusinessInformedRevenue:
      type: object
      nullable: true
      required:
        - frequency
        - frequency_additional_info
        - amount
        - currency
        - year
      description: Información sobre los ingresos reportados del negocio.
      properties:
        frequency:
          $ref: '#/components/schemas/EnumOwnerBusinessInformedRevenueFrequency'
        frequency_additional_info:
          type: string
          nullable: true
          maxLength: 100
          pattern: '[\w\W\s]*'
          description: Información adicional sobre la frecuencia.
          example: Recently switched from weekly to monthly.
        amount:
          type: number
          pattern: ^\d{1,15}\.\d{2,4}$
          description: >-
            Los ingresos reportados del negocio.


            > **No anulable:** Se debe devolver un valor por la red de finanzas
            abiertas de Brasil si el campo `informed_revenue` está disponible.
          example: 45391.89
        currency:
          type: string
          maxLength: 3
          pattern: ^[A-Z]{3}$
          description: >-
            El código de moneda de tres letras (ISO-4217).


            > **No anulable:** Se debe devolver un valor por la red de finanzas
            abiertas de Brasil si el campo `informed_revenue` está disponible.
          example: BRL
        year:
          type: integer
          maxLength: 4
          minimum: 1700
          maximum: 2090
          description: >-
            El año en que se declaró por última vez el ingreso.


            > **No anulable:** Se debe devolver un valor por la red de finanzas
            abiertas de Brasil si el campo `informed_revenue` está disponible.
          example: 2022
    OwnerBusinessPatrimony:
      type: object
      nullable: true
      required:
        - amount
        - currency
        - date
      description: Información sobre los activos reportados del individuo.
      properties:
        amount:
          type: number
          format: float
          pattern: ^\d{1,15}\.\d{2,4}$
          description: >-
            Los activos reportados del negocio.


            > **No anulable:** Se debe devolver un valor por la red de finanzas
            abiertas de Brasil si el campo `patrimony` está disponible.
          example: 45391.89
        currency:
          type: string
          maxLength: 3
          pattern: ^[A-Z]{3}$
          description: >-
            El código de moneda de tres letras (ISO-4217).


            > **No anulable:** Se debe devolver un valor por la red de finanzas
            abiertas de Brasil si el campo `patrimony` está disponible.
          example: BRL
        date:
          type: string
          format: date
          maxLength: 10
          pattern: ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])$
          description: >-
            La fecha en la que se aplicaron los activos reportados, en formato
            `YYYY-MM-DD`.


            > **No anulable:** Se debe devolver un valor por la red de finanzas
            abiertas de Brasil si el campo `patrimony` está disponible.
          example: '2022-12-12'
    OwnerBusinessFinancialProfile:
      type: object
      nullable: true
      required:
        - economic_activities
        - informed_revenue
        - patrimony
      description: Información sobre el perfil financiero del individuo.
      properties:
        economic_activities:
          type: array
          description: Detalles sobre las actividades económicas reportadas de la empresa.
          items:
            $ref: '#/components/schemas/OwnerBusinessEconomicActivies'
        informed_revenue:
          $ref: '#/components/schemas/OwnerBusinessInformedRevenue'
        patrimony:
          $ref: '#/components/schemas/OwnerBusinessPatrimony'
    EnumOwnerBusinessProductType:
      type: string
      nullable: true
      enum:
        - SAVINGS_ACCOUNT
        - CHECKING_ACCOUNT
        - null
      description: >-
        Los productos adicionales que el negocio tiene en la institución.
        Devolvemos uno de los siguientes valores:

          - `SAVINGS_ACCOUNT`
          - `CHECKING_ACCOUNT`
          - `null`
      example: SAVINGS_ACCOUNT
    OwnerBusinessProducts:
      type: object
      nullable: true
      required:
        - type
        - subtype
        - agency
        - clearing_code
        - number
        - check_digit
      description: >-
        Detalles sobre cualquier producto adicional que la persona tenga con la
        institución.
      properties:
        type:
          $ref: '#/components/schemas/EnumOwnerBusinessProductType'
        subtype:
          type: string
          description: >-
            El subtipo del producto que la empresa tiene en la institución.


            > **No anulable:** Se debe devolver un valor por la red de finanzas
            abiertas de Brasil si el campo `products` está disponible.
          example: CONJUNTA_SIMPLES
        agency:
          type: string
          nullable: true
          maxLength: 4
          pattern: ^\d{1,4}$
          description: El código de sucursal donde se abrió el producto.
          example: '6272'
        clearing_code:
          type: string
          maxLength: 3
          pattern: ^\d{3}$
          description: >-
            El código de compensación bancaria para el producto.


            > **No anulable:** Se debe devolver un valor por la red de finanzas
            abiertas de Brasil si el campo `products` está disponible.
          example: '001'
        number:
          type: string
          maxLength: 20
          pattern: ^\d{8,20}$
          description: >-
            El número de cuenta del producto.


            > **No anulable:** Se debe devolver un valor por la red de finanzas
            abiertas de Brasil si el campo `products` está disponible.
          example: '24550245'
        check_digit:
          type: string
          maxLength: 2
          pattern: ^[\w\W\s]{0,2}$
          description: >-
            El dígito de control del número del producto.


            > **No anulable:** Se debe devolver un valor por la red de finanzas
            abiertas de Brasil si el campo `products` está disponible.
          example: '7'
    OwnerBusinessFinancialRelation:
      type: object
      nullable: true
      required:
        - start_date
        - product_services
        - procurators
        - products
      description: >-
        Detalles sobre cualquier relación adicional que la empresa tenga con la
        institución (por ejemplo, otras cuentas o productos que tengan con la
        institución).
      properties:
        start_date:
          type: string
          format: date-time
          maxLength: 20
          pattern: >-
            ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$
          description: >-
            La marca de tiempo ISO-8601 cuando comenzó la relación financiera
            entre la empresa y la institución.


            > **No anulable:** La red de finanzas abiertas de Brasil debe
            devolver un valor.
          example: '2021-05-21T08:30:00Z'
        product_services:
          type: array
          minItems: 1
          description: >-
            Una lista de productos que la empresa tiene con la institución.


            > **No anulable:** La red de finanzas abiertas de Brasil debe
            devolver un valor.
          items:
            type: string
            description: El nombre del producto, según la institución.
            example: CONTA_DEPOSITO_A_VISTA
        procurators:
          type: array
          description: >-
            Información sobre cualquier individuo o empresa que pueda actuar en
            nombre del propietario.
          items:
            $ref: '#/components/schemas/OwnerProcurators'
        products:
          type: array
          description: >-
            Detalles sobre cualquier producto adicional que la empresa tenga con
            la institución.
          items:
            $ref: '#/components/schemas/OwnerBusinessProducts'
    OwnerBusinessOpenFinanceBrazil:
      type: object
      title: Propietario del Negocio (OFDA Brasil)
      required:
        - id
        - link
        - internal_identification
        - collected_at
        - created_at
        - company_name
        - trade_name
        - incorporation_date
        - companies_id
        - document_id
        - additional_documents
        - email
        - emails
        - address
        - addresses
        - phone_number
        - phone_numbers
        - parties
        - financial_profile
        - financial_relation
      properties:
        id:
          $ref: '#/components/schemas/id'
        link:
          $ref: '#/components/schemas/link'
        internal_identification:
          type: string
          nullable: true
          description: El identificador interno de la institución para el propietario.
          example: 7e5838e4
        collected_at:
          $ref: '#/components/schemas/collected_at'
        created_at:
          $ref: '#/components/schemas/created_at'
        company_name:
          type: string
          maxLength: 128
          pattern: ^[\w\W]{0,128}$
          description: >-
            El nombre completo (oficial) del negocio, tal como lo proporciona la
            institución.


            > **No anulable:** La red de finanzas abiertas de Brasil debe
            devolver un valor.
          example: Wayne Enterprises
        trade_name:
          type: string
          nullable: true
          maxLength: 128
          pattern: ^[\w\W]{0,128}$
          description: El nombre comercial del negocio.
          example: WayneCorp
        incorporation_date:
          type: string
          format: date
          maxLength: 10
          pattern: ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])$
          description: >-
            La fecha en que se constituyó la empresa, en formato `YYYY-MM-DD`.


            > **No anulable:** La red de finanzas abiertas de Brasil debe
            devolver un valor.
          example: '1988-07-15'
        companies_id:
          type: array
          minItems: 1
          description: >-
            Las instituciones responsables de la creación y verificación del
            propietario.


            > **No anulable:** La red de finanzas abiertas de Brasil debe
            devolver un valor.
          items:
            type: string
            maxLength: 14
            pattern: ^\d{14}$
            description: >-
              Las instituciones responsables de la creación y verificación del
              propietario.
            example: '01773247000103'
        document_id:
          $ref: '#/components/schemas/OwnerDocumentIdOpenFinanceBrazil'
        additional_documents:
          type: array
          minItems: 1
          description: >-
            Información detallada sobre documentos adicionales proporcionados
            para probar la identificación del negocio.


            > **No anulable:** La red de finanzas abiertas de Brasil debe
            devolver un valor.
          items:
            $ref: '#/components/schemas/OwnerBusinessDocumentIds'
        email:
          type: string
          nullable: true
          format: email
          maxLength: 256
          description: >-
            La dirección de correo electrónico registrada del propietario de la
            cuenta.
          example: johndoe@belvo.com
        emails:
          type: array
          minItems: 0
          description: >-
            Lista adicional de correos electrónicos proporcionada por el
            propietario.
          items:
            $ref: '#/components/schemas/OwnerEmails'
        address:
          type: string
          nullable: true
          description: La dirección registrada del propietario de las cuentas.
          example: Carrer de la Llacuna, 162, 08018 Barcelona
        addresses:
          type: array
          minItems: 1
          description: Información detallada sobre las direcciones del propietario.
          items:
            $ref: '#/components/schemas/OwnerAddresses'
        phone_number:
          type: string
          nullable: true
          description: El número de teléfono registrado del propietario de la cuenta.
          example: +52-XXX-XXX-XXXX
        phone_numbers:
          type: array
          minItems: 0
          description: Información detallada sobre los `phone_number`s del propietario.
          items:
            $ref: '#/components/schemas/OwnerPhoneNumbers'
        parties:
          type: array
          minItems: 1
          description: >-
            Información detallada sobre las partes autorizadas para actuar en
            nombre del propietario.


            > **No anulable:** La red de finanzas abiertas de Brasil debe
            devolver un valor.
          items:
            $ref: '#/components/schemas/OwnerParties'
        financial_profile:
          $ref: '#/components/schemas/OwnerBusinessFinancialProfile'
        financial_relation:
          $ref: '#/components/schemas/OwnerBusinessFinancialRelation'
    OwnerDocumentId:
      type: object
      nullable: true
      required:
        - document_type
        - document_number
      description: >-
        Información sobre el documento de identificación que el propietario
        proporcionó al banco.
      properties:
        document_type:
          type: string
          nullable: true
          description: >-
            El tipo de documento que el propietario proporcionó a la institución
            para abrir la cuenta. Los tipos de documentos comunes son:


            🇧🇷 Brasil

            - `CPF` (*Cadastro de Pessoas Físicas*)

            - `CNPJ` (*Cadastro Nacional de Pessoas Jurídicas*)


            🇨🇴 Colombia

            - `CC` (*Cédula de Ciudadanía*)

            - `NIT` (*Número de Identificación Tributaria*)


            🇲🇽 México

            - `CURP` (*Clave Única de Registro de Población*)

            - `NSS` (*Número de Seguridad Social*)

            - `RFC` (*Registro Federal de Contribuyentes*)
          example: CPF
        document_number:
          type: string
          nullable: true
          description: El número de identificación del documento.
          example: 235578435-S
    Owner:
      type: object
      title: Propietario Estándar (Multi-Región)
      required:
        - id
        - link
        - internal_identification
        - display_name
        - email
        - phone_number
        - address
        - collected_at
      properties:
        id:
          $ref: '#/components/schemas/id'
        link:
          $ref: '#/components/schemas/link'
        internal_identification:
          type: string
          nullable: true
          description: El identificador interno de la institución para el propietario.
          example: 7e5838e4
        collected_at:
          $ref: '#/components/schemas/collected_at'
        created_at:
          $ref: '#/components/schemas/created_at'
        display_name:
          type: string
          nullable: true
          maxLength: 128
          description: >-
            El nombre completo del propietario, tal como lo proporciona el
            banco.
          example: John Doe
        email:
          type: string
          nullable: true
          format: email
          maxLength: 256
          description: >-
            La dirección de correo electrónico registrada del propietario de la
            cuenta.
          example: johndoe@belvo.com
        phone_number:
          type: string
          nullable: true
          description: El número de teléfono registrado del propietario de la cuenta.
          example: +52-XXX-XXX-XXXX
        address:
          type: string
          nullable: true
          description: La dirección registrada del propietario de las cuentas.
          example: Carrer de la Llacuna, 162, 08018 Barcelona
        document_id:
          $ref: '#/components/schemas/OwnerDocumentId'
        business_name:
          type: string
          nullable: true
          deprecated: true
          description: >-
            *Este campo ha quedado obsoleto. Para obtener más información sobre
            Belvo y la obsolescencia, consulta nuestra explicación de campos
            obsoletos.*


            *El nombre del negocio.*
          example: null
        first_name:
          type: string
          nullable: true
          deprecated: true
          description: >-
            *Este campo ha quedado obsoleto. Para obtener más información sobre
            Belvo y la obsolescencia, consulte nuestra explicación de campos
            obsoletos.*


            *El nombre del propietario de la cuenta.*
          example: null
        last_name:
          type: string
          nullable: true
          deprecated: true
          description: >-
            *Este campo ha sido desaprobado. Para obtener más información sobre
            Belvo y la desaprobación, consulta nuestra explicación de campos
            desaprobados.*


            *El apellido del titular de la cuenta.*
          example: null
        second_last_name:
          type: string
          nullable: true
          deprecated: true
          description: >-
            *Este campo ha sido desaprobado. Para obtener más información sobre
            Belvo y la desaprobación, consulta nuestra explicación de campos
            desaprobados.*


            *El segundo apellido del titular de la cuenta.*
          example: null
    InvestmentBalance:
      type: object
      title: Saldo del Instrumento de Inversión
      description: El saldo del instrumento de inversión, a partir de la `reference_date`.
      properties:
        reference_date:
          type: string
          format: date-time
          description: >-
            La fecha y hora en que se calculó el saldo para el instrumento de
            inversión, en formato `YYYY-MM-DDTHH:MM:SSZ`.
          example: '2022-07-21T17:32:00Z'
        gross_value:
          type: number
          format: float
          description: El valor bruto del instrumento de inversión.
          example: 1000
        blocked_amount:
          type: number
          format: float
          description: >-
            La cantidad del instrumento de inversión que está bloqueada o no
            disponible para transacciones.
          example: 100
        quantity:
          type: number
          format: float
          pattern: ‘^-?\d{1,15}\.\d{2,8}$’
          description: >-
            El número de unidades, cuotas o activos mantenidos en la fecha de
            referencia.
          example: 100
        gross_unit_price:
          type: number
          format: float
          nullable: true
          pattern: ‘^-?\d{1,15}\.\d{2,8}$’
          description: >-
            El valor bruto unitario actual de la inversión en la fecha de
            referencia
          example: 10
        net_value:
          type: number
          format: float
          nullable: true
          pattern: ‘^-?\d{1,15}\.\d{2,8}$’
          description: >-
            El valor neto de la inversión después de deducciones por impuestos,
            tarifas y otros cargos, a la fecha de referencia.
          example: 900
        withheld_amount:
          type: number
          format: float
          nullable: true
          pattern: ‘^\d{1,15}\.\d{2,4}$’
          description: >-
            La cantidad del instrumento de inversión que ha sido retenida o
            deducida del valor neto.
          example: 10
        transaction_fee:
          type: number
          format: float
          nullable: true
          pattern: ‘^\d{1,15}\.\d{2,4}$’
          description: Las tarifas e impuestos cobrados por la transacción.
          example: 5
        purchase_unit_price:
          type: number
          format: float
          nullable: true
          pattern: ‘^\d{1,15}\.\d{2,4}$’
          description: El precio unitario en el momento de la compra del valor o activo.
          example: 10
        pre_fixed_rate:
          type: number
          format: float
          nullable: true
          pattern: ‘^\d{1}\.\d{6}$’
          description: La tasa de remuneración prefijada para el producto de ingresos.
          example: 0.05
        post_fixed_rate:
          type: number
          format: float
          nullable: true
          pattern: ‘^\d{1}\.\d{6}$’
          description: >-
            El porcentaje del indexador post-fijado para el producto de
            ingresos.
          example: 0.05
        penalty_fee:
          type: number
          format: float
          nullable: true
          pattern: ‘^\d{1,15}\.\d{2,4}$’
          description: >-
            La penalización (multa) por retrasos en los pagos, tal como se
            define en el contrato.
          example: 10
        late_payment_fee:
          type: number
          format: float
          nullable: true
          pattern: ‘^\d{1,15}\.\d{2,4}$’
          description: El interés cobrado por pagos atrasados.
          example: 10
        closing_price:
          type: number
          format: float
          nullable: true
          pattern: ‘^-?\d{1,15}\.\d{2,8}$’
          description: El precio de cierre de la inversión en la fecha de referencia.
          example: 10
        unit_price_factor:
          type: number
          format: float
          nullable: true
          pattern: ‘^\d{1,15}\.\d{2,4}$’
          description: El factor utilizado para calcular el precio unitario.
          example: 1
    Remuneration:
      type: object
      description: Los detalles de la remuneración del instrumento de inversión.
      properties:
        pre_fixed_rate:
          type: number
          format: float
          nullable: true
          pattern: ‘^\d{1}\.\d{6}$’
          description: >-
            La tasa de interés fija definida en la emisión, expresada como un
            decimal (por ejemplo, `0.150000` representa el 15%).
          example: 0.05
        post_fixed_rate:
          type: number
          format: float
          nullable: true
          pattern: ‘^\d{1}\.\d{6}$’
          description: >-
            La tasa de interés post-fijada definida en la emisión, expresada
            como un decimal (por ejemplo, `0.150000` representa el 15%).
          example: 0.05
        rate_type:
          type: string
          nullable: true
          maxLength: 30
          pattern: '[\w\W-]*'
          description: >-
            El tipo de tasa de remuneración aplicada al instrumento financiero.
            Puede ser:
              - `LINEAR`
              - `EXPONENCIAL`
          example: LINEAR
        rate_periodicity:
          type: string
          nullable: true
          description: >-
            La frecuencia con la que se aplica la tasa de remuneración al
            instrumento financiero. Puede ser:
              - `DIARIO`
              - `MENSAL`
              - `ANUAL`
              - `SEMESTRAL`
          example: MENSAL
        calculation_base:
          type: string
          nullable: true
          maxLength: 30
          pattern: '[\w\W-]*'
          description: >-
            Indica si el cálculo de la remuneración o de los intereses se basa
            en días hábiles (*dias úteis*) o días calendario (*dias corridos*).

            - `DIAS_UTEIS`
              - `DIAS_CORRIDOS`
          example: DIAS_CORRIDOS
        indexer:
          type: string
          nullable: true
          maxLength: 30
          pattern: '[\w\W-]*'
          description: >-
            El índice utilizado como referencia para calcular la rentabilidad o
            los rendimientos del instrumento financiero. Puede ser uno de los
            siguientes:
              - `CDI` 
              - `DI` 
              - `TR` 
              - `IPCA` 
              - `IGP_M` 
              - `IGP_DI` 
              - `INPC` 
              - `BCP` 
              - `TLC` 
              - `SELIC` 
              - `PRE_FIXADO` 
              - `OUTROS`
          example: CDI
        indexer_additional_info:
          type: string
          nullable: true
          maxLength: 50
          pattern: '[\w\W-]*'
          description: >-
            Información adicional sobre la tasa de `indexer`. Requerido cuando
            `indexer` está configurado en `OUTROS`.
          example: IPCA + 5%
    ClassificationDetails:
      type: object
      nullable: true
      description: >-
        Los detalles de clasificación del instrumento de inversión.


        > 🚧 Solo aplicable para inversiones de tipo `INVESTMENT_FUND`.

        >

        > Este objeto solo es aplicable para inversiones de tipo
        `INVESTMENT_FUND`. Para todos los demás tipos de inversión, este objeto
        será `null`.
      properties:
        category:
          type: string
          nullable: true
          maxLength: 11
          description: >-
            La categoría del fondo de inversión, según los estándares de
            clasificación de ANBIMA. Puede ser una de las siguientes:
              - `RENDA_FIXA`
              - `ACOES`
              - `MULTIMERCADO`
              - `CAMBIAL`
          example: ACOES
        class:
          type: string
          nullable: true
          maxLength: 70
          pattern: '[\w\W\s]*'
          description: >-
            La clase dentro de la categoría del fondo de inversión, según los
            estándares de clasificación de ANBIMA.
          example: Ações Livre
        subclass:
          type: string
          nullable: true
          maxLength: 70
          pattern: '[\w\W\s]*'
          description: >-
            La subclase del fondo de inversión, según los estándares de
            clasificación de ANBIMA.
          example: Ações Livre
    VoucherPaymentDetails:
      type: object
      title: Detalles de Pago del Voucher
      description: >-
        Los detalles del pago del voucher (también conocido como pagos de cupón)
        del instrumento de inversión.


        > 🚧 Solo aplicable para inversiones de tipo `FIXED_INCOME_CREDIT` y
        `TREASURY_BOND`.

        >

        > Este objeto solo es aplicable para inversiones de tipo
        `FIXED_INCOME_CREDIT` y `TREASURY_BOND`. Para todos los demás tipos de
        inversión, este objeto será `null`.
      properties:
        is_voucher_payment:
          type: boolean
          description: >-
            Indica si el instrumento financiero paga intereses periódicos (pagos
            de cupones).
          example: true
        periodicity:
          type: string
          nullable: true
          description: >-
            La frecuencia con la que se realizan los pagos del voucher.
            Requerido cuando `is_voucher_payment` está configurado como `true`.
            Puede ser uno de los siguientes:
              - `MENSAL` 
              - `TRIMESTRAL` 
              - `SEMESTRAL` 
              - `ANUAL` 
              - `IRREGULAR` 
              - `OUTROS`
          example: MENSAL
        periodicity_additional_info:
          type: string
          nullable: true
          maxLength: 50
          pattern: '[\w\W\s]*'
          description: >-
            Información adicional sobre la periodicidad del pago del vale.
            Requerido cuando `periodicity` está configurado como `OUTROS`.
          example: 30/360
    DebtorDetails:
      type: object
      nullable: true
      title: Detalles del Deudor
      description: >-
        Los detalles del deudor del instrumento de inversión.


        > 🚧 Solo aplicable para inversiones de tipo `FIXED_INCOME_CREDIT`.

        >

        > Este objeto solo es aplicable para inversiones de tipo
        `FIXED_INCOME_CREDIT`. Para todos los demás tipos de inversión, este
        objeto será `null`.
      properties:
        name:
          type: string
          maxLength: 70
          pattern: '[\w\W\s]*'
          description: El nombre del deudor.
          example: Roberto Marino
        id_document_number:
          type: string
          maxLength: 14
          pattern: ‘^\d{14}$’
          description: El número del documento de identificación del deudor (CNPJ).
          example: 12345678901
    InvestmentBrazil:
      type: object
      title: Objeto de Inversiones (Brasil)
      x-tags:
        - Investments Brazil
      properties:
        id:
          type: string
          format: uuid
          description: >-
            El identificador único creado por Belvo utilizado para referenciar
            la inversión actual.
          example: 5359ddc5-31fc-4346-934b-cc24630a8d06
        type:
          type: string
          description: |-
            El tipo de inversión: Puede ser

              - `FIXED_INCOME_BANKING` (*Renda Fixa Bancária*)
              - `FIXED_INCOME_CREDIT` (*Renda Fixa Crédito*)
              - `VARIABLE_INCOME` (*Renda Variável*)
              - `TREASURY_BOND` (*Tesouro Direto*)
              - `INVESTMENT_FUND` (*Fundos de Investimento*)
          example: FIXED_INCOME_BANKING
        issuer_id_number:
          type: string
          nullable: true
          maxLength: 14
          pattern: ^\d{14}$
          description: >-
            El número de CNPJ de la institución emisora. Para los Fondos de
            Inversión, este es el CNPJ del fondo.


            > 🚧 No aplicable para inversiones en `TREASURY_BOND`.
          example: '10187609364567'
        isin_number:
          type: string
          nullable: true
          maxLength: 12
          pattern: ‘^[A-Z]{2}([A-Z0-9]){9}\d{1}$’
          description: >-
            El Número de Identificación de Valores Internacionales ISO-6166
            (ISIN) para el instrumento financiero.
          example: BRCST4CTF001
        currency:
          type: string
          minLength: 3
          maxLength: 3
          pattern: ^[A-Z]{3}$
          description: >-
            El código de moneda de tres letras (ISO-4217) de la inversión. Por
            ejemplo, `BRL` para el Real Brasileño.
          example: BRL
        product_name:
          type: string
          maxLength: 250
          description: >-
            El nombre del producto de inversión.


            - Para `FIXED_INCOME_BANKING`, puede ser: CDB, RDB, LCI o LCA.

            - Para `FIXED_INCOME_CREDIT`, puede ser: DEBENTURES, CRI o CRA.

            - Para `INVESTMENT_FUND`, será el nombre del fondo. Por ejemplo:
            CONSTELLATION MASTER FIA

            - Para `TREASURY_BOND`, será el nombre del bono. Por ejemplo:
            Tesouro Selic 2025.

            - Para `VARIABLE_INCOME_INCOME`, será el nombre de la acción. Por
            ejemplo AAPL.
          example: CONSTELLATION MASTER FIA
        is_tax_exempt:
          type: boolean
          description: |-
            Indica si la inversión está exenta de impuestos.

            > 🚧 Solo aplicable para inversiones de tipo `FIXED_INCOME_CREDIT`.
          example: false
        clearing_code:
          type: string
          nullable: true
          maxLength: 30
          pattern: '[\w\W-]*'
          description: >-
            El código de compensación de la inversión.


            > 🚧 Solo aplicable para `FIXED_INCOME_BANKING` y
            `FIXED_INCOME_CREDIT`.
          example: CDB421GPXXX
        due_date:
          type: string
          format: date
          nullable: true
          description: >-
            La fecha de vencimiento del instrumento financiero.


            > 🚧 Solo aplicable para inversiones en `FIXED_INCOME_BANKING`,
            `FIXED_INCOME_CREDIT` y `TREASURY_BOND`.
          example: '2022-01-01'
        issue_date:
          type: string
          format: date
          nullable: true
          description: >-
            La fecha en que se emitió el instrumento financiero.


            > 🚧 Solo aplicable para `FIXED_INCOME_BANKING` y
            `FIXED_INCOME_CREDIT`.
          example: '2021-01-01'
        purchase_date:
          type: string
          format: date
          nullable: true
          description: >-
            La fecha en que se adquirió el instrumento financiero.


            > 🚧 Solo aplicable para inversiones en `FIXED_INCOME_BANKING`,
            `FIXED_INCOME_CREDIT` y `TREASURY_BOND`.
          example: '2021-01-01'
        grace_period_date:
          type: string
          format: date
          nullable: true
          description: >-
            La fecha del período de gracia del instrumento financiero.


            > 🚧 Solo aplicable para `FIXED_INCOME_BANKING` y
            `FIXED_INCOME_CREDIT`.
          example: '2021-01-01'
        issue_unit_price:
          type: number
          format: float
          nullable: true
          description: >-
            El precio unitario del instrumento financiero en el momento de la
            emisión.


            > 🚧 Solo aplicable para `FIXED_INCOME_BANKING` y
            `FIXED_INCOME_CREDIT`.
          example: 1000
        balance:
          $ref: '#/components/schemas/InvestmentBalance'
        remuneration:
          $ref: '#/components/schemas/Remuneration'
        classification_details:
          $ref: '#/components/schemas/ClassificationDetails'
        voucher_payment_details:
          $ref: '#/components/schemas/VoucherPaymentDetails'
        debtor_details:
          $ref: '#/components/schemas/DebtorDetails'
    BrokerNote:
      type: object
      title: Nota del Broker
      nullable: true
      required:
        - broker_note_number
        - gross_value
        - brokerage_fee
        - clearing_settlement_fee
        - clearing_registration_fee
        - stock_exchange_asset_trade_notice_fee
        - stock_exchange_fee
        - clearing_custody_fee
        - taxes
        - income_tax
        - net_value
      description: >-
        Detalles sobre la nota de corretaje asociada con esta transacción. Este
        objeto solo se devuelve para transacciones que están asociadas con un
        tipo de inversión `VARIABLE_INCOME`.


        > 📘 Info

        >

        > Una nota de corretaje (*nota de corretagem*) es un documento oficial
        emitido por una correduría que detalla las transacciones realizadas por
        un inversor en un día determinado. Incluye información sobre el valor
        bruto de todas las compras y ventas, comisiones de corretaje, tarifas de
        compensación y liquidación, tarifas de compensación y registro, tarifas
        de aviso de negociación de activos en bolsa, tarifas de bolsa, tarifas
        de custodia de compensación, impuestos y el impuesto sobre la renta
        retenido en la fuente.
      properties:
        broker_note_number:
          type: string
          pattern: ‘^\d{1,16}$’
          minLength: 1
          maxLength: 16
          description: El número de la nota del broker.
          example: '1854009930314350'
        gross_value:
          type: number
          format: float
          description: El valor bruto de todas las compras y ventas del día.
          example: 1000
        brokerage_fee:
          type: number
          format: float
          description: La tarifa total de corretaje cobrada por el día.
          example: 10
        clearing_settlement_fee:
          type: number
          format: float
          description: La tarifa cobrada por la compensación y liquidación en custodia.
          example: 2.5
        clearing_registration_fee:
          type: number
          format: float
          description: La tarifa cobrada por la compensación y el registro en custodia.
          example: 1
        stock_exchange_asset_trade_notice_fee:
          type: number
          format: float
          description: >-
            La tarifa cobrada por la bolsa de valores por las notificaciones de
            comercio de activos.
          example: 0.5
        stock_exchange_fee:
          type: number
          format: float
          description: >-
            La tarifa cobrada por la bolsa de valores por los servicios de
            registro.
          example: 3
        clearing_custody_fee:
          type: number
          format: float
          description: >-
            La tarifa cobrada por las instituciones financieras por los
            servicios de custodia.
          example: 1.5
        taxes:
          type: number
          format: float
          description: >-
            El monto total de los impuestos cobrados en la transacción del día,
            excluyendo el impuesto sobre la renta retenido en la fuente.
          example: 10
        income_tax:
          type: number
          format: float
          description: >-
            El monto total del impuesto sobre la renta retenido en la fuente
            para el día.
          example: 5
        net_value:
          type: number
          format: float
          description: >-
            El valor neto de la nota del corredor después de deducir los gastos
            por comisiones de corretaje, tarifas de liquidación de compensación,
            tarifas de registro, tarifas de ANA, emolumentos, tarifas de
            custodia, impuestos y IRRF.
          example: 980
    InvestmentTransactionBrazil:
      type: object
      description: Detalles sobre la transacción de inversión.
      title: Objeto de Transacción de Inversión (Brasil)
      x-tags:
        - Investment Transactions Brazil
      properties:
        id:
          $ref: '#/components/schemas/id'
        link:
          $ref: '#/components/schemas/link'
        collected_at:
          $ref: '#/components/schemas/collected_at'
        created_at:
          $ref: '#/components/schemas/created_at'
        investment:
          $ref: '#/components/schemas/InvestmentBrazil'
        internal_identification:
          type: string
          pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{0,99}$
          minLength: 1
          maxLength: 100
          description: >-
            La identificación interna de la institución de la transacción de
            inversión.
          example: ABCD2126019929279212650822221989319253344
        value_date:
          type: string
          format: date
          description: >-
            La fecha en la que se liquidó la transacción, en formato
            `YYYY-MM-DD`.


            > 📘 `VARIABLE_INCOME`

            >

            > Para inversiones de `VARIABLE_INCOME`, solo recibirás
            transacciones hasta la última fecha de negociación. Por ejemplo, si
            hoy es 19.11.2024, solo recibirás transacciones hasta el 18.11.2024.


            > 📘 `INVESTMENT_FUND`

            >

            > Para inversiones de `INVESTMENT_FUND`, esta es la fecha en la que
            la transacción (compra o rescate) se procesa oficialmente en
            acciones o cuotas del fondo. Para compras, esta es la fecha en la
            que el dinero del inversor se aplica para adquirir acciones del
            fondo. Para rescates, esta es la fecha en la que las acciones del
            fondo se convierten oficialmente de nuevo en efectivo.
          example: '2024-11-18'
        gross_value:
          type: number
          format: float
          pattern: ‘^-?\d{1,15}\.\d{2,4}$’
          description: |-
            El valor bruto de la transacción.

            > 🚧 No aplicable para inversiones de `VARIABLE_INCOME`.
          example: 60
        net_value:
          type: number
          format: float
          pattern: ‘^-?\d{1,15}\.\d{2,4}$’
          description: |-
            El valor neto de la transacción.

            > 🚧 No aplicable para inversiones de `VARIABLE_INCOME`.
          example: 60
        value:
          type: number
          format: float
          description: >-
            El valor de la transacción.


            Para inversiones de **`VARIABLE_INCOME`**, este es el valor de la
            operación ejecutada por el cliente. Si el cliente compra o vende
            acciones, este campo indica el valor total de la operación (por
            ejemplo, el precio por acción × cantidad).


            Para inversiones de **`INVESTMENT_FUND`**, este es el valor
            solicitado por el cliente para una transacción de fondo.


            > 🚧 Solo aplicable para inversiones de `VARIABLE_INCOME` y
            `INVESTMENT_FUND`.
          example: 60
        unit_price:
          type: number
          format: float
          description: El precio por una unidad o cuota individual.
          example: 3
        price_factor:
          type: number
          format: float
          description: >-
            El número de unidades (acciones) considerado al calcular el precio
            por acción o unidad para una transacción.


            > 🚧 Solo aplicable para inversiones de `VARIABLE_INCOME`.
          example: 1
        transaction_tax:
          type: number
          format: float
          description: >-
            El Impuesto sobre Operaciones Financieras (*Imposto sobre Operações
            Financeiras (IOF)*) aplicado o retenido durante la transacción.


            > 🚧 No aplicable para inversiones de `VARIABLE_INCOME`.
          example: 0
        income_tax:
          type: number
          format: float
          description: >-
            El Impuesto sobre la Renta (*Imposto de Renda (IR)*) aplicado o
            retenido durante la transacción.


            > 🚧 No aplicable para inversiones de `VARIABLE_INCOME`.
          example: 0
        quantity:
          type: number
          format: float
          description: >-
            El número de unidades, cuotas o activos involucrados en una
            transacción.
          example: 20
        type:
          type: string
          enum:
            - INFLOW
            - OUTFLOW
            - 'null'
          description: >-
            El tipo de transacción (`INFLOW` o `OUTFLOW`) desde la perspectiva
            de la inversión.
          example: INFLOW
        subtype:
          type: string
          description: >-
            El subtipo de transacción.


            - Para `FIXED_INCOME_BANKING`: APLICACAO, RESGATE, CANCELAMENTO,
            VENCIMENTO, PAGAMENTO_JUROS, AMORTIZACAO,
            TRANSFERENCIA_TITULARIDADE, TRANSFERENCIA_CUSTODIA, OUTROS.

            - Para `FIXED_INCOME_CREDIT`: COMPRA, VENDA, CANCELAMENTO,
            VENCIMENTO, PAGAMENTO_JUROS, AMORTIZACAO, PRÊMIO,
            TRANSFERENCIA_TITULARIDADE, TRANSFERENCIA_CUSTODIA, MULTA, MORA,
            OUTROS.

            - Para `VARIABLE_INCOME`: COMPRA, VENDA, DIVIDENDOS, JCP, ALUGUEIS,
            TRANSFERENCIA_TITULARIDADE, OUTROS.

            - Para `INVESTMENT_FUND`: AMORTIZACAO, TRANSFERENCIA_DE_COTAS,
            APLICACAO, RESGATE, COME_COTAS, OUTROS.

            - Para `TREASURY_BOND`: COMPRA, VENDA, CANCELAMENTO, VENCIMENTO,
            PAGAMENTO_JUROS, AMORTIZACAO, TRANSFERENCIA_TITULARIDADE,
            TRANSFERENCIA_CUSTODIA, OUTROS.
          example: null
        subtype_additional_info:
          type: string
          pattern: ‘[\w\W\s]*’
          maxLength: 100
          description: >-
            Información adicional sobre el subtipo de transacción. Este campo es
            obligatorio cuando el subtipo es `OUTROS`.
          example: null
        indexer_percentage:
          type: number
          format: float
          description: >-
            El porcentaje máximo del indexador para el contrato (Bancaria) o
            transacción (Crédito).


            > 🚧 Solo aplicable para inversiones en `FIXED_INCOME_BANKING` y
            `FIXED_INCOME_CREDIT`.
          example: 0
        rate:
          type: number
          format: float
          description: >-
            La tasa de remuneración aplicada a la transacción.


            > 🚧 Solo aplicable para inversiones en `FIXED_INCOME_BANKING`,
            `FIXED_INCOME_CREDIT` y `TREASURY_BOND`.
          example: 0
        exit_fee:
          type: number
          format: float
          description: >-
            La tarifa de salida se aplica a la transacción del Fondo de
            Inversión (Fundos de Investimento). Esta tarifa se cobra cuando un
            cliente rescata o sale del fondo.


            > 🚧 Solo aplicable para inversiones de tipo `INVESTMENT_FUND`.
          example: 0
        broker_note_details:
          $ref: '#/components/schemas/BrokerNote'
    EnumEmploymentRecordStatus:
      type: string
      enum:
        - EMPLOYED
        - RETIRED
        - UNEMPLOYED
        - 'null'
      description: >-
        Indica el estado laboral del individuo. Devolvemos una de las siguientes
        respuestas:

          - `EMPLOYED`
          - `RETIRED`
          - `UNEMPLOYED`
          - `null`
      example: EMPLOYED
    EmploymentRecordEntitlement:
      type: object
      description: Detalles sobre los beneficios a los que tiene derecho el individuo.
      properties:
        entitled_to_health_insurance:
          type: boolean
          description: Indica si el individuo tiene derecho o no a un seguro de salud.
          example: true
        entitled_to_company_benefits:
          type: boolean
          description: >-
            Indica si el individuo tiene derecho o no a beneficios de la
            empresa.
          example: true
        valid_until:
          type: string
          nullable: true
          format: date
          description: >-
            Fecha hasta la cual el individuo está cubierto por el seguro de
            salud y/o beneficios de la empresa. Si es `null`, el empleado está
            trabajando actualmente y no se requiere una fecha de finalización.
          example: null
        status:
          $ref: '#/components/schemas/EnumEmploymentRecordStatus'
    EnumEmploymentRecordDocumentType:
      type: string
      nullable: true
      enum:
        - NSS
        - CURP
        - RFC
      description: >-
        El tipo de documento relacionado con el individuo. Devolvemos uno de los
        siguientes valores:

          - `NSS`
          - `CURP`
          - `RFC`
      example: NSS
    EmploymentRecordDocumentId:
      type: object
      description: Detalles sobre los documentos de identificación del individuo.
      properties:
        document_type:
          $ref: '#/components/schemas/EnumEmploymentRecordDocumentType'
        document_number:
          type: string
          nullable: true
          description: El número del documento de identificación (como una cadena).
          example: '10277663582'
    EmploymentRecordPersonalData:
      type: object
      description: Detalles sobre la información personal del individuo.
      properties:
        official_name:
          type: string
          nullable: true
          description: El nombre legal del individuo.
          example: Bruce Banner del Torro
        first_name:
          type: string
          nullable: true
          description: El primer nombre del individuo.
          example: Bruce
        last_name:
          type: string
          nullable: true
          description: El apellido del individuo.
          example: Banner del Torro
        birth_date:
          type: string
          nullable: true
          format: date
          description: La fecha de nacimiento del individuo, en formato `YYYY-MM-DD`.
          example: '2022-02-09'
        entitlements:
          $ref: '#/components/schemas/EmploymentRecordEntitlement'
        document_ids:
          type: array
          description: Detalles sobre los documentos de identificación del individuo.
          items:
            $ref: '#/components/schemas/EmploymentRecordDocumentId'
        email:
          type: string
          nullable: true
          deprecated: true
          description: La dirección de correo electrónico del individuo.
          example: bruce.banner@avengers.com
    EmploymentRecordSocialSecuritySummary:
      type: object
      nullable: true
      description: >-
        Detalles sobre las contribuciones al seguro social del individuo, de
        acuerdo con el IMSS.


        >**Nota**: Para ISSSTE México, este valor devolverá `null`.
      properties:
        weeks_redeemed:
          type: integer
          nullable: true
          format: int32
          description: Número de semanas que el individuo necesitó retirar de su pensión.
          example: 0
        weeks_reinstated:
          type: integer
          nullable: true
          format: int32
          description: >-
            Número de semanas que el individuo ha vuelto a cotizar en su pensión
            (*AFORE*), después de haberlas retirado previamente.
          example: 0
        weeks_contributed:
          type: integer
          nullable: true
          format: int32
          description: >-
            Número de semanas que el individuo ha contribuido a su seguridad
            social, basado en el número de semanas que el individuo ha trabajado
            según el IMSS.
          example: 188
    EnumEmploymentRecordStatusUpdateEvents:
      type: string
      nullable: true
      enum:
        - DISMISSED_RESIGNED
        - SALARY_MODIFICATION
        - HIRED
        - VOLUNTARY_CONTRIBUTION
        - ABSENCE
        - SICK_LEAVE
        - NORMAL
        - BDUTA_CERTIFICATE
        - DYE_CERTIFICATE
      description: >-
        Para el IMSS en México, este es el evento que causó el cambio en el
        estado de empleo o salario. Devolvemos uno de los siguientes valores:

          - `DISMISSED_RESIGNED`: El empleado fue despedido o renunció.
          - `SALARY_MODIFICATION`: El empleado recibió una modificación salarial (aumento o disminución).
          - `HIRED`: El empleado fue contratado.
          - `VOLUNTARY_CONTRIBUTION`: El empleado realizó una contribución voluntaria al IMSS.
          - `ABSENCE`: El empleado estuvo ausente (como por vacaciones).
          - `SICK_LEAVE`: El empleado estuvo de baja por enfermedad.

        Para el ISSSTE en México, esta es la fuente de información respecto al
        cambio en el estado de empleo o salario. Devolvemos uno de los
        siguientes valores:

          - `NORMAL`: Indica que la información fue recibida del **Instituto de Seguridad y Servicios Sociales de los Trabajadores del Estado (ISSSTE)**.
          - `BDUTA_CERTIFICATE`: Indica que la información fue recibida de la base de datos central, **Base de Datos Única de Trabajadores Activos (BDUTA)**.
          - `DYE_CERTIFICATE`: Indica que la información fue recibida de una institución afiliada, **Dependencia y Entidad (DYE)**.
      example: HIRED
    EmploymentRecordEmploymentStatusUpdates:
      type: object
      description: Detalles sobre cualquier cambio de empleo del individuo.
      nullable: true
      properties:
        event:
          $ref: '#/components/schemas/EnumEmploymentRecordStatusUpdateEvents'
        base_salary:
          type: number
          format: float
          description: |-
            El salario base del individuo, vigente a partir de la `update_date`.

              - Para IMSS México, este valor se calcula incluyendo las prestaciones a las que el individuo tiene derecho durante todo el año.
              - Para ISSSTE México, este valor se calcula excluyendo las prestaciones del individuo.
          example: 1033.09
        update_date:
          type: string
          format: date
          description: >-
            La fecha en que ocurrió el evento de empleo, en formato
            `YYYY-MM-DD`.
          example: '2021-09-01'
    EmploymentRecordDetail:
      type: object
      description: Detalles sobre el historial laboral del individuo.
      properties:
        collected_at:
          type: string
          format: date-time
          description: La marca de tiempo ISO-8601 cuando se recopiló el punto de datos.
          example: '2020-04-23T21:32:55.336854+00:00'
        employer:
          type: string
          description: >-
            El nombre oficial del empleador.


            >**Nota**: Para ISSSTE México, este es el nombre oficial de la
            entidad junto con la entidad responsable de gestionar la información
            del empleado, separados por un punto y coma (`;`). Por ejemplo:
            SECRETARIA DE EDUCACION PUBLICA (SEP);SECRETARIA DE EDUCACION
            PUBLICA (SEP).
          example: Batman Enterprises CDMX
        employer_id:
          type: string
          nullable: true
          description: |-
            El ID oficial del empleador, según el país.

            >**Nota**: Para ISSSTE México, este valor devolverá `null`.
          example: 780-BAT-88769-CDMX
        start_date:
          type: string
          format: date
          description: Fecha de inicio del empleo, en formato `YYYY-MM-DD`.
          example: '2019-10-10'
        end_date:
          type: string
          nullable: true
          format: date
          description: >-
            Fecha en que finalizó el empleo, en formato `YYYY-MM-DD`.


            >**Nota**: Este campo devolverá `null` para el empleo actual del
            usuario.
          example: '2019-12-31'
        weeks_employed:
          type: integer
          format: int32
          description: Número de semanas que el individuo estuvo empleado.
          example: 12
        state:
          type: string
          nullable: true
          description: >-
            En qué estado geográfico estaba empleado el individuo, según el
            país.


            >**Nota**: Para ISSSTE México, este valor devolverá `null`.
          example: DISTRITO FEDERAL
        most_recent_base_salary:
          type: number
          format: float
          description: >-
            El salario base más reciente que la persona ganó.


            - Para el IMSS México, este valor se calcula incluyendo las
            prestaciones a las que la persona tiene derecho durante todo el año.

            - Para el ISSSTE México, este valor se calcula dividiendo
            `monthly_salary` entre 30 (días) y excluye las prestaciones de la
            persona.
          example: 762.54
        monthly_salary:
          type: number
          format: float
          description: >-
            El salario mensual del individuo, incluyendo cualquier beneficio
            adicional.


            - Para IMSS México, este valor se calcula incluyendo los beneficios
            a los que el individuo tiene derecho a lo largo del año.

            - Para ISSSTE México, este valor se calcula excluyendo los
            beneficios.
        currency:
          type: string
          description: El código de moneda de tres letras en el que se paga el salario.
          example: MXN
        employment_status_updates:
          type: array
          nullable: true
          description: Detalles sobre cualquier cambio de empleo del individuo.
          items:
            $ref: '#/components/schemas/EmploymentRecordEmploymentStatusUpdates'
    EmploymentRecordScore:
      type: object
      description: >-
        El puntaje de empleo ofrece una visión sobre la empleabilidad y el
        potencial de generación de ingresos en un período determinado.
      properties:
        score:
          type: integer
          nullable: true
          minimum: 300
          maximum: 900
          description: >-
            Una puntuación entre 300 y 900 que proporciona una visión sobre la
            empleabilidad y el potencial de generación de ingresos.


            - Una puntuación baja (más cercana a 300) podría indicar una menor
            empleabilidad y potencial de generación de ingresos, sugiriendo
            posibles desafíos para asegurar empleo o alcanzar niveles de
            ingresos más altos en el futuro.

            - Una puntuación alta (más cercana a 900) podría sugerir una mayor
            probabilidad de asegurar empleo y generar niveles de ingresos más
            altos.


            La puntuación puede devolver `null` si el individuo no tiene
            historial laboral.
          example: 612
        period:
          type: integer
          minimum: 1
          maximum: 12
          description: >-
            El número de meses (en el futuro) para los cuales se calcula la
            puntuación.


            Por ejemplo, un período de `6` indica que la puntuación se calcula
            para los próximos `6` meses.


            > **Nota**: Actualmente, Belvo calcula la puntuación para 3, 6 y 12
            meses.
          example: 6
        version:
          type: string
          description: >-
            La versión de nuestro modelo de puntuación de empleo utilizada para
            realizar el cálculo.
          example: 1.0.0
    EmploymentRecordFile:
      type: object
      description: >-
        Archivos binarios PDF adicionales relacionados con el empleo del
        individuo.
      properties:
        type:
          type: string
          description: El título del documento.
          example: ReporteSemanasCotizadas_190123
        value:
          type: string
          nullable: true
          description: |-
            El binario PDF del archivo (como una cadena).

            > **Nota**: En nuestro entorno sandbox, este campo devolverá `null`.
          example: '=PDF_BINARY='
    EmploymentRecord:
      type: object
      description: Carga útil de respuesta del registro de empleo
      title: Objeto de Registro de Empleo (México)
      x-tags:
        - Employment Records Mexico
      properties:
        id:
          $ref: '#/components/schemas/id'
        link:
          $ref: '#/components/schemas/link'
        created_at:
          $ref: '#/components/schemas/created_at'
        collected_at:
          $ref: '#/components/schemas/collected_at'
        report_date:
          type: string
          format: date
          description: >-
            La fecha en que se generó el informe del registro de empleo, en
            formato `YYYY-MM-DD`.
          example: '2023-01-19'
        internal_identification:
          type: string
          description: >-
            ID único para el usuario según la institución. Para IMSS e ISSSTE
            México, este es el CURP.
          example: BLPM951331IONVGR54
        personal_data:
          $ref: '#/components/schemas/EmploymentRecordPersonalData'
        social_security_summary:
          $ref: '#/components/schemas/EmploymentRecordSocialSecuritySummary'
        employment_records:
          type: array
          description: Detalles sobre el historial laboral del individuo.
          items:
            $ref: '#/components/schemas/EmploymentRecordDetail'
        employment_scores:
          type: array
          nullable: true
          description: >-
            Un array de puntuaciones de `employment_record`. Cada puntuación
            proporciona una visión sobre la empleabilidad y el potencial de
            generación de ingresos en un período determinado.


            > **Nota 1**: Este campo solo está disponible para enlaces creados
            con el IMSS de México. Para otras instituciones, este campo
            devolverá `null`.


            > **Nota 2**: Este campo devolverá `null` para los registros de
            empleo recuperados antes del 16-04-2024. Para los registros de
            empleo generados antes del 16-04-2024, necesitarás hacer una nueva
            solicitud POST para recuperar los registros de empleo y calcular las
            puntuaciones.
          items:
            $ref: '#/components/schemas/EmploymentRecordScore'
          example:
            - score: 722
              period: 3
              version: 1.0.0
            - score: 612
              period: 6
              version: 1.0.0
            - score: 570
              period: 12
              version: 1.0.0
        files:
          type: array
          nullable: true
          description: >-
            Archivos binarios PDF adicionales relacionados con el empleo del
            individuo.
          items:
            $ref: '#/components/schemas/EmploymentRecordFile'
    attach_pdf:
      type: boolean
      default: false
      description: >-
        Cuando se establece en `true`, recibirás el PDF en formato binario en la
        respuesta.
      example: true
    CurrentEmploymentDocumentId:
      type: object
      description: Detalles sobre los documentos de identificación del individuo.
      properties:
        document_type:
          $ref: '#/components/schemas/EnumEmploymentRecordDocumentType'
        document_number:
          type: string
          nullable: true
          description: El número del documento de identificación (como una cadena).
          example: '10277663582'
    CurrentEmploymentPersonalData:
      type: object
      description: Detalles sobre la información personal del individuo.
      properties:
        official_name:
          type: string
          nullable: true
          description: El nombre legal del individuo.
          example: Bruce Banner del Torro
        first_name:
          type: string
          nullable: true
          description: El primer nombre del individuo.
          example: Bruce
        last_name:
          type: string
          nullable: true
          description: El apellido del individuo.
          example: Banner del Torro
        birth_date:
          type: string
          nullable: true
          format: date
          description: La fecha de nacimiento del individuo, en formato `YYYY-MM-DD`.
          example: '1990-02-09'
        document_ids:
          type: array
          description: Detalles sobre los documentos de identificación del individuo.
          items:
            $ref: '#/components/schemas/CurrentEmploymentDocumentId'
    CurrentEmploymentRecord:
      type: object
      description: Detalles del registro de empleo actual
      required:
        - employer
        - employer_id
        - employer_rfc
        - state
        - days_employed
        - base_salary
        - monthly_salary
      properties:
        employer:
          type: string
          description: El nombre oficial del empleador.
          example: Batman Enterprises CDMX
        employer_id:
          type: string
          description: El ID oficial del empleador, según el país.
          example: '123456789010'
        employer_rfc:
          type: string
          description: El RFC del empleador (número de identificación fiscal).
          example: RFC123456
        state:
          type: string
          description: El estado geográfico donde se encuentra el empleo.
          example: CDMX
        days_employed:
          type: integer
          description: >-
            El número de días que el individuo ha estado empleado con este
            empleador.
          example: 365
        base_salary:
          type: number
          format: float
          description: El salario base del individuo.
          example: 10000
        monthly_salary:
          type: number
          format: float
          description: >-
            El salario mensual del individuo, incluidos cualquier beneficio
            adicional.
          example: 304166.67
    CurrentEmployment:
      type: object
      description: Carga útil de respuesta del estado actual de empleo
      title: Objeto de Empleo Actual (México)
      x-tags:
        - Current Employments Mexico
      required:
        - id
        - link
        - created_at
        - collected_at
        - status
        - personal_data
      properties:
        id:
          $ref: '#/components/schemas/id'
        link:
          $ref: '#/components/schemas/link'
        created_at:
          $ref: '#/components/schemas/created_at'
        collected_at:
          $ref: '#/components/schemas/collected_at'
        month:
          type: string
          nullable: true
          pattern: ^\d{4}-\d{2}$
          description: >-
            El mes para el cual se informa el estado de empleo actual, en
            formato `YYYY-MM`. Si `status` es `UNEMPLOYED`, este campo es
            `null`.
          example: 2023-01
        internal_identification:
          type: string
          nullable: true
          description: >-
            ID único para el usuario según la institución. Para IMSS e ISSSTE
            México, esto es el CURP. Si `status` es `UNEMPLOYED`, este campo es
            `null`.
          example: BLPM230130IONVGR54
        personal_data:
          $ref: '#/components/schemas/CurrentEmploymentPersonalData'
        status:
          type: string
          enum:
            - EMPLOYED
            - UNEMPLOYED
          description: El estado actual de empleo del individuo.
          example: EMPLOYED
        current_employment_records:
          type: array
          minItems: 1
          nullable: true
          description: >-
            Detalles sobre el empleo actual del individuo. Si `status` es
            `UNEMPLOYED`, este campo es `null`.
          items:
            $ref: '#/components/schemas/CurrentEmploymentRecord'
    EmployerDataBrazil:
      type: object
      description: Detalles sobre el empleador.
      additionalProperties: false
      required:
        - name
        - code
        - economic_activity
      properties:
        name:
          type: string
          minLength: 5
          description: El nombre del empleador.
          example: Wayne Industries
        code:
          type: string
          minLength: 8
          maxLength: 14
          description: El código único de la institución para el empleador.
          example: '49430669'
        economic_activity:
          type: string
          minLength: 4
          description: >-
            La principal actividad económica en la que está involucrado el
            empleador. Para Brasil, este es el código de la *Classificação
            Nacional de Atividades Econômicas* (CNAE).
          example: 6421-2 - BANCOS COMERCIAIS
    OccupationBrazil:
      type: object
      description: Detalles sobre la ocupación que el empleado tenía en el empleador.
      additionalProperties: false
      required:
        - start_date
        - end_date
        - description
        - name
        - locale
      properties:
        start_date:
          type: string
          format: date
          pattern: ^\d{4}-\d{2}-\d{2}$
          minLength: 10
          maxLength: 10
          description: >-
            La fecha en que el empleado comenzó el puesto, en formato
            `YYYY-MM-DD`.
          example: '2022-01-01'
        end_date:
          type: string
          format: date
          nullable: true
          pattern: ^\d{4}-\d{2}-\d{2}$
          minLength: 10
          maxLength: 10
          description: >-
            La fecha en que el empleado dejó de trabajar en este puesto, en
            formato `YYYY-MM-DD`. Si es `null`, esto significa que el empleado
            aún ocupa este puesto.
          example: '2023-01-01'
        description:
          type: string
          minLength: 5
          description: >-
            El puesto que ocupaba el empleado. Para Brasil, esta descripción
            debe estar de acuerdo con el Ministerio de Trabajo y figurar en la
            *Classificação Brasileira de Ocupações* (CBO).
          example: ANALISTA DE PRODUTOS BANCARIOS
        name:
          type: string
          minLength: 5
          description: >-
            La ocupación de los empleados, según lo proporcionado por el
            empleador.
          example: ANALISTA DE PRODUTOS BANCARIOS - 2525-40
        locale:
          type: string
          description: >-
            Donde el empleado cumplió con sus deberes. Para Brasil, esto puede
            ser:
              - `Urbana` (Urbano)
              - `Rural` (Rural)
              - `Não Identificado`
              - `null`
          example: Urbana
    EnumEmploymentSalaryType:
      type: string
      nullable: true
      enum:
        - REGULAR
        - THIRTEENTH
        - null
      description: |-
        El tipo de salario.

        Devolvemos uno de los siguientes valores:
          - `REGULAR`
          - `THIRTEENTH`
          - `null`
      example: REGULAR
    SalaryBrazil:
      type: object
      description: Detalles sobre el salario que el empleado recibió del empleador.
      additionalProperties: false
      required:
        - base_amount
        - retained_amount
        - month
        - currency
      properties:
        base_amount:
          type: number
          format: float
          pattern: ^\d{1,15}\.\d{2,4}$
          description: >-
            El monto base del salario, antes de cualquier deducción o
            bonificación.
          example: 1033.09
        retained_amount:
          type: number
          format: float
          pattern: ^\d{1,15}\.\d{2,4}$
          description: >-
            El monto retenido por el *Instituto Nacional do Seguro Social*
            (INSS) de Brasil.
          example: 0.01
        type:
          $ref: '#/components/schemas/EnumEmploymentSalaryType'
        month:
          type: string
          minLength: 7
          maxLength: 7
          pattern: ^\d{4}-\d{2}$
          description: El mes en que el empleado recibió su salario, en formato `YYYY-MM`.
          example: 2022-01
        currency:
          type: string
          minLength: 3
          maxLength: 3
          pattern: ^[A-Z]{3}$
          description: El código de moneda de tres letras (ISO-4217).
          example: BRL
    EmploymentBrazil:
      type: object
      description: >-
        Detalles sobre el empleo que el empleado tuvo en un determinado
        empleador.
      title: Objeto de Employments (Brasil)
      x-tags:
        - Employments Brazil
      additionalProperties: false
      required:
        - id
        - link
        - created_at
        - collected_at
        - start_date
        - end_date
        - employer_data
        - occupations
        - salaries
      properties:
        id:
          $ref: '#/components/schemas/id'
        link:
          $ref: '#/components/schemas/link'
        created_at:
          $ref: '#/components/schemas/created_at'
        collected_at:
          $ref: '#/components/schemas/collected_at'
        start_date:
          type: string
          format: date
          pattern: ^\d{4}-\d{2}-\d{2}$
          minLength: 10
          maxLength: 10
          description: >-
            La fecha de inicio del empleado en el empleador, en formato
            `YYYY-MM-DD`.
          example: '2022-01-01'
        end_date:
          type: string
          format: date
          nullable: true
          pattern: ^\d{4}-\d{2}-\d{2}$
          minLength: 10
          maxLength: 10
          description: >-
            La fecha de finalización del empleado en el empleador, en formato
            `YYYY-MM-DD`. Si es `null`, el empleado todavía está trabajando en
            el empleador.
          example: '2023-01-01'
        employer_data:
          $ref: '#/components/schemas/EmployerDataBrazil'
        occupations:
          type: array
          description: Las ocupaciones del empleado en el empleador.
          items:
            $ref: '#/components/schemas/OccupationBrazil'
        salaries:
          type: array
          description: Los salarios que el empleado recibió del empleador.
          items:
            $ref: '#/components/schemas/SalaryBrazil'
    EnumIncomeStreamType:
      type: string
      enum:
        - SALARY
        - GOVERNMENT
        - INTEREST
        - RENT
        - RETIREMENT
        - FREELANCE
        - ALTERNATIVE_INCOME
        - TRANSFER
        - DEPOSIT
        - UNKNOWN
      description: |-
        El tipo de ingreso utilizado en los cálculos.

        Devolvemos uno de los siguientes valores de enum:

          - `SALARY`
          - `GOVERNMENT`
          - `INTEREST`
          - `RENT`
          - `RETIREMENT`
          - `FREELANCE`
          - `ALTERNATIVE_INCOME`
          - `TRANSFER`
          - `DEPOSIT`
          - `UNKNOWN`
      example: SALARY
    EnumIncomeStreamFrequency:
      type: string
      enum:
        - MONTHLY
        - FORTNIGHTLY
        - WEEKLY
        - IRREGULAR
        - SINGLE
      description: |-
        Con qué frecuencia se recibe el ingreso.

        Devolvemos uno de los siguientes valores de enum:

          - `MONTHLY` - Para transacciones que ocurren una vez al mes.
          - `FORTNIGHTLY` - Para transacciones que ocurren una vez cada dos semanas.
          - `WEEKLY` - Para transacciones que ocurren una vez por semana.
          - `IRREGULAR` - Para transacciones que no ocurren con un patrón de frecuencia definido.
          - `SINGLE` - Para transacciones que ocurren solo una vez y no se repiten.
      example: MONTHLY
    EnumIncomeStreamConfidence:
      type: string
      enum:
        - HIGH
        - MEDIUM
        - LOW
      description: |-
        Nivel de confianza de Belvo para ingresos futuros.

        Devolvemos uno de los siguientes valores de enum:

          - `HIGH`
          - `MEDIUM`
          - `LOW`
      example: HIGH
    IncomeStreamsBody:
      type: object
      required:
        - account_id
        - income_type
        - frequency
        - monthly_average
        - average_income_amount
        - last_income_amount
        - currency
        - last_income_description
        - last_income_date
        - stability
        - regularity
        - trend
        - lookback_periods
        - full_periods
        - periods_with_income
        - number_of_incomes
        - confidence
      description: >-
        Una lista de fuentes de ingresos para la cuenta.


        Para cada fuente de ingresos, proporcionamos información adicional como:

        - Frecuencia, estabilidad y nivel de confianza de las transacciones de
        ingresos.

        - Métricas clave sobre los montos de las transacciones.

        ℹ️ Si no se encuentran fuentes de ingresos, devolvemos un array vacío.
      properties:
        account_id:
          type: string
          description: >-
            ID único para la cuenta bancaria que se verificará para flujos de
            ingresos.
          example: EBACA-89077589
        income_type:
          $ref: '#/components/schemas/EnumIncomeStreamType'
        frequency:
          $ref: '#/components/schemas/EnumIncomeStreamFrequency'
        monthly_average:
          type: number
          format: float
          description: >-
            La cantidad promedio de ingresos recibidos de la fuente durante
            `periods_with_income`.
          example: 2500
        monthly_median:
          type: number
          format: float
          description: >-
            La cantidad mediana de ingresos recibidos de la fuente durante un
            mes natural.
          example: 2200
        average_income_amount:
          type: number
          format: float
          description: El monto promedio de transacción de ingresos de la fuente.
          example: 2500
        last_income_amount:
          type: number
          format: float
          description: El monto del ingreso más reciente recibido de la fuente.
          example: 2500
        currency:
          type: string
          description: |-
            El código de moneda de tres letras del ingreso. Por ejemplo:

              • 🇧🇷 BRL (Real Brasileño)
              • 🇨🇴 COP (Peso Colombiano)
              • 🇲🇽 MXN (Peso Mexicano)
          example: BRL
        last_income_description:
          type: string
          description: La descripción del ingreso más reciente del stream.
          example: Salário
        last_income_date:
          type: string
          format: date
          description: >-
            La fecha en que se recibió el ingreso más reciente del flujo, en
            formato `YYYY-MM-DD`.
          example: '2023-02-09'
        stability:
          type: number
          nullable: true
          format: float
          description: >-
            La estabilidad del ingreso basada en su cantidad, con un rango de 0
            a 1, donde 1 representa estabilidad perfecta.


            **Nota:** Para transacciones con `frequency`=`SINGLE`, este valor
            devuelve `null`.
          example: 1
        regularity:
          type: number
          nullable: true
          format: float
          description: >-
            La regularidad del ingreso se basa en su frecuencia, con un rango de
            0 a 1, donde 1 representa una regularidad perfecta.


            **Nota:** Para transacciones con `frequency`=`SINGLE`, este valor
            devuelve `null`.
          example: 1
        trend:
          type: number
          nullable: true
          format: float
          description: >-
            La tendencia de ingresos durante un período de tiempo se calcula
            entre el último ingreso y el primer ingreso recibido, donde:
              - un número flotante negativo significa que la tendencia de ingresos está disminuyendo durante el período de tiempo.
              - un número flotante positivo significa que la tendencia de ingresos está aumentando durante el período de tiempo.

            **Nota:** Para transacciones con `frequency`=`SINGLE`, este valor
            devuelve `null`.
          example: 0
        lookback_periods:
          type: integer
          format: int32
          description: >-
            Número de unidades de período (basadas en *meses móviles*)
            utilizadas para generar conocimientos y cálculos.


            **Nota:** Un *mes móvil* es un período de 30 días. Por ejemplo, del
            2023-01-15 al 2023-02-15.
          example: 9
        full_periods:
          type: integer
          format: int32
          description: >-
            Número de unidades de período (basado en *meses móviles*) con datos
            para realizar cálculos.


            **Nota:** Un *mes móvil* es un período de 30 días. Por ejemplo, del
            2023-01-15 al 2023-02-15.
          example: 9
        periods_with_income:
          type: integer
          format: int32
          description: >-
            Número de unidades de período (basadas en *meses móviles*) con al
            menos un ingreso disponible.


            **Nota:** Un *mes móvil* es un período de 30 días. Por ejemplo, del
            2023-01-15 al 2023-02-15.
          example: 9
        number_of_incomes:
          type: integer
          format: int32
          description: Número de transacciones de ingresos durante los `lookback_periods`.
          example: 9
        confidence:
          $ref: '#/components/schemas/EnumIncomeStreamConfidence'
    EnumIncomeSourceType:
      type: string
      enum:
        - BANK
      description: |-
        El tipo de fuente de la que generamos información sobre ingresos.
        Devolvemos uno de los siguientes valores de 'enum':

          - `BANK`
      example: BANK
    Income:
      type: object
      description: Perspectivas de ingresos
      title: Objeto de Ingreso
      x-tags:
        - Incomes
      required:
        - id
        - link
        - created_at
        - income_streams
        - income_source_type
        - first_transaction_date
        - last_transaction_date
        - best_working_day_to_charge
        - good_working_days_to_charge
        - number_of_income_streams
        - monthly_average
        - monthly_average_regular
        - monthly_average_irregular
        - monthly_average_low_confidence
        - monthly_average_medium_confidence
        - monthly_average_high_confidence
        - total_income_amount
        - total_regular_income_amount
        - total_low_confidence
        - total_medium_confidence
        - total_high_confidence
      properties:
        id:
          $ref: '#/components/schemas/id'
        link:
          $ref: '#/components/schemas/link'
        created_at:
          $ref: '#/components/schemas/created_at'
        income_streams:
          type: array
          description: Una matriz de objetos de flujo de ingresos enriquecidos.
          items:
            $ref: '#/components/schemas/IncomeStreamsBody'
        income_source_type:
          $ref: '#/components/schemas/EnumIncomeSourceType'
        first_transaction_date:
          type: string
          nullable: true
          format: date
          description: >-
            La fecha en que ocurrió la primera transacción, en formato
            `YYYY-MM-DD`.
          example: '2022-06-09'
        last_transaction_date:
          type: string
          format: date
          description: >-
            La fecha en la que ocurrió la última transacción, en formato
            `YYYY-MM-DD`.
          example: '2023-02-09'
        best_working_day_to_charge:
          type: integer
          format: int32
          description: El mejor día laborable del mes para cobrar al usuario.
          example: 22
        good_working_days_to_charge:
          type: array
          minItems: 0
          maxItems: 3
          items:
            type: integer
            format: int32
          description: >-
            Días laborales adicionales que se han identificado como buenos días
            para cobrar al usuario.
          example:
            - 17
            - 7
            - 2
        number_of_income_streams:
          type: integer
          format: int32
          description: Número de flujos de ingresos totales analizados.
          example: 1
        monthly_average:
          type: number
          format: float
          description: >-
            Cantidad promedio de ingresos recibidos por mes en todas las cuentas
            para el usuario específico.
          example: 2500
        monthly_average_regular:
          type: number
          format: float
          description: >-
            Cantidad promedio de ingresos regulares (con una frecuencia de
            `MONTHLY`, `FORTNIGHTLY` o `WEEKLY`) recibidos por mes para el
            usuario específico.
          example: 2500
        monthly_average_irregular:
          type: number
          format: float
          description: >-
            Monto promedio de ingresos irregulares (con una frecuencia de
            `SINGLE` o `IRREGULAR`) recibidos por mes para el usuario
            específico.
          example: 0
        monthly_average_low_confidence:
          type: number
          format: float
          description: >-
            Cantidad promedio de ingresos recibidos por mes para el usuario
            específico con confianza `LOW`.
          example: 0
        monthly_average_medium_confidence:
          type: number
          format: float
          description: >-
            Cantidad promedio de ingresos recibidos por mes para el usuario
            específico con confianza `MEDIUM`.
          example: 0
        monthly_average_high_confidence:
          type: number
          format: float
          description: >-
            Cantidad promedio de ingresos recibidos por mes para el usuario
            específico con confianza `HIGH`.
          example: 2500
        total_income_amount:
          type: number
          format: float
          description: >-
            Monto total de todos los ingresos recibidos para el usuario
            específico.
          example: 22500
        total_regular_income_amount:
          type: number
          format: float
          description: >-
            Cantidad total de ingresos regulares (con una frecuencia de
            `MONTHLY`, `FORTNIGHTLY`, `WEEKLY`) para el usuario específico.
          example: 22500
        total_irregular_income_amount:
          type: number
          format: float
          description: >-
            Monto total de ingresos irregulares (con una frecuencia de `SINGLE`
            o `IRREGULAR`) para el usuario específico.
          example: 0
        total_low_confidence:
          type: number
          format: float
          description: >-
            Cantidad total de ingresos para el usuario específico con confianza
            `LOW`.
          example: 0
        total_medium_confidence:
          type: number
          format: float
          description: >-
            Cantidad total de ingresos para el usuario específico con confianza
            `MEDIUM`.
          example: 0
        total_high_confidence:
          type: number
          format: float
          description: >-
            Cantidad total de ingresos para el usuario específico con confianza
            `HIGH`.
          example: 22500
    EnumInvoiceAllowedIncomeTypesRequest:
      type: string
      enum:
        - SALARY
        - GOVERNMENT
        - INTEREST
        - RENT
        - RETIREMENT
        - FREELANCE
        - ALTERNATIVE_INCOME
        - TRANSFER
        - DEPOSIT
        - UNKNOWN
      description: |-
        Las categorías de los ingresos para los que deseas obtener información.

        Puedes enviar uno o más de los siguientes valores:
          - `SALARY`
          - `GOVERNMENT`
          - `INTEREST`
          - `RENT`
          - `RETIREMENT`
          - `FREELANCE`
          - `ALTERNATIVE_INCOME`
          - `TRANSFER`
          - `DEPOSIT`
          - `UNKNOWN`
      example: SALARY
    EnumIncomeMinimumConfidenceLevelRequest:
      type: string
      enum:
        - HIGH
        - MEDIUM
        - LOW
      description: >-
        El nivel de confianza mínimo de los ingresos para los que deseas obtener
        información.


        Puedes enviar uno de los siguientes valores:

          - `HIGH`
          - `MEDIUM`
          - `LOW`
      example: HIGH
    EnumAccountCategory:
      type: string
      nullable: true
      enum:
        - CHECKING_ACCOUNT
        - CREDIT_CARD
        - INVESTMENT_ACCOUNT
        - LOAN_ACCOUNT
        - PENSION_FUND_ACCOUNT
        - SAVINGS_ACCOUNT
        - UNCATEGORIZED
        - null
      description: |-
        El tipo de cuenta.  
        Devolvemos uno de los siguientes valores del enum:  
          - `CHECKING_ACCOUNT`
          - `CREDIT_CARD`
          - `INVESTMENT_ACCOUNT`
          - `LOAN_ACCOUNT`
          - `PENSION_FUND_ACCOUNT`
          - `SAVINGS_ACCOUNT`
          - `UNCATEGORIZED`
          - `null`
      example: CHECKING_ACCOUNT
    AccountsBalance:
      type: object
      required:
        - current
      description: Detalles sobre los saldos actual y disponible de la cuenta.
      properties:
        current:
          type: number
          nullable: true
          format: float
          description: >-
            El saldo actual se calcula de manera diferente según el tipo de
            cuenta.


            - **💰 Cuentas corrientes y de ahorro**:


            El saldo de la cuenta del usuario en el momento del timestamp
            `collected_at`.


            - **💳 Tarjetas de crédito**:


            La cantidad que el usuario ha gastado en el período de facturación
            actual de la tarjeta (consulte `credit_data.cutting_date` para
            obtener información sobre cuándo finaliza el período de facturación
            actual).


            - **🏡 Cuentas de préstamo**:


            La cantidad restante por pagar en el préstamo del usuario.
          example: 5874.13
        available:
          type: number
          nullable: true
          format: float
          description: >-
            El saldo que el propietario de la cuenta puede utilizar.


            - **💰 Cuentas corrientes y de ahorro**:


            El saldo disponible puede ser diferente al saldo `current` debido a
            transacciones pendientes.


            - **💳 Tarjetas de crédito**:


            El monto de crédito que el usuario aún tiene disponible para el
            período actual. El saldo `available` puede ser diferente al saldo
            `current` debido a transacciones pendientes o cuotas futuras.


            - **🏡 Cuentas de préstamo**:


            El valor presente requerido para liquidar el préstamo, según lo
            proporcionado por la institución.


            **Nota:** Si la institución no proporciona este valor, devolvemos
            `null`.
          example: 5621.12
    AccountsCreditData:
      type: object
      nullable: true
      required:
        - credit_limit
        - cutting_date
        - next_payment_date
        - minimum_payment
        - no_interest_payment
        - interest_rate
        - collected_at
      description: Las opciones de crédito asociadas con esta cuenta.
      properties:
        credit_limit:
          type: number
          nullable: true
          format: float
          example: 192000
          description: La cantidad máxima de crédito que el propietario puede recibir.
        collected_at:
          $ref: '#/components/schemas/collected_at'
        cutting_date:
          type: string
          nullable: true
          example: '2019-12-11'
          description: La fecha de cierre del período de crédito, en formato `YYYY-MM-DD`.
        next_payment_date:
          type: string
          description: >-
            La fecha de vencimiento para el próximo pago, en formato
            `YYYY-MM-DD`.
          example: '2019-12-13'
        minimum_payment:
          type: number
          nullable: true
          format: float
          example: 2400.3
          description: El monto mínimo a pagar en la `next_payment_date`.
        no_interest_payment:
          type: number
          nullable: true
          format: float
          example: 2690.83
          description: La cantidad mínima requerida para pagar y evitar generar intereses.
        interest_rate:
          type: number
          nullable: true
          format: float
          description: La tasa de interés anualizada del crédito.
          example: 4
        monthly_payment:
          type: number
          nullable: true
          deprecated: true
          description: >-
            *Este campo ha sido desaprobado. Para obtener más información sobre
            Belvo y la desaprobación, consulta nuestra explicación de campos
            desaprobados.*


            *El pago mensual recurrente, si corresponde.*
          example: null
        last_payment_date:
          type: string
          nullable: true
          deprecated: true
          description: >-
            *Este campo ha sido desaprobado. Para obtener más información sobre
            Belvo y la desaprobación, consulta nuestra explicación de campos
            desaprobados.*


            *La fecha en que se realizó el último pago de crédito, en formato
            `YYYY-MM-DD`.*
          example: null
        last_period_balance:
          type: string
          nullable: true
          deprecated: true
          description: >-
            *Este campo ha quedado obsoleto. Para obtener más información sobre
            Belvo y la obsolescencia, consulte nuestra explicación de Campos
            obsoletos.*


            *El saldo restante después de la `last_payment_date`.*
          example: null
    EnumLoanDataInterestRateType:
      type: string
      nullable: true
      enum:
        - MONTHLY
        - YEARLY
      description: >-
        El período en el que se aplica el interés al préstamo. Devolvemos uno de
        los siguientes valores:

          - `MONTHLY`
          - `YEARLY`
      example: MONTHLY
    AccountsLoanDataInterestRate:
      type: object
      required:
        - name
        - type
        - value
      description: Desglose del interés aplicado al préstamo.
      properties:
        name:
          type: string
          nullable: true
          description: El nombre del tipo de tasa de interés aplicada al préstamo.
          example: jurosEfetivo
        type:
          $ref: '#/components/schemas/EnumLoanDataInterestRateType'
        value:
          type: number
          nullable: true
          format: float
          description: La tasa de interés (en porcentaje o valor monetario).
          example: 7.85
    EnumLoanDataFeeType:
      type: string
      enum:
        - OPERATION_FEE
        - INSURANCE_FEE
        - OTHERS
      description: |-
        El tipo de tarifa. Devolvemos uno de los siguientes valores:

          - `OPERATION_FEE`
          - `INSURANCE_FEE`
          - `OTHERS`
      example: OPERATION_FEE
    AccountsLoanDataFees:
      type: object
      nullable: true
      required:
        - type
        - value
      description: Desglose de las tarifas aplicadas al préstamo.
      properties:
        type:
          $ref: '#/components/schemas/EnumLoanDataFeeType'
        value:
          type: number
          format: float
          description: El valor total de la tarifa. Misma moneda del Préstamo.
          example: 5.6
    AccountsLoanData:
      type: object
      nullable: true
      required:
        - principal
        - monthly_payment
        - outstanding_balance
        - interest_rates
        - collected_at
      description: Las opciones de préstamo asociadas con esta cuenta.
      properties:
        collected_at:
          $ref: '#/components/schemas/collected_at'
        contract_amount:
          type: number
          nullable: true
          format: float
          description: >-
            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
        principal:
          type: number
          nullable: true
          format: float
          description: Monto total del préstamo (la cantidad que el usuario recibe).
          example: 192000
        loan_type:
          type: string
          nullable: true
          description: El tipo de préstamo, según la institución.
          example: Consignado
        payment_day:
          type: string
          nullable: true
          description: >-
            El día del mes en el que el propietario necesita pagar el préstamo
            (`DD`).
          example: '27'
        outstanding_principal:
          type: number
          nullable: true
          format: float
          description: >-
            Monto pendiente del préstamo, es decir, cuánto queda por pagar del
            principal (sin incluir intereses).
          example: 142023
        outstanding_balance:
          type: number
          nullable: true
          format: float
          description: El monto restante a pagar en total, incluidos los intereses.
          example: 182000
        monthly_payment:
          type: number
          nullable: true
          format: float
          description: El pago mensual recurrente, si corresponde.
          example: 1000
        interest_rates:
          type: array
          nullable: true
          description: Desglose del interés aplicado al préstamo.
          items:
            $ref: '#/components/schemas/AccountsLoanDataInterestRate'
        fees:
          type: array
          nullable: true
          description: Desglose de las tarifas aplicadas al préstamo.
          items:
            $ref: '#/components/schemas/AccountsLoanDataFees'
        number_of_installments_total:
          type: integer
          nullable: true
          format: int32
          description: El número total de cuotas necesarias para pagar el préstamo.
          example: 60
        number_of_installments_outstanding:
          type: integer
          nullable: true
          format: int32
          description: El número de cuotas restantes por pagar.
          example: 48
        contract_start_date:
          type: string
          nullable: true
          description: >-
            La fecha en que se firmó el contrato de préstamo, en formato
            `YYYY-MM-DD`.
          example: '2020-03-01'
        contract_end_date:
          type: string
          format: date
          description: >-
            La fecha en la que se espera que el préstamo se complete, en formato
            `YYYY-MM-DD`.
          example: '2027-10-01'
        contract_number:
          type: string
          nullable: true
          description: >-
            El número de contrato del préstamo, tal como lo proporciona la
            institución.
          example: 890ASLDJF87SD00
        credit_limit:
          type: number
          nullable: true
          deprecated: true
          description: >-
            *Este campo ha quedado obsoleto. Para obtener más información sobre
            Belvo y la obsolescencia, consulte nuestra explicación de Campos
            obsoletos.*


            Por favor, consulte `principal` en su lugar.
          example: null
        last_period_balance:
          type: number
          nullable: true
          deprecated: true
          description: >-
            *Este campo ha quedado obsoleto. Para obtener más información sobre
            Belvo y la obsolescencia, consulte nuestra explicación de Campos
            obsoletos.*


            Por favor, consulte `outstanding_balance` en su lugar.
          example: null
        interest_rate:
          type: number
          nullable: true
          deprecated: true
          description: >-
            *Este campo ha quedado obsoleto. Para obtener más información sobre
            Belvo y la obsolescencia, consulte nuestra explicación de Campos
            obsoletos.*


            Por favor, consulte el objeto `interest_rates` en su lugar.
          example: null
        limit_day:
          type: string
          nullable: true
          deprecated: true
          description: >-
            *Este campo ha quedado obsoleto. Para obtener más información sobre
            Belvo y la obsolescencia, consulte nuestra explicación de campos
            obsoletos.*


            Por favor, consulte `payment_day` en su lugar.
          example: null
        cutting_day:
          type: string
          nullable: true
          deprecated: true
          description: >-
            *Este campo ha sido desaprobado. Para obtener más información sobre
            Belvo y la desaprobación, consulte nuestra explicación de campos
            desaprobados.*


            El día de cierre del mes para el préstamo.
          example: null
        cutting_date:
          type: string
          nullable: true
          deprecated: true
          description: >-
            *Este campo ha sido desaprobado. Para obtener más información sobre
            Belvo y la desaprobación, consulta nuestra explicación de campos
            desaprobados.*


            La fecha de cierre del período del préstamo, en formato
            `YYYY-MM-DD`.
          example: null
        last_payment_date:
          type: string
          nullable: true
          deprecated: true
          description: >-
            *Este campo ha sido desaprobado. Para obtener más información sobre
            Belvo y la desaprobación, consulta nuestra explicación de campos
            desaprobados.*


            La fecha en que se realizó el último pago del préstamo, en formato
            `YYYY-MM-DD`.
        next_payment_date:
          type: string
          nullable: true
          deprecated: true
          description: >-
            *Este campo ha sido desaprobado. Para obtener más información sobre
            Belvo y la desaprobación, consulte nuestra explicación de Campos
            desaprobados.*


            Por favor, use `payment_day` en su lugar, en formato `YYYY-MM-DD`.
          example: null
        no_interest_payment:
          type: number
          nullable: true
          deprecated: true
          description: >-
            *Este campo ha sido desaprobado. Para obtener más información sobre
            Belvo y la desaprobación, consulte nuestra explicación de campos
            desaprobados.*


            La cantidad mínima requerida para pagar y evitar generar intereses.
          example: null
    AccountsFundsDataPublicIdentifications:
      type: object
      required:
        - name
        - value
      properties:
        name:
          type: string
          description: El tipo de número de identificación para el fondo.
          example: CNPJ
        value:
          type: string
          nullable: true
          description: El número de identificación del fondo.
          example: 05.954.445/0221-68
    AccountsFundsData:
      type: object
      properties:
        collected_at:
          $ref: '#/components/schemas/collected_at'
        name:
          type: string
          nullable: true
          example: FIX X
          description: El nombre del fondo de pensiones.
        type:
          type: string
          nullable: true
          example: CNPJ
          description: Tipo de fondo de pensiones.
        public_identifications:
          type: array
          nullable: true
          description: Los IDs públicos del fondo.
          items:
            $ref: '#/components/schemas/AccountsFundsDataPublicIdentifications'
        balance:
          type: number
          nullable: true
          format: float
          example: 88427.94
          description: El monto en el fondo.
        percentage:
          type: number
          nullable: true
          format: float
          example: 100
          description: >-
            Cuánto contribuye este fondo, como porcentaje, al total de la cuenta
            de pensión.
    Account:
      type: object
      nullable: true
      title: Cuentas Estándar (Multi-Region)
      description: >-
        Detalles sobre la cuenta.


        **Nota**: Para nuestro recurso de gastos recurrentes, esta cuenta se
        refiere a la cuenta que fue analizada para generar el informe de gastos
        recurrentes.
      required:
        - name
        - number
        - type
        - category
        - public_identification_name
        - public_identification_value
        - currency
        - balance
        - balance_type
        - credit_data
        - loan_data
        - collected_at
        - last_accessed_at
      properties:
        id:
          $ref: '#/components/schemas/id'
        link:
          $ref: '#/components/schemas/link'
        institution:
          $ref: '#/components/schemas/InstitutionAccount'
        collected_at:
          $ref: '#/components/schemas/collected_at'
        created_at:
          $ref: '#/components/schemas/created_at'
        category:
          $ref: '#/components/schemas/EnumAccountCategory'
        balance_type:
          type: string
          nullable: true
          description: >-
            Indica si esta cuenta es un `ASSET` o un `LIABILITY`. Puedes
            considerar el saldo de un `ASSET` como positivo, mientras que el
            saldo de un `LIABILITY` como negativo.
          example: ASSET
        type:
          type: string
          nullable: true
          description: El tipo de cuenta, según lo designado por la institución.
          example: Cuentas de efectivo
        name:
          type: string
          nullable: true
          description: El nombre de la cuenta, tal como lo proporciona la institución.
          example: Cuenta Perfiles- M.N. - MXN-666
        number:
          type: string
          nullable: true
          description: El número de cuenta, según lo designado por la institución.
          example: '4057068115181'
        balance:
          $ref: '#/components/schemas/AccountsBalance'
        currency:
          type: string
          nullable: true
          description: >-
            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
        public_identification_name:
          type: string
          nullable: true
          description: >-
            El nombre público para el tipo de identificación. Por ejemplo:
            `"CLABE"`.


            ℹ️ Para cuentas de ahorro y cheques en 🇧🇷 Brasil, este campo será
            `AGENCY/ACCOUNT`.
          example: CLABE
        public_identification_value:
          type: string
          nullable: true
          description: >-
            El valor para el `public_identification_name`.


            ℹ️ 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: `0444/45722-0`.
          example: '150194683119900273'
        last_accessed_at:
          $ref: '#/components/schemas/last_accessed_at'
        credit_data:
          $ref: '#/components/schemas/AccountsCreditData'
        loan_data:
          $ref: '#/components/schemas/AccountsLoanData'
        funds_data:
          type: array
          nullable: true
          description: Uno o más fondos que contribuyen a la cuenta de pensión.
          items:
            $ref: '#/components/schemas/AccountsFundsData'
        bank_product_id:
          type: string
          nullable: true
          deprecated: true
          description: >-
            *Este campo ha sido desaprobado. Para obtener más información sobre
            Belvo y la desaprobación, consulta nuestra explicación de campos
            desaprobados.*


            *El ID de producto de la institución para el tipo de cuenta.*
          example: null
        internal_identification:
          deprecated: true
          type: string
          nullable: true
          description: >-
            *Este campo ha sido desaprobado. Para obtener más información sobre
            Belvo y la desaprobación, consulta nuestra explicación de campos
            desaprobados.*


            *La identificación interna de la institución para la cuenta.*
          example: null
    RecurringExpenseSourceTransaction:
      type: object
      nullable: true
      required:
        - amount
        - description
        - value_date
      description: >-
        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.
      properties:
        amount:
          type: number
          format: float
          description: El monto de la transacción.
          example: 2145.45
        description:
          type: string
          nullable: true
          description: >-
            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.


            **Nota:** Para EYOD Risk Insights, la descripción es la que
            proporcionaste en la solicitud inicial.
          example: Netflix.com/march
        value_date:
          type: string
          format: date
          description: La fecha en que ocurrió la transacción, en formato `YYYY-MM-DD`.
          example: '2019-10-23'
    EnumRecurringExpenseFrequency:
      type: string
      enum:
        - MONTHLY
      default: MONTHLY
      description: |-
        La frecuencia con la que ocurre este gasto recurrente.

        ℹ️ **Nota:** Belvo solo identifica frecuencias `MONTHLY`.
      example: MONTHLY
    EnumRecurringExpenseCategory:
      type: string
      enum:
        - Bills & Utilities
        - Credits & Loans
        - Insurance
        - Online Platforms & Leisure
        - Transport & Travel
        - Taxes
      description: >-
        La categoría de transacción para el gasto recurrente. Para obtener más
        información sobre las categorías disponibles, consulte nuestra <a
        href="https://developers.belvo.com/docs/banking#categorizing-transactions"
        target="_blank">documentación de categorización de transacciones</a>.


        - `Online Platforms & Leisure` (Netflix, Spotify, Membresías de
        gimnasio)

        - `Bills & Utilities` (electricidad, teléfono, internet)

        - `Credits & Loans` (adelantos en efectivo de tarjetas de crédito,
        préstamo estudiantil, arrendamiento de embarcaciones)

        - `Insurance` (seguro de hogar, automóvil, y salud & vida)

        - `Transport & Travel` (viaje en Uber, airbnb, estacionamiento)

        - `Taxes` (tarifa de servicio, donación, impuestos judiciales)
      example: Online Platforms & Leisure
    EnumRecurringExpensePaymentType:
      type: string
      nullable: true
      enum:
        - SUBSCRIPTION
        - REGULAR
      description: |-
        El tipo de gasto recurrente. Devolvemos uno de los siguientes valores:

          - `SUBSCRIPTION`
          - `REGULAR`
      example: SUBSCRIPTION
    RecurringExpenses:
      type: object
      title: Objeto de Gastos Recurrentes
      x-tags:
        - Recurring Expenses
      required:
        - account
        - name
        - transactions
        - frequency
        - average_transaction_amount
        - median_transaction_amount
        - days_since_last_transaction
        - category
        - payment_type
      description: >-
        Información sobre gastos recurrentes.


        ℹ️ Si no se encuentran datos sobre gastos recurrentes, devolvemos un
        array vacío.
      properties:
        id:
          $ref: '#/components/schemas/id'
        account:
          $ref: '#/components/schemas/Account'
        name:
          type: string
          nullable: true
          default: null
          description: >-
            El nombre para el gasto recurrente.


            ℹ️ **Nota**: 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
        transactions:
          type: array
          description: >-
            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.
          items:
            $ref: '#/components/schemas/RecurringExpenseSourceTransaction'
        frequency:
          $ref: '#/components/schemas/EnumRecurringExpenseFrequency'
        average_transaction_amount:
          type: number
          format: float
          description: El monto promedio de la transacción del gasto recurrente.
          example: 32.9
        median_transaction_amount:
          type: number
          format: float
          description: El monto medio de la transacción del gasto recurrente.
          example: 32.9
        days_since_last_transaction:
          type: integer
          format: int32
          description: >-
            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
        category:
          $ref: '#/components/schemas/EnumRecurringExpenseCategory'
        payment_type:
          $ref: '#/components/schemas/EnumRecurringExpensePaymentType'
    RiskInsightsAssetMetrics:
      type: object
      nullable: true
      description: >-
        Agregue detalles sobre los activos utilizados en el análisis de
        percepción de riesgos. Para las métricas de activos, solo consideramos
        cuentas corrientes y de ahorros.


        > Las métricas de activos pueden proporcionar una instantánea de la
        riqueza y los activos líquidos de su usuario, indicando cómo gestionan
        su riqueza y su estado financiero actual.
      required:
        - institutions
        - num_accounts
        - num_checking_accounts
        - num_savings_accounts
        - checking_accounts_balance
        - savings_accounts_balance
      properties:
        institutions:
          type: array
          nullable: true
          description: >-
            Una matriz de instituciones de las cuales se recuperó información de
            la cuenta para el usuario.


            > **Nota**: Para la mayoría de los casos de uso, esta matriz solo
            devolverá un elemento.
          items:
            type: string
            description: El nombre de la institución
            example: erebor_mx_retail
          example:
            - erebor_mx_retail
        num_assets_accounts:
          type: integer
          nullable: true
          format: int32
          description: El número total de cuentas encontradas para el usuario.
          example: 1
        num_checking_accounts:
          type: integer
          nullable: true
          format: int32
          description: El número total de cuentas corrientes encontradas para el usuario.
          example: 1
        num_savings_accounts:
          type: integer
          nullable: true
          format: int32
          description: El número total de cuentas de ahorro encontradas para el usuario.
          example: 1
        checking_accounts_balance:
          type: number
          nullable: true
          format: float
          description: El saldo total de cierre de todas las cuentas corrientes.
          example: 35901.46
        savings_accounts_balance:
          type: number
          nullable: true
          format: float
          description: El saldo total de cierre de todas las cuentas de ahorro.
          example: 300.02
    RiskInsightsCreditCardMetrics:
      type: object
      nullable: true
      required:
        - num_accounts
        - sum_credit_limit
        - sum_credit_used
        - credit_card_limit_utilization
      description: >-
        Métricas agregadas calculadas en base a las cuentas de tarjetas de
        crédito del usuario.


        > Las métricas de tarjetas de crédito ilustran los hábitos de un cliente
        con sus tarjetas de crédito, revelando cuántas cuentas de tarjetas de
        crédito tiene un cliente, su límite de crédito total, cuánto de ese
        límite está utilizando y la tasa de utilización de su límite de crédito.
      properties:
        num_accounts:
          type: integer
          format: int32
          minimum: 0
          description: Número de cuentas de tarjetas de crédito asociadas al usuario.
          example: 2
        sum_credit_limit:
          type: number
          nullable: true
          format: float
          description: Suma total de los límites de todas las tarjetas de crédito.
          example: 106560
        sum_credit_used:
          type: number
          nullable: true
          format: float
          description: Suma total de todo el crédito utilizado.
          example: 101020.14
        credit_card_limit_utilization:
          type: number
          nullable: true
          format: float
          description: El porcentaje del límite de la tarjeta de crédito utilizado.
          example: 0.95
    RiskInsightsLoansMetrics:
      type: object
      nullable: true
      description: >-
        Métricas agregadas calculadas en base a las cuentas de préstamo del
        usuario y las cuentas corrientes que tienen sobregiro.


        > Las métricas de préstamos ayudan a comprender el comportamiento de
        préstamo y reembolso de un cliente, lo que puede ayudar a evaluar su
        capacidad para asumir crédito adicional y los posibles riesgos de
        incumplimiento.
      required:
        - num_accounts
        - sum_loans_principal
        - sum_loans_outstanding_principal
        - sum_loans_monthly_payment
        - loan_limit_utilization
        - overdraft_limit
        - overdraft_limit_utilization
      properties:
        num_accounts:
          type: integer
          format: int32
          description: El número de cuentas de préstamo asociadas con el usuario.
          example: 1
        sum_loans_principal:
          type: number
          nullable: true
          format: float
          description: >-
            Suma total del principal de todas las cuentas de préstamo del
            usuario.
          example: 5000
        sum_loans_outstanding_principal:
          type: number
          nullable: true
          format: float
          description: >-
            Suma total del principal pendiente para todas las cuentas de
            préstamo del usuario.
          example: 2000
        sum_loans_monthly_payment:
          type: number
          nullable: true
          format: float
          description: >-
            Suma total de los pagos mensuales de todas las cuentas de préstamo
            del usuario.
          example: 400
        loan_limit_utilization:
          type: number
          nullable: true
          format: float
          description: El porcentaje del límite del préstamo utilizado.
          example: 0.3
        overdraft_limit:
          type: number
          nullable: true
          format: float
          description: >-
            El límite total de sobregiro de todas las cuentas corrientes y de
            ahorro.
          example: 900
        overdraft_limit_utilization:
          type: number
          nullable: true
          format: float
          description: El porcentaje del límite de sobregiro utilizado.
          example: 0.4
    RiskInsightsBalanceMetrics:
      type: object
      nullable: true
      description: >-
        Métricas de balance calculadas en base a los saldos del usuario de las
        cuentas corrientes y de ahorros.
      required:
        - closing_balance
        - min_balance_3d
        - min_balance_1w
        - min_balance_1m
        - min_balance_3m
        - min_balance_6m
        - min_balance_12m
        - mean_balance_3d
        - mean_balance_1w
        - mean_balance_1m
        - mean_balance_3m
        - mean_balance_6m
        - mean_balance_12m
        - max_balance_3d
        - max_balance_1w
        - max_balance_1m
        - max_balance_3m
        - max_balance_6m
        - max_balance_12m
        - std_balance_3d
        - std_balance_1w
        - std_balance_1m
        - std_balance_3m
        - std_balance_6m
        - std_balance_12m
        - balance_trend_3d
        - balance_trend_1w
        - balance_trend_1m
        - balance_trend_3m
        - balance_trend_6m
        - balance_trend_12m
        - days_balance_below_0_3d
        - days_balance_below_0_1w
        - days_balance_below_0_1m
        - days_balance_below_0_3m
        - days_balance_below_0_6m
        - days_balance_below_0_12m
        - days_balance_below_mean_3d
        - days_balance_below_mean_1w
        - days_balance_below_mean_1m
        - days_balance_below_mean_3m
        - days_balance_below_mean_6m
        - days_balance_below_mean_12m
        - days_balance_below_x_3d
        - days_balance_below_x_1w
        - days_balance_below_x_1m
        - days_balance_below_x_3m
        - days_balance_below_x_6m
        - days_balance_below_x_12m
        - balance_threshold_x
      properties:
        closing_balance:
          type: number
          nullable: true
          format: float
          description: El saldo de todas las cuentas en el momento `collected_at`.
          example: 35901.46
        min_balance_3d:
          type: number
          nullable: true
          format: float
          description: El saldo mínimo en los últimos tres días.
          example: 35417.68
        min_balance_1w:
          type: number
          nullable: true
          format: float
          description: El saldo mínimo en la última semana).
          example: 34150.5
        min_balance_1m:
          type: number
          nullable: true
          format: float
          description: El saldo mínimo en el último mes.
          example: 33990.59
        min_balance_3m:
          type: number
          nullable: true
          format: float
          description: El saldo mínimo en los últimos tres meses.
          example: 33990.59
        min_balance_6m:
          type: number
          nullable: true
          format: float
          description: El saldo mínimo en los últimos seis meses.
          example: 33990.59
        min_balance_12m:
          type: number
          nullable: true
          format: float
          description: El saldo mínimo en los últimos doce meses.
          example: 33990.59
        mean_balance_3d:
          type: number
          nullable: true
          format: float
          description: El saldo medio en los últimos tres días.
          example: 35659.57
        mean_balance_1w:
          type: number
          nullable: true
          format: float
          description: El saldo medio en la última semana.
          example: 35077.1
        mean_balance_1m:
          type: number
          nullable: true
          format: float
          description: El saldo medio en el último mes.
          example: 34816.08
        mean_balance_3m:
          type: number
          nullable: true
          format: float
          description: El saldo medio en los últimos tres meses.
          example: 34816.08
        mean_balance_6m:
          type: number
          nullable: true
          format: float
          description: El saldo medio en los últimos seis meses.
          example: 34816.08
        mean_balance_12m:
          type: number
          nullable: true
          format: float
          description: El saldo medio en los últimos doce meses.
          example: 34816.08
        max_balance_3d:
          type: number
          nullable: true
          format: float
          description: El saldo máximo en los últimos tres días.
          example: 35901.46
        max_balance_1w:
          type: number
          nullable: true
          format: float
          description: El saldo máximo en la última semana.
          example: 35901.46
        max_balance_1m:
          type: number
          nullable: true
          format: float
          description: El saldo máximo en el último mes.
          example: 35901.46
        max_balance_3m:
          type: number
          nullable: true
          format: float
          description: El saldo máximo en los últimos tres meses.
          example: 35901.46
        max_balance_6m:
          type: number
          nullable: true
          format: float
          description: El saldo máximo en los últimos seis meses.
          example: 35901.46
        max_balance_12m:
          type: number
          nullable: true
          format: float
          description: El saldo máximo en los últimos doce meses.
          example: 35901.46
        std_balance_3d:
          type: number
          nullable: true
          format: float
          description: La desviación estándar del balance en los últimos tres días.
          example: 279.31
        std_balance_1w:
          type: number
          nullable: true
          format: float
          description: La desviación estándar del balance en la última semana.
          example: 764.03
        std_balance_1m:
          type: number
          nullable: true
          format: float
          description: La desviación estándar del balance en el último mes.
          example: 586.55
        std_balance_3m:
          type: number
          nullable: true
          format: float
          description: La desviación estándar del balance en los últimos tres meses.
          example: 586.55
        std_balance_6m:
          type: number
          nullable: true
          format: float
          description: La desviación estándar del saldo en los últimos seis meses.
          example: 586.55
        std_balance_12m:
          type: number
          nullable: true
          format: float
          description: La desviación estándar del saldo en los últimos doce meses.
          example: 586.55
        balance_trend_3d:
          type: number
          nullable: true
          format: float
          description: La tendencia del saldo del usuario en los últimos tres días.
          example: 193.51
        balance_trend_1w:
          type: number
          nullable: true
          format: float
          description: La tendencia del saldo del usuario en la última semana.
          example: 290.18
        balance_trend_1m:
          type: number
          nullable: true
          format: float
          description: La tendencia del saldo del usuario en el último mes.
          example: 22.6
        balance_trend_3m:
          type: number
          nullable: true
          format: float
          description: La tendencia del saldo del usuario en los últimos tres meses.
          example: 22.6
        balance_trend_6m:
          type: number
          nullable: true
          format: float
          description: La tendencia del saldo del usuario en los últimos seis meses.
          example: 22.6
        balance_trend_12m:
          type: number
          nullable: true
          format: float
          description: La tendencia del saldo del usuario en los últimos doce meses.
          example: 22.6
        days_balance_below_0_3d:
          type: integer
          nullable: true
          format: int32
          description: >-
            El número de días en los que el saldo total de la cuenta es menor o
            igual a 0 en los últimos tres días.
          example: 0
        days_balance_below_0_1w:
          type: integer
          nullable: true
          format: int32
          description: >-
            El número de días en los que el saldo total de la cuenta es menor o
            igual a 0 en la última semana.
          example: 0
        days_balance_below_0_1m:
          type: integer
          nullable: true
          format: int32
          description: >-
            El número de días en que el saldo total de la cuenta es menor o
            igual a 0 en el último mes.
          example: 0
        days_balance_below_0_3m:
          type: integer
          nullable: true
          format: int32
          description: >-
            El número de días en los que el saldo total de la cuenta es menor o
            igual a 0 en los últimos tres meses.
          example: 0
        days_balance_below_0_6m:
          type: integer
          nullable: true
          format: int32
          description: >-
            El número de días en los que el saldo total de la cuenta es menor o
            igual a 0 en los últimos seis meses.
          example: 0
        days_balance_below_0_12m:
          type: integer
          nullable: true
          format: int32
          description: >-
            El número de días en que el saldo total de la cuenta es menor o
            igual a 0 en los últimos doce meses.
          example: 0
        days_balance_below_mean_3d:
          type: integer
          nullable: true
          format: int32
          description: >-
            El número de días en que el saldo medio de la cuenta es menor o
            igual a la cantidad especificada en `mean_daily_balance_3d`.
          example: 2
        days_balance_below_mean_1w:
          type: integer
          nullable: true
          format: int32
          description: >-
            El número de días en que el saldo medio de la cuenta es menor o
            igual a la cantidad especificada en `mean_daily_balance_1w`.
          example: 3
        days_balance_below_mean_1m:
          type: integer
          nullable: true
          format: int32
          description: >-
            El número de días en que el saldo medio de la cuenta es menor o
            igual a la cantidad especificada en `mean_daily_balance_1m`.
          example: 17
        days_balance_below_mean_3m:
          type: integer
          nullable: true
          format: int32
          description: >-
            El número de días en que el saldo medio de la cuenta es menor o
            igual a la cantidad especificada en `mean_daily_balance_3m`.
          example: 17
        days_balance_below_mean_6m:
          type: integer
          nullable: true
          format: int32
          description: >-
            El número de días en que el saldo medio de la cuenta es menor o
            igual a la cantidad especificada en `mean_daily_balance_6m`.
          example: 17
        days_balance_below_mean_12m:
          type: integer
          nullable: true
          format: int32
          description: >-
            El número de días en que el saldo medio de la cuenta es menor o
            igual a la cantidad especificada en `mean_daily_balance_12m`.
          example: 17
        days_balance_below_x_3d:
          type: integer
          nullable: true
          format: int32
          description: >-
            El número de días en los que el saldo total de la cuenta es menor o
            igual a la cantidad especificada en `balance_threshold_x` en los
            últimos tres días.
          example: 0
        days_balance_below_x_1w:
          type: integer
          nullable: true
          format: int32
          description: >-
            El número de días en los que el saldo total de la cuenta es menor o
            igual a la cantidad especificada en `balance_threshold_x` en la
            última semana.
          example: 0
        days_balance_below_x_1m:
          type: integer
          nullable: true
          format: int32
          description: >-
            El número de días en los que el saldo total de la cuenta es menor o
            igual a la cantidad especificada en `balance_threshold_x` en el
            último mes.
          example: 0
        days_balance_below_x_3m:
          type: integer
          nullable: true
          format: int32
          description: >-
            El número de días en los que el saldo total de la cuenta es menor o
            igual a la cantidad especificada en `balance_threshold_x` en los
            últimos tres meses.
          example: 0
        days_balance_below_x_6m:
          type: integer
          nullable: true
          format: int32
          description: >-
            El número de días en los que el saldo total de la cuenta es menor o
            igual a la cantidad especificada en `balance_threshold_x` en los
            últimos seis meses.
          example: 0
        days_balance_below_x_12m:
          type: integer
          nullable: true
          format: int32
          description: >-
            El número de días en los que el saldo total de la cuenta es menor o
            igual a la cantidad especificada en `balance_threshold_x` en los
            últimos doce meses.
          example: 0
        balance_threshold_x:
          type: number
          format: float
          description: >-
            El umbral utilizado para calcular `days_balance_below_x_period`.
            Tenga en cuenta que este valor es específico del país (tanto en
            términos de la cantidad como de la moneda).
          example: 1000
    RiskInsightsTransactionMetrics:
      type: object
      nullable: true
      description: >-
        Métricas agregadas calculadas basadas en las transacciones del usuario
        de cuentas corrientes, de ahorros, de tarjetas de crédito y de
        préstamos.


        > ℹ️ **Nota**

        >

        > Si no hay suficientes datos transaccionales para un período dado,
        devolvemos `null` para los campos calculados y `0` para los campos
        basados en conteo. Por ejemplo, si la cuenta solo ha estado abierta
        durante cinco días (o si has proporcionado datos solo para cinco días),
        devolvemos valores para `_3d`, `_1w` y `_1m`, sin embargo:

        > 

        > - `mean_num_transactions_3m` devolverá `null` ya que no hay datos para
        los meses dos y tres (campo calculado).

        > - `num_transactions_3m` devolverá `0` ya que no hay datos para los
        meses dos y tres (campo basado en conteo).
      required:
        - num_transactions_3d
        - num_transactions_1w
        - num_transactions_1m
        - num_transactions_3m
        - num_transactions_6m
        - num_transactions_12m
        - max_num_transactions_3d
        - max_num_transactions_1w
        - max_num_transactions_1m
        - max_num_transactions_3m
        - max_num_transactions_6m
        - max_num_transactions_12m
        - mean_num_transactions_3d
        - mean_num_transactions_1w
        - mean_num_transactions_1m
        - mean_num_transactions_3m
        - mean_num_transactions_6m
        - mean_num_transactions_12m
        - num_incoming_transactions_3d
        - num_incoming_transactions_1w
        - num_incoming_transactions_1m
        - num_incoming_transactions_3m
        - num_incoming_transactions_6m
        - num_incoming_transactions_12m
        - max_num_incoming_transactions_3d
        - max_num_incoming_transactions_1w
        - max_num_incoming_transactions_1m
        - max_num_incoming_transactions_3m
        - max_num_incoming_transactions_6m
        - max_num_incoming_transactions_12m
        - mean_num_incoming_transactions_3d
        - mean_num_incoming_transactions_1w
        - mean_num_incoming_transactions_1m
        - mean_num_incoming_transactions_3m
        - mean_num_incoming_transactions_6m
        - mean_num_incoming_transactions_12m
        - sum_incoming_amount_3d
        - sum_incoming_amount_1w
        - sum_incoming_amount_1m
        - sum_incoming_amount_3m
        - sum_incoming_amount_6m
        - sum_incoming_amount_12m
        - max_incoming_amount_3d
        - max_incoming_amount_1w
        - max_incoming_amount_1m
        - max_incoming_amount_3m
        - max_incoming_amount_6m
        - max_incoming_amount_12m
        - mean_incoming_amount_3d
        - mean_incoming_amount_1w
        - mean_incoming_amount_1m
        - mean_incoming_amount_3m
        - mean_incoming_amount_6m
        - mean_incoming_amount_12m
        - num_outgoing_transactions_3d
        - num_outgoing_transactions_1w
        - num_outgoing_transactions_1m
        - num_outgoing_transactions_3m
        - num_outgoing_transactions_6m
        - num_outgoing_transactions_12m
        - max_num_outgoing_transactions_3d
        - max_num_outgoing_transactions_1w
        - max_num_outgoing_transactions_1m
        - max_num_outgoing_transactions_3m
        - max_num_outgoing_transactions_6m
        - max_num_outgoing_transactions_12m
        - mean_num_outgoing_transactions_3d
        - mean_num_outgoing_transactions_1w
        - mean_num_outgoing_transactions_1m
        - mean_num_outgoing_transactions_3m
        - mean_num_outgoing_transactions_6m
        - mean_num_outgoing_transactions_12m
        - sum_outgoing_amount_3d
        - sum_outgoing_amount_1w
        - sum_outgoing_amount_1m
        - sum_outgoing_amount_3m
        - sum_outgoing_amount_6m
        - sum_outgoing_amount_12m
        - max_outgoing_amount_3d
        - max_outgoing_amount_1w
        - max_outgoing_amount_1m
        - max_outgoing_amount_3m
        - max_outgoing_amount_6m
        - max_outgoing_amount_12m
        - mean_outgoing_amount_3d
        - mean_outgoing_amount_1w
        - mean_outgoing_amount_1m
        - mean_outgoing_amount_3m
        - mean_outgoing_amount_6m
        - mean_outgoing_amount_12m
        - days_without_transactions_3d
        - days_without_transactions_1w
        - days_without_transactions_1m
        - days_without_transactions_3m
        - days_without_transactions_6m
        - days_without_transactions_12m
        - days_since_last_transaction
        - days_since_last_incoming_transaction
        - days_since_last_outgoing_transaction
        - days_history
      properties:
        num_transactions_3d:
          type: integer
          format: int32
          default: 0
          description: >-
            El número total de transacciones analizadas para determinar las
            perspectivas de riesgo durante los últimos tres días (entrantes y
            salientes).
          example: 26
        num_transactions_1w:
          type: integer
          format: int32
          default: 0
          description: >-
            El número total de transacciones analizadas para determinar las
            perspectivas de riesgo de la última semana (entrantes y salientes).
          example: 46
        num_transactions_1m:
          type: integer
          format: int32
          default: 0
          description: >-
            El número total de transacciones analizadas para determinar las
            perspectivas de riesgo del último mes (entrantes y salientes).
          example: 168
        num_transactions_3m:
          type: integer
          format: int32
          default: 0
          description: >-
            El número total de transacciones analizadas para determinar las
            perspectivas de riesgo durante los últimos tres meses (entrantes y
            salientes).
          example: 460
        num_transactions_6m:
          type: integer
          format: int32
          default: 670
          description: >-
            El número total de transacciones analizadas para determinar las
            perspectivas de riesgo durante los últimos seis meses (entrantes y
            salientes).
          example: 472
        num_transactions_12m:
          type: integer
          format: int32
          default: 0
          description: >-
            El número total de transacciones analizadas para determinar las
            perspectivas de riesgo durante los últimos doce meses (entrantes y
            salientes).
          example: 496
        max_num_transactions_3d:
          type: integer
          format: int32
          default: 0
          description: El número máximo de transacciones de los últimos tres días.
          example: 10
        max_num_transactions_1w:
          type: integer
          format: int32
          default: 0
          description: El número máximo de transacciones de la última semana.
          example: 10
        max_num_transactions_1m:
          type: integer
          format: int32
          default: 0
          description: El número máximo de transacciones del último mes.
          example: 18
        max_num_transactions_3m:
          type: integer
          format: int32
          default: 0
          description: El número máximo de transacciones de los últimos tres meses.
          example: 18
        max_num_transactions_6m:
          type: integer
          format: int32
          default: 0
          description: El número máximo de transacciones de los últimos seis meses.
          example: 18
        max_num_transactions_12m:
          type: integer
          format: int32
          default: 0
          description: El número máximo de transacciones de los últimos doce meses.
          example: 18
        mean_num_transactions_3d:
          type: number
          format: float
          default: 0
          description: El número medio de transacciones de los últimos tres días.
          example: 6.5
        mean_num_transactions_1w:
          type: number
          format: float
          default: 0
          description: El número medio de transacciones de la última semana.
          example: 5.75
        mean_num_transactions_1m:
          type: number
          format: float
          default: 0
          description: El número medio de transacciones del último mes.
          example: 5.42
        mean_num_transactions_3m:
          type: number
          format: float
          default: 0
          description: El número medio de transacciones de los últimos tres meses.
          example: 5.05
        mean_num_transactions_6m:
          type: number
          format: float
          default: 0
          description: El número medio de transacciones de los últimos seis meses.
          example: 2.61
        mean_num_transactions_12m:
          type: number
          format: float
          default: 0
          description: El número medio de transacciones de los últimos doce meses.
          example: 1.37
        num_incoming_transactions_3d:
          type: integer
          format: int32
          default: 0
          description: >-
            El número total de transacciones de entrada en los últimos tres
            días.
          example: 12
        num_incoming_transactions_1w:
          type: integer
          format: int32
          default: 0
          description: El número total de transacciones de entrada de la última semana.
          example: 21
        num_incoming_transactions_1m:
          type: integer
          format: int32
          default: 0
          description: El número total de transacciones de entrada del mes pasado.
          example: 80
        num_incoming_transactions_3m:
          type: integer
          format: int32
          default: 0
          description: >-
            El número total de transacciones de entrada en los últimos tres
            meses.
          example: 229
        num_incoming_transactions_6m:
          type: integer
          format: int32
          default: 0
          description: >-
            El número total de transacciones de entrada en los últimos seis
            meses.
          example: 238
        num_incoming_transactions_12m:
          type: integer
          format: int32
          default: 0
          description: >-
            El número total de transacciones de entrada en los últimos doce
            meses.
          example: 256
        max_num_incoming_transactions_3d:
          type: integer
          format: int32
          default: 0
          description: >-
            El número máximo de transacciones de entrada de los últimos tres
            días.
          example: 6
        max_num_incoming_transactions_1w:
          type: integer
          format: int32
          default: 0
          description: El número máximo de transacciones de entrada de la última semana.
          example: 6
        max_num_incoming_transactions_1m:
          type: integer
          format: int32
          default: 0
          description: El número máximo de transacciones de entrada del mes pasado.
          example: 10
        max_num_incoming_transactions_3m:
          type: integer
          format: int32
          default: 0
          description: >-
            El número máximo de transacciones de entrada en los últimos tres
            meses.
          example: 10
        max_num_incoming_transactions_6m:
          type: integer
          format: int32
          default: 0
          description: >-
            El número máximo de transacciones de entrada en los últimos seis
            meses.
          example: 10
        max_num_incoming_transactions_12m:
          type: integer
          format: int32
          default: 0
          description: >-
            El número máximo de transacciones de entrada en los últimos doce
            meses.
          example: 10
        mean_num_incoming_transactions_3d:
          type: number
          format: float
          default: 0
          description: >-
            El número medio de transacciones de entrada de los últimos tres
            días.
          example: 3
        mean_num_incoming_transactions_1w:
          type: number
          format: float
          default: 0
          description: El número medio de transacciones de entrada de la última semana.
          example: 2.62
        mean_num_incoming_transactions_1m:
          type: number
          format: float
          default: 0
          description: El número medio de transacciones de entrada del mes pasado.
          example: 2.58
        mean_num_incoming_transactions_3m:
          type: number
          format: float
          default: 0
          description: >-
            El número promedio de transacciones de entrada durante los últimos
            tres meses.
          example: 2.52
        mean_num_incoming_transactions_6m:
          type: number
          format: float
          default: 0
          description: >-
            El número medio de transacciones de entrada durante los últimos seis
            meses.
          example: 1.31
        mean_num_incoming_transactions_12m:
          type: number
          format: float
          default: 0
          description: >-
            El número medio de transacciones de entrada durante los últimos doce
            meses.
          example: 0.71
        sum_incoming_amount_3d:
          type: number
          nullable: true
          format: float
          description: >-
            La suma total de todas las transacciones de entrada de los últimos
            tres días.
          example: 17142.16
        sum_incoming_amount_1w:
          type: number
          nullable: true
          format: float
          description: >-
            La suma total de todas las transacciones de entrada de la última
            semana.
          example: 24825.92
        sum_incoming_amount_1m:
          type: number
          nullable: true
          format: float
          description: La suma total de todas las transacciones de entrada del mes pasado.
          example: 75993.36
        sum_incoming_amount_3m:
          type: number
          nullable: true
          format: float
          description: >-
            La suma total de todas las transacciones de entrada de los últimos
            tres meses.
          example: 198197.28
        sum_incoming_amount_6m:
          type: number
          nullable: true
          format: float
          description: >-
            La suma total de todas las transacciones de entrada de los últimos
            seis meses.
          example: 223697.28
        sum_incoming_amount_12m:
          type: number
          nullable: true
          format: float
          description: >-
            La suma total de todas las transacciones de entrada de los últimos
            doce meses.
          example: 274697.28
        max_incoming_amount_3d:
          type: number
          nullable: true
          format: float
          description: La transacción de entrada de mayor valor en los últimos tres días.
          example: 3000
        max_incoming_amount_1w:
          type: number
          nullable: true
          format: float
          description: La transacción de entrada de mayor valor en la última semana.
          example: 3000
        max_incoming_amount_1m:
          type: number
          nullable: true
          format: float
          description: La transacción de entrada de mayor valor en el último mes.
          example: 3000
        max_incoming_amount_3m:
          type: number
          nullable: true
          format: float
          description: La transacción de entrada de mayor valor en los últimos tres meses.
          example: 3000
        max_incoming_amount_6m:
          type: number
          nullable: true
          format: float
          description: La transacción de entrada de mayor valor en los últimos seis meses.
          example: 3000
        max_incoming_amount_12m:
          type: number
          nullable: true
          format: float
          description: La transacción de entrada de mayor valor en los últimos doce meses.
          example: 3000
        mean_incoming_amount_3d:
          type: number
          nullable: true
          format: float
          description: >-
            El valor medio entrante de todas las transacciones en los últimos
            tres días.
          example: 1428.51
        mean_incoming_amount_1w:
          type: number
          nullable: true
          format: float
          description: >-
            El valor medio entrante de todas las transacciones de la última
            semana.
          example: 1182.19
        mean_incoming_amount_1m:
          type: number
          nullable: true
          format: float
          description: El valor medio entrante de todas las transacciones del mes pasado.
          example: 949.92
        mean_incoming_amount_3m:
          type: number
          nullable: true
          format: float
          description: >-
            El valor medio entrante de todas las transacciones en los últimos
            tres meses.
          example: 865.49
        mean_incoming_amount_6m:
          type: number
          nullable: true
          format: float
          description: >-
            El valor medio entrante de todas las transacciones en los últimos
            seis meses.
          example: 939.9
        mean_incoming_amount_12m:
          type: number
          nullable: true
          format: float
          description: >-
            El valor medio entrante de todas las transacciones en los últimos
            doce meses.
          example: 1073.04
        num_outgoing_transactions_3d:
          type: integer
          format: int32
          default: 0
          description: Al número total de transacciones de salida en los últimos tres días.
          example: 14
        num_outgoing_transactions_1w:
          type: integer
          format: int32
          default: 0
          description: Al número total de transacciones de salida en la última semana.
          example: 25
        num_outgoing_transactions_1m:
          type: integer
          format: int32
          default: 0
          description: Al total de transacciones de salida en el último mes.
          example: 88
        num_outgoing_transactions_3m:
          type: integer
          format: int32
          default: 0
          description: >-
            Al número total de transacciones de salida en los últimos tres
            meses.
          example: 231
        num_outgoing_transactions_6m:
          type: integer
          format: int32
          default: 0
          description: >-
            Al número total de transacciones de salida en los últimos seis
            meses.
          example: 234
        num_outgoing_transactions_12m:
          type: integer
          format: int32
          default: 0
          description: >-
            Al número total de transacciones de salida en los últimos doce
            meses.
          example: 240
        max_num_outgoing_transactions_3d:
          type: integer
          format: int32
          default: 0
          description: >-
            El número máximo de transacciones de salida de los últimos tres
            días.
          example: 6
        max_num_outgoing_transactions_1w:
          type: integer
          format: int32
          default: 0
          description: El número máximo de transacciones de salida de la última semana.
          example: 6
        max_num_outgoing_transactions_1m:
          type: integer
          format: int32
          default: 0
          description: El número máximo de transacciones de salida del último mes.
          example: 8
        max_num_outgoing_transactions_3m:
          type: integer
          format: int32
          default: 0
          description: >-
            El número máximo de transacciones de salida en los últimos tres
            meses.
          example: 9
        max_num_outgoing_transactions_6m:
          type: integer
          format: int32
          default: 0
          description: >-
            El número máximo de transacciones de salida en los últimos seis
            meses.
          example: 9
        max_num_outgoing_transactions_12m:
          type: integer
          format: int32
          default: 0
          description: >-
            El número máximo de transacciones de salida en los últimos doce
            meses.
          example: 9
        mean_num_outgoing_transactions_3d:
          type: number
          format: float
          default: 0
          description: El número medio de transacciones de salida de los últimos tres días.
          example: 3.5
        mean_num_outgoing_transactions_1w:
          type: number
          format: float
          default: 0
          description: El número medio de transacciones de salida de la última semana.
          example: 3.12
        mean_num_outgoing_transactions_1m:
          type: number
          format: float
          default: 0
          description: El número medio de transacciones de salida del último mes.
          example: 2.84
        mean_num_outgoing_transactions_3m:
          type: number
          format: float
          default: 0
          description: >-
            El número medio de transacciones de salida durante los últimos tres
            meses.
          example: 2.54
        mean_num_outgoing_transactions_6m:
          type: number
          format: float
          default: 0
          description: >-
            El número medio de transacciones de salida durante los últimos seis
            meses.
          example: 1.29
        mean_num_outgoing_transactions_12m:
          type: number
          format: float
          default: 0
          description: >-
            El número medio de transacciones de salida durante los últimos doce
            meses.
          example: 0.66
        sum_outgoing_amount_3d:
          type: number
          nullable: true
          format: float
          description: >-
            La suma total de todas las transacciones de salida de los últimos
            tres días.
          example: 18246.95
        sum_outgoing_amount_1w:
          type: number
          nullable: true
          format: float
          description: >-
            La suma total de todas las transacciones de salida de la última
            semana.
          example: 26362.25
        sum_outgoing_amount_1m:
          type: number
          nullable: true
          format: float
          description: La suma total de todas las transacciones de salida del mes pasado.
          example: 78243.82
        sum_outgoing_amount_3m:
          type: number
          nullable: true
          format: float
          description: >-
            La suma total de todas las transacciones de salida de los últimos
            tres meses.
          example: 192608.77
        sum_outgoing_amount_6m:
          type: number
          nullable: true
          format: float
          description: >-
            La suma total de todas las transacciones de salida de los últimos
            seis meses.
          example: 201608.77
        sum_outgoing_amount_12m:
          type: number
          nullable: true
          format: float
          description: >-
            La suma total de todas las transacciones de salida de los últimos
            doce meses.
          example: 219608.77
        max_outgoing_amount_3d:
          type: number
          nullable: true
          format: float
          description: La transacción de salida de mayor valor en los últimos tres días.
          example: 3000
        max_outgoing_amount_1w:
          type: number
          nullable: true
          format: float
          description: La transacción de salida de mayor valor en la última semana.
          example: 3000
        max_outgoing_amount_1m:
          type: number
          nullable: true
          format: float
          description: La transacción de salida de mayor valor en el último mes.
          example: 3000
        max_outgoing_amount_3m:
          type: number
          nullable: true
          format: float
          description: La transacción de salida de mayor valor en los últimos tres meses.
          example: 3000
        max_outgoing_amount_6m:
          type: number
          nullable: true
          format: float
          description: La transacción de salida de mayor valor en los últimos seis meses.
          example: 3000
        max_outgoing_amount_12m:
          type: number
          nullable: true
          format: float
          description: La transacción de salida de mayor valor en los últimos doce meses.
          example: 3000
        mean_outgoing_amount_3d:
          type: number
          nullable: true
          format: float
          description: >-
            El valor medio de salida de todas las transacciones en los últimos
            tres días.
          example: 1303.35
        mean_outgoing_amount_1w:
          type: number
          nullable: true
          format: float
          description: >-
            El valor medio de salida de todas las transacciones de la última
            semana.
          example: 1054.49
        mean_outgoing_amount_1m:
          type: number
          nullable: true
          format: float
          description: El valor medio de salida de todas las transacciones del mes pasado.
          example: 889.13
        mean_outgoing_amount_3m:
          type: number
          nullable: true
          format: float
          description: >-
            El valor medio de salida de todas las transacciones en los últimos
            tres meses.
          example: 833.8
        mean_outgoing_amount_6m:
          type: number
          nullable: true
          format: float
          description: >-
            El valor medio de salida de todas las transacciones en los últimos
            seis meses.
          example: 861.58
        mean_outgoing_amount_12m:
          type: number
          nullable: true
          format: float
          description: >-
            El valor medio de salida de todas las transacciones en los últimos
            doce meses.
          example: 915.04
        days_without_transactions_3d:
          type: integer
          format: int32
          default: 0
          description: >-
            El número de días en los que no ocurrieron transacciones en los
            últimos tres días.
          example: 0
        days_without_transactions_1w:
          type: integer
          format: int32
          default: 0
          description: >-
            El número de días en los que no ocurrieron transacciones durante la
            última semana.
          example: 0
        days_without_transactions_1m:
          type: integer
          format: int32
          default: 0
          description: >-
            El número de días en los que no se realizaron transacciones durante
            el último mes.
          example: 0
        days_without_transactions_3m:
          type: integer
          format: int32
          default: 0
          description: >-
            El número de días en los que no ocurrieron transacciones en los
            últimos tres meses.
          example: 0
        days_without_transactions_6m:
          type: integer
          format: int32
          default: 0
          description: >-
            El número de días en los que no ocurrieron transacciones en los
            últimos seis meses.
          example: 87
        days_without_transactions_12m:
          type: integer
          format: int32
          default: 0
          description: >-
            El número de días en los que no ocurrieron transacciones en los
            últimos doce meses.
          example: 261
        days_since_last_transaction:
          type: integer
          format: int32
          default: 0
          description: El número de días desde que ocurrió la última transacción.
          example: 0
        days_since_last_incoming_transaction:
          type: integer
          format: int32
          default: 0
          description: >-
            El número de días desde que ocurrió la última transacción de
            entrada.
          example: 0
        days_since_last_outgoing_transaction:
          type: integer
          format: int32
          default: 0
          description: El número de días desde que ocurrió la última transacción de salida.
          example: 0
        days_history:
          type: integer
          format: int32
          default: 0
          description: >-
            El número de días entre cuando se realizó la solicitud de
            información de riesgo y la primera transacción.
          example: 365
    RiskInsightsCashflowMetrics:
      type: object
      nullable: true
      description: >-
        Métricas agregadas calculadas basadas en las transacciones del usuario
        de cuentas corrientes, de ahorros, de crédito y de préstamos. Sin
        embargo, las transferencias internas (transferencias entre cuentas
        pertenecientes al mismo enlace) no se utilizan en el cálculo.


        {% admonition type="info" %}
          Si no hay suficientes datos transaccionales para un período dado, devolvemos `null`. Por ejemplo, si la cuenta solo ha estado abierta durante 15 días (o solo has proporcionado datos para solo 15 días), devolvemos valores para `_3d`, `_1w` y `_1m`, sin embargo, para `_3m` devolveremos `null` ya que no hay datos para los meses dos y tres.
        {% /admonition %}
      required:
        - max_positive_3d
        - max_positive_1w
        - max_positive_1m
        - max_positive_3m
        - max_positive_6m
        - max_positive_12m
        - max_negative_3d
        - max_negative_1w
        - max_negative_1m
        - max_negative_3m
        - max_negative_6m
        - max_negative_12m
        - mean_positive_3d
        - mean_positive_1w
        - mean_positive_1m
        - mean_positive_3m
        - mean_positive_6m
        - mean_positive_12m
        - mean_negative_3d
        - mean_negative_1w
        - mean_negative_1m
        - mean_negative_3m
        - mean_negative_6m
        - mean_negative_12m
        - sum_positive_3d
        - sum_positive_1w
        - sum_positive_1m
        - sum_positive_3m
        - sum_positive_6m
        - sum_positive_12m
        - sum_positive_trend_3d
        - sum_positive_trend_1w
        - sum_positive_trend_1m
        - sum_positive_trend_3m
        - sum_positive_trend_6m
        - sum_positive_trend_12m
        - sum_negative_3d
        - sum_negative_1w
        - sum_negative_1m
        - sum_negative_3m
        - sum_negative_6m
        - sum_negative_12m
        - sum_negative_trend_3d
        - sum_negative_trend_1w
        - sum_negative_trend_1m
        - sum_negative_trend_3m
        - sum_negative_trend_6m
        - sum_negative_trend_12m
        - positive_to_negative_ratio_3d
        - positive_to_negative_ratio_1w
        - positive_to_negative_ratio_1m
        - positive_to_negative_ratio_3m
        - positive_to_negative_ratio_6m
        - positive_to_negative_ratio_12m
        - net_cashflow_3d
        - net_cashflow_1w
        - net_cashflow_1m
        - net_cashflow_3m
        - net_cashflow_6m
        - net_cashflow_12m
        - net_cashflow_trend_3d
        - net_cashflow_trend_1w
        - net_cashflow_trend_1m
        - net_cashflow_trend_3m
        - net_cashflow_trend_6m
        - net_cashflow_trend_12m
      properties:
        max_positive_3d:
          type: number
          nullable: true
          format: float
          description: >-
            El valor más alto de las transacciones de flujo de caja positivo en
            los últimos tres días.
          example: 1850.12
        max_positive_1w:
          type: number
          nullable: true
          format: float
          description: >-
            El valor más alto de las transacciones de flujo de caja positivo de
            la última semana.
          example: 3808.99
        max_positive_1m:
          type: number
          nullable: true
          format: float
          description: >-
            El valor más alto de las transacciones de flujo de caja positivo del
            mes pasado.
          example: 4012.61
        max_positive_3m:
          type: number
          nullable: true
          format: float
          description: >-
            El valor más alto de las transacciones de flujo de caja positivo en
            los últimos tres meses.
          example: 5001.08
        max_positive_6m:
          type: number
          nullable: true
          format: float
          description: >-
            El valor más alto de las transacciones de flujo de caja positivo en
            los últimos seis meses.
          example: 8500
        max_positive_12m:
          type: number
          nullable: true
          format: float
          description: >-
            El valor más alto de las transacciones de flujo de caja positivo en
            los últimos doce meses.
          example: 8500
        max_negative_3d:
          type: number
          nullable: true
          format: float
          description: >-
            El valor más alto de las transacciones de flujo de caja negativo en
            los últimos tres días.
          example: 3375.43
        max_negative_1w:
          type: number
          nullable: true
          format: float
          description: >-
            El valor más alto de las transacciones de flujo de caja negativo en
            la última semana.
          example: 3375.43
        max_negative_1m:
          type: number
          nullable: true
          format: float
          description: >-
            El valor más alto de las transacciones de flujo de caja negativo en
            el último mes.
          example: 5305.92
        max_negative_3m:
          type: number
          nullable: true
          format: float
          description: >-
            El valor más alto de las transacciones de flujo de caja negativo en
            los últimos tres meses.
          example: 7535.85
        max_negative_6m:
          type: number
          nullable: true
          format: float
          description: >-
            El valor más alto de las transacciones de flujo de caja negativo en
            los últimos seis meses.
          example: 7535.85
        max_negative_12m:
          type: number
          nullable: true
          format: float
          description: >-
            El valor más alto de las transacciones de flujo de caja negativo en
            los últimos doce meses.
          example: 7535.85
        mean_positive_3d:
          type: number
          nullable: true
          format: float
          description: >-
            El valor medio de las transacciones de flujo de caja positivo en los
            últimos tres días.
          example: 1410.54
        mean_positive_1w:
          type: number
          nullable: true
          format: float
          description: >-
            El valor medio de las transacciones de flujo de caja positivo en la
            última semana.
          example: 1665.74
        mean_positive_1m:
          type: number
          nullable: true
          format: float
          description: >-
            El valor medio de las transacciones de flujo de caja positivo en el
            último mes.
          example: 1827.36
        mean_positive_3m:
          type: number
          nullable: true
          format: float
          description: >-
            El valor medio de las transacciones de flujo de caja positivo en los
            últimos tres meses.
          example: 1881.58
        mean_positive_6m:
          type: number
          nullable: true
          format: float
          description: >-
            El valor medio de las transacciones de flujo de caja positivo en los
            últimos seis meses.
          example: 2102.19
        mean_positive_12m:
          type: number
          nullable: true
          format: float
          description: >-
            El valor medio de las transacciones de flujo de caja positivo en los
            últimos doce meses.
          example: 2502.06
        mean_negative_3d:
          type: number
          nullable: true
          format: float
          description: >-
            El valor medio de las transacciones de flujo de caja negativo en los
            últimos tres días.
          example: 3373.48
        mean_negative_1w:
          type: number
          nullable: true
          format: float
          description: >-
            El valor medio de las transacciones de flujo de caja negativo en la
            última semana.
          example: 2477.04
        mean_negative_1m:
          type: number
          nullable: true
          format: float
          description: >-
            El valor medio de las transacciones de flujo de caja negativo en el
            último mes.
          example: 1904.96
        mean_negative_3m:
          type: number
          nullable: true
          format: float
          description: >-
            El valor medio de las transacciones de flujo de caja negativo en los
            últimos tres meses.
          example: 1838.47
        mean_negative_6m:
          type: number
          nullable: true
          format: float
          description: >-
            El valor medio de las transacciones de flujo de caja negativo en los
            últimos seis meses.
          example: 1877.63
        mean_negative_12m:
          type: number
          nullable: true
          format: float
          description: >-
            El valor medio de las transacciones de flujo de caja negativo en los
            últimos doce meses.
          example: 1948.51
        sum_positive_3d:
          type: number
          nullable: true
          format: float
          description: >-
            El total de todas las transacciones que resultaron en un flujo de
            caja positivo en los últimos tres días.
          example: 5642.16
        sum_positive_1w:
          type: number
          nullable: true
          format: float
          description: >-
            El total de todas las transacciones que resultaron en un flujo de
            caja positivo en la última semana.
          example: 13325.92
        sum_positive_1m:
          type: number
          nullable: true
          format: float
          description: >-
            El total de todas las transacciones que resultaron en un flujo de
            caja positivo en el último mes.
          example: 52993.36
        sum_positive_3m:
          type: number
          nullable: true
          format: float
          description: >-
            El total de todas las transacciones que conducen a un flujo de caja
            positivo en los últimos tres meses.
          example: 163697.28
        sum_positive_6m:
          type: number
          nullable: true
          format: float
          description: >-
            El total de todas las transacciones que conducen a un flujo de caja
            positivo en los últimos seis meses.
          example: 189197.28
        sum_positive_12m:
          type: number
          nullable: true
          format: float
          description: >-
            El total de todas las transacciones que conducen a un flujo de caja
            positivo en los últimos doce meses.
          example: 240197.28
        sum_positive_trend_3d:
          type: number
          nullable: true
          format: float
          description: >-
            La tendencia de flujo de caja positivo basada en la suma de todas
            las transacciones positivas en los últimos tres días.
          example: 98.902
        sum_positive_trend_1w:
          type: number
          nullable: true
          format: float
          description: >-
            La tendencia de flujo de caja positivo basada en la suma de todas
            las transacciones positivas de la última semana.
          example: -84.0393
        sum_positive_trend_1m:
          type: number
          nullable: true
          format: float
          description: >-
            La tendencia de flujo de caja positivo basada en la suma de todas
            las transacciones positivas del último mes.
          example: 22.7315
        sum_positive_trend_3m:
          type: number
          nullable: true
          format: float
          description: >-
            La tendencia de flujo de caja positivo basada en la suma de todas
            las transacciones positivas en los últimos tres meses.
          example: 1.8398
        sum_positive_trend_6m:
          type: number
          nullable: true
          format: float
          description: >-
            La tendencia de flujo de caja positivo basada en la suma de todas
            las transacciones positivas en los últimos seis meses.
          example: -17.1869
        sum_positive_trend_12m:
          type: number
          nullable: true
          format: float
          description: >-
            La tendencia de flujo de caja positivo basada en la suma de todas
            las transacciones positivas en los últimos doce meses.
          example: -25.9856
        sum_negative_3d:
          type: number
          nullable: true
          format: float
          description: >-
            El total de todas las transacciones que resultaron en un flujo de
            caja negativo en los últimos tres días.
          example: 6746.95
        sum_negative_1w:
          type: number
          nullable: true
          format: float
          description: >-
            El total de todas las transacciones que resultaron en un flujo de
            caja negativo en la última semana.
          example: 14862.25
        sum_negative_1m:
          type: number
          nullable: true
          format: float
          description: >-
            El total de todas las transacciones que resultaron en un flujo de
            caja negativo en el último mes.
          example: 55243.82
        sum_negative_3m:
          type: number
          nullable: true
          format: float
          description: >-
            El total de todas las transacciones que resultan en un flujo de caja
            negativo en los últimos tres meses.
          example: 158108.77
        sum_negative_6m:
          type: number
          nullable: true
          format: float
          description: >-
            El total de todas las transacciones que resultaron en un flujo de
            caja negativo en los últimos seis meses.
          example: 167108.77
        sum_negative_12m:
          type: number
          nullable: true
          format: float
          description: >-
            El total de todas las transacciones que resultaron en un flujo de
            caja negativo en los últimos doce meses.
          example: 185108.77
        sum_negative_trend_3d:
          type: number
          nullable: true
          format: float
          description: >-
            La tendencia de flujo de caja negativo basada en la suma de todas
            las transacciones negativas en los últimos tres días.
          example: -3.91
        sum_negative_trend_1w:
          type: number
          nullable: true
          format: float
          description: >-
            La tendencia de flujo de caja negativo basada en la suma de todas
            las transacciones negativas de la última semana.
          example: 254.2517
        sum_negative_trend_1m:
          type: number
          nullable: true
          format: float
          description: >-
            La tendencia de flujo de caja negativo basada en la suma de todas
            las transacciones negativas del último mes.
          example: 58.376
        sum_negative_trend_3m:
          type: number
          nullable: true
          format: float
          description: >-
            La tendencia de flujo de caja negativo basada en la suma de todas
            las transacciones negativas en los últimos tres meses.
          example: 2.5895
        sum_negative_trend_6m:
          type: number
          nullable: true
          format: float
          description: >-
            La tendencia de flujo de caja negativo basada en la suma de todas
            las transacciones negativas en los últimos seis meses.
          example: -1.4824
        sum_negative_trend_12m:
          type: number
          nullable: true
          format: float
          description: >-
            La tendencia de flujo de caja negativo basada en la suma de todas
            las transacciones negativas en los últimos doce meses.
          example: -4.2394
        positive_to_negative_ratio_3d:
          type: number
          nullable: true
          format: float
          description: >-
            La relación entre sum_positive / sum_negative en los últimos tres
            días.


            ℹ️ Si la relación es mayor que `1`, significa que el usuario tiene
            más ingresos que egresos, lo que indica que gasta menos de lo que
            gana.


            **Nota**: En el caso de que no haya habido transacciones de egreso,
            el valor será `null`.
          example: 0.84
        positive_to_negative_ratio_1w:
          type: number
          nullable: true
          format: float
          description: >-
            La relación entre sum_positive / sum_negative en la última semana.


            ℹ️ Si la relación es mayor que `1`, significa que el usuario tiene
            más ingresos que egresos, lo que indica que gasta menos de lo que
            gana.


            **Nota**: En el caso de que no haya habido transacciones de egresos,
            el valor será `null`.
          example: 0.9
        positive_to_negative_ratio_1m:
          type: number
          nullable: true
          format: float
          description: >-
            La relación entre sum_positive / sum_negative en el último mes.


            ℹ️ Si la relación es mayor que `1`, significa que el usuario tiene
            más ingresos que egresos, lo que indica que gasta menos de lo que
            gana.


            **Nota**: En el caso de que no haya habido transacciones de egresos,
            el valor será `null`.
          example: 0.96
        positive_to_negative_ratio_3m:
          type: number
          nullable: true
          format: float
          description: >-
            La relación entre sum_positive / sum_negative en los últimos tres
            meses.


            ℹ️ Si la relación es mayor que `1`, significa que el usuario tiene
            más ingresos que egresos, lo que indica que gasta menos de lo que
            gana.


            **Nota**: En el caso de que no haya habido transacciones de egresos,
            el valor será `null`.
          example: 1.04
        positive_to_negative_ratio_6m:
          type: number
          nullable: true
          format: float
          description: >-
            La relación entre sum_positive / sum_negative en los últimos seis
            meses.


            ℹ️ Si la relación es mayor que `1`, significa que el usuario tiene
            más ingresos que egresos, lo que indica que gasta menos de lo que
            gana.


            **Nota**: En el caso de que no haya habido transacciones de egreso,
            el valor será `null`.
          example: 1.13
        positive_to_negative_ratio_12m:
          type: number
          nullable: true
          format: float
          description: >-
            La relación entre sum_positive / sum_negative en los últimos doce
            meses.


            ℹ️ Si la relación es mayor que `1`, significa que el usuario tiene
            más ingresos que egresos, lo que indica que gasta menos de lo que
            gana.


            **Nota**: En el caso de que no haya habido transacciones de egresos,
            el valor será `null`.
          example: 1.3
        net_cashflow_3d:
          type: number
          nullable: true
          format: float
          description: El flujo de caja neto en los últimos tres días.
          example: -1104.79
        net_cashflow_1w:
          type: number
          nullable: true
          format: float
          description: El flujo de caja neto en la última semana.
          example: -1536.33
        net_cashflow_1m:
          type: number
          nullable: true
          format: float
          description: El flujo de caja neto en el último mes.
          example: -2250.46
        net_cashflow_3m:
          type: number
          nullable: true
          format: float
          description: El flujo de caja neto en los últimos tres meses.
          example: 5588.51
        net_cashflow_6m:
          type: number
          nullable: true
          format: float
          description: El flujo de caja neto en los últimos seis meses.
          example: 22088.51
        net_cashflow_12m:
          type: number
          nullable: true
          format: float
          description: El flujo de caja neto en los últimos doce meses.
          example: 55088.51
        net_cashflow_trend_3d:
          type: number
          nullable: true
          format: float
          description: La tendencia del flujo de caja neto en los últimos tres días meses.
          example: 1448.683
        net_cashflow_trend_1w:
          type: number
          nullable: true
          format: float
          description: La tendencia del flujo de caja neto en la última semana.
          example: 163.8856
        net_cashflow_trend_1m:
          type: number
          nullable: true
          format: float
          description: La tendencia del flujo de caja neto en el último mes.
          example: 1.3034
        net_cashflow_trend_3m:
          type: number
          nullable: true
          format: float
          description: La tendencia del flujo de caja neto en los últimos tres meses.
          example: -0.472
        net_cashflow_trend_6m:
          type: number
          nullable: true
          format: float
          description: La tendencia del flujo de caja neto en los últimos seis meses.
          example: -15.1286
        net_cashflow_trend_12m:
          type: number
          nullable: true
          format: float
          description: La tendencia del flujo de caja neto en los últimos doce meses.
          example: -21.5511
    RiskInsightsCategoryMetrics:
      type: object
      properties:
        category:
          $ref: '#/components/schemas/EnumTransactionCategory'
        subcategory:
          $ref: '#/components/schemas/EnumTransactionSubcategory'
        net_amount_3m:
          type: number
          nullable: true
          format: float
          description: >-
            El monto neto de las transacciones para esta categoría en los
            últimos tres meses (calculado como el total de transacciones
            entrantes menos el total de transacciones salientes para esta
            categoría).
          example: 642.76
        category_inflow_ratio_3m:
          type: number
          nullable: true
          format: float
          description: >-
            La proporción de `net_amount_3m` dividida por la suma de todas las
            transacciones categorizadas entrantes (incluida la categoría actual)
            para el mismo período.


            Nota: Si no hay transacciones de entrada para el período, este valor
            devolverá `null`.
          example: 1
        trend_3m:
          type: number
          nullable: true
          format: float
          description: >-
            La tendencia de transacciones netas de la categoría (transacciones
            entrantes - transacciones salientes para la categoría) para el
            período.
          example: 0
    RiskInsights:
      type: object
      title: Objeto de Perspectivas de Riesgo
      x-tags:
        - Risk Insights
      required:
        - id
        - link
        - created_at
        - accounts
        - assets_metrics
        - transactions_metrics
        - balances_metrics
        - cashflow_metrics
        - credit_cards_metrics
        - loans_metrics
        - category_metrics
      properties:
        id:
          $ref: '#/components/schemas/id'
        link:
          $ref: '#/components/schemas/link'
        created_at:
          $ref: '#/components/schemas/created_at'
        accounts:
          type: array
          nullable: true
          description: >-
            Una matriz de números de cuenta generados por Belvo (UUIDs) que se
            utilizaron durante el análisis de perspectivas de riesgo. Si no se
            encontraron cuentas, devolvemos una matriz vacía.
          items:
            type: string
            format: uuid
            description: El ID generado por Belvo para la cuenta.
            example: 0d3ffb69-f83b-456e-ad8e-208d0998d71d
          example:
            - 0d3ffb69-f83b-456e-ad8e-208d0998d71d
            - 00293c8e-1152-440b-9892-3c071fb88672
            - cf638fba-ef45-4c10-bc6f-adecc4b2bf4e
            - 3861a5da-ae9b-4f20-a632-a9294489d5ac
            - 1f60315b-236d-498e-be7a-92bc613d329b
            - a2c8da63-ed51-41e6-891a-4ae7e784463a
        assets_metrics:
          $ref: '#/components/schemas/RiskInsightsAssetMetrics'
        credit_cards_metrics:
          $ref: '#/components/schemas/RiskInsightsCreditCardMetrics'
        loans_metrics:
          $ref: '#/components/schemas/RiskInsightsLoansMetrics'
        balances_metrics:
          $ref: '#/components/schemas/RiskInsightsBalanceMetrics'
        transactions_metrics:
          $ref: '#/components/schemas/RiskInsightsTransactionMetrics'
        cashflow_metrics:
          $ref: '#/components/schemas/RiskInsightsCashflowMetrics'
        category_metrics:
          type: array
          description: >-
            Un array de métricas agregadas sobre las categorías y subcategorías
            de transacciones que Belvo ha identificado dentro del historial de
            transacciones del usuario.


            En el array, Belvo solo devuelve las categorías que han sido
            identificadas.
          items:
            $ref: '#/components/schemas/RiskInsightsCategoryMetrics'
    EmploymentMetric:
      type: object
      description: Detalles de las métricas de empleo
      title: Objeto de Métricas de Empleo
      x-tags:
        - Employment Metrics
      required:
        - id
        - link
        - collected_at
        - created_at
        - updated_at
        - reference_date
        - age
        - current_status
        - current_employer_count
        - base_salary_last
        - weeks_employed_last_job
        - weeks_since_last_job
        - weeks_employed_total
        - weeks_with_multiple_employers
        - employer_count
        - unique_employer_count
        - employers_per_year
        - weeks_between_jobs
        - max_weeks_between_jobs
        - increases_last_job
        - decreases_last_job
        - increases_after_change
        - decreases_after_change
        - increases_overall
        - decreases_overall
        - increases_1y
        - decreases_1y
        - increases_3y
        - decreases_3y
        - increases_5y
        - decreases_5y
        - yearly_change_1y
        - yearly_change_3y
        - yearly_change_5y
        - min_monthly_salary_1y
        - min_monthly_salary_3y
        - min_monthly_salary_5y
        - average_monthly_salary_1y
        - average_monthly_salary_3y
        - average_monthly_salary_5y
        - max_monthly_salary_1y
        - max_monthly_salary_3y
        - max_monthly_salary_5y
      properties:
        id:
          $ref: '#/components/schemas/id'
        link:
          $ref: '#/components/schemas/link'
        collected_at:
          $ref: '#/components/schemas/collected_at'
        created_at:
          $ref: '#/components/schemas/created_at'
        updated_at:
          type: string
          nullable: true
          format: date-time
          description: >-
            La marca de tiempo ISO-8601 de cuándo se actualizó por última vez el
            cálculo de las métricas de empleo.
          example: '2023-08-30T15:31:35.728607Z'
        reference_date:
          type: string
          nullable: true
          format: date
          description: >-
            La reference_date que proporcionaste en tu solicitud. Si no
            proporcionaste una, este campo devolverá `null`, lo que indica que
            los cálculos se realizan hasta la fecha de la solicitud.


            **Nota:** Todos los cálculos son relativos a esta fecha.
          example: '2023-06-01'
        age:
          type: integer
          format: int32
          description: La edad del individuo.
          example: 32
        current_status:
          $ref: '#/components/schemas/EnumEmploymentRecordStatus'
        current_employer_count:
          type: integer
          nullable: true
          format: int32
          description: El número de empleadores que tiene actualmente el individuo.
          example: 1
        base_salary_last:
          type: number
          nullable: true
          format: float
          description: >-
            El último salario base del usuario. Si `current_status` es
            `EMPLOYED`, este es el salario base actual del usuario.
          example: 42.17
        weeks_employed_last_job:
          type: number
          nullable: true
          format: float
          description: >-
            El número de semanas que el usuario estuvo empleado en su último
            trabajo. Si `current_status` es `EMPLOYED`, entonces este campo
            indica el número de semanas que el usuario ha estado empleado en su
            trabajo actual.
          example: 327.1429
        weeks_since_last_job:
          type: number
          nullable: true
          format: float
          description: >-
            El número de semanas desde su último trabajo. Si el valor de este
            campo es `0`, esto indica que el usuario está actualmente empleado.
          example: 0
        weeks_employed_total:
          type: number
          nullable: true
          format: float
          description: >-
            El número total de semanas que el usuario ha estado empleado, según
            la institución.


            > **Nota:**

            >

            > En el caso de que el usuario esté empleado en dos o más lugares al
            mismo tiempo, seguimos calculando esas semanas como una semana. Por
            ejemplo, si un usuario tiene tres trabajos simultáneos durante un
            mes, esto se calcula como 4 semanas.
          example: 148.2
        weeks_with_multiple_employers:
          type: number
          nullable: true
          format: float
          description: >-
            El número de semanas que el individuo ha tenido más de un empleador
            al mismo tiempo.
          example: 0
        employer_count:
          type: integer
          nullable: true
          format: int32
          description: >-
            El número total de empleadores que el usuario ha tenido. Útil para
            indicar la estabilidad laboral a lo largo de su vida.
          example: 14
        unique_employer_count:
          type: integer
          nullable: true
          format: int32
          description: >-
            El número de empleadores únicos que ha tenido la persona.


            > **Nota:**

            >

            > Si el usuario dejó una empresa y regresó, por ejemplo, seis meses
            después a la misma empresa, esto se cuenta como un solo empleador.
          example: 3
        employers_per_year:
          type: number
          nullable: true
          format: float
          description: >-
            Número de empleadores por año. Útil para indicar la estabilidad
            laboral a lo largo de un año.


            > **Nota:**

            >

            > Si el usuario dejó una empresa y regresó, por ejemplo, seis meses
            después a la misma empresa, esto se cuenta como un solo empleador.
          example: 0.6326
        weeks_between_jobs:
          type: number
          nullable: true
          format: float
          description: El número total de semanas que el individuo estuvo desempleado.
          example: 687.2865
        max_weeks_between_jobs:
          type: number
          nullable: true
          format: float
          description: El número máximo de semanas que el individuo estuvo desempleado.
          example: 249.8571
        increases_last_job:
          type: integer
          nullable: true
          format: int32
          description: >-
            El número total de aumentos salariales que el usuario tuvo en su
            último trabajo. Si `current_status` es `EMPLOYED`, esto se refiere
            al trabajo actual del usuario.


            > **Nota:**

            >

            > Para todos los aumentos o disminuciones salariales, solo tomamos
            en cuenta aquellos donde el cambio en el salario es superior al 2%.
          example: 0
        decreases_last_job:
          type: integer
          nullable: true
          format: int32
          description: >-
            El número total de aumentos salariales que el usuario tuvo en su
            último trabajo. Si `current_status` es `EMPLOYED`, esto se refiere
            al trabajo actual del usuario.
          example: 0
        increases_after_change:
          type: integer
          nullable: true
          format: int32
          description: >-
            El número total de aumentos salariales entre el penúltimo trabajo
            del individuo y el último (o actual) trabajo.
          example: 0
        decreases_after_change:
          type: integer
          nullable: true
          format: int32
          description: >-
            El número total de disminuciones salariales entre el penúltimo
            trabajo del individuo y el último (o actual) trabajo.
          example: 0
        increases_overall:
          type: integer
          nullable: true
          format: int32
          description: >-
            El número total de aumentos salariales a lo largo de la carrera
            laboral del individuo.
          example: 0
        decreases_overall:
          type: integer
          nullable: true
          format: int32
          description: >-
            El número total de disminuciones salariales a lo largo de la carrera
            laboral del individuo.
          example: 0
        increases_1y:
          type: integer
          nullable: true
          format: int32
          description: >-
            El número total de aumentos salariales a lo largo del último año del
            individuo (YTD).
          example: 0
        decreases_1y:
          type: integer
          nullable: true
          format: int32
          description: >-
            El número total de disminuciones salariales a lo largo del último
            año del individuo (YTD).
          example: 0
        increases_3y:
          type: integer
          nullable: true
          format: int32
          description: >-
            El número total de aumentos salariales durante los últimos tres años
            del individuo.


            > **Nota:**

            >

            > Si la carrera laboral del individuo es de menos de tres años,
            devolvemos `null`.
          example: null
        decreases_3y:
          type: integer
          nullable: true
          format: int32
          description: >-
            El número total de disminuciones salariales a lo largo de los
            últimos tres años del individuo.


            > **Nota:**

            >

            > Si la carrera laboral del individuo es de menos de tres años,
            devolvemos `null`.
          example: null
        increases_5y:
          type: integer
          nullable: true
          format: int32
          description: >-
            El número total de aumentos salariales durante los últimos cinco
            años del individuo.


            > **Nota:**

            >

            > Si la carrera laboral del individuo es de menos de cinco años,
            devolvemos `null`.
          example: null
        decreases_5y:
          type: integer
          nullable: true
          format: int32
          description: >-
            El número total de disminuciones salariales a lo largo de los
            últimos cinco años del individuo.


            > **Nota:**

            >

            > Si la carrera laboral del individuo es de menos de cinco años,
            devolvemos `null`.
          example: null
        yearly_change_1y:
          type: number
          nullable: true
          format: float
          description: >-
            El cambio porcentual del salario del individuo para el último año
            (YTD).
          example: 0
        yearly_change_3y:
          type: number
          nullable: true
          format: float
          description: >-
            El cambio porcentual del salario del individuo durante los últimos
            tres años.


            > **Nota:**

            >

            > Si la carrera laboral del individuo es inferior a tres años,
            devolvemos `null`.
          example: null
        yearly_change_5y:
          type: number
          nullable: true
          format: float
          description: >-
            El cambio porcentual del salario del individuo durante los últimos
            cinco años.


            > **Nota:**

            >

            > Si la carrera laboral del individuo es inferior a cinco años,
            devolvemos `null`.
          example: null
        min_monthly_salary_1y:
          type: number
          nullable: true
          format: float
          description: El salario mensual mínimo del individuo durante el último año.
          example: 3402.88
        min_monthly_salary_3y:
          type: number
          nullable: true
          format: float
          description: >-
            El salario mensual mínimo del individuo durante los últimos tres
            años.
          example: 3402.88
        min_monthly_salary_5y:
          type: number
          nullable: true
          format: float
          description: >-
            El salario mensual mínimo del individuo durante los últimos cinco
            años.
          example: 3402.88
        average_monthly_salary_1y:
          type: number
          nullable: true
          format: float
          description: El salario mensual promedio del individuo durante el último año.
          example: 3402.88
        average_monthly_salary_3y:
          type: number
          nullable: true
          format: float
          description: >-
            El salario mensual promedio del individuo durante los últimos tres
            años.
          example: 3402.88
        average_monthly_salary_5y:
          type: number
          nullable: true
          format: float
          description: >-
            El salario mensual promedio del individuo durante los últimos cinco
            años.
          example: 3402.88
        max_monthly_salary_1y:
          type: number
          nullable: true
          format: float
          description: El salario mensual máximo del individuo para el último año.
          example: 3402.88
        max_monthly_salary_3y:
          type: number
          nullable: true
          format: float
          description: >-
            El salario mensual máximo del individuo durante los últimos tres
            años.
          example: 3402.88
        max_monthly_salary_5y:
          type: number
          nullable: true
          format: float
          description: >-
            El salario mensual máximo del individuo durante los últimos cinco
            años.
          example: 3402.88
    FinancialStatementBalanceSheetCurrentAssets:
      type: object
      description: Los activos corrientes de la empresa para el año dado.
      required:
        - cash_and_equivalents
        - short_term_investments
        - accounts_receivable
        - notes_receivable
        - other_debtors
        - bad_debt_provision
        - tax_recoverable
        - inventory
        - prepaid_expenses
        - assets_available_for_sale
        - total
      properties:
        cash_and_equivalents:
          type: number
          format: float
          nullable: true
          description: >-
            El monto total de efectivo y equivalentes de efectivo, incluyendo
            moneda, cuentas bancarias y otras inversiones líquidas que pueden
            convertirse rápidamente en efectivo.
          example: 48572.01
        short_term_investments:
          type: number
          format: float
          nullable: true
          description: >-
            El valor de las inversiones que se espera sean liquidadas en
            efectivo dentro de un año, como los valores negociables.
          example: 21345.01
        accounts_receivable:
          type: number
          format: float
          nullable: true
          description: >-
            El monto adeudado por los clientes por ventas realizadas a crédito,
            que se espera recibir en un corto período.
          example: 154321.01
        notes_receivable:
          type: number
          format: float
          nullable: true
          description: >-
            El valor de los pagarés escritos recibidos de clientes u otros, que
            prometen pagar una cantidad especificada en una fecha determinada.
          example: 31789.01
        other_debtors:
          type: number
          format: float
          nullable: true
          description: >-
            Los montos totales adeudados por varios otros deudores, excluyendo
            cuentas y documentos por cobrar.
          example: 12345.01
        bad_debt_provision:
          type: number
          format: float
          nullable: true
          description: >-
            El monto estimado de cuentas por cobrar que se espera que sean
            incobrables, a menudo se denomina provisión para cuentas de dudoso
            cobro.
          example: 0.01
        tax_recoverable:
          type: number
          format: float
          nullable: true
          description: >-
            El monto de los pagos de impuestos que se pueden recuperar de las
            autoridades fiscales.
          example: 8976.01
        inventory:
          type: number
          format: float
          nullable: true
          description: >-
            El valor total de los bienes disponibles para la venta, materias
            primas, trabajo en proceso y productos terminados.
          example: 65432.01
        prepaid_expenses:
          type: number
          format: float
          nullable: true
          description: >-
            El monto pagado por adelantado por bienes o servicios que se
            recibirán en el futuro, como primas de seguro o alquiler.
          example: 14321.01
        assets_available_for_sale:
          type: number
          format: float
          nullable: true
          description: >-
            El valor de los activos no corrientes que están disponibles para la
            venta pero aún no se han vendido, como equipos excedentes o
            propiedades.
          example: 54321.01
        total:
          type: number
          format: float
          nullable: true
          description: >-
            La suma de todos los activos corrientes, que representa el valor
            total de los activos que se espera convertir en efectivo o utilizar
            dentro de un año.
          example: 372480.01
    FinancialStatementBalanceSheetNonCurrentAssets:
      type: object
      description: >-
        Los activos no corrientes de la empresa, que son inversiones a largo
        plazo o propiedades que no se convierten fácilmente en efectivo, para el
        año dado.
      required:
        - property_plant_and_equipment
        - accumulated_depreciation_and_amortization
        - long_term_accounts_receivable
        - prepayment_to_suppliers
        - goodwill
        - intangible_assets
        - investments_in_associates
        - long_term_financial_instruments
        - total
      properties:
        property_plant_and_equipment:
          type: number
          format: float
          nullable: true
          description: >-
            El valor total de los bienes inmuebles, planta y equipo propiedad de
            la empresa, incluyendo terrenos, edificios, maquinaria y vehículos,
            utilizados para operaciones a largo plazo.
          example: 1123456.01
        accumulated_depreciation_and_amortization:
          type: number
          format: float
          nullable: true
          description: >-
            La depreciación y amortización acumulada total, que representa la
            asignación acumulativa del costo de los activos no corrientes
            durante el período en que se espera que proporcionen beneficios
            económicos.
          example: 123456.01
        long_term_accounts_receivable:
          type: number
          format: float
          nullable: true
          description: >-
            El monto adeudado por los clientes por ventas realizadas a crédito,
            que se espera recibir después de un año.
          example: 10987.01
        prepayment_to_suppliers:
          type: number
          format: float
          nullable: true
          description: >-
            El monto pagado por adelantado a los proveedores por bienes o
            servicios que se recibirán en el futuro, que se espera utilizar a
            largo plazo.
          example: 5432.01
        goodwill:
          type: number
          format: float
          nullable: true
          description: >-
            El valor de los activos intangibles que surgen de la adquisición de
            otras empresas, representando la prima pagada sobre el valor
            razonable de los activos netos adquiridos.
          example: 47654.01
        intangible_assets:
          type: number
          format: float
          nullable: true
          description: >-
            El valor total de los activos intangibles propiedad de la empresa,
            como patentes, marcas registradas y derechos de autor, con vidas
            útiles que se extienden más allá de un año.
          example: 43210.01
        investments_in_associates:
          type: number
          format: float
          nullable: true
          description: >-
            El valor de las inversiones en otras empresas en las que la compañía
            tiene una influencia significativa pero no control, típicamente
            representado por la propiedad del 20-50% de las acciones con derecho
            a voto del asociado.
          example: 65432.01
        long_term_financial_instruments:
          type: number
          format: float
          nullable: true
          description: >-
            El valor de los instrumentos financieros que se espera mantener por
            más de un año, como bonos, debentures y préstamos a largo plazo.
          example: 32876.01
        total:
          type: number
          format: float
          nullable: true
          description: >-
            La suma de todos los activos no corrientes, que representa el valor
            total de los activos que se espera utilizar o mantener por más de un
            año.
          example: 1346647.01
    FinancialStatementBalanceSheetCurrentLiabilities:
      type: object
      description: >-
        Los pasivos corrientes de la empresa, que se espera sean liquidados
        dentro del año dado.
      required:
        - bank_loans
        - accounts_payable
        - notes_payable
        - financial_instruments
        - other_creditors
        - income_tax_payable
        - customer_advances
        - provisions
        - taxes_payable
        - total
      properties:
        bank_loans:
          type: number
          format: float
          nullable: true
          description: >-
            El monto total de los préstamos tomados de bancos o instituciones
            financieras, que se espera sean reembolsados dentro de un año.
          example: 49876.01
        accounts_payable:
          type: number
          format: float
          nullable: true
          description: >-
            El monto adeudado a los proveedores por bienes o servicios comprados
            a crédito, que se espera pagar en un corto período.
          example: 103298.01
        notes_payable:
          type: number
          format: float
          nullable: true
          description: >-
            El valor de los pagarés emitidos a proveedores u otros, prometiendo
            pagar una cantidad especificada en una fecha determinada.
          example: 25643.01
        financial_instruments:
          type: number
          format: float
          nullable: true
          description: >-
            El valor de los instrumentos financieros que se espera sean
            liquidados en efectivo dentro de un año, como bonos, debentures y
            préstamos a corto plazo.
          example: 14321.01
        other_creditors:
          type: number
          format: float
          nullable: true
          description: >-
            Los montos totales adeudados a varios otros acreedores, excluyendo
            cuentas y pagarés por pagar.
          example: 21987.01
        income_tax_payable:
          type: number
          format: float
          nullable: true
          description: >-
            La cantidad de impuesto sobre la renta que se debe a las autoridades
            fiscales, que se espera pagar en un corto período.
          example: 12765.01
        customer_advances:
          type: number
          format: float
          nullable: true
          description: >-
            El monto total recibido por adelantado de los clientes por bienes o
            servicios que se entregarán en el futuro, que se espera utilizar
            dentro de un año.
          example: 18765.01
        provisions:
          type: number
          format: float
          nullable: true
          description: >-
            El monto estimado reservado para pasivos o pérdidas futuras, como
            garantías, reclamaciones legales o costos de reestructuración.
          example: 10987.01
        taxes_payable:
          type: number
          format: float
          nullable: true
          description: >-
            El monto total de impuestos adeudados a las autoridades fiscales,
            que se espera pagar en un corto período.
          example: 5321.01
        total:
          type: number
          format: float
          nullable: true
          description: >-
            La suma de todos los pasivos corrientes, que representa el valor
            total de las obligaciones que se espera liquidar dentro de un año.
          example: 260963.01
    FinancialStatementBalanceSheetNonCurrentLiabilities:
      type: object
      description: >-
        Los pasivos no corrientes de la empresa, que son obligaciones a largo
        plazo que no vencen dentro del año dado.
      required:
        - long_term_accounts_payable
        - long_term_financial_instruments
        - deferred_revenue
        - contributions_for_future_capital_increases
        - deferred_income_tax
        - employee_benefits
        - long_term_provisions
        - total
      properties:
        long_term_accounts_payable:
          type: number
          format: float
          nullable: true
          description: >-
            El monto adeudado a los proveedores por bienes o servicios comprados
            a crédito, que se espera pagar después de un año.
          example: 30876.01
        long_term_financial_instruments:
          type: number
          format: float
          nullable: true
          description: >-
            El valor de los instrumentos financieros que se espera mantener por
            más de un año, como bonos, debentures y préstamos a largo plazo.
          example: 42310.01
        deferred_revenue:
          type: number
          format: float
          nullable: true
          description: >-
            El monto recibido por adelantado de los clientes por bienes o
            servicios que se entregarán en el futuro, que se espera reconocer
            como ingresos a largo plazo (como el alquiler).
          example: 21987.01
        contributions_for_future_capital_increases:
          type: number
          format: float
          nullable: true
          description: >-
            Las contribuciones totales recibidas de los accionistas u otros
            inversores para futuros aumentos de capital, que se espera sean
            utilizadas a largo plazo.
          example: 10987.01
        deferred_income_tax:
          type: number
          format: float
          nullable: true
          description: >-
            La cantidad de impuesto sobre la renta que se difiere a períodos
            futuros, que se espera pagar después de un año.
          example: 26543.01
        employee_benefits:
          type: number
          format: float
          nullable: true
          description: >-
            El monto total de los beneficios adeudados a los empleados, como
            pensiones, gratificaciones y otros beneficios posteriores al empleo,
            que se espera liquidar a largo plazo.
          example: 30218.01
        long_term_provisions:
          type: number
          format: float
          nullable: true
          description: >-
            El monto estimado reservado para pasivos o pérdidas futuras, como
            garantías, reclamaciones legales o costos de reestructuración, que
            se espera liquidar después de un año.
          example: 15432.01
        total:
          type: number
          format: float
          nullable: true
          description: >-
            La suma de todos los pasivos no corrientes, que representa el valor
            total de las obligaciones que se espera liquidar después de un año.
          example: 178353.01
    FinancialStatementBalanceSheetEquity:
      type: object
      description: >-
        El patrimonio de la empresa, que representa el interés residual en los
        activos después de deducir los pasivos.
      required:
        - stockholders_equity
        - future_capital_contributions
        - legal_reserve
        - capital_update_excess
        - capital_update_insufficiency
        - capital_reserve
        - share_premium_on_stock_sales
        - retained_earnings
        - other_comprehensive_income
        - controlling_interest
        - non_controlling_interest
        - total
      properties:
        stockholders_equity:
          type: number
          format: float
          nullable: true
          description: >-
            El valor total de las acciones emitidas por la empresa, que
            representa el interés de propiedad de los accionistas en el negocio.
          example: 501234.01
        future_capital_contributions:
          type: number
          format: float
          nullable: true
          description: >-
            Los fondos recibidos de los accionistas que están específicamente
            designados para futuros aumentos de capital o inversiones.
          example: 75000.01
        legal_reserve:
          type: number
          format: float
          nullable: true
          description: >-
            La reserva legal exigida por la ley, generalmente apartada de las
            ganancias, para proporcionar protección financiera contra pérdidas u
            obligaciones futuras.
          example: 25000.01
        capital_update_excess:
          type: number
          format: float
          nullable: true
          description: >-
            El excedente resultante de los ajustes realizados al capital social,
            a menudo debido a la inflación o la revalorización de activos.
          example: 15000.01
        capital_update_insufficiency:
          type: number
          format: float
          nullable: true
          description: >-
            El déficit resultante de los ajustes realizados al capital social, a
            menudo debido a la inflación o la revalorización de activos.
          example: -5000.01
        capital_reserve:
          type: number
          format: float
          nullable: true
          description: >-
            La reserva de capital derivada de actividades no operativas, como
            ganancias de revalorizaciones de activos o ciertas transacciones de
            capital.
          example: 10000.01
        share_premium_on_stock_sales:
          type: number
          format: float
          nullable: true
          description: >-
            El monto excedente recibido por una empresa cuando las acciones se
            emiten a un precio superior a su valor nominal (par).
          example: 50000.01
        retained_earnings:
          type: number
          format: float
          nullable: true
          description: >-
            Las ganancias o pérdidas acumuladas de la empresa que no se han
            distribuido a los accionistas como dividendos.
          example: 202345.01
        other_comprehensive_income:
          type: number
          format: float
          nullable: true
          description: >-
            Las ganancias o pérdidas que no se incluyen en el ingreso neto pero
            se reportan directamente en el patrimonio, como las ganancias no
            realizadas en inversiones o los ajustes por conversión de moneda
            extranjera.
          example: 10987.01
        controlling_interest:
          type: number
          format: float
          nullable: true
          description: >-
            El interés de propiedad en la empresa que posee la entidad matriz o
            los accionistas mayoritarios, que representa la participación de
            control en el negocio.
          example: 70876.01
        non_controlling_interest:
          type: number
          format: float
          nullable: true
          description: >-
            La participación accionaria en la empresa mantenida por los
            accionistas minoritarios, que representa la participación no
            controladora en el negocio.
          example: 50321.01
        total:
          type: number
          format: float
          nullable: true
          description: >-
            La suma del capital social, las ganancias retenidas, otros ingresos
            integrales, el interés controlador y el interés no controlador, que
            representa el patrimonio total de la empresa.
          example: 836763.01
    FinancialStatementBalanceSheet:
      type: object
      description: >-
        El balance general que detalla los activos, pasivos y patrimonio de la
        empresa para el año dado.
      properties:
        current_assets:
          $ref: '#/components/schemas/FinancialStatementBalanceSheetCurrentAssets'
        non_current_assets:
          $ref: '#/components/schemas/FinancialStatementBalanceSheetNonCurrentAssets'
        current_liabilities:
          $ref: >-
            #/components/schemas/FinancialStatementBalanceSheetCurrentLiabilities
        non_current_liabilities:
          $ref: >-
            #/components/schemas/FinancialStatementBalanceSheetNonCurrentLiabilities
        equity:
          $ref: '#/components/schemas/FinancialStatementBalanceSheetEquity'
    FinancialStatementIncomeStatement:
      type: object
      description: >-
        El estado de resultados que detalla los ingresos, gastos y beneficios de
        la empresa para el año dado.
      required:
        - net_revenue
        - domestic_sales
        - foreign_sales
        - materials_used
        - cost_of_goods_sold
        - cost_of_services_sold
        - gross_profit
        - gross_loss
        - operating_expenses
        - operating_income
        - operating_loss
        - financial_result
        - income_statement_financial_gains
        - income_statement_financial_costs
        - equity_in_earnings_of_affiliates
        - income_before_taxes
        - loss_before_taxes
        - income_taxes
        - income_from_continuing_operations
        - loss_from_continuing_operations
        - discontinued_operations
        - net_income
        - net_loss
      properties:
        net_revenue:
          type: number
          format: float
          nullable: true
          description: >-
            Los ingresos totales generados por la empresa a partir de sus
            operaciones comerciales principales, excluyendo cualquier deducción
            por descuentos, devoluciones o bonificaciones.


            > **Nota**: `domestic_sales` + `foreign_sales` no sumarán el
            `net_revenue` debido a la exclusión de descuentos, devoluciones y
            bonificaciones.
          example: 1212345.01
        domestic_sales:
          type: number
          format: float
          nullable: true
          description: >-
            Los ingresos generados por la empresa a partir de la venta de bienes
            o servicios dentro de su país de origen.
          example: 1123456.01
        foreign_sales:
          type: number
          format: float
          nullable: true
          description: >-
            Los ingresos generados por la empresa a partir de la venta de bienes
            o servicios en países extranjeros.
          example: 88987.01
        materials_used:
          type: number
          format: float
          nullable: true
          description: >-
            El costo total de los materiales utilizados o comercializados por la
            empresa durante el período de informe.
          example: 609876.01
        cost_of_goods_sold:
          type: number
          format: float
          nullable: true
          description: >-
            El costo total incurrido por la empresa para producir o comprar los
            bienes vendidos durante el período de informe.
          example: 412345.01
        cost_of_services_sold:
          type: number
          format: float
          nullable: true
          description: >-
            El costo total incurrido por la empresa para proporcionar los
            servicios vendidos durante el período de informe.
          example: 101234.01
        gross_profit:
          type: number
          format: float
          nullable: true
          description: >-
            La diferencia entre los ingresos netos y el costo total de los
            bienes y servicios vendidos, que representa la ganancia obtenida de
            las operaciones comerciales principales antes de deducir los gastos
            operativos.
          example: 190890.01
        gross_loss:
          type: number
          format: float
          nullable: true
          description: >-
            La diferencia negativa entre los ingresos netos y el costo total de
            bienes y servicios vendidos, que representa la pérdida incurrida por
            las operaciones principales del negocio antes de deducir los gastos
            operativos.
          example: null
        operating_expenses:
          type: number
          format: float
          nullable: true
          description: >-
            Los gastos totales incurridos por la empresa en sus actividades
            operativas normales, incluidos los gastos de venta, generales y
            administrativos.
          example: 122345.01
        operating_income:
          type: number
          format: float
          nullable: true
          description: >-
            El beneficio obtenido de las operaciones principales del negocio
            después de deducir los gastos operativos, pero antes de considerar
            intereses, impuestos y otros elementos no operativos.
          example: 68545.01
        operating_loss:
          type: number
          format: float
          nullable: true
          description: >-
            La pérdida incurrida por las operaciones principales del negocio
            después de deducir los gastos operativos, pero antes de considerar
            intereses, impuestos y otros elementos no operativos.
          example: null
        financial_result:
          type: number
          format: float
          nullable: true
          description: >-
            El resultado neto de las actividades financieras, incluyendo los
            ingresos por intereses, los gastos por intereses y otras ganancias o
            pérdidas financieras.
          example: 15098.01
        income_statement_financial_gains:
          type: number
          format: float
          nullable: true
          description: >-
            El ingreso financiero total positivo, incluyendo ingresos por
            intereses, ganancias por diferencias de cambio y otras ganancias de
            actividades de financiamiento. Este valor siempre debe ser positivo.
          minimum: 0
          example: 85000.01
        income_statement_financial_costs:
          type: number
          format: float
          nullable: true
          description: >-
            Los gastos financieros totales, incluidos los gastos por intereses,
            las pérdidas por diferencias de cambio y otros costos incurridos por
            actividades de financiación. Este valor siempre debe ser negativo.
          maximum: 0
          example: -32000.01
        equity_in_earnings_of_affiliates:
          type: number
          format: float
          nullable: true
          description: >-
            La participación de la empresa en las ganancias o pérdidas de sus
            asociadas, entidades sobre las cuales tiene una influencia
            significativa pero no control.
          example: 5678.01
        income_before_taxes:
          type: number
          format: float
          nullable: true
          description: >-
            El beneficio obtenido antes de contabilizar los gastos por impuesto
            sobre la renta.
          example: 89321.01
        loss_before_taxes:
          type: number
          format: float
          nullable: true
          description: >-
            La pérdida incurrida antes de contabilizar los gastos por impuesto
            sobre la renta.
          example: null
        income_taxes:
          type: number
          format: float
          nullable: true
          description: >-
            El monto total de los gastos por impuesto sobre la renta incurridos
            durante el período de informe.
          example: 20123.01
        income_from_continuing_operations:
          type: number
          format: float
          nullable: true
          description: >-
            El beneficio obtenido de las operaciones comerciales en curso de la
            empresa después de deducir los gastos operativos e impuestos.
          example: 69198.01
        loss_from_continuing_operations:
          type: number
          format: float
          nullable: true
          description: >-
            La pérdida incurrida por las operaciones comerciales en curso de la
            empresa después de deducir los gastos operativos e impuestos.
          example: null
        discontinued_operations:
          type: number
          format: float
          nullable: true
          description: >-
            El resultado neto de las operaciones que han sido descontinuadas o
            vendidas durante el período de reporte.
          example: 0.01
        net_income:
          type: number
          format: float
          nullable: true
          description: >-
            El beneficio total obtenido por la empresa después de deducir todos
            los gastos, incluidos los operativos, no operativos, intereses e
            impuestos.
          example: 69198.01
        net_loss:
          type: number
          format: float
          nullable: true
          description: >-
            La pérdida total incurrida por la empresa después de deducir todos
            los gastos, incluidos los operativos, no operativos, intereses e
            impuestos.
          example: null
    FinancialStatement:
      type: object
      description: >-
        El estado financiero que detalla el desempeño financiero de la empresa
        para el año dado.
      title: Objeto de Estado Financiero (México)
      x-tags:
        - Financial Statements
      required:
        - id
        - link
        - collected_at
        - created_at
        - error
        - year
        - currency
        - balance_sheet
        - income_statement
      properties:
        id:
          $ref: '#/components/schemas/id'
        link:
          $ref: '#/components/schemas/link'
        collected_at:
          $ref: '#/components/schemas/collected_at'
        created_at:
          $ref: '#/components/schemas/created_at'
        error:
          type: string
          nullable: true
          description: >-
            En casos donde surjan problemas durante la extracción de estados
            financieros de la institución fiscal, se pueden proporcionar los
            siguientes mensajes de error para explicar los problemas
            encontrados:

              - `Unable to validate if the user has an available financial statement for the specified year.`
              - `No available financial statement found for the user for the specified year, preventing data extraction.`
              - `Unable to verify if the user has *conceptos vigentes* for the specified year.`
              - `The fiscal institution provided the financial statement in an unrecognized format.`
          example: null
        year:
          type: string
          pattern: ^\d{4}$
          description: El año del estado financiero.
          example: 2020
        currency:
          type: string
          description: La moneda del estado financiero.
          example: MXN
        balance_sheet:
          $ref: '#/components/schemas/FinancialStatementBalanceSheet'
        income_statement:
          $ref: '#/components/schemas/FinancialStatementIncomeStatement'
    EnumInvoiceSatInvoiceType:
      type: string
      nullable: true
      enum:
        - Egreso
        - Ingreso
        - Nómina
        - Pago
        - Traslado
      description: |-
        La clasificación de la factura por parte de la institución fiscal.

        Para el SAT de México, devolvemos uno de los siguientes valores:

          - `Egreso`
          - `Ingreso`
          - `Nómina`
          - `Pago`
          - `Traslado`
      example: Ingreso
    EnumInvoiceType:
      type: string
      nullable: true
      enum:
        - OUTFLOW
        - INFLOW
        - null
      description: >-
        La dirección de la factura (desde la perspectiva del propietario del
        Link).

        - `OUTFLOW` indica una factura enviada.

        - `INFLOW` indica una factura recibida.
      example: INFLOW
    TaxDetailsInvoicesSat:
      type: object
      description: Información general sobre los impuestos de la factura.
      properties:
        total_tax_retained:
          type: number
          format: float
          description: Monto total de impuestos retenidos.
          example: 194.27
        total_tax_transferred:
          type: number
          format: float
          description: Monto total de impuestos transferidos.
          example: 150.4
        retained_taxes:
          type: array
          description: Lista de impuestos retenidos.
          items:
            type: object
            properties:
              tax:
                type: string
                description: El tipo de impuesto retenido (por ejemplo, ISR, IVA o IEPS).
                example: ISR
              tax_percentage:
                type: number
                format: float
                nullable: true
                description: El porcentaje de impuesto retenido.
                example: null
              pre_tax_amount:
                type: number
                format: float
                nullable: true
                description: El monto antes de impuestos.
                example: null
              tax_amount:
                type: number
                format: float
                description: El monto del impuesto retenido.
                example: 94
        transferred_taxes:
          type: array
          description: Lista de impuestos transferidos.
          items:
            type: object
            properties:
              tax:
                type: string
                description: >-
                  El tipo de impuesto transferido (por ejemplo, ISR, IVA o
                  IEPS).
                example: IVA
              tax_percentage:
                type: number
                format: float
                description: El porcentaje de impuesto transferido.
                example: 16
              pre_tax_amount:
                type: number
                format: float
                description: El monto antes de impuestos.
                example: 940
              tax_amount:
                type: number
                format: float
                description: El monto del impuesto transferido.
                example: 150.4
    EnumInvoiceSatPaymentMethod:
      type: string
      nullable: true
      enum:
        - PUE
        - PPD
        - null
      description: >-
        El código del método de pago utilizado para esta factura, según lo
        definido por la entidad legal del país.


        - 🇲🇽 México <a
        href="https://developers.belvo.com/docs/sat-catalogs#payment-method"
        target="_blank">artículo de referencia del catálogo SAT</a>. Para
        México, devolvemos `PUE`, `PPD` o `null`.
      example: PUE
    InvoiceDetailRetainedTaxSat:
      type: object
      required:
        - tax
        - tax_percentage
        - retained_tax_amount
      properties:
        collected_at:
          $ref: '#/components/schemas/collected_at'
        tax:
          type: string
          nullable: true
          description: El tipo de impuesto retenido (por ejemplo, ISR, IVA o IEPS).
          example: ISR
        tax_percentage:
          type: number
          nullable: true
          format: float
          description: El porcentaje de impuesto retenido.
          example: 10
        retained_tax_amount:
          type: number
          nullable: true
          format: float
          description: El monto del impuesto retenido.
          example: 209.79
    InvoiceDetailTransferredTaxSat:
      type: object
      required:
        - tax
        - tax_percentage
        - transferred_tax_amount
      properties:
        collected_at:
          $ref: '#/components/schemas/collected_at'
        tax:
          type: string
          nullable: true
          description: El tipo de impuesto transferido (por ejemplo, ISR, IVA o IEPS).
          example: IVA
        tax_percentage:
          type: number
          nullable: true
          format: float
          description: El porcentaje de impuesto transferido.
          example: 10
        transferred_tax_amount:
          type: number
          nullable: true
          format: float
          description: El monto del impuesto transferido.
          example: 209.79
    InvoiceDetailSat:
      type: object
      required:
        - description
        - product_identification
        - quantity
        - unit_amount
        - unit_description
        - unit_code
        - pre_tax_amount
        - tax_percentage
        - tax_amount
        - total_amount
      properties:
        collected_at:
          $ref: '#/components/schemas/collected_at'
        description:
          type: string
          nullable: true
          description: >-
            La descripción del artículo de la factura (una factura puede tener
            uno o más artículos).
          example: December 2019 accounting fees
        product_identification:
          type: string
          nullable: true
          description: >-
            El código de identificación del producto o del servicio, tal como lo
            define la entidad legal en el país.\n- \U0001F1F2\U0001F1FD <a
            href="http://200.57.3.89/Pys/catPyS.aspx"
            target="_blank">México</a>.
          example: '84101600'
        quantity:
          type: number
          nullable: true
          format: float
          description: La cantidad de este artículo de factura.
          example: 10
        unit_code:
          type: string
          nullable: true
          description: >-
            La unidad de medida, según lo definido por la entidad legal en el
            país. \n- \U0001F1F2\U0001F1FD México <a
            href="https://developers.belvo.com/docs/sat-catalogs#unit-code"
            target="_blank">Referencia del catálogo SAT</a>.
          example: E48
        unit_description:
          type: string
          nullable: true
          description: >-
            La descripción del artículo, según lo definido por la entidad legal
            en el país.\n- \U0001F1F2\U0001F1FD México <a
            href="https://developers.belvo.com/docs/sat-catalogs#unit-code"
            target="_blank">Referencia del catálogo SAT</a>.
          example: Unidad de servicio
        unit_amount:
          type: number
          nullable: true
          format: float
          description: El precio de un artículo singular.
          example: 200
        tax_type:
          type: string
          nullable: true
          description: El tipo de impuesto del artículo.
          example: null
        pre_tax_amount:
          type: number
          nullable: true
          format: float
          description: >-
            El precio total de este artículo antes de aplicar impuestos es
            (`quantity` x `unit_amount`).
          example: 400
        tax_percentage:
          type: number
          nullable: true
          format: float
          description: El porcentaje de impuesto a aplicar.
          example: 16
        tax_amount:
          type: number
          nullable: true
          format: float
          description: >-
            El monto del impuesto para este artículo de factura
            (`pre_tax_amount` x `tax_percentage`).
          example: 64
        total_amount:
          type: number
          nullable: true
          format: float
          description: >-
            El precio total para este artículo de factura (`pre_tax_amount` +
            `tax_amount`).
          example: 464
        retained_taxes:
          type: array
          description: El impuesto retenido en el artículo de la factura.
          items:
            $ref: '#/components/schemas/InvoiceDetailRetainedTaxSat'
        transferred_taxes:
          type: array
          description: Los impuestos transferidos relacionados con la factura.
          items:
            $ref: '#/components/schemas/InvoiceDetailTransferredTaxSat'
    RelatedInvoiceSat:
      type: object
      description: Elemento de factura relacionado.
      properties:
        relationship_type:
          type: string
          nullable: true
          description: >-
            El tipo de relación entre esta factura y la factura relacionada,
            según lo definido por la entidad legal en el país. Para obtener más
            información, consulta nuestro <a
            href="https://developers.belvo.com/docs/sat-catalogs#related-invoices"
            target="_blank">artículo de referencia del catálogo SAT</a>.
          example: '01'
        related_invoice_identification:
          type: string
          nullable: true
          description: El SAT ID de la factura relacionada.
          example: INV-123456
    InvoicesPaymentsRelatedDocumentsSat:
      type: object
      required:
        - invoice_identification
        - currency
        - payment_method
        - previous_balance
        - amount_paid
        - outstanding_balance
      description: >-
        Lista de todas las facturas diferidas relacionadas afectadas por el
        pago.
      properties:
        invoice_identification:
          type: string
          nullable: true
          description: >-
            El ID único de la institución fiscal para la factura diferida
            relacionada.
          example: 7EE015F3-6311-11EA-B02A-00155D014007
        currency:
          type: string
          nullable: true
          description: >-
            La moneda de la factura relacionada. 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
        payment_method:
          type: string
          nullable: true
          description: El método de pago de la factura relacionada.
          example: PPD
        partiality_number:
          type: integer
          format: int32
          description: El número de cuota de pago.
          example: 1
        previous_balance:
          type: number
          nullable: true
          format: float
          description: El monto de la factura antes del pago.
          example: 18877.84
        amount_paid:
          type: number
          nullable: true
          format: float
          description: El monto pagado en esta cuota.
          example: 8000
        outstanding_balance:
          type: number
          nullable: true
          format: float
          description: El monto restante por pagar.
          example: 10877.84
    InvoicesPaymentsSat:
      type: object
      required:
        - date
        - payment_type
        - currency
        - exchange_rate
        - amount
        - operation_number
        - beneficiary_account_number
        - payer_rfc
        - payer_account_number
        - payer_bank_name
        - related_documents
      properties:
        date:
          type: string
          nullable: true
          format: date-time
          description: Marca de tiempo ISO-8601 cuando se realizó el pago.
          example: '2020-03-17T12:00:00.000Z'
        payment_type:
          type: string
          nullable: true
          description: >-
            Código de tipo de pago utilizado para esta factura, según lo
            definido por la entidad legal del país.


            - 🇲🇽 México <a
            href="https://developers.belvo.com/docs/sat-catalogs#payment-type"
            target="_blank">Artículo de referencia del catálogo SAT</a>
          example: '03'
        currency:
          type: string
          nullable: true
          description: >-
            La moneda del pago. 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: BRL
        exchange_rate:
          type: string
          nullable: true
          description: La tasa de cambio de `currency` a MXN cuando se realizó el pago.
          example: '3.75'
        amount:
          type: number
          nullable: true
          format: float
          description: El monto de la factura, en la moneda de la factura original.
          example: 8000.5
        operation_number:
          type: string
          nullable: true
          description: El identificador interno de la institución fiscal para la operación.
          example: '831840'
        beneficiary_rfc:
          type: string
          nullable: true
          description: El ID fiscal del beneficiario del pago.
          example: BNM840515VB1
        beneficiary_account_number:
          type: string
          nullable: true
          description: El número de cuenta bancaria del beneficiario del pago.
          example: '12343453245633'
        payer_rfc:
          type: string
          nullable: true
          description: El ID fiscal del emisor del pago.
          example: BKJM840515VB1
        payer_account_number:
          type: string
          nullable: true
          description: El número de cuenta bancaria del emisor del pago.
          example: '13343663245699'
        payer_bank_name:
          type: string
          nullable: true
          description: La institución bancaria que fue utilizada por el emisor del pago.
          example: CITI BANAMEX
        related_documents:
          type: array
          description: >-
            Una lista de todas las facturas diferidas relacionadas afectadas por
            el pago.
          items:
            $ref: '#/components/schemas/InvoicesPaymentsRelatedDocumentsSat'
    EnumInvoicePayrollPeriodicity:
      type: string
      nullable: true
      enum:
        - DAILY
        - WEEKLY
        - TENTH_DAY
        - FOURTEENTH_DAY
        - FIFTEENTH_DAY
        - MONTHLY
        - BIMONTHLY
        - PER_TASK
        - COMMISSION
        - ONE_OFF
        - OTHER_PERIODICITY
        - 'null'
      description: |-
        Con qué frecuencia se realiza el pago de nómina.

        Para el SAT de México, devolvemos uno de los siguientes valores:

          - `DAILY`
          - `WEEKLY`
          - `TENTH_DAY`
          - `FOURTEENTH_DAY`
          - `FIFTEENTH_DAY`
          - `MONTHLY`
          - `BIMONTHLY`
          - `PER_TASK`
          - `COMMISSION`
          - `ONE_OFF`
          - `OTHER_PERIODICITY`
      example: MONTHLY
    InvoicePayrollEarningsBreakdown:
      type: object
      nullable: true
      description: Un desglose de las ganancias para el pago de nómina.
      properties:
        type:
          type: string
          nullable: true
          description: >-
            El tipo de ingreso. Para ver una lista completa de los valores
            posibles, por favor consulta la <a
            href="https://developers.belvo.com/docs/sat-catalogs#payroll-earnings-breakdown-type"
            target="_blank">tabla de tipos de desglose de ingresos de
            nómina</a>.
          example: CHRISTMAS_BONUS
        taxable_amount:
          type: number
          format: float
          description: La cantidad de ingresos que es imponible.
          example: 1505
        vat_free_amount:
          type: number
          format: float
          description: El monto del ingreso que no está sujeto a IVA.
          example: 0
    InvoicePayrollTaxDeductions:
      type: object
      nullable: true
      description: Un desglose de las deducciones fiscales en el pago de nómina.
      properties:
        type:
          type: string
          nullable: true
          description: >-
            El tipo de deducción fiscal. Para ver una lista completa de los
            valores posibles, por favor consulta la <a
            href="https://developers.belvo.com/docs/sat-catalogs#payroll-tax-deductions-type"
            target="_blank">tabla de tipos de deducciones fiscales de
            nómina</a>.
          example: UNION_FEES
        amount:
          type: number
          format: float
          description: El monto de la deducción fiscal.
          example: 1505
    InvoicePayrollOtherPayments:
      type: object
      nullable: true
      description: Un desglose de otros pagos para la nómina.
      properties:
        type:
          type: string
          nullable: true
          description: >-
            El tipo de otro pago. Para ver una lista completa de los valores
            posibles, consulte la <a
            href="https://developers.belvo.com/docs/sat-catalogs#payroll-other-payments-type"
            target="_blank">tabla de tipos de otros pagos de nómina</a>.
          example: EMPLOYMENT_SUBSIDY
        amount:
          type: number
          format: float
          description: El monto del otro pago.
          example: 1505
    InvoicesPayrollSat:
      type: object
      nullable: true
      required:
        - version
        - type
        - payment_date
        - date_from
        - date_to
        - days
        - amount
      description: >-
        Detalles sobre el pago de nómina. Solo aplicable para facturas de
        nómina.
      properties:
        days:
          type: integer
          nullable: true
          format: int32
          description: El número de días cubiertos por el pago.
          example: 30
        type:
          type: string
          nullable: true
          description: >-
            El tipo de nómina, según lo definido por la entidad legal del país.


            - 🇲🇽 México <a
            href="https://developers.belvo.com/docs/sat-catalogs#payroll-type"
            target="_blank">Artículo de referencia del catálogo SAT</a>
          example: O
        amount:
          type: number
          format: float
          description: El monto total del pago de nómina.
          example: 20400.1
        version:
          type: string
          description: La versión del objeto de nómina.
          example: '1.2'
        date_from:
          type: string
          nullable: true
          format: date
          description: La fecha de inicio del período de pago, en formato `YYYY-MM-DD`.
          example: '2018-07-01'
        date_to:
          type: string
          nullable: true
          format: date
          description: >-
            La fecha de finalización del período de pago, en formato
            `YYYY-MM-DD`.
          example: '2018-07-31'
        collected_at:
          $ref: '#/components/schemas/collected_at'
        payment_date:
          type: string
          format: date
          description: La fecha de pago, en formato `YYYY-MM-DD`.
          example: '2018-07-16'
        periodicity:
          $ref: '#/components/schemas/EnumInvoicePayrollPeriodicity'
        earnings_breakdown:
          type: array
          nullable: true
          description: Un desglose de las ganancias para el pago de nómina.
          items:
            $ref: '#/components/schemas/InvoicePayrollEarningsBreakdown'
        tax_deductions:
          type: array
          nullable: true
          description: Un desglose de las deducciones fiscales en el pago de nómina.
          items:
            $ref: '#/components/schemas/InvoicePayrollTaxDeductions'
        other_payments:
          type: array
          nullable: true
          description: Un desglose de otros pagos para la nómina.
          items:
            $ref: '#/components/schemas/InvoicePayrollOtherPayments'
    InvoiceWarningsSat:
      type: object
      nullable: true
      required:
        - code
        - message
      description: >-
        Objeto que contiene información sobre cualquier advertencia relacionada
        con esta factura.
      properties:
        code:
          type: string
          nullable: true
          description: |-
            El código de advertencia. Puede ser uno de:

              - `sat_xml_limit_reached`
              - `sat_service_unavailable`
              - `null`
          example: sat_xml_limit_reached
        message:
          type: string
          nullable: true
          description: >-
            La descripción de la advertencia.


            El mensaje dependerá del código de advertencia:


            `sat_xml_limit_reached`<br>

            Se alcanzó el límite diario de descargas XML establecido por el SAT,
            por lo que esta factura podría tener datos faltantes. Por favor,
            consulte https://tinyurl.com/yydzhy5d para más información sobre
            este error.


            `sat_service_unavailable` <br>

            No está disponible la descarga de detalles de facturas. El portal
            del SAT generó un error 503.
          example: >
            The daily limit for XML downloads set by SAT was reached so this
            invoice

            might be missing data. Please check https://tinyurl.com/yydzhy5d for
            more

            information on this error.
    InvoiceWithIdSat:
      type: object
      title: Objeto de Facturas (México)
      x-tags:
        - Invoices
      required:
        - type
        - invoice_identification
        - invoice_date
        - invoice_type
        - subtotal_amount
        - tax_amount
        - discount_amount
        - total_amount
        - currency
        - exchange_rate
        - status
        - sender_name
        - sender_id
        - receiver_name
        - receiver_id
        - certification_authority
        - certification_date
        - cancelation_status
        - cancelation_update_date
        - payment_type
        - payment_type_description
        - invoice_details
        - payroll
        - payments
        - collected_at
      properties:
        id:
          $ref: '#/components/schemas/id'
        link:
          $ref: '#/components/schemas/link'
        collected_at:
          $ref: '#/components/schemas/collected_at'
        created_at:
          $ref: '#/components/schemas/created_at'
        invoice_identification:
          type: string
          nullable: true
          description: El ID único de la institución fiscal para la factura.
          example: A1A1A1A1-2B2B-3C33-D44D-555555E55EE
        invoice_date:
          type: string
          nullable: true
          description: La fecha de la factura, en formato `YYYY-MM-DD`.
          example: '2019-12-01'
        status:
          type: string
          nullable: true
          description: >-
            El estado de la factura. Puede ser *Vigente* (válido) o *Cancelado*
            (cancelado).
          example: Vigente
        invoice_type:
          $ref: '#/components/schemas/EnumInvoiceSatInvoiceType'
        type:
          $ref: '#/components/schemas/EnumInvoiceType'
        tax_details:
          $ref: '#/components/schemas/TaxDetailsInvoicesSat'
        sender_id:
          type: string
          nullable: true
          description: El ID fiscal del remitente de la factura
          example: AAA111111AA11
        sender_fiscal_regime:
          type: string
          nullable: true
          description: >-
            El régimen fiscal del remitente, según lo definido por la entidad
            legal en el país.
          example: '601'
        sender_name:
          type: string
          nullable: true
          description: El nombre del remitente de la factura.
          example: ACME CORP
        sender_tax_fraud_status:
          type: string
          nullable: true
          description: >-
            Indica si el remitente está o no en la lista de fraude fiscal del
            SAT por haber presentado datos incorrectos, tener pagos pendientes o
            haber realizado negocios que violan las regulaciones de la
            institución fiscal.<br><br>


            El SAT actualiza la lista de fraude fiscal cada tres meses. <br><br>


            Para más información sobre las razones por las cuales un
            contribuyente puede ser incluido en la lista de fraude fiscal,
            consulte el <a
            href="http://omawww.sat.gob.mx/cifras_sat/Paginas/datos/vinculo.html?page=ListCompleta69.html"
            target="_blank">Artículo 69</a> y el <a
            href="http://omawww.sat.gob.mx/cifras_sat/Paginas/datos/vinculo.html?page=ListCompleta69B.html"
            target="_blank">Artículo 69-B</a> del Código Fiscal de la Federación
            de México.

            <br><br>


            Los estados posibles son:


            - `INVESTIGATING` <br>

            La institución fiscal ha identificado irregularidades y ha abierto
            una investigación sobre el contribuyente.

            <br>

            - `DISMISSED` <br>

            La institución fiscal ha investigado al contribuyente y lo ha
            declarado inocente.

            <br>

            - `CONFIRMED` <br>

            La institución fiscal ha confirmado que el contribuyente es
            culpable.

            <br>

            - `OVERTURNED` <br>

            La institución fiscal ha reevaluado a un contribuyente previamente
            confirmado y, basándose en nueva evidencia, lo ha retirado de la
            lista de fraude fiscal.

            <br>

            - `NO_TAX_FRAUD_STATUS` <br>

            El receptor o remitente no se encuentra en la lista (en otras
            palabras, están cumpliendo con las regulaciones de la institución
            fiscal).
          example: NO_TAX_FRAUD_STATUS
        receiver_id:
          type: string
          nullable: true
          description: El ID fiscal del receptor de la factura.
          example: BBB222222BB22
        receiver_postal_code:
          type: string
          description: El código postal del receptor.
          example: '11560'
        receiver_fiscal_regime:
          type: string
          nullable: true
          description: >-
            El régimen fiscal del receptor, según lo definido por la entidad
            legal en el país.
          example: '601'
        receiver_name:
          type: string
          nullable: true
          description: El nombre del receptor de la factura.
          example: BELVO CORP
        receiver_tax_fraud_status:
          type: string
          nullable: true
          description: >-
            Indica si el receptor está o no en la lista de fraude fiscal del SAT
            por haber presentado datos incorrectos, tener pagos pendientes o
            haber realizado negocios que violan las regulaciones de la
            institución fiscal.<br><br>


            El SAT actualiza la lista de fraude fiscal cada tres meses. <br><br>


            Para obtener más información sobre las razones por las cuales un
            contribuyente puede ser incluido en la lista de fraude fiscal,
            consulte el <a
            href="http://omawww.sat.gob.mx/cifras_sat/Paginas/datos/vinculo.html?page=ListCompleta69.html"
            target="_blank">Artículo 69</a> y el <a
            href="http://omawww.sat.gob.mx/cifras_sat/Paginas/datos/vinculo.html?page=ListCompleta69B.html"
            target="_blank">Artículo 69-B</a> del Código Fiscal de la Federación
            de México.

            <br><br>


            Los estados posibles son:


            - `INVESTIGATING` <br>

            La institución fiscal ha identificado irregularidades y ha abierto
            una investigación sobre el contribuyente.

            <br>

            - `DISMISSED` <br>

            La institución fiscal ha investigado al contribuyente y lo ha
            declarado inocente.

            <br>

            - `CONFIRMED` <br>

            La institución fiscal ha confirmado que el contribuyente es
            culpable.

            <br>

            - `OVERTURNED` <br>

            La institución fiscal ha reevaluado a un contribuyente previamente
            confirmado y, basándose en nueva evidencia, lo ha retirado de la
            lista de fraude fiscal.

            <br>

            - `NO_TAX_FRAUD_STATUS` <br>

            El receptor o emisor no se encuentra en la lista (en otras palabras,
            está cumpliendo con las regulaciones de la institución fiscal).
          example: NO_TAX_FRAUD_STATUS
        cancelation_status:
          type: string
          nullable: true
          description: >-
            Si la factura es cancelada, este campo indica el estado de la
            cancelación.
        cancelation_update_date:
          type: string
          nullable: true
          format: date
          description: La fecha de la cancelación de la factura, en formato `YYYY-MM-DD`.
          example: '2019-12-02'
        certification_date:
          type: string
          nullable: true
          format: date
          description: La fecha de la certificación fiscal, en formato `YYYY-MM-DD`.
          example: '2019-12-01'
        certification_authority:
          type: string
          nullable: true
          description: El ID fiscal del proveedor de certificación.
          example: CCC333333CC33
        payment_type:
          type: string
          nullable: true
          description: >-
            El código de tipo de pago utilizado para esta factura, según lo
            definido por la entidad legal del país.


            - 🇲🇽 México <a
            href="https://developers.belvo.com/docs/sat-catalogs#payment-type"
            target="_blank">Artículo de referencia del catálogo SAT</a>
          example: '99'
        payment_type_description:
          type: string
          nullable: true
          deprecated: true
          description: >-
            *Este campo ha quedado obsoleto. Para obtener más información sobre
            Belvo y la obsolescencia, consulte nuestra explicación de Campos
            obsoletos.*
          example: null
        payment_method:
          $ref: '#/components/schemas/EnumInvoiceSatPaymentMethod'
        payment_method_description:
          type: string
          nullable: true
          deprecated: true
          description: >-
            *Este campo ha sido desaprobado. Para obtener más información sobre
            Belvo y la desaprobación, consulte nuestra explicación de Campos
            desaprobados.*


            *La descripción del método de pago utilizado para esta factura.*
          example: null
        usage:
          type: string
          nullable: true
          description: >-
            El código de uso de la factura, tal como lo define la entidad legal
            del país.


            - 🇲🇽 México <a
            href="https://developers.belvo.com/docs/sat-catalogs#usage"
            target="_blank">Artículo de referencia del catálogo del SAT</a>
          example: P01
        version:
          type: string
          nullable: true
          description: La versión CFDI de la factura.
          example: '3.3'
        place_of_issue:
          type: string
          nullable: true
          description: El código postal de donde se emitió la factura.
          example: '01165'
        invoice_details:
          type: array
          description: >-
            Una lista de descripciones para cada artículo (producto comprado o
            servicio prestado) en la factura.
          items:
            $ref: '#/components/schemas/InvoiceDetailSat'
        currency:
          type: string
          nullable: true
          description: |-
            La moneda de la factura. Por ejemplo:

            - 🇧🇷 BRL (Real Brasileño)
            - 🇨🇴 COP (Peso Colombiano)
            - 🇲🇽 MXN (Peso Mexicano)
            - 🇺🇸 USD (Dólar Estadounidense)
          example: MXN
        subtotal_amount:
          type: number
          nullable: true
          format: float
          description: >-
            El monto antes de impuestos de esta factura (suma del
            `pre_tax_amount` de cada artículo).
          example: 400
        exchange_rate:
          type: number
          nullable: true
          format: float
          description: El tipo de cambio utilizado en esta factura para la moneda.
          example: 0.052
        tax_amount:
          type: number
          nullable: true
          format: float
          description: >-
            El monto del impuesto para esta factura (suma del `tax_amount` de
            cada artículo).
          example: 64
        discount_amount:
          type: number
          nullable: true
          format: float
          description: El monto total descontado en esta factura.
          example: 10
        total_amount:
          type: number
          nullable: true
          format: float
          description: >-
            El monto total de la factura (`subtotal_amount` + `tax_amount` -
            `discount_amount`)
          example: 454
        related_invoices:
          type: array
          description: Una lista de facturas relacionadas.
          items:
            $ref: '#/components/schemas/RelatedInvoiceSat'
        payments:
          type: array
          description: Una lista que detalla todos los pagos de facturas.
          items:
            $ref: '#/components/schemas/InvoicesPaymentsSat'
        payroll:
          $ref: '#/components/schemas/InvoicesPayrollSat'
        folio:
          type: string
          nullable: true
          description: >-
            El número de control interno que el contribuyente asigna a la
            factura.
          example: '26'
        export_type:
          type: string
          nullable: true
          description: >-
            El tipo de exportación de la factura, según lo definido por la
            entidad legal en el país. Para más información, consulta nuestro <a
            href="https://developers.belvo.com/docs/sat-catalogs#export-type"
            target="_blank">artículo de referencia del catálogo SAT</a>.
          example: '01'
        xml:
          type: string
          nullable: true
          description: XML del documento de factura.
        warnings:
          $ref: '#/components/schemas/InvoiceWarningsSat'
        sender_blacklist_status:
          type: string
          nullable: true
          deprecated: true
          description: >-
            *Este campo ha sido desaprobado. Para obtener más información sobre
            Belvo y la desaprobación, consulte nuestra explicación de Campos
            desaprobados.*

            Por favor, use `sender_tax_fraud_status` en su lugar.
          example: null
        receiver_blacklist_status:
          type: string
          nullable: true
          deprecated: true
          description: >-
            *Este campo ha sido desaprobado. Para obtener más información sobre
            Belvo y la desaprobación, consulte nuestra explicación de Campos
            desaprobados.*

            Por favor, use `receiver_tax_fraud_status` en su lugar.
          example: null
    attach_xml:
      type: boolean
      default: false
      description: Cuando se establece en `true`, recibirás la factura XML en la respuesta.
      example: false
    EnumTaxComplianceStatusOutcome:
      type: string
      nullable: true
      enum:
        - POSITIVE
        - NEGATIVE
        - NO_OBLIGATIONS
      description: >-
        Indica si el contribuyente está cumpliendo con todas sus obligaciones
        fiscales (`POSITIVE`), si no lo está (`NEGATIVE`), o si no tiene ninguna
        obligación que cumplir (`NO_OBLIGATIONS`).
      example: NEGATIVE
    TaxComplianceStatus:
      type: object
      title: Objeto de Estado de Cumplimiento Fiscal (México)
      x-tags:
        - Tax compliance status
      required:
        - pdf
        - collected_at
      properties:
        id:
          $ref: '#/components/schemas/id'
        collected_at:
          $ref: '#/components/schemas/collected_at'
        created_at:
          $ref: '#/components/schemas/created_at'
        internal_identification:
          type: string
          nullable: true
          description: >-
            El número de identificación interno de la institución para el
            documento.
          example: 20NE1234567
        pdf:
          type: string
          nullable: true
          format: binary
          description: Estado de cumplimiento fiscal PDF como binario.
          example: '=PDF-STRING='
        rfc:
          type: string
          nullable: true
          description: >-
            El número de RFC (Registro Federal de Contribuyentes) del titular de
            la cuenta.
          example: KDFC211118IS0
        outcome:
          $ref: '#/components/schemas/EnumTaxComplianceStatusOutcome'
    TaxReturnPersonal:
      type: object
      additionalProperties: true
      title: Declaración de Impuestos Personal (Anual)
      required:
        - informacion_general
        - sueldos_salarios
        - servicios_profesionales
        - dividendos
        - deducciones_personales
        - retenciones
        - determinacion_impuesto
        - pdf
        - receipt_pdf
        - collected_at
      properties:
        id:
          $ref: '#/components/schemas/id'
        link:
          $ref: '#/components/schemas/link'
        collected_at:
          $ref: '#/components/schemas/collected_at'
        created_at:
          $ref: '#/components/schemas/created_at'
        informacion_general:
          type: object
          nullable: true
          description: >-
            Información general sobre la declaración de impuestos (año, RFC,
            tipo de declaración, nombre de la persona/empresa, etc.).
        sueldos_salarios:
          type: object
          nullable: true
          description: >-
            Detalles sobre la información de ingresos junto con los impuestos
            retenidos.
        servicios_profesionales:
          type: object
          nullable: true
          description: >-
            Detalles sobre la información de ingresos e impuestos de los
            servicios profesionales prestados.
        deducciones_personales:
          type: object
          nullable: true
          description: Lista de todas las deducciones personales de impuestos.
        determinacion_impuesto:
          type: object
          nullable: true
          description: Detalles sobre la declaración de impuestos final.
        retenciones:
          type: object
          nullable: true
          description: Detalles sobre los impuestos ya retenidos.
        dividendos:
          type: object
          nullable: true
          description: Detalles sobre los dividendos.
        datos_informativos:
          type: object
          nullable: true
          description: Datos adicionales informativos en la declaración de impuestos.
        pdf:
          type: string
          nullable: true
          format: binary
          description: Declaración de impuestos en PDF como binario.
          example: '=PDF-STRING='
        receipt_pdf:
          type: string
          nullable: true
          format: binary
          description: >-
            El recibo de acuse de recibo de la institución fiscal que confirma
            que han recibido la declaración de impuestos.
          example: '=PDF-STRING='
    TaxReturnPersonalMonthly:
      type: object
      additionalProperties: true
      title: Declaración de Impuestos Personal (Mensual)
      required:
        - informacion_general
        - pdf
        - type
        - isr
        - iva
        - collected_at
      properties:
        id:
          $ref: '#/components/schemas/id'
        collected_at:
          $ref: '#/components/schemas/collected_at'
        created_at:
          $ref: '#/components/schemas/created_at'
        informacion_general:
          type: object
          nullable: true
          description: >-
            Información general sobre la declaración de impuestos (año, RFC,
            tipo de declaración, nombre de la persona/empresa, etc.).
        isr:
          type: object
          nullable: true
          description: >-
            Información utilizada para calcular los pagos provisionales
            mensuales del impuesto sobre la renta.
        iva:
          type: object
          nullable: true
          description: >-
            Información utilizada para calcular los pagos provisionales
            mensuales del impuesto al IVA.
        pdf:
          type: string
          nullable: true
          format: binary
          description: Declaración de impuestos en PDF como binario.
          example: '=PDF-STRING='
        receipt_pdf:
          type: string
          nullable: true
          format: binary
          description: >-
            El recibo de acuse de recibo de la institución fiscal que confirma
            que han recibido la declaración de impuestos.
          example: '=PDF-STRING='
        type:
          type: string
          description: El tipo de declaración de impuestos. Puede ser mensual o anual.
          example: monthly
    TaxReturnBusiness:
      type: object
      additionalProperties: true
      title: Declaración de Impuestos Empresarial (Anual)
      required:
        - id
        - collected_at
        - created_at
        - informacion_general
        - datos_adicionales
        - estado_resultados
        - estado_posicion_financiera_balance
        - conciliacion_entre_resultado_contable_fiscal
        - deducciones_autorizadas
        - cifras_cierre_ejercicio
        - determinacion_del_impuesto_sobre_la_renta
        - dividendos_o_utilidades_distribuidos
        - detalle_pago_r1_isr_personas_morales
        - pdf
        - receipt_pdf
      properties:
        id:
          $ref: '#/components/schemas/id'
        collected_at:
          $ref: '#/components/schemas/collected_at'
        created_at:
          $ref: '#/components/schemas/created_at'
        informacion_general:
          type: object
          nullable: true
          description: >-
            Información general sobre la declaración de impuestos (año, RFC,
            tipo de declaración, nombre de la persona/empresa, etc.).
        datos_adicionales:
          type: object
          nullable: true
          description: Datos adicionales sobre la declaración de impuestos.
        estado_resultados:
          type: object
          nullable: true
          description: >-
            Información detallada sobre las ganancias y pérdidas anuales de la
            entidad legal.


            > **Nota**: Para las declaraciones de impuestos presentadas para el
            año fiscal 2022 y posteriores, este campo devolverá null ya que ya
            no es un campo obligatorio al presentar su declaración de impuestos.
        estado_posicion_financiera_balance:
          type: object
          nullable: true
          description: >-
            Detalles sobre el balance general de la entidad legal.


            > **Nota**: Para las declaraciones de impuestos presentadas para el
            año fiscal 2022 y posteriores, este campo devolverá null ya que ya
            no es un campo obligatorio al presentar su declaración de impuestos.
        conciliacion_entre_resultado_contable_fiscal:
          type: object
          nullable: true
          description: >-
            Detalles sobre la conciliación contable.


            > **Nota**: Para las declaraciones de impuestos presentadas para el
            año fiscal 2022 y posteriores, este campo devolverá null ya que ya
            no es un campo requerido al presentar su declaración de impuestos.
        deducciones_autorizadas:
          type: object
          nullable: true
          description: Detalles sobre las deducciones de la entidad legal.
        cifras_cierre_ejercicio:
          type: object
          nullable: true
          description: Detalles sobre los números clave al final del ejercicio fiscal.
        determinacion_del_impuesto_sobre_la_renta:
          type: object
          nullable: true
          description: Detalles sobre la declaración de impuestos final.
        dividendos_o_utilidades_distribuidos:
          type: object
          nullable: true
          description: Detalles sobre los dividendos distribuidos.
        detalle_pago_r1_isr_personas_morales:
          type: object
          nullable: true
          description: Detalles del pago de impuestos.
        ingressos:
          type: object
          nullable: true
          description: >-
            > **Nota**: Solo aplicable para declaraciones de impuestos
            presentadas en o después de 2022. Para declaraciones de impuestos
            presentadas antes de 2022, este campo devolverá `null`.


            Detalles sobre los montos totales ganados en el año fiscal.
        determinacion:
          type: object
          nullable: true
          description: >-
            > **Nota**: Solo aplicable para declaraciones de impuestos
            presentadas en 2022 o después. Para declaraciones de impuestos
            presentadas antes de 2022, este campo devolverá `null`.


            Detalles sobre el impuesto adeudado o el crédito fiscal.
        pdf:
          type: string
          nullable: true
          format: binary
          description: Declaración de impuestos en PDF como binario.
          example: '=PDF-STRING='
        receipt_pdf:
          type: string
          nullable: true
          format: binary
          description: >-
            El recibo de acuse de recibo de la institución fiscal que confirma
            que han recibido la declaración de impuestos.
          example: '=PDF-STRING='
    TaxReturnBusinessMonthly:
      type: object
      additionalProperties: true
      title: Declaración de Impuestos Empresarial (Mensual)
      required:
        - informacion_general
        - determinacion_isr
        - pdf
        - type
        - collected_at
        - detalle_pago_isr
        - determinacion_iva
        - detalle_pago_iva
      properties:
        id:
          $ref: '#/components/schemas/id'
        collected_at:
          $ref: '#/components/schemas/collected_at'
        created_at:
          $ref: '#/components/schemas/created_at'
        informacion_general:
          type: object
          nullable: true
          description: >-
            Información general sobre la declaración de impuestos (año, RFC,
            tipo de declaración, nombre de la persona/empresa, etc.).
        determinacion_isr:
          type: object
          nullable: true
          description: >-
            Información utilizada para calcular el impuesto sobre la renta
            provisional para el período.
        detalle_pago_isr:
          type: object
          nullable: true
          description: >-
            Información sobre los pagos provisionales mensuales para el impuesto
            sobre la renta.
        determinacion_iva:
          type: object
          nullable: true
          description: >-
            Información utilizada para calcular el impuesto provisional del IVA
            para el período.
        detalle_pago_iva:
          type: object
          nullable: true
          description: >-
            Información sobre los pagos provisionales mensuales para el impuesto
            al valor agregado (IVA).
        pdf:
          type: string
          nullable: true
          format: binary
          description: Declaración de impuestos en PDF como binario.
          example: '=PDF-STRING='
        receipt_pdf:
          type: string
          nullable: true
          format: binary
          description: >-
            El recibo de acuse de recibo de la institución fiscal que confirma
            que han recibido la declaración de impuestos.
          example: '=PDF-STRING='
        type:
          type: string
          nullable: true
          description: El tipo de declaración de impuestos. Puede ser mensual o anual.
          example: monthly
    TaxReturnsMonthlyRequest:
      type: object
      title: Declaraciones de impuestos mensuales
      description: Cuerpo de la solicitud para declaraciones de impuestos mensuales
      required:
        - link
        - type
        - date_from
        - date_to
      properties:
        link:
          $ref: '#/components/schemas/link_request'
        attach_pdf:
          $ref: '#/components/schemas/attach_pdf'
        save_data:
          $ref: '#/components/schemas/save_data'
        type:
          type: string
          default: monthly
          description: >-
            El tipo de declaración de impuestos a devolver. Para las
            declaraciones de impuestos mensuales, este campo debe establecerse
            en `monthly`.
        date_from:
          $ref: '#/components/schemas/date_from'
        date_to:
          $ref: '#/components/schemas/date_to'
    TaxReturnsYearlyRequest:
      type: object
      title: Declaraciones de impuestos anuales
      description: Cuerpo de la solicitud para declaraciones de impuestos anuales
      required:
        - link
        - type
        - year_to
        - year_from
      properties:
        link:
          $ref: '#/components/schemas/link_request'
        attach_pdf:
          $ref: '#/components/schemas/attach_pdf'
        save_data:
          $ref: '#/components/schemas/save_data'
        type:
          type: string
          default: yearly
          description: >-
            El tipo de declaración de impuestos a devolver. Para las
            declaraciones de impuestos anuales, esto debe establecerse en
            `yearly`.


            Por defecto, Belvo devuelve las declaraciones de impuestos anuales.
        year_from:
          type: string
          pattern: ^(19|20)\d{2}$
          description: >-
            El año de inicio para el que deseas obtener datos, en formato
            `YYYY`.
          example: '2018'
        year_to:
          type: string
          pattern: ^(19|20)\d{2}$
          description: El año en el que deseas dejar de obtener datos, en formato `YYYY`.
          example: '2019'
    EnumTaxRetentionReceiverNationality:
      type: string
      nullable: true
      enum:
        - NATIONAL
        - FOREIGN
      description: >-
        Si el receptor de la factura es un nacional mexicano o no. Si el
        receptor no se considera un nacional mexicano, los impuestos retenidos
        pueden calcularse de manera diferente. Valores posibles:
          - `NATIONAL`
          - `FOREIGN`
      example: NATIONAL
    EnumTaxRetentionPaymentStatus:
      type: string
      nullable: true
      enum:
        - PAID
        - PROVISIONED
      description: |-
        Indica si el impuesto ha sido pagado o no. Puede ser:
          - `PAID`
          - `PROVISIONED`
      example: PAID
    RetentionBreakdown:
      type: object
      required:
        - base_amount
        - tax_type
        - retained_amount
        - payment_status
      description: Un desglose de los impuestos retenidos
      properties:
        base_amount:
          type: number
          nullable: true
          format: float
          description: >-
            El monto base que se utilizó para calcular la retención de
            impuestos.
          example: 0.03
        tax_type:
          type: string
          nullable: true
          description: >-
            Atributo opcional para indicar el tipo de impuesto retenido para el
            período o año según el <a
            href="https://developers.belvo.com/docs/sat-catalogs#retention-code"
            target="_blank">catálogo del SAT</a>.
          example: '01'
        retained_amount:
          type: number
          nullable: true
          format: float
          description: El monto retenido.
          example: 0
        payment_status:
          $ref: '#/components/schemas/EnumTaxRetentionPaymentStatus'
    TaxRetentions:
      type: object
      title: Objeto de Retenciones de Impuestos (México)
      x-tags:
        - Tax retentions
      required:
        - collected_at
        - invoice_identification
        - version
        - code
        - issued_at
        - certified_at
        - cancelled_at
        - sender_id
        - sender_name
        - receiver_nationality
        - receiver_id
        - receiver_name
        - total_invoice_amount
        - total_taxable_amount
        - total_exempt_amount
        - total_retained_amount
        - retention_breakdown
        - xml
      properties:
        id:
          $ref: '#/components/schemas/id'
        link:
          $ref: '#/components/schemas/link'
        collected_at:
          $ref: '#/components/schemas/collected_at'
        created_at:
          $ref: '#/components/schemas/created_at'
        invoice_identification:
          type: string
          nullable: true
          format: uuid
          description: >-
            El ID único de la institución fiscal para la factura a la que se
            refiere la retención de impuestos.
          example: def404af-5eef-4112-aa99-d1ec8493b89a
        version:
          type: string
          nullable: true
          description: La versión CFDI de las retenciones de impuestos.
          example: '1.0'
        code:
          type: integer
          nullable: true
          format: int32
          description: >-
            El código de retención de impuestos. Para obtener más información,
            consulta nuestro <a
            href="https://developers.belvo.com/docs/sat-catalogs#retention-code"
            target="_blank">artículo del DevPortal sobre los catálogos del
            SAT</a>.
          example: 25
        issued_at:
          type: string
          nullable: true
          format: date-time
          description: >-
            La marca de tiempo ISO-8601 de cuando se emitió la retención de
            impuestos.
          example: '2019-01-03T21:10:40.000Z'
        certified_at:
          type: string
          nullable: true
          format: date-time
          description: >-
            La marca de tiempo ISO-8601 de cuando se certificó la retención de
            impuestos.
          example: '2019-01-03T21:10:41.000Z'
        cancelled_at:
          type: string
          nullable: true
          format: date-time
          description: >-
            La marca de tiempo ISO-8601 de cuando se canceló la retención de
            impuestos (si corresponde).
          example: null
        sender_id:
          type: string
          nullable: true
          description: El ID fiscal del remitente de la factura.
          example: JKUF980404P0
        sender_name:
          type: string
          nullable: true
          description: El nombre del remitente de la factura.
          example: Roberto Nunez Batman
        receiver_nationality:
          $ref: '#/components/schemas/EnumTaxRetentionReceiverNationality'
        receiver_id:
          type: string
          nullable: true
          description: El ID fiscal del receptor de la factura.
          example: GYGK3207809L1
        receiver_name:
          type: string
          nullable: true
          description: El nombre del receptor de la factura.
          example: ACME LTD
        total_invoice_amount:
          type: number
          nullable: true
          format: float
          description: >-
            El monto total de la factura al que se refiere la retención de
            impuestos.
          example: 53249.8
        total_exempt_amount:
          type: number
          nullable: true
          format: float
          description: Cantidad total que está exenta de impuestos.
          example: 1000.8
        total_retained_amount:
          type: number
          nullable: true
          format: float
          description: Total de impuestos retenidos.
          example: 1550.7
        total_taxable_amount:
          type: number
          nullable: true
          format: float
          description: >-
            El monto total que se puede gravar. Se calcula como
            `total_invoice_amount` - `total_exempt_amount`.
          example: 43249
        retention_breakdown:
          type: array
          nullable: true
          description: Un desglose de los impuestos retenidos.
          items:
            $ref: '#/components/schemas/RetentionBreakdown'
        xml:
          type: string
          nullable: true
          description: El documento de retención de impuestos en formato XML.
          example: '=XML-STRING='
    EnumTaxRetentionType:
      type: string
      enum:
        - OUTFLOW
        - INFLOW
      description: >-
        El tipo de retención de impuestos en relación con la factura (desde la
        perspectiva del propietario del Link).


        - `OUTFLOW` se refiere a una retención de impuestos para una factura
        enviada.

        - `INFLOW` se refiere a una retención de impuestos para una factura
        recibida.
      example: INFLOW
    TaxStatusTaxPayerInformationSat:
      type: object
      nullable: true
      required:
        - rfc
        - start_operations_date
        - status_padron
        - last_status_change_date
      description: Detalles sobre el contribuyente.
      properties:
        rfc:
          type: string
          nullable: true
          description: >-
            El número de identificación del contribuyente (Para México, este es
            el RFC).
          example: BEMP12345G58
        curp:
          type: string
          nullable: true
          description: >-
            El número de *Clave Única de Registro de Población* (CURP) del
            contribuyente.
          example: null
        name:
          type: string
          nullable: true
          description: El nombre de pila del contribuyente.
          example: JOHN
        first_last_name:
          type: string
          nullable: true
          description: El primer apellido del contribuyente.
          example: DOE
        second_last_name:
          type: string
          nullable: true
          description: El segundo apellido del contribuyente.
          example: SCHMOE
        start_operations_date:
          type: string
          nullable: true
          format: date
          description: >-
            Fecha en la que el contribuyente comenzó actividades comerciales
            gravables, en formato `YYYY-MM-DD`.
          example: null
        status_padron:
          type: string
          nullable: true
          description: >-
            Estado del contribuyente en el Registro Federal de Contribuyentes
            (RFC). Puede ser `ACTIVO` o `INACTIVO`.
          example: null
        last_status_change_date:
          type: string
          nullable: true
          format: date
          description: >-
            Fecha en la que `status_padron` se actualizó más recientemente, en
            formato `YYYY-MM-DD`.
          example: null
        commercial_name:
          type: string
          nullable: true
          description: >-
            El nombre del negocio designado para los consumidores y el público
            en general.


            **Nota**: Solo aplicable para negocios.
          example: Jar Jar Transport
        social_name:
          type: string
          nullable: true
          description: >-
            El nombre único y exclusivo dentro del territorio nacional que las
            empresas reciben para fines legales o administrativos.


            **Nota**: Solo aplicable para negocios.
          example: John Doe SA DE CV
        email:
          type: string
          nullable: true
          description: Dirección de correo electrónico de contacto para el contribuyente.
          example: john_doe@gmail.com
        phone:
          type: string
          nullable: true
          description: Número de teléfono de contacto del contribuyente.
          example: '1234567890'
    TaxStatusAddressBetweenStreetSat:
      type: object
      properties:
        street_one:
          type: string
          nullable: true
          description: La primera calle entre la que se encuentra `street`.
          example: CALLE PRINCIPE
        street_two:
          type: string
          nullable: true
          description: La segunda calle entre la que se encuentra `street`.
          example: CALLE NUEVA ROMA
    TaxStatusAddressSat:
      type: object
      nullable: true
      required:
        - postal_code
      description: Los detalles de la dirección del contribuyente.
      properties:
        postal_code:
          type: string
          nullable: true
          description: El código postal de la dirección.
          example: '21255'
        street_type:
          type: string
          nullable: true
          description: El tipo `street`.
          example: CALLE
        street:
          type: string
          nullable: true
          description: La calle de los contribuyentes.
          example: LA MALINCHE
        exterior_number:
          type: string
          nullable: true
          description: El número de la calle.
          example: '432'
        interior_number:
          type: string
          nullable: true
          description: Información adicional de la dirección.
          example: PLANTA BAJA
        suburb:
          type: string
          nullable: true
          description: El suburbio del contribuyente.
          example: BUENAVENTURA
        locality:
          type: string
          nullable: true
          description: La localidad de la dirección.
          example: none
        municipality:
          type: string
          nullable: true
          description: El municipio de la dirección.
          example: CDMX DC
        state:
          type: string
          nullable: true
          description: El estado en el que se encuentra la dirección.
          example: Federal
        between_street:
          type: array
          nullable: true
          description: Información adicional sobre dónde se encuentra la `street`.
          items:
            $ref: '#/components/schemas/TaxStatusAddressBetweenStreetSat'
    TaxStatusEconomicActivitySat:
      type: object
      properties:
        economic_activity:
          type: string
          nullable: true
          description: La descripción de la actividad económica.
          example: Asalariado
        initial_date:
          type: string
          nullable: true
          description: >-
            La fecha de inicio de la actividad económica, en formato
            `YYYY-MM-DD`.
          example: '2020-12-06'
        end_date:
          type: string
          nullable: true
          format: date
          description: >-
            La fecha de finalización de la actividad económica, en formato
            `YYYY-MM-DD`.
          example: null
        order:
          type: string
          nullable: true
          description: El orden de la actividad económica.
          example: '2'
        percentage:
          type: string
          nullable: true
          description: El porcentaje de la actividad económica.
          example: '1'
    TaxStatusRegimensSat:
      type: object
      required:
        - regimen
        - initial_date
        - end_date
      properties:
        end_date:
          type: string
          nullable: true
          format: date
          description: La fecha de finalización del régimen, en formato `YYYY-MM-DD`.
          example: null
        initial_date:
          type: string
          nullable: true
          format: date
          description: La fecha de inicio del régimen, en formato `YYYY-MM-DD`.
          example: '2020-12-06'
        regimen:
          type: string
          nullable: true
          description: La descripción del régimen.
          example: Régimen de Ingresos por Dividendos (socios y accionistas)
    TaxStatusObligationsSat:
      type: object
      description: |-
        Detalles sobre las obligaciones de un negocio.

        ℹ️ Para cuentas que no son de negocio, este campo se devolverá vacío.
      properties:
        obligation:
          type: string
          nullable: true
          description: La descripción de la obligación.
          example: Declaración informativa de IVA con la anual de ISR
        expiration:
          type: string
          nullable: true
          description: >-
            La fecha límite para cumplir con la obligación, según lo impuesto
            por la autoridad fiscal.
          example: Conjuntamente con la declaración anual del ejercicio.
        initial_date:
          type: string
          nullable: true
          format: date
          description: La fecha en que comenzó la obligación, en formato `YYYY-MM-DD`.
          example: '2020-12-06'
        end_date:
          type: string
          nullable: true
          format: date
          description: La fecha en que terminó la obligación, en formato `YYYY-MM-DD`.
          example: null
    TaxStatusSat:
      type: object
      title: Objeto de Estado Fiscal (México)
      x-tags:
        - Tax status
      required:
        - id
        - link
        - collected_at
        - created_at
        - place_and_date_of_issuance
        - official_name
        - id_cif
        - tax_payer_information
        - address
        - economic_activity
        - regimes
        - obligations
        - digital_stamp
        - digital_stamp_chain
        - pdf
      properties:
        id:
          $ref: '#/components/schemas/id'
        link:
          $ref: '#/components/schemas/link'
        collected_at:
          $ref: '#/components/schemas/collected_at'
        created_at:
          $ref: '#/components/schemas/created_at'
        place_and_date_of_issuance:
          type: string
          nullable: true
          description: El lugar y la fecha en que se emitió el estado fiscal.
          example: TLALPAN , CIUDAD DE MEXICO A 19 DE MARZO DE 2020
        official_name:
          type: string
          nullable: true
          description: El nombre de la persona o empresa.
          example: John Doe
        id_cif:
          type: string
          nullable: true
          description: El ID de *Cédula de Identificación Fiscal* (CIF) del contribuyente.
          example: '12345678901'
        tax_payer_information:
          $ref: '#/components/schemas/TaxStatusTaxPayerInformationSat'
        address:
          $ref: '#/components/schemas/TaxStatusAddressSat'
        economic_activity:
          type: array
          nullable: true
          description: Una lista de objetos de actividad económica.
          items:
            $ref: '#/components/schemas/TaxStatusEconomicActivitySat'
        regimes:
          type: array
          nullable: true
          description: Una lista de objetos de régimen.
          items:
            $ref: '#/components/schemas/TaxStatusRegimensSat'
        obligations:
          type: array
          nullable: true
          description: >-
            Detalles sobre las obligaciones de un negocio.


            ℹ️ Para cuentas que no son de negocio, este campo se devolverá
            vacío.
          items:
            $ref: '#/components/schemas/TaxStatusObligationsSat'
        digital_stamp:
          type: string
          nullable: true
          description: El certificado de validación del documento.
          example: |
            ||2020/04/26|GHTF980303F7|CONSTANCIA DE SITUACIÓN
            FISCAL|2044441088666600000034||
        digital_stamp_chain:
          type: string
          nullable: true
          description: >-
            Una cadena de datos que contiene la estructura básica de un cheque
            fiscal digital. Para México, este es el *Comprobante Fiscal Digital
            por Internet* (CFDI).
          example: >
            EtenSA9t1adG7bn+Jj23kj43JK+XbMPxdOppwabhXD+pXseSqYowWWDna0mpUk3264lkj2345j23faNZB852dCDt9KAjow=
        pdf:
          type: string
          nullable: true
          format: binary
          description: Estado fiscal PDF como una cadena binaria.
          example: '=PDF-STRING='
    invoice_chile:
      type: object
      title: Objeto de Factura (Chile)
      x-tags:
        - Invoices Chile
      properties:
        id:
          $ref: '#/components/schemas/id'
        link:
          $ref: '#/components/schemas/link'
        created_at:
          $ref: '#/components/schemas/created_at'
        collected_at:
          $ref: '#/components/schemas/collected_at'
        total_amount:
          type: number
          format: float
          pattern: ^\d{1,15}\.\d{2,4}$
          description: >-
            El importe total de la factura, incluidos el IVA y otros impuestos o
            cargos.
          example: 3272500.02
        net_amount:
          type: number
          format: float
          pattern: ^\d{1,15}\.\d{2,4}$
          description: El monto total de la factura después del IVA y otros impuestos.
          example: 2750000.02
        vat_amount:
          type: number
          format: float
          pattern: ^\d{1,15}\.\d{2,4}$
          description: El importe total del IVA de la factura.
          example: 522500.02
        currency:
          type: string
          pattern: ^[A-Z]{3}$
          description: El código de moneda de tres letras (ISO-4217) de la factura.
          example: CLP
        issue_date:
          type: string
          format: date
          pattern: ^\d{4}-\d{2}-\d{2}$
          description: La fecha en que se emitió la factura, en formato `YYYY-MM-DD`.
          example: '2024-09-23'
        received_at:
          type: string
          format: date-time
          description: La marca de tiempo ISO-8601 de cuando se recibió la factura.
          example: '2024-09-02T15:23:47-03:00'
        acknowledged_at:
          type: string
          format: date-time
          description: >-
            La marca de tiempo ISO-8601 de cuando se reconoció la recepción de
            la factura.
          example: '2024-09-02T15:23:47-03:00'
        claim_date:
          type: string
          format: date
          pattern: ^\d{4}-\d{2}-\d{2}$
          nullable: true
          description: >-
            La fecha en que se presentó una reclamación o disputa sobre la
            factura, en formato `YYYY-MM-DD`.
          example: null
        status:
          type: string
          description: |-
            El estado de la factura. Puede ser:

              - `REGISTERED`
              - `PENDING`
              - `REJECTED`
              - `CANCELLED`
          example: REGISTERED
        document_code:
          type: integer
          description: >-
            Un código que indica si el documento es una factura, una nota de
            crédito o débito, etc.
          example: 33
        category:
          type: string
          description: La categoría de la factura, según la institución.
          example: Del Giro
        folio:
          type: string
          description: El código único de la institución para la factura.
          example: '23559723'
        sender_id:
          type: string
          description: >-
            El número de identificación del remitente. Para SII Chile, este es
            el RUT.
          example: 59324768-2
        sender_name:
          type: string
          description: El nombre registrado del remitente.
          example: Cafe del Sur
        receiver_id:
          type: string
          description: >-
            El número de identificación del receptor. Para SII Chile, este es el
            RUT.
          example: 82136549-6
        receiver_name:
          type: string
          description: El nombre registrado del receptor.
          example: Alejandra Gonzalez
        type:
          type: string
          enum:
            - INFLOW
            - OUTFLOW
          description: Indica si la factura es un INFLOW o OUTFLOW.
          example: INFLOW
        purchase_invoice_details:
          type: object
          nullable: true
          description: >-
            Detalles sobre la factura de compra. Si la factura es una factura de
            venta (`type` = `OUTFLOW`), este campo devolverá `null`.
          properties:
            vat_refundable_amount:
              type: number
              format: float
              pattern: ^\d{1,15}\.\d{2,4}$
              nullable: true
              description: >-
                El monto del IVA pagado que es elegible para ser reclamado como
                un crédito fiscal.
              example: 300.02
            vat_non_refundable_amount:
              type: number
              format: float
              pattern: ^\d{1,15}\.\d{2,4}$
              nullable: true
              description: >-
                El monto del IVA pagado que no se puede reclamar como crédito
                fiscal.
              example: 20.02
            vat_non_refundable_code:
              type: integer
              format: int32
              nullable: true
              description: >-
                Un código que identifica la razón por la cual el IVA no es
                recuperable.
              example: 90
            net_amount_fixed_assets:
              type: number
              format: float
              pattern: ^\d{1,15}\.\d{2,4}$
              nullable: true
              description: El valor neto de los activos fijos adquiridos.
              example: 8000.02
            vat_fixed_assets:
              type: number
              format: float
              pattern: ^\d{1,15}\.\d{2,4}$
              nullable: true
              description: El valor del IVA en la compra de activos fijos.
              example: 80.02
            vat_common_use:
              type: number
              format: float
              pattern: ^\d{1,15}\.\d{2,4}$
              nullable: true
              description: >-
                El IVA que se aplica a las compras utilizadas tanto para fines
                gravables como no gravables.
              example: 129.02
            tax_non_credit_amount:
              type: number
              format: float
              pattern: ^\d{1,15}\.\d{2,4}$
              nullable: true
              description: El monto del impuesto que no se puede reclamar como crédito.
              example: 5.02
            vat_non_withheld:
              type: number
              format: float
              pattern: ^\d{1,15}\.\d{2,4}$
              nullable: true
              description: El monto del IVA que no fue retenido por el comprador.
              example: 8.02
            tax_exempt_amount:
              type: number
              format: float
              pattern: ^\d{1,15}\.\d{2,4}$
              nullable: true
              description: La parte de la compra que está exenta de IVA.
              example: 33.02
            credit_or_debit_note_on_purchase:
              type: boolean
              nullable: true
              description: >-
                Indica si la factura está vinculada con una nota de crédito o
                débito.
              example: false
            tax_cigarettes_amount:
              type: number
              format: float
              pattern: ^\d{1,15}\.\d{2,4}$
              nullable: true
              description: El monto total de impuestos aplicado a los cigarrillos.
              example: 50.02
            tax_cigar_amount:
              type: number
              format: float
              pattern: ^\d{1,15}\.\d{2,4}$
              nullable: true
              description: El monto total de impuestos aplicado a los cigarros.
              example: 51.02
            tax_processed_tobacco_amount:
              type: number
              format: float
              pattern: ^\d{1,15}\.\d{2,4}$
              nullable: true
              description: El monto total de impuestos aplicado al tabaco procesado.
              example: 49.02
            additional_tax_amount:
              type: number
              format: float
              pattern: ^\d{1,15}\.\d{2,4}$
              nullable: true
              description: El monto total del impuesto del impuesto adicional.
              example: 1005.02
            additional_tax_rate:
              type: string
              nullable: true
              description: La tasa impositiva del impuesto adicional.
              example: '2.1'
            additional_tax_code:
              type: integer
              format: int32
              nullable: true
              description: El código fiscal para el impuesto adicional.
              example: 50993
        sales_invoice_details:
          type: object
          nullable: true
          description: >-
            Detalles sobre la factura de ventas. Si la factura es una factura de
            compra (`type` = `INFLOW`), este campo devolverá `null`.
          properties:
            construction_sector_tax_credit:
              type: number
              format: float
              pattern: ^\d{1,15}\.\d{2,4}$
              nullable: true
              description: >-
                El monto del crédito fiscal aplicable para las empresas de
                construcción.
              example: 50000.02
            tax_free_trade_zone_amount:
              type: number
              format: float
              pattern: ^\d{1,15}\.\d{2,4}$
              nullable: true
              description: >-
                Impuesto aplicable a las transacciones en zonas de libre
                comercio.
              example: 38490.02
            container_deposit_guarantee:
              type: number
              format: float
              pattern: ^\d{1,15}\.\d{2,4}$
              nullable: true
              description: >-
                Se refiere a depósitos o garantías sobre contenedores, si
                corresponde.
              example: 0.02
            is_free_of_charge:
              type: boolean
              nullable: true
              description: >-
                Indique si esta venta se realizó sin costo (por ejemplo, la
                factura es para material promocional, reabastecimientos
                periódicos gratuitos y similares).
              example: false
            periodic_billing_type:
              type: boolean
              nullable: true
              description: Marca si la factura es para servicios periódicos.
              example: false
            non_billable_amount:
              type: number
              format: float
              pattern: ^\d{1,15}\.\d{2,4}$
              nullable: true
              description: La parte de la transacción que no es facturable.
              example: 40.02
            total_amount_for_period:
              type: number
              format: float
              pattern: ^\d{1,15}\.\d{2,4}$
              nullable: true
              description: >-
                El monto total para un período específico, a menudo utilizado
                para la facturación periódica.
            domestic_transportation_amount:
              type: number
              format: float
              pattern: ^\d{1,15}\.\d{2,4}$
              nullable: true
              description: El monto total gastado en transporte doméstico.
              example: 67.02
            international_transportation_amount:
              type: number
              format: float
              pattern: ^\d{1,15}\.\d{2,4}$
              nullable: true
              description: El monto total gastado en transporte internacional.
              example: 56.02
            branch_code:
              type: integer
              format: int32
              nullable: true
              description: >-
                El código de la sucursal fiscal donde se emitió la factura de
                venta.
              example: 76129014
            tax_exempt_amount:
              type: number
              format: float
              pattern: ^\d{1,15}\.\d{2,4}$
              nullable: true
              description: La parte de la venta que está exenta de IVA.
              example: 4000.02
            credit_or_debit_note_on_purchase:
              type: boolean
              nullable: true
              description: >-
                Indica si la factura está vinculada con una nota de crédito o
                débito.
              example: false
            additional_tax_code:
              type: integer
              nullable: true
              description: El código fiscal para el impuesto adicional.
              example: 50993
            additional_tax_rate:
              type: string
              nullable: true
              description: La tasa impositiva del impuesto adicional.
              example: '2.1'
            additional_tax_amount:
              type: number
              format: float
              pattern: ^\d{1,15}\.\d{2,4}$
              nullable: true
              description: El monto total del impuesto del impuesto adicional.
              example: 1005.02
            vat_total_withheld:
              type: number
              format: float
              pattern: ^\d{1,15}\.\d{2,4}$
              nullable: true
              description: El total del IVA retenido.
              example: 33.02
            vat_partially_withheld:
              type: number
              format: float
              pattern: ^\d{1,15}\.\d{2,4}$
              nullable: true
              description: El monto del IVA parcialmente retenido.
              example: 30.02
            vat_non_withheld:
              type: number
              format: float
              pattern: ^\d{1,15}\.\d{2,4}$
              nullable: true
              description: El monto del IVA que no fue retenido.
              example: 40.02
            vat_sales:
              type: number
              format: float
              pattern: ^\d{1,15}\.\d{2,4}$
              nullable: true
              description: >-
                El importe del IVA correspondiente a las ventas propias del
                vendedor.
              example: 100.02
            vat_third_party:
              type: number
              format: float
              pattern: ^\d{1,15}\.\d{2,4}$
              nullable: true
              description: >-
                Importe del IVA relacionado con ventas de terceros si actúa como
                intermediario.
              example: 1000.02
            vat_past_due:
              type: number
              format: float
              pattern: ^\d{1,15}\.\d{2,4}$
              nullable: true
              description: >-
                IVA que se contabiliza o paga después de la fecha de
                vencimiento.
              example: 31.02
            invoice_settlement_sender_id:
              type: string
              nullable: true
              description: El RUT de la entidad que emitió la liquidación para la factura.
              example: 55524768-7
            invoice_settlement_net_commission:
              type: number
              format: float
              pattern: ^\d{1,15}\.\d{2,4}$
              nullable: true
              description: El importe neto de la comisión en la liquidación de la factura.
              example: 54.02
            invoice_settlement_exempt_commission:
              type: number
              format: float
              pattern: ^\d{1,15}\.\d{2,4}$
              nullable: true
              description: >-
                La parte de la comisión en la liquidación de la factura que está
                exenta de impuestos.
              example: 16.02
            invoice_settlement_vat_commission:
              type: number
              format: float
              pattern: ^\d{1,15}\.\d{2,4}$
              nullable: true
              description: >-
                IVA cobrado sobre el monto de la comisión en la liquidación de
                la factura.
              example: 78.02
            reference_document_type:
              type: string
              nullable: true
              description: >-
                Indica el tipo de documento al que se refiere o está vinculado
                esta factura.
              example: null
            reference_document_folio:
              type: string
              nullable: true
              description: El número de folio del documento referido.
              example: null
            foreign_recipient_id:
              type: string
              nullable: true
              description: El número de identificación de un individuo extranjero.
              example: JANM-7820234
            foreign_recipient_nationality:
              type: string
              nullable: true
              description: La nacionalidad del individuo extranjero.
              example: Peru
        summary_invoice_details:
          type: object
          description: >-
            Detalles sobre el resumen de las facturas `BOLETA_ELECTRONICA` o
            `COMPROBANTE_PAGO`.
          properties:
            month:
              type: string
              pattern: ^\d{4}-\d{2}$
              description: El año y mes de las facturas, en formato `YYYY-MM`.
              example: 2024-08
            updated_at:
              type: string
              format: date-time
              description: >-
                La marca de tiempo ISO-8601 de cuándo se actualizó por última
                vez la lista de facturas.
              example: '2024-09-02T15:23:47-03:00'
            total_documents:
              type: integer
              format: int32
              description: El número total de facturas en el resumen.
              example: 23
            tax_exempt_amount:
              type: number
              format: float
              pattern: ^\d{1,15}\.\d{2,4}$
              description: >-
                El valor total de la factura (de todas las facturas en el
                resumen) que está exento de IVA.
              example: 4000.02
    tax_status_sii_entity_details:
      type: object
      description: >-
        Detalles sobre la entidad fiscal (fechas clave e información de
        identificación).
      required:
        - incorporation_date
        - start_date
        - end_date
        - document_id_type
        - document_id_number
        - name
      properties:
        incorporation_date:
          type: string
          format: date
          description: >-
            La fecha en que se constituyó la entidad fiscal, en formato
            `YYYY-MM-DD`.
          example: 24-09-2010
        start_date:
          type: string
          format: date
          description: >-
            La fecha en que la entidad fiscal comenzó a operar, en formato
            `YYYY-MM-DD`.
          example: 24-09-2010
        end_date:
          type: string
          format: date
          nullable: true
          description: >-
            La fecha en que la entidad fiscal cesó sus operaciones, en formato
            `YYYY-MM-DD`. Si la entidad aún está operando, este campo devolverá
            `null`.
          example: null
        document_id_type:
          type: string
          description: >-
            El tipo de ID de documento que tiene la entidad fiscal. Para Chile,
            esto será el `RUT`.
          example: RUT
        document_id_number:
          type: string
          description: El número de identificación del documento de la entidad fiscal.
          example: 197476427-K
        name:
          type: string
          description: El nombre de la entidad fiscal.
          example: Empresa de Prueba
    tax_status_sii_address:
      type: object
      description: Detalles sobre la dirección de la entidad fiscal.
      required:
        - type
        - date
        - address
      properties:
        type:
          type: string
          enum:
            - PRIMARY
            - SECONDARY
            - MAILING_ADDRESS
            - NOTIFICATION_ADDRESS
          description: |-
            El tipo de dirección. Puede ser:

              - `PRIMARY` (*domicilio*)
              - `SECONDARY` (*sucursal*)
              - `MAILING_ADDRESS` (*DOM. POSTAL*)
              - `NOTIFICATION_ADDRESS` (*DOM. URBANO_VALIDO_NOTIFICACIONES*)
          example: PRIMARY
        date:
          type: string
          format: date
          description: >-
            La fecha en que la dirección fue añadida a los registros de la
            entidad fiscal, en formato `YYYY-MM-DD`.
          example: 24-09-2010
        address:
          type: string
          description: La dirección de la entidad fiscal.
          example: Calle Falsa 123
    tax_status_sii_emails:
      type: object
      description: >-
        Detalles sobre las direcciones de correo electrónico de la entidad
        fiscal.
      required:
        - type
        - email
      properties:
        type:
          type: string
          enum:
            - CONTACT
            - NOTIFICATION
            - OTHER
          description: |-
            El tipo de correo electrónico. Puede ser:

            - `CONTACT` (*Correo electrónico de contacto*)
            - `NOTIFICATION` (*Correo electrónico para notificaciones*)
            - `OTHER`.
          example: CONTACT
        email:
          type: string
          format: email
          description: La dirección de correo electrónico de la entidad fiscal.
          example: mi-email@empresa.cl
    tax_status_sii_phone:
      type: object
      description: Detalles sobre los números de teléfono de la entidad fiscal.
      required:
        - number
        - type
      properties:
        type:
          type: string
          nullable: true
          enum:
            - LANDLINE
            - MOBILE
            - OTHER
            - 'null'
          description: |-
            El tipo de número de teléfono. Puede ser:

              - `LANDLINE`
              - `MOBILE`
              - `OTHER`
          example: LANDLINE
        number:
          type: string
          description: El número de teléfono de la entidad fiscal.
          example: 123456789
    tax_status_sii_economic_activity:
      type: object
      description: Detalles sobre la actividad económica de la entidad fiscal.
      required:
        - type
        - activity
        - code
        - tax_category
        - vat_affected
        - start_date
      properties:
        type:
          type: string
          description: >-
            El tipo de actividad económica general, según el Servicio de
            Impuestos Internos (SII).
          example: ASESORIA EN INGENIERIA
        activity:
          type: string
          description: >-
            La actividad económica específica, según el Servicio de Impuestos
            Internos (SII).
          example: ACTIVIDADES DE CONSULTORIA DE GESTION
        code:
          type: string
          description: >-
            El código de actividad económica, según el Servicio de Impuestos
            Internos (SII).
          example: '702000'
        tax_category:
          type: integer
          description: >-
            La categoría tributaria de la actividad económica, según el Servicio
            de Impuestos Internos (SII).
          example: 1
        vat_affected:
          type: boolean
          description: Indica si la actividad económica está afectada por el IVA.
          example: true
        start_date:
          type: string
          format: date
          description: >-
            La fecha en que la entidad fiscal comenzó esta actividad económica,
            en formato `YYYY-MM-DD`.
          example: 24-09-2010
    tax_status_sii_legal_representative:
      type: object
      description: Detalles sobre los representantes legales de la entidad fiscal.
      required:
        - is_current
        - name
        - document_id_type
        - document_id_number
        - start_date
      properties:
        is_current:
          type: boolean
          description: >-
            Indica si el representante legal es el representante legal actual de
            la entidad fiscal.
          example: true
        name:
          type: string
          description: El nombre del representante legal.
          example: Juan Perez
        document_id_type:
          type: string
          enum:
            - RUT
          description: >-
            El tipo de identificación del documento del representante legal.
            Para Chile, esto siempre se establecerá como `RUT`.
          example: RUT
        document_id_number:
          type: string
          description: >-
            El número de identificación del documento del representante legal.
            Para Chile, este será el número RUT.
          example: 12345678-9
        start_date:
          type: string
          format: date
          description: >-
            La fecha en que el representante legal comenzó a representar a la
            entidad fiscal, en formato `YYYY-MM-DD`.
          example: 24-09-2010
        end_date:
          type: string
          format: date
          nullable: true
          description: >-
            La fecha en que el representante legal dejó de representar a la
            entidad fiscal, en formato `YYYY-MM-DD`. Si el representante legal
            aún representa a la entidad fiscal, este campo devolverá `null`.
          example: null
    tax_status_sii_equity_holder:
      type: object
      description: Detalles sobre los titulares de capital de la entidad fiscal.
      required:
        - is_current
        - name
        - document_id_type
        - document_id_number
        - inactive
        - start_date
        - capital_contributed
        - capital_contribution_outstanding
        - ownership_share
        - profit_share
      properties:
        is_current:
          type: boolean
          description: Indica si el titular de la equidad está actualmente activo.
          example: true
        name:
          type: string
          description: El nombre del titular de la participación.
          example: Juan Perez
        document_id_type:
          type: string
          enum:
            - RUT
          description: >-
            El tipo de identificación del documento del titular de la equidad.
            Para Chile, esto siempre se establecerá en `RUT`.
          example: RUT
        document_id_number:
          type: string
          description: >-
            El número de identificación del documento del titular de acciones.
            Para Chile, este será el número RUT.
          example: 12345678-9
        inactive:
          type: boolean
          description: Indica si el titular de la equidad está actualmente inactivo.
          example: false
        start_date:
          type: string
          format: date
          description: >-
            La fecha en que el titular de la equidad comenzó a poseer equidad en
            la entidad fiscal, en formato `YYYY-MM-DD`.
          example: 24-09-2010
        end_date:
          type: string
          format: date
          nullable: true
          description: >-
            La fecha en que el titular de la participación dejó de tener
            participación en la entidad fiscal, en formato `YYYY-MM-DD`. Si el
            titular de la participación aún mantiene participación en la entidad
            fiscal, este campo devolverá `null`.
          example: null
        capital_contributed:
          type: number
          description: La cantidad de capital aportada por el titular de capital.
          example: 1000000
        capital_contribution_outstanding:
          type: number
          description: >-
            El monto de la contribución de capital pendiente por parte del
            titular de capital.
          example: 3750
        ownership_share:
          type: number
          description: El porcentaje de participación accionaria del titular de capital.
          example: 25.25
        profit_share:
          type: number
          description: >-
            El porcentaje de participación en las ganancias del titular de
            acciones.
          example: 31.25
    tax_status_sii_company_stake:
      type: object
      description: Detalles sobre las participaciones de la empresa de la entidad fiscal.
      required:
        - name
        - document_id_type
        - document_id_number
        - inactive
        - start_date
        - capital_contributed
        - capital_contribution_outstanding
        - ownership_share
        - profit_share
      properties:
        name:
          type: string
          description: El nombre de la entidad que esta entidad fiscal.
          example: Empresa de Prueba
        document_id_type:
          type: string
          enum:
            - RUT
          description: >-
            El tipo de ID de documento del negocio. Para Chile, esto siempre se
            establecerá en `RUT`.
          example: RUT
        document_id_number:
          type: string
          description: >-
            El número de identificación del documento de la empresa. Para Chile,
            este será el número RUT.
          example: 12345678-9
        inactive:
          type: boolean
          description: Indica si el negocio está actualmente activo.
          example: false
        start_date:
          type: string
          format: date
          description: >-
            La fecha en que la empresa comenzó a tener participación en la
            entidad fiscal, en formato `YYYY-MM-DD`.
          example: 24-09-2010
        end_date:
          type: string
          format: date
          nullable: true
          description: >-
            La fecha en que el titular de la empresa dejó de poseer acciones en
            la entidad fiscal, en formato `YYYY-MM-DD`. Si el titular de las
            acciones aún posee acciones en la entidad fiscal, este campo
            devolverá `null`.
          example: null
        capital_contributed:
          type: number
          format: float
          pattern: ^\d{1,15}\.\d{2,4}$
          description: La cantidad de capital aportado por la empresa.
          example: 1000000.02
        capital_contribution_outstanding:
          type: number
          format: float
          pattern: ^\d{1,15}\.\d{2,4}$
          description: El monto de la contribución de capital pendiente por la empresa.
          example: 3750.02
        ownership_share:
          type: number
          format: float
          pattern: ^\d{1,15}\.\d{2,4}$
          description: El porcentaje de participación accionaria de la empresa.
          example: 25.25
        profit_share:
          type: number
          format: float
          pattern: ^\d{1,15}\.\d{2,4}$
          description: El porcentaje de participación en las ganancias de la empresa.
          example: 31.25
    tax_status_sii_regime:
      type: object
      description: Detalles sobre el régimen fiscal de la entidad fiscal.
      required:
        - type
        - start_date
      properties:
        type:
          type: string
          description: >-
            El tipo de régimen tributario, según lo definido por el Servicio de
            Impuestos Internos (SII).
          example: MICRO EMPRESA
        start_date:
          type: string
          format: date
          description: >-
            La fecha en que la entidad fiscal comenzó este régimen fiscal, en
            formato `YYYY-MM-DD`.
          example: '2023-01-01'
    tax_status_sii_authorized_tax_document:
      type: object
      description: Detalles sobre un documento fiscal autorizado para la entidad fiscal.
      required:
        - type
        - document_limit
        - authorization_date
      properties:
        type:
          type: string
          description: >-
            El tipo de documento tributario autorizado, según lo definido por el
            Servicio de Impuestos Internos (SII).
          example: CONTABILIDAD EN HOJAS SUELTAS CON NRO.UN
        document_limit:
          type: integer
          description: >-
            El número máximo de documentos que se pueden emitir bajo esta
            autorización.
          example: 2000
        authorization_date:
          type: string
          format: date
          description: >-
            La fecha en que se establecieron el documento fiscal y el límite, en
            formato `YYYY-MM-DD`.
          example: '2010-18-11'
    tax_status_sii_property_tax_liabilities:
      type: object
      description: >-
        Detalles sobre las obligaciones fiscales de una propiedad con la que la
        entidad está asociada.
      required:
        - property_id
        - district
        - address
        - type
        - overdue_tax_payments
        - scheduled_tax_payments
      properties:
        property_id:
          type: string
          description: >-
            El identificador único de la propiedad, según el Servicio de
            Impuestos Internos (SII).
          example: '12345'
        district:
          type: string
          description: El distrito donde se encuentra la propiedad.
          example: NUNAO
        address:
          type: string
          description: La dirección de la propiedad.
          example: 123 Example Street
        type:
          type: string
          description: El tipo de propiedad asociado con la responsabilidad fiscal.
          example: HABITACIONAL
        overdue_tax_payments:
          type: array
          description: Una lista de pagos de impuestos atrasados para la propiedad.
          items:
            type: object
            required:
              - year
              - installment
              - due_date
              - amount_due
            properties:
              year:
                type: integer
                description: El año para el cual el pago de impuestos está atrasado.
                example: 2023
              installment:
                type: integer
                description: El número de cuota del pago de impuestos atrasado.
                example: 1
              due_date:
                type: string
                format: date
                description: >-
                  La fecha de vencimiento del pago de impuestos atrasados, en
                  formato `YYYY-MM-DD`.
                example: '2023-04-30'
              amount_due:
                type: number
                format: float
                description: El monto adeudado por el pago de impuestos atrasado.
                example: 19.864
        scheduled_tax_payments:
          type: array
          description: Una lista de pagos de impuestos programados para la propiedad.
          items:
            type: object
            required:
              - year
              - installment
              - due_date
              - amount_due
            properties:
              year:
                type: integer
                description: El año para el cual está programado el pago de impuestos.
                example: 2023
              installment:
                type: integer
                description: El número de cuota del pago de impuestos programado.
                example: 1
              due_date:
                type: string
                format: date
                description: >-
                  La fecha de vencimiento del pago de impuestos programado, en
                  formato `YYYY-MM-DD`.
                example: '2023-04-30'
              amount_due:
                type: number
                format: float
                description: El monto adeudado para el pago programado de impuestos.
                example: 19.864
    tax_status_sii_fiscal_office:
      type: object
      description: >-
        Detalles sobre la oficina fiscal donde está registrada la entidad
        fiscal.
      required:
        - name
        - address
      properties:
        name:
          type: string
          description: El nombre de la oficina fiscal donde está registrado el ente fiscal.
          example: VIÑA DEL MAR
        address:
          type: string
          description: >-
            La dirección de la oficina fiscal donde está registrado el ente
            fiscal.
          example: ARLEGUI 525, VIÑA DEL MAR
    tax_status_sii:
      type: object
      title: Objeto de Estado Tributario (Chile)
      x-tags:
        - Tax Status Chile
      properties:
        id:
          $ref: '#/components/schemas/id'
        link:
          $ref: '#/components/schemas/link'
        collected_at:
          $ref: '#/components/schemas/collected_at'
        created_at:
          $ref: '#/components/schemas/created_at'
        entity_details:
          $ref: '#/components/schemas/tax_status_sii_entity_details'
        addresses:
          type: array
          description: Una matriz de direcciones para la entidad fiscal.
          items:
            $ref: '#/components/schemas/tax_status_sii_address'
        emails:
          type: array
          description: >-
            Una matriz de direcciones de correo electrónico para la entidad
            fiscal.
          items:
            $ref: '#/components/schemas/tax_status_sii_emails'
        phone_numbers:
          type: array
          description: Un array de números de teléfono para la entidad fiscal.
          items:
            $ref: '#/components/schemas/tax_status_sii_phone'
        economic_activities:
          type: array
          description: Un conjunto de actividades económicas para la entidad fiscal.
          items:
            $ref: '#/components/schemas/tax_status_sii_economic_activity'
        legal_representative:
          type: array
          description: Un array de representantes legales para la entidad fiscal.
          items:
            $ref: '#/components/schemas/tax_status_sii_legal_representative'
        equity_holders:
          type: array
          description: Un array de titulares de acciones para la entidad fiscal.
          items:
            $ref: '#/components/schemas/tax_status_sii_equity_holder'
        company_partnership_stakes:
          type: array
          description: >-
            Una matriz de participaciones en asociaciones de la empresa para la
            entidad fiscal.
          items:
            $ref: '#/components/schemas/tax_status_sii_company_stake'
        regimes:
          type: array
          nullable: true
          description: Una lista de regímenes fiscales para la entidad fiscal.
          items:
            $ref: '#/components/schemas/tax_status_sii_regime'
        authorized_tax_documents:
          type: array
          nullable: true
          description: Una lista de documentos fiscales autorizados para la entidad fiscal.
          items:
            $ref: '#/components/schemas/tax_status_sii_authorized_tax_document'
        property_tax_liabilities:
          type: array
          nullable: true
          description: >-
            Una lista de las obligaciones fiscales de una propiedad con las que
            la entidad está asociada.
          items:
            $ref: '#/components/schemas/tax_status_sii_property_tax_liabilities'
        fiscal_office:
          $ref: '#/components/schemas/tax_status_sii_fiscal_office'
    debt_chile:
      type: object
      title: Objeto de Informe de Deuda (Chile)
      x-tags:
        - Debt Reports Chile
      properties:
        id:
          $ref: '#/components/schemas/id'
        link:
          $ref: '#/components/schemas/link'
        collected_at:
          $ref: '#/components/schemas/collected_at'
        created_at:
          $ref: '#/components/schemas/created_at'
        personal_data:
          type: object
          properties:
            full_name:
              type: string
              description: El nombre completo del individuo.
              example: 'Cabezas Pérez Martín Vicente '
            document_id_type:
              type: string
              enum:
                - RUT
              description: >-
                El tipo de identificación de documento del individuo. Para
                Chile, esto siempre se establecerá en `RUT`.
              example: RUT
            document_id_number:
              type: string
              description: >-
                El número de identificación del documento del individuo. Para
                Chile, este será el número RUT.
              example: 12345678-9
        debt_data_last_update:
          type: string
          format: date
          description: >-
            La fecha en que se actualizaron por última vez los datos de la
            deuda, en formato `YYYY-MM-DD`.
          example: '2023-07-02'
        currency:
          type: string
          pattern: ^[A-Z]{3}$
          description: La moneda de las deudas. Para Chile, esto será el `CLP`.
          example: CLP
        total:
          type: number
          format: float
          pattern: ^\d{1,15}\.\d{2,4}$
          nullable: true
          description: >-
            El monto total de la deuda, incluyendo deudas actuales, morosas,
            gravemente morosas y en incumplimiento.
          example: 6506000.02
        current:
          type: number
          format: float
          pattern: ^\d{1,15}\.\d{2,4}$
          nullable: true
          description: La cantidad de deuda que actualmente está pendiente pero no vencida.
          example: 5350000.02
        delinquent:
          type: number
          format: float
          pattern: ^\d{1,15}\.\d{2,4}$
          nullable: true
          description: La cantidad de deuda que tiene un retraso de 30 a 59 días.
          example: null
        severely_delinquent:
          type: number
          format: float
          pattern: ^\d{1,15}\.\d{2,4}$
          nullable: true
          description: La cantidad de deuda que tiene un retraso de 60-89 días.
          example: 56000.02
        defaulted:
          type: number
          format: float
          pattern: ^\d{1,15}\.\d{2,4}$
          nullable: true
          description: La cantidad de deuda que tiene un retraso de 90 días.
          example: 1100000.02
        direct_debts:
          type: array
          nullable: true
          description: Una lista de deudas que se atribuyen directamente al individuo.
          items:
            type: object
            properties:
              financial_institution:
                type: string
                description: >-
                  El nombre de la institución financiera donde se mantiene la
                  deuda.
                example: Banco Santander
              credit_type:
                type: string
                description: >-
                  El tipo de crédito emitido por la institución financiera. Por
                  ejemplo, `Vivienda`, `Comercial`, `Consumo` o `Otro`.
                example: Vivienda
              amount:
                type: number
                format: float
                pattern: ^\d{1,15}\.\d{2,4}$
                description: El monto total de la deuda en la institución financiera.
                example: 5000000.02
              current:
                type: number
                format: float
                pattern: ^\d{1,15}\.\d{2,4}$
                nullable: true
                description: >-
                  El monto pendiente actual de la deuda en la institución
                  financiera.
                example: 5000000.02
              delinquent:
                type: number
                format: float
                pattern: ^\d{1,15}\.\d{2,4}$
                nullable: true
                description: La cantidad de deuda que tiene un retraso de 30 a 59 días.
                example: null
              severely_delinquent:
                type: number
                format: float
                nullable: true
                description: La cantidad de deuda que tiene un retraso de 60-89 días.
                example: null
              defaulted:
                type: number
                format: float
                pattern: ^\d{1,15}\.\d{2,4}$
                nullable: true
                description: La cantidad de deuda que tiene un retraso de 90 días.
                example: null
        indirect_debts:
          type: array
          nullable: true
          description: Lista de deudas indirectas de instituciones financieras.
          items:
            type: object
            properties:
              financial_institution:
                type: string
                description: >-
                  Nombre de la institución financiera que proporciona la deuda
                  indirecta.
                example: Banco BCI
              credit_type:
                type: string
                description: >-
                  El tipo de crédito emitido por la institución financiera. Por
                  ejemplo, `Vivienda`, `Comercial`, `Consumo` o `Otro`.
                example: Consumo
              amount:
                type: number
                format: float
                pattern: ^\d{1,15}\.\d{2,4}$
                description: El monto total de la deuda en la institución financiera.
                example: 200000.02
              current:
                type: number
                format: float
                pattern: ^\d{1,15}\.\d{2,4}$
                nullable: true
                description: >-
                  El monto pendiente actual de la deuda en la institución
                  financiera.
                example: null
              delinquent:
                type: number
                format: float
                pattern: ^\d{1,15}\.\d{2,4}$
                nullable: true
                description: La cantidad de deuda que tiene un retraso de 30 a 59 días.
                example: null
              severely_delinquent:
                type: number
                format: float
                pattern: ^\d{1,15}\.\d{2,4}$
                nullable: true
                description: La cantidad de deuda que tiene un retraso de 60-89 días.
                example: null
              defaulted:
                type: number
                format: float
                pattern: ^\d{1,15}\.\d{2,4}$
                nullable: true
                description: La cantidad de deuda que tiene un retraso de 90 días.
                example: 200000.02
        credit_lines:
          type: array
          nullable: true
          description: >-
            Lista de líneas de crédito (como tarjetas de crédito) disponibles
            para el individuo.
          items:
            type: object
            properties:
              financial_institution:
                type: string
                description: >-
                  El nombre de la institución financiera que proporciona la
                  línea de crédito.
                example: Banco BCI
              direct_amount:
                type: number
                format: float
                pattern: ^\d{1,15}\.\d{2,4}$
                nullable: true
                description: La cantidad de crédito directo disponible.
                example: 5000000.02
              indirect_amount:
                type: number
                format: float
                pattern: ^\d{1,15}\.\d{2,4}$
                nullable: true
                description: La cantidad de crédito indirecto disponible.
                example: null
        other_credits:
          type: array
          nullable: true
          description: >-
            Lista de otros créditos (como notas de garantía, crédito extranjero,
            etc.) disponibles para el individuo.
          items:
            type: object
            properties:
              financial_institution:
                type: string
                description: >-
                  El nombre de la institución financiera que proporciona el
                  crédito.
                example: Banco BCI
              direct_amount:
                type: number
                format: float
                pattern: ^\d{1,15}\.\d{2,4}$
                nullable: true
                description: La cantidad de crédito directo disponible.
                example: null
              indirect_amount:
                type: number
                format: float
                pattern: ^\d{1,15}\.\d{2,4}$
                nullable: true
                description: La cantidad de crédito indirecto disponible.
                example: 250000.02
    payments_common_pagination_properties:
      type: object
      properties:
        count:
          type: integer
          format: int32
          description: El número total de resultados en tu cuenta de Belvo.
          example: 130
        next:
          type: string
          nullable: true
          format: uri
          description: >-
            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:
          type: string
          nullable: true
          format: uri
          description: >-
            La URL a la página anterior de resultados. Si no hay una página
            anterior, el valor es `null`.
          example: null
    paymentInstitutionBR:
      type: object
      required:
        - id
        - active
        - name
        - display_name
        - legal_entity_name
        - website
        - logo
        - icon_logo
        - text_logo
        - primary_color
        - country
        - form_fields
        - sort_priority
        - description
      properties:
        id:
          type: string
          format: uuid
          description: ID único de Belvo para referenciar la institución.
          example: bbaceead-7b96-46d8-9354-38dec9707004
        active:
          type: boolean
          description: Indica si esta institución está disponible para su uso o no.
          example: true
        institution_type:
          type: string
          enum:
            - BUSINESS
            - INDIVIDUAL
          description: El tipo de institución. Puede ser `BUSINESS` o `INDIVIDUAL`.
          example: INDIVIDUAL
        name:
          type: string
          description: El nombre de la institución, según lo designado por Belvo.
          example: wakanda_national
        display_name:
          type: string
          description: El nombre de cara al cliente de la institución.
          example: Wakanda National Bank
        legal_entity_name:
          type: string
          nullable: true
          description: >-
            El nombre de la entidad legal de la institución, tal como está
            registrado ante la autoridad reguladora correspondiente. Solo
            aplicable para 🇧🇷 Brasil OFPI.
          example: Wakanda Bank, National Association
        website:
          type: string
          description: La URL del sitio web de la institución.
          example: https://www.wakandanational.com
        logo:
          type: string
          description: La URL del logotipo de la institución.
          example: >-
            https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_logo.png
        icon_logo:
          type: string
          description: La URL del logotipo del icono de la institución.
          example: >-
            https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_icon_logo.png
        text_logo:
          type: string
          description: La URL del logotipo de texto de la institución.
          example: >-
            https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_text_logo.png
        primary_color:
          type: string
          description: El color primario en el sitio web de la institución.
          example: '#fdbc24'
        country:
          type: string
          maxLength: 3
          description: >-
            El país en el que se encuentra la institución. Para Brasil, esto
            siempre se establece en `BRA`.
          example: BRA
        form_fields:
          type: array
          nullable: true
          description: Este campo no es aplicable para OFPI y devolverá un array vacío.
          example: []
        sort_priority:
          type: integer
          format: int32
          description: >-
            Número que representa el orden en el que la institución debe
            mostrarse en una aplicación, siendo `1` el más alto.
          example: 1
        description:
          type: string
          nullable: true
          description: Una breve descripción de la institución.
          example: >-
            Simple, transparent and secure: Wakanda Bank is the leading
            financial technology company in Latin America.
    401UnauthorizedError:
      type: object
      title: Error no autorizado
      description: >-
        Este error ocurre cuando intentas realizar una llamada API utilizando
        credenciales incorrectas de la API de Belvo (ya sea tu clave secreta o
        contraseña secreta, o ambas, son incorrectas).
      properties:
        code:
          type: string
          description: >-
            Un código de error único (`authentication_failed`) que te permite
            clasificar y manejar el error de manera programática.
          example: authentication_failed
        message:
          type: string
          description: |-
            Una breve descripción del error.

            Para los errores `authentication_failed`, la descripción es:

              - `Invalid Secret Keys`.
          example: Invalid Secret Keys
        request_id:
          $ref: '#/components/schemas/request_id'
    EnumCustomerType:
      type: string
      enum:
        - INDIVIDUAL
        - BUSINESS
      minLength: 8
      maxLength: 10
      description: |-
        El tipo de cliente. Puede ser:

          - `INDIVIDUAL`
          - `BUSINESS` (solo para OFPI de Brasil)
      example: INDIVIDUAL
    external_id__payments:
      type: string
      format: uuid
      description: >-
        Un identificador único adicional para el recurso con fines internos.


        > 👍 Altamente recomendado

        >

        > Recomendamos usar este campo para almacenar su propio identificador
        único para cada recurso (cliente, cuenta bancaria, intención de pago o
        inscripción). Esto puede ser útil para rastrear el recurso en su sistema
        y para fines de depuración.
      example: 4b8a81a0-e33c-45a6-8567-479efb105f73
    EnumPaymentsCountry:
      type: string
      nullable: true
      enum:
        - BRA
        - 'null'
      maxLength: 3
      description: |-
        El país de residencia del cliente.
        -  BRA (🇧🇷 Brasil)
      example: BRA
    EnumCustomerIdentifierTypeOfpi:
      type: string
      enum:
        - CPF
        - CNPJ
      description: >-
        El tipo de documento de identificación del cliente. Para Brasil, esto
        puede ser:


        - `CPF` (cuando `customer_type` es `INDIVIDUAL`)

        - `CNPJ` (cuando `customer_type` es `BUSINESS`)
      example: CPF
    CustomerOfpi:
      type: object
      title: Brasil 🇧🇷 OFPI
      required:
        - id
        - created_at
        - created_by
        - customer_type
        - name
        - country
        - email
        - identifier
        - identifier_type
      properties:
        id:
          $ref: '#/components/schemas/id'
        created_at:
          $ref: '#/components/schemas/created_at'
        created_by:
          $ref: '#/components/schemas/created_by'
        customer_type:
          $ref: '#/components/schemas/EnumCustomerType'
        name:
          type: string
          nullable: true
          minLength: 5
          maxLength: 200
          description: El nombre completo del cliente.
          example: Gustavo Veloso
        external_id:
          $ref: '#/components/schemas/external_id__payments'
        country:
          $ref: '#/components/schemas/EnumPaymentsCountry'
        email:
          type: string
          nullable: true
          pattern: ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$
          description: La dirección de correo electrónico del cliente.
          example: gustavo.veloso@musicabrazil.br
        identifier:
          type: string
          minLength: 11
          maxLength: 14
          description: >-
            El número de documento de la identificación del cliente (dependiendo
            del `identifier_type`).
          example: 191
        identifier_type:
          $ref: '#/components/schemas/EnumCustomerIdentifierTypeOfpi'
        address:
          type: string
          nullable: true
          minLength: 5
          maxLength: 150
          description: La dirección física del cliente.
          example: Rua de Gustavo Veloso 432, 70200 Brasilia
        phone:
          type: string
          nullable: true
          pattern: \+55\d{11}$
          description: El número de teléfono del cliente.
          example: '+5511987654321'
    CreateCustomerOfpi:
      type: object
      description: Crear un cliente para la Iniciación de Pagos (OFPI) Brasil 🇧🇷
      required:
        - identifier
      properties:
        identifier:
          type: string
          minLength: 11
          maxLength: 14
          description: El número de CPF o CNPJ del cliente.
          example: '10187609363'
        name:
          type: string
          minLength: 5
          maxLength: 200
          description: El nombre completo del cliente que deseas crear.
          example: Gustavo Veloso
        external_id:
          $ref: '#/components/schemas/external_id__payments'
        email:
          type: string
          pattern: ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$
          description: La dirección de correo electrónico del cliente.
          example: gustavo.veloso@musicabrazil.br
        phone:
          type: string
          nullable: true
          pattern: \+55\d{11}$
          description: El número de teléfono del cliente.
          example: '+5511987654321'
        address:
          type: string
          nullable: true
          description: La dirección física del cliente.
          example: Rua de Gustavo Veloso 432, 70200 Brasilia
    400ValidationError:
      type: object
      title: Error de validación
      required:
        - code
        - message
        - request_id
      description: >-
        Este error ocurre cuando los parámetros proporcionados no coinciden con
        los campos esperados o el elemento que estás intentando crear ya está en
        nuestra base de datos, lo que lleva a errores de validación de campos.
      properties:
        code:
          type: string
          description: >-
            Un código de error único (`null`, `does_not_exist`, `required`,
            `already_registered`, `invalid_choice`, `max_length`, `min_length`,
            `blank`, `null`, `cancellation_error`) que te permite clasificar y
            manejar el error de manera programática.
          example: required
        message:
          type: string
          description: |-
            Una breve descripción del error.

            La descripción puede ser (entre otras):

              - `Este campo es obligatorio.`
              - `El objeto con nombre=narnia no existe.`
              - `Este campo no puede ser nulo.`
              - `Este campo no puede estar en blanco.`
              - `Este cliente ya está registrado.`
              - `Asegúrese de que este campo tenga al menos 2 caracteres.`
              - `Asegúrese de que este campo no tenga más de 4 caracteres.`
              - `El valor ingresado no es válido.`
              - `Debe establecer todos los campos obligatorios: username, password, username_type.`
              - `Payment Intent no puede ser cancelado porque no está SCHEDULED.`
              - `Payment Intent no puede ser cancelado ya que el tiempo límite (23:59:00) ha pasado.`
          example: This field is required.
        request_id:
          $ref: '#/components/schemas/request_id'
        field:
          type: string
          nullable: true
          description: >-
            Nombre del campo donde se encontró el error.


            > **Nota**: Este campo solo está presente cuando el error está
            relacionado con un campo específico.
          example: institution
    EnumBankAccountPixAccountTypeOfpi:
      type: string
      enum:
        - CHECKINGS
        - SAVINGS
        - SALARY
        - PAYMENTS
      description: |-
        El tipo de cuenta bancaria. Puede ser:

          - `CHECKINGS` (también conocida como Conta Corrente en Brasil)
          - `SAVINGS` (también conocida como Conta Poupança en Brasil)
          - `SALARY` (también conocida como Conta Salário en Brasil)
          - `PAYMENTS` (también conocida como Conta de Pagamento Instantâneo o Conta de Pagamento en Brasil)
      example: CHECKINGS
    BankAccountDetailsOfpi:
      type: object
      title: OFPI (Información de Cuenta PIX)
      description: Información sobre la cuenta bancaria.
      required:
        - account_type
        - agency
        - number
      properties:
        account_type:
          $ref: '#/components/schemas/EnumBankAccountPixAccountTypeOfpi'
        agency:
          type: string
          minLength: 1
          maxLength: 4
          pattern: ^[0-9]{1,4}$
          description: >-
            La agencia (número de sucursal) de la institución donde se creó la
            cuenta.
          example: '0444'
        number:
          type: string
          pattern: ^[0-9]{1,20}$
          minLength: 1
          maxLength: 20
          description: >-
            El número de cuenta bancaria.


            > 📘 Caracteres válidos para el número de cuenta

            >

            > Solo puedes enviar números (`^[0-9]+$`) en la cadena. Por ejemplo,
            `"457220"` es un número de cuenta bancaria válido, mientras que
            "`45722-0`" es inválido ya que contiene un guion (`-`).
          example: '457220'
    HolderInformationIndividualOfpiResponse:
      type: object
      title: INDIVIDUAL
      description: Detalles sobre el titular de la cuenta bancaria individual.
      required:
        - first_name
        - last_name
        - identifier
        - identifier_type
      properties:
        first_name:
          type: string
          minLength: 1
          maxLength: 256
          description: El nombre de pila del titular de la cuenta bancaria.
          example: Dom
        last_name:
          type: string
          minLength: 1
          maxLength: 256
          description: El apellido del titular de la cuenta bancaria.
          example: Mesa
        identifier_type:
          type: string
          enum:
            - CPF
          description: >-
            El tipo de documento de identificación del cliente. Para individuos
            en Brasil, esto debe establecerse en `CPF`.
        identifier:
          type: string
          minLength: 11
          maxLength: 11
          pattern: ^\d{11}$
          description: El número de documento de la identificación del cliente.
          example: 191
    HolderResponseOfpiIndividual:
      type: object
      title: OFPI Brazil 🇧🇷 INDIVIDUAL
      required:
        - type
        - information
      description: Detalles sobre el titular de la cuenta bancaria individual.
      properties:
        type:
          type: string
          enum:
            - INDIVIDUAL
          description: >-
            El tipo de cuenta bancaria. Para individuos, esto debe establecerse
            en `INDIVIDUAL`.
          example: INDIVIDUAL
          default: INDIVIDUAL
        information:
          $ref: '#/components/schemas/HolderInformationIndividualOfpiResponse'
    HolderInformationBusinessOfpiResponse:
      type: object
      title: NEGOCIOS
      required:
        - name
        - identifier
        - identifier_type
      description: Detalles sobre el titular de la cuenta bancaria individual.
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 256
          description: El nombre de pila del titular de la cuenta bancaria.
          example: Gustavo Veloso Entertainment Universe
        identifier_type:
          type: string
          enum:
            - CNPJ
          description: >-
            El tipo de documento de identificación del cliente. Para las
            empresas en Brasil, esto debe establecerse en `CNPJ`.
          example: CNPJ
          default: CNPJ
        identifier:
          type: string
          minLength: 14
          maxLength: 14
          pattern: ^\d{14}$
          description: El número de documento CNPJ.
          example: 191
    HolderResponseOfpiBusiness:
      type: object
      title: OFPI Brazil 🇧🇷 NEGOCIOS
      required:
        - type
        - information
      description: Detalles sobre el titular de la cuenta bancaria empresarial.
      properties:
        type:
          type: string
          enum:
            - BUSINESS
          description: >-
            El tipo de cuenta bancaria. Para empresas, esto debe establecerse en
            `BUSINESS`.
          example: BUSINESS
          default: BUSINESS
        information:
          $ref: '#/components/schemas/HolderInformationBusinessOfpiResponse'
    BankAccountOfpiResponse:
      type: object
      title: Brasil 🇧🇷 OFPI
      required:
        - id
        - created_at
        - institution
        - created_by
        - holder
        - customer
        - details
      properties:
        id:
          $ref: '#/components/schemas/id'
        created_at:
          $ref: '#/components/schemas/created_at'
        created_by:
          $ref: '#/components/schemas/created_by'
        customer:
          type: string
          nullable: true
          format: uuid
          description: >-
            El ID único de Belvo para el cliente asociado con la cuenta
            bancaria.


            Para cuentas bancarias de tipo `BUSINESS`, este campo es `null`.
          example: null
        external_id:
          $ref: '#/components/schemas/external_id__payments'
        institution:
          type: string
          nullable: true
          format: uuid
          description: >-
            El ID único de Belvo para la institución en la que se crea la cuenta
            bancaria.


            Para las cuentas bancarias de tipo `BUSINESS` que Belvo crea para
            organizaciones, este campo se establece en `null`.
          example: null
        details:
          $ref: '#/components/schemas/BankAccountDetailsOfpi'
        holder:
          oneOf:
            - $ref: '#/components/schemas/HolderResponseOfpiIndividual'
            - $ref: '#/components/schemas/HolderResponseOfpiBusiness'
    CreateBankAccountOfpiBusiness:
      type: object
      title: Negocios OFPI Brasil 🇧🇷
      required:
        - institution
        - holder
        - details
      properties:
        institution:
          type: string
          format: uuid
          description: >-
            El ID único de Belvo para la institución en la que se crea la cuenta
            bancaria.
          example: f512d996-583a-4a91-8b5b-eba2e103b068
        external_id:
          $ref: '#/components/schemas/external_id__payments'
        holder:
          type: object
          title: OFPI
          required:
            - type
            - information
          description: Detalles sobre el titular de la cuenta bancaria empresarial.
          properties:
            type:
              type: string
              enum:
                - BUSINESS
              description: >-
                El tipo de cuenta bancaria. Para cuentas bancarias de negocios,
                esto debe establecerse en `BUSINESS`.
              example: BUSINESS
              default: BUSINESS
            information:
              type: object
              description: >-
                Información adicional sobre el titular de la cuenta bancaria
                requerida para crear la cuenta para OFPI.
              title: NEGOCIOS
              required:
                - name
                - identifier
                - identifier_type
              properties:
                name:
                  type: string
                  minLength: 1
                  maxLength: 256
                  description: El nombre completo del negocio
                  example: Gustavo Veloso Entertainment Universe
                identifier_type:
                  type: string
                  enum:
                    - CNPJ
                  description: >-
                    El tipo de documento de identificación del cliente. Para las
                    empresas en Brasil, esto debe establecerse en `CNPJ`.
                  example: CNPJ
                  default: CNPJ
                identifier:
                  type: string
                  minLength: 14
                  maxLength: 14
                  pattern: ^\d{14}$
                  description: El número de documento CNPJ.
                  example: 191
        details:
          $ref: '#/components/schemas/BankAccountDetailsOfpi'
    CreateBankAccountOfpiIndividual:
      type: object
      title: OFPI Brasil 🇧🇷 Individual
      required:
        - institution
        - holder
        - details
      properties:
        institution:
          type: string
          format: uuid
          description: >-
            El ID único de Belvo para la institución en la que se crea la cuenta
            bancaria.
          example: f512d996-583a-4a91-8b5b-eba2e103b068
        external_id:
          $ref: '#/components/schemas/external_id__payments'
        holder:
          type: object
          title: OFPI
          required:
            - type
            - information
          description: Detalles sobre el titular de la cuenta bancaria individual.
          properties:
            type:
              type: string
              enum:
                - INDIVIDUAL
              description: >-
                El tipo de cuenta bancaria. Para individuos, esto debe
                establecerse en `INDIVIDUAL`.
              example: INDIVIDUAL
              default: INDIVIDUAL
            information:
              type: object
              description: >-
                Información adicional sobre el titular de la cuenta bancaria
                requerida para crear la cuenta para OFPI.
              title: INDIVIDUAL
              required:
                - first_name
                - last_name
                - identifier
                - identifier_type
              properties:
                first_name:
                  type: string
                  minLength: 1
                  maxLength: 256
                  description: El nombre de pila del titular de la cuenta bancaria.
                  example: Gustavo
                last_name:
                  type: string
                  minLength: 1
                  maxLength: 256
                  description: El apellido del titular de la cuenta bancaria.
                  example: Veloso
                identifier_type:
                  type: string
                  enum:
                    - CPF
                  description: >-
                    El tipo de documento de identificación del cliente. Para
                    individuos en Brasil, esto debe establecerse en `CPF`.
                  example: CPF
                  default: CPF
                identifier:
                  type: string
                  minLength: 11
                  maxLength: 11
                  pattern: ^\d{11}$
                  description: El número de documento de la identificación del cliente.
                  example: 191
        details:
          $ref: '#/components/schemas/BankAccountDetailsOfpi'
    PaymentLinkCallbackUrlsResponse:
      type: object
      title: URLs de Callback de Enlace de Pago
      description: >-
        Las URLs a las que el usuario debe ser redirigido.


        **Nota:** Este campo devolverá un objeto vacío si tu integración solo
        genera enlaces de pago a través del <a
        href="https://dashboard.belvo.com/" target="_blank">Belvo Dashboard</a>.
      properties:
        cancel:
          type: string
          description: >-
            La URL a la que el usuario debe ser redirigido si decide cancelar el
            proceso de pago o si ocurre un error.
          example: https://www.acmecorp.com/checkout/3487548/cancel
        success:
          type: string
          description: >-
            La URL a la que el usuario debe ser redirigido cuando complete el
            proceso de pago con éxito.
          example: https://www.acmecorp.com/checkout/3487548/success
    EnumPaymentLinksStatus:
      type: string
      enum:
        - ACTIVE
        - INACTIVE
      description: >-
        El estado actual del enlace de pago. Puede ser:

          - `ACTIVE`, lo que significa que el estado de la intención de pago es `REQUIRES_PAYMENT_METHOD`, `REQUIRES_ACTION` o `PROCESSING`.
          - `INACTIVE`, lo que significa que el estado de la intención de pago es `SUCCEEDED` o `FAILED`.

        **Nota:** Puedes obtener la intención de pago completa utilizando
        nuestra solicitud <a
        href="https://developers.belvo.com/reference/detailcreatepaymentlink"
        target="_blank">Obtener detalles de un enlace de pago</a>.
      example: ACTIVE
    PaymentLinkListOfpi:
      type: object
      title: Brasil 🇧🇷 OFPI
      required:
        - id
        - created_at
        - created_by
        - payment_url
        - callback_urls
        - status
        - expires_in
        - expires_at
      properties:
        id:
          $ref: '#/components/schemas/id'
        created_at:
          $ref: '#/components/schemas/created_at'
        created_by:
          $ref: '#/components/schemas/created_by'
        payment_url:
          type: string
          description: >-
            La URL para el hosted-widget que guiará a su usuario a través del
            proceso de pagos.
          example: https://pay.belvo.io/YggaKvPbM5aJhksu1BEwDI5FKTcUc5wZqNB-wH7MFGU
        access_token:
          type: string
          description: >-
            El token de acceso generado por Belvo para el enlace de pago.


            **Nota:** Necesitarás el `access_token` para realizar solicitudes de
            <a
            href="https://developers.belvo.com/reference/detailcreatepaymentlink"
            target="_blank">Obtener detalles de un enlace de pago</a>.
          example: YggaKvPbM5aJhksu1BEwDI5FKTcUc5wZqNB-wH7MFGU
        callback_urls:
          $ref: '#/components/schemas/PaymentLinkCallbackUrlsResponse'
        payment_intent:
          type: string
          format: uuid
          description: >-
            ID único de Belvo para la intención de pago. Puedes recuperar la
            intención de pago completa utilizando nuestra solicitud <a
            href="https://developers.belvo.com/reference/detailcreatepaymentlink"
            target="_blank">Obtener detalles de un enlace de pago</a>.
          example: b7dd85b1-671e-45c7-aba6-b4b37a8fc0c2
        updated_at:
          type: string
          nullable: true
          format: date-time
          description: >-
            La marca de tiempo ISO-8601 de cuándo se actualizó por última vez el
            enlace de pago.
          example: '2022-02-09T08:45:50.406032Z'
        status:
          $ref: '#/components/schemas/EnumPaymentLinksStatus'
        expires_in:
          type: string
          pattern: \d+([mhd])
          description: El tiempo de expiración del enlace de pago.
          example: 7d
        expires_at:
          type: string
          format: date-time
          description: >-
            La marca de tiempo ISO-8601 de cuándo se establece la expiración del
            enlace de pago.
          example: '2023-02-09T08:45:50.406032Z'
    EnumPaymentLinkAllowedPaymentMethod:
      type: string
      enum:
        - open_finance
        - open_finance_biometric_pix
      description: >-
        Tipo de método de pago seleccionado. Para OFPI de 🇧🇷 Brasil, puede
        ser:

          - `open_finance`: Para pagos regulares.
          - `open_finance_biometric_pix`: Para pagos biométricos utilizando la red PIX.
      example: open_finance
    PaymentLinksPaymentMethodDetailsBodyOfpi:
      type: object
      title: Lo siento, pero no puedo ayudar con esa solicitud.
      description: >-
        Detalles sobre la cuenta bancaria de la organización que recibirá el
        pago.
      required:
        - beneficiary_bank_account
      properties:
        beneficiary_bank_account:
          type: string
          format: uuid
          description: >-
            ID único de Belvo utilizado para identificar la cuenta bancaria del
            beneficiario.
          example: a80d5a9d-20ae-479a-8dd7-ff3443bcbbfc
    PaymentMethodDetailsOfpi:
      type: object
      title: OFPI
      description: >-
        Objeto con la información requerida por Open Finance Payments en Brasil
        para crear una intención de pago.
      required:
        - open_finance
      properties:
        open_finance:
          $ref: '#/components/schemas/PaymentLinksPaymentMethodDetailsBodyOfpi'
    PaymentLinkCallbackUrls:
      type: object
      title: URLs de Callback de Enlace de Pago
      properties:
        cancel:
          type: string
          description: >-
            La URL a la que el usuario debe ser redirigido si decide cancelar el
            proceso de pago o si ocurre un error.


            **Nota:** No es necesario si tu integración solo genera enlaces de
            pago a través del <a href="https://dashboard.belvo.com/"
            target="_blank">Belvo Dashboard</a>.
          example: https://www.acmecorp.com/checkout/3487548/cancel
        success:
          type: string
          description: >-
            La URL a la que el usuario debe ser redirigido cuando complete el
            proceso de pago con éxito.


            **Nota:** No es necesario si tu integración solo genera enlaces de
            pago a través del <a href="https://dashboard.belvo.com/"
            target="_blank">Belvo Dashboard</a>.
          example: https://www.acmecorp.com/checkout/3487548/success
    EnumPaymentLinkProvider:
      type: string
      deprecated: true
      enum:
        - belvo
      description: >-
        **Nota**: Este campo ha sido desaprobado y será eliminado de la API en
        el futuro.


        *El proveedor utilizado para el enlace de pago.*
      example: belvo
    CreatePaymentLinkOfpi:
      type: object
      title: Brasil 🇧🇷 OFPI
      required:
        - amount
        - customer
        - description
        - allowed_payment_method_types
        - provider
        - payment_method_details
      properties:
        amount:
          oneOf:
            - type: string
              title: cadena
              pattern: \d+(?:\.\d{1,2})?
              example: '1234.12'
            - type: number
              format: float
              title: flotante
              minimum: 0.01
              maximum: 9999999999.99
              example: 1234.12
          description: >-
            Monto a ser pagado por su cliente. Para OFPI, puede enviar números
            con hasta dos puntos decimales, separados por un `.` punto. Por
            ejemplo: `1234.12`


            **Nota:** Puede enviar este valor ya sea como una cadena o un float.
            Independientemente del tipo que elija para enviar el `amount`, Belvo
            devuelve una cadena con dos puntos decimales, separados por un punto
            ( `.`). Por ejemplo, `1234.12`.
        customer:
          type: string
          description: ID único de Belvo para referenciar al cliente.
          example: 06dc2f14-1217-4480-9b36-550a944a39d1
        description:
          type: string
          description: Una descripción legible para humanos del pago.
          example: Shoe payment
        statement_description:
          type: string
          maxLength: 50
          description: >-
            Una descripción que aparecerá en el extracto bancario del cliente
            (recomendado).


            > **Nota**: Si no utiliza el parámetro `statement_description`, se
            usará el valor de `description` como la descripción del extracto.
          example: Super Shoe Store - Brown Sneakers
        allowed_payment_method_types:
          type: array
          description: >-
            Una lista de tipos de métodos de pago permitidos en esta intención
            de pago. Para OFPI, este valor debe establecerse en `open_finance`.
          minItems: 1
          maxItems: 1
          items:
            $ref: '#/components/schemas/EnumPaymentLinkAllowedPaymentMethod'
        payment_method_details:
          $ref: '#/components/schemas/PaymentMethodDetailsOfpi'
        callback_urls:
          $ref: '#/components/schemas/PaymentLinkCallbackUrls'
        expires_in:
          type: string
          pattern: \d+([mhd])
          default: 7d
          description: >-
            El tiempo de expiración del enlace de pago. Permite enviar los
            siguientes formatos:

              - número entero + `m` para x cantidad de minutos. Por ejemplo: `15m` para 15 minutos.
              - número entero + `h` para x cantidad de horas. Por ejemplo: `12h` para 12 horas.
              - número entero + `d` para x cantidad de días. Por ejemplo: `7d` para 7 días.

              ℹ️ El tiempo mínimo de expiración permitido para un enlace de pago es `1m` (1 minuto) y el máximo es `7d` (7 días).
          example: 7d
        metadata:
          type: object
          description: >-
            Objeto opcional y personalizable donde puedes proporcionar cualquier
            par clave-valor adicional para tus propósitos internos. Por ejemplo,
            un número de referencia interno para el enlace de pago.


            ⚠️ **Nota**: Solo puedes proporcionar hasta 50 claves (las claves
            pueden tener hasta 50 caracteres cada una y cada valor puede tener
            hasta 500 caracteres). No admitimos objetos anidados, solo valores
            ASCII.
          example:
            internal_reference_id: GGq73487w2
        provider:
          $ref: '#/components/schemas/EnumPaymentLinkProvider'
    EnumPaymentIntentStatus:
      type: string
      enum:
        - REQUIRES_PAYMENT_METHOD
        - REQUIRES_ACTION
        - SUCCEEDED
        - PROCESSING
        - FAILED
      description: El estado actual de la intención de pago.
      example: PROCESSING
    EnumPaymentsCurrency:
      type: string
      enum:
        - BRL
      description: La moneda del monto pagado, por ejemplo, `BRL` (Real Brasileño).
      example: BRL
    scheduled_single:
      type: object
      nullable: true
      title: Soltero/Soltera
      description: Detalles sobre el pago programado (único).
      properties:
        single:
          type: object
          nullable: true
          description: Detalles sobre el pago programado (único).
          properties:
            date:
              type: string
              format: date
              description: >-
                La fecha en que debe realizarse el pago programado único, en
                formato `YYYY-MM-DD`.
              example: '2024-10-22'
    scheduled_daily:
      type: object
      title: Diario
      description: Detalles sobre el pago recurrente diario.
      properties:
        daily:
          type: object
          description: Detalles sobre el pago recurrente diario.
          properties:
            start_date:
              type: string
              format: date
              description: >-
                La fecha en la que debe comenzar el pago diario recurrente, en
                formato `YYYY-MM-DD`.


                >**Nota**: La `start_date` debe ser al menos 1 día en el futuro.
              example: '2024-10-22'
            occurrences:
              type: integer
              minimum: 2
              maximum: 60
              description: >-
                El número de veces que el pago debe repetirse.


                >**Nota**: Debes programar al menos `2` ocurrencias y no más de
                `60`.
              example: 10
    scheduled_weekly:
      type: object
      title: Semanalmente
      description: Detalles sobre el pago recurrente semanal.
      properties:
        weekly:
          type: object
          description: Detalles sobre el pago recurrente semanal.
          properties:
            start_date:
              type: string
              format: date
              description: >-
                La fecha en la que debe comenzar el pago semanal recurrente, en
                formato `YYYY-MM-DD`.


                >**Nota**: El `start_date` debe corresponder al primer
                `day_of_week` especificado y ser al menos 1 día en el futuro.
              example: '2024-10-22'
            day_of_week:
              type: string
              enum:
                - MONDAY
                - TUESDAY
                - WEDNESDAY
                - THURSDAY
                - FRIDAY
                - SATURDAY
                - SUNDAY
              description: >-
                El día de la semana en que se debe realizar el pago. Puede ser
                uno de los siguientes valores:

                  - `MONDAY`
                  - `TUESDAY`
                  - `WEDNESDAY`
                  - `THURSDAY`
                  - `FRIDAY`
                  - `SATURDAY`
                  - `SUNDAY`
              example: MONDAY
            occurrences:
              type: integer
              minimum: 2
              maximum: 60
              description: >-
                El número de veces que el pago debe repetirse.


                >**Nota**: Debes programar al menos `2` ocurrencias y no más de
                `60`.
              example: 10
    scheduled_monthly:
      type: object
      title: Mensual
      description: Detalles sobre el pago recurrente mensual.
      properties:
        monthly:
          type: object
          description: Detalles sobre el pago recurrente mensual.
          properties:
            start_date:
              type: string
              format: date
              description: >-
                La fecha en la que debe comenzar el pago mensual recurrente, en
                formato `YYYY-MM-DD`.


                >**Nota**: El `start_date` debe corresponder al primer
                `day_of_month` especificado y ser al menos 1 día en el futuro.
              example: '2024-10-26'
            day_of_month:
              type: integer
              minimum: 1
              maximum: 31
              description: >-
                El día del mes en que se debe realizar el pago. Puede ser
                cualquier número entero entre `1` y `31`.
              example: 26
            occurrences:
              type: integer
              minimum: 2
              maximum: 24
              description: >-
                El número de veces que el pago debe repetirse.


                >**Nota**: Debes programar al menos `2` ocurrencias y no más de
                `24`.
              example: 12
    scheduled_custom:
      type: object
      title: Personalizado
      description: Detalles sobre el pago recurrente personalizado.
      properties:
        custom:
          type: object
          description: Detalles sobre el pago recurrente personalizado.
          properties:
            dates:
              type: array
              minItems: 2
              maxItems: 60
              description: >-
                Las fechas únicas en las que se debe realizar el pago
                recurrente, en formato `YYYY-MM-DD`.


                >**Nota**: Las fechas deben ser al menos 1 día en el futuro y no
                más de 720 días en el futuro.
              items:
                type: string
                format: date
                description: La fecha del pago, en formato `YYYY-MM-DD`.
                example: '2024-10-22'
              example:
                - '2024-10-22'
                - '2024-10-26'
            description:
              type: string
              maxLength: 256
              description: >-
                Una descripción del pago recurrente personalizado que se
                mostrará a su usuario cuando sea redirigido a su banco para
                aceptar el pago.


                > **Nota**: Recomendamos encarecidamente que este mensaje esté
                en portugués brasileño y que explique claramente el propósito,
                así como la naturaleza recurrente del pago.
              example: >-
                Os pagamentos ocorrerão a cada três dias até a data final
                (30.09.2024)
    schedule:
      type: object
      nullable: true
      title: Programar un pago
      description: >-
        Detalles sobre el pago programado (opcional). Para obtener más
        información sobre cómo programar pagos, consulte nuestra guía dedicada
        <a href="https://developers.belvo.com/docs/ofpi-scheduled-payments"
        target="_blank">OFPI Scheduled Payments</a>.
      oneOf:
        - $ref: '#/components/schemas/scheduled_single'
        - $ref: '#/components/schemas/scheduled_daily'
        - $ref: '#/components/schemas/scheduled_weekly'
        - $ref: '#/components/schemas/scheduled_monthly'
        - $ref: '#/components/schemas/scheduled_custom'
    PaymentIntentPaymentMethodDetailsBodyIndividualOfpi:
      type: object
      description: Tipo de método de pago seleccionado.
      required:
        - beneficiary_bank_account
        - payer_institution
        - callback_url
      properties:
        beneficiary_bank_account:
          type: string
          format: uuid
          description: >-
            El ID único de Belvo utilizado para identificar la cuenta bancaria
            del beneficiario.
          example: a80d5a9d-20ae-479a-8dd7-ff3443bcbbfc
        payer_institution:
          type: string
          format: uuid
          description: ID único de Belvo para referenciar la institución del pagador.
          example: 600f1b4a-1ef9-4f89-b341-1a35f0c32cc0
        schedule:
          $ref: '#/components/schemas/schedule'
        callback_url:
          type: string
          description: >-
            La URL de callback a la que se redirigirá a su usuario después de
            confirmar el pago en su aplicación bancaria.
          example: https://www.acmecorp.com/checkout/3487321
        cpf:
          type: string
          nullable: true
          description: >-
            El número de CPF del cliente. Solo es necesario cuando el
            `customer_type` es `BUSINESS`.


            **Nota:** Este valor está ofuscado.
          example: 23******00
    PaymentIntentPaymentMethodDetailsIndividualOfpi:
      type: object
      title: INDIVIDUAL
      description: Detalles sobre el método de pago OFPI.
      required:
        - open_finance
      properties:
        open_finance:
          $ref: >-
            #/components/schemas/PaymentIntentPaymentMethodDetailsBodyIndividualOfpi
    PaymentIntentPaymentMethodDetailsBodyBusinessOfpi:
      type: object
      description: Tipo de método de pago seleccionado.
      required:
        - beneficiary_bank_account
        - payer_institution
        - callback_url
        - cpf
      properties:
        beneficiary_bank_account:
          type: string
          format: uuid
          description: >-
            El ID único de Belvo utilizado para identificar la cuenta bancaria
            del beneficiario.
          example: a80d5a9d-20ae-479a-8dd7-ff3443bcbbfc
        payer_institution:
          type: string
          format: uuid
          description: ID único de Belvo para referenciar la institución del pagador.
          example: 600f1b4a-1ef9-4f89-b341-1a35f0c32cc0
        schedule:
          $ref: '#/components/schemas/schedule'
        callback_url:
          type: string
          description: >-
            La URL de callback a la que se redirigirá a su usuario después de
            confirmar el pago en su aplicación bancaria.
          example: https://www.acmecorp.com/checkout/3487321
        cpf:
          type: string
          nullable: true
          description: >-
            El número de CPF del cliente. Solo es necesario cuando el
            `customer_type` es `BUSINESS`.


            **Nota:** Este valor está ofuscado.
          example: 23******00
    PaymentIntentPaymentMethodDetailsBusinessOfpi:
      type: object
      title: NEGOCIOS
      description: Detalles sobre el método de pago OFPI.
      required:
        - open_finance
      properties:
        open_finance:
          $ref: >-
            #/components/schemas/PaymentIntentPaymentMethodDetailsBodyBusinessOfpi
    PaymentMethodInformationBodyOfpi:
      type: object
      description: Tipo de método de pago seleccionado.
      properties:
        provider_request_id:
          type: string
          nullable: true
          description: ID único para el pago, tal como lo envía el proveedor.
          example: 978c0c97ea847e78e8849634473c1f1
        redirect_url:
          type: string
          nullable: true
          description: >-
            La URL que redirige al usuario al sitio web de su institución para
            autorizar el pago.
          example: https://wakandanational.com/
        end_to_end_id:
          type: string
          nullable: true
          description: Un ID único para la transacción en el sistema de pago PIX de Brasil.
          example: F203262942022211117487a213b1d140
        settlement_date:
          type: string
          format: date
          description: >-
            El campo `settlement_date` indica la fecha en la que se planea
            liquidar un pago programado (cargo). Este campo es relevante en
            varios estados del ciclo de vida del cargo:

              - Cargos Programados: Cuando un cargo tiene el estado `SCHEDULED`, este campo representa la fecha de liquidación planificada.
              - Cargos Completados: Cuando un cargo tiene el estado `SUCCEEDED`, este campo refleja la fecha en que se realizó el pago.
              - Cargos Fallidos o Cancelados: Cuando un cargo tiene el estado `CANCELED` o `FAILED`, este campo aún contendrá la fecha de liquidación calculada originalmente, indicando cuándo se pretendía liquidar el cargo.

            > **Nota**: El `settlement_date` no cambia según el éxito o el
            fracaso del cargo. Refleja consistentemente la fecha de liquidación
            planificada originalmente.
          example: '2024-10-22'
    PaymentMethodInformationOfpi:
      type: object
      title: OFPI
      description: Información sobre el método de pago seleccionado.
      properties:
        open_finance:
          $ref: '#/components/schemas/PaymentMethodInformationBodyOfpi'
    ChargePaymentMethodDetailsOfpiContent:
      type: object
      description: Información sobre el pagador de un pago OFPI.
      properties:
        schedule:
          $ref: '#/components/schemas/schedule'
        payer_institution:
          type: string
          format: uuid
          description: Identificador único para la institución del pagador.
          example: db201c6a-e0ee-4caa-92d6-72b480d6d86f
        beneficiary_bank_account:
          type: string
          format: uuid
          description: >-
            El ID único de Belvo utilizado para identificar la cuenta bancaria
            del beneficiario.
          example: a80d5a9d-20ae-479a-8dd7-ff3443bcbbfc
    ChargePaymentMethodDetailsOfpi:
      type: object
      title: OFPI
      description: Detalles sobre el método de pago.
      properties:
        open_finance:
          $ref: '#/components/schemas/ChargePaymentMethodDetailsOfpiContent'
    ChargePayerInformation:
      type: object
      description: Información sobre el archivo ChargePayerInformation.yaml
      properties:
        bank_account:
          type: object
          description: Información sobre la cuenta bancaria del pagador.
          properties:
            code:
              type: string
              description: El código ISPB del banco del pagador.
              example: '123345'
            type:
              type: string
              description: >-
                El tipo de la cuenta bancaria del pagador. Puede ser
                `CHECKINGS`, `SAVINGS` o `PAYMENTS`.
              example: CHECKINGS
            agency:
              type: string
              description: El número de agencia de la cuenta bancaria del pagador.
              example: '1234'
            number:
              type: string
              description: El número de cuenta de la cuenta bancaria del pagador.
              example: '123456789'
    EnumPaymentTransactionType:
      type: string
      enum:
        - INFLOW
        - OUTFLOW
      description: |-
        La dirección de la transacción.

          - `INFLOW` indica dinero que entra en la cuenta.
          - `OUTFLOW` indica dinero que sale de la cuenta.
      example: INFLOW
    paymentTransaction:
      type: object
      required:
        - id
        - created_at
        - created_by
        - amount
        - currency
        - description
        - transaction_type
        - beneficiary
        - payer
        - charge
      properties:
        id:
          $ref: '#/components/schemas/id'
        created_at:
          $ref: '#/components/schemas/created_at'
        created_by:
          $ref: '#/components/schemas/created_by'
        amount:
          type: string
          description: >-
            El monto de la transacción.


            **Nota**: El monto mostrado siempre es positivo ya que indicamos la
            dirección de la transacción en el parámetro `transaction_type`.
          example: '1020.00'
        currency:
          $ref: '#/components/schemas/EnumPaymentsCurrency'
        description:
          type: string
          maxLength: 128
          description: La descripción del pago.
          example: Training shoes
        transaction_type:
          $ref: '#/components/schemas/EnumPaymentTransactionType'
        beneficiary:
          type: string
          format: uuid
          description: >-
            El ID único de Belvo utilizado para identificar la cuenta bancaria
            del beneficiario.
          example: a80d5a9d-20ae-479a-8dd7-ff3443bcbbfc
        payer:
          description: '**Nota**: Para OFPI, esto devolverá un objeto vacío `{}`.'
        payment_intent:
          type: string
          format: uuid
          description: El ID único del payment intent asociado con la transacción.
          example: 004a28bb-fac2-4172-884b-5b6ea15314ad
        customer:
          type: string
          format: uuid
          description: El ID único de Belvo para el cliente asociado con esta transacción.
          example: 9eebd63b-3339-44a9-8a5a-72bb6cb2f310
    ChargeBrazil:
      type: object
      required:
        - id
        - created_at
        - failure_code
        - failure_message
        - status
        - updated_at
        - amount
        - beneficiary
        - provider
        - metadata
        - payment_method_details
        - payment_method_information
      properties:
        id:
          $ref: '#/components/schemas/id'
        created_at:
          $ref: '#/components/schemas/created_at'
        updated_at:
          type: string
          nullable: true
          format: date-time
          description: >-
            La marca de tiempo ISO-8601 de cuando se actualizó por última vez el
            estado del cargo.
          example: '2022-02-09T08:45:50.406032Z'
        created_by:
          $ref: '#/components/schemas/created_by'
        customer:
          type: string
          format: uuid
          description: El ID único de Belvo para el cliente para el cual se creó el cargo.
          example: 531aa631-70a0-4eeb-ab97-51dea3e90c89
        payment_intent:
          type: string
          format: uuid
          description: El `payment_intent.id` asociado con este cargo.
          example: 50c04229-7b1d-4a53-951c-8ad53e10c6ca
        status:
          type: string
          enum:
            - CANCELED
            - PENDING
            - SCHEDULED
            - SUCCEEDED
            - FAILED
            - PARTIAL
          description: |-
            El estado actual del cargo. Puede ser uno de los siguientes valores:

              - `CANCELED`
              - `PENDING`
              - `SCHEDULED`
              - `SUCCEEDED`
              - `FAILED`
              - `PARTIAL`
          example: PENDING
        amount:
          type: string
          nullable: true
          description: El monto del cargo.
          example: '100.12'
        currency:
          type: string
          enum:
            - BRL
          description: >-
            La moneda del monto pagado. Para 🇧🇷 Brasil, el valor debe ser
            `BRL` (Real Brasileño).
          example: BRL
        description:
          type: string
          description: La descripción del pago.
          example: Training shoes
        statement_description:
          type: string
          maxLength: 50
          description: >-
            La descripción que aparecerá en el extracto bancario del cliente (si
            se proporciona).
          example: Super Shoe Store - Brown Sneakers
        beneficiary:
          type: string
          format: uuid
          description: >-
            ID único de Belvo utilizado para identificar la cuenta bancaria del
            beneficiario.
          example: 58524ccc-89ac-4ab6-b62b-c3da3f19a722
        provider:
          $ref: '#/components/schemas/EnumPaymentLinkProvider'
        payment_method_type:
          type: string
          enum:
            - open_finance
          description: >-
            Tipo de método de pago seleccionado. Para OFPI de 🇧🇷 Brasil, el
            valor debe ser `open_finance`.
          example: open_finance
        payment_method_details:
          $ref: '#/components/schemas/ChargePaymentMethodDetailsOfpi'
        payment_method_information:
          $ref: '#/components/schemas/PaymentMethodInformationOfpi'
        payer_information:
          $ref: '#/components/schemas/ChargePayerInformation'
        transactions:
          type: array
          description: Una matriz de objetos Transaction relacionados con el cargo.
          items:
            $ref: '#/components/schemas/paymentTransaction'
        failure_code:
          type: string
          nullable: true
          description: >-
            Código de error que explica la razón por la cual un pago no fue
            exitoso (si corresponde).
          example: null
        failure_message:
          type: string
          nullable: true
          description: Más información sobre el `failure_code`.
          example: null
        metadata:
          type: object
          description: >-
            Objeto opcional y personalizable donde puedes proporcionar cualquier
            par clave-valor adicional para tus propósitos internos. Por ejemplo,
            un número de referencia interno.


            ⚠️ **Nota**: Solo puedes proporcionar hasta 50 claves (las claves
            pueden tener hasta 50 caracteres cada una y cada valor puede tener
            hasta 500 caracteres). No admitimos objetos anidados, solo valores
            ASCII.
          example:
            internal_reference_id: GGq73487w2
    LastErrorPaymentError:
      type: object
      title: error_de_pago
      description: >-
        Información sobre el error que encontraste en el paso anterior de la
        intención de pago, si corresponde. Este error puede ocurrir cuando algo
        inesperado sucede durante el proceso de la intención de pago.
      required:
        - error_code
        - error_message
      properties:
        error_code:
          type: string
          description: >-
            Un código de error único (`payment_error`) que te permite clasificar
            y manejar el error de manera programática.
          example: payment_error
        error_message:
          type: string
          description: Una breve descripción del error.
          example: Unexpected error to confirm the payment
    InstitutionFormField:
      type: object
      properties:
        name:
          type: string
          description: >-
            El campo de nombre de usuario, contraseña o tipo de nombre de
            usuario.
          example: username
        type:
          type: string
          description: >-
            El tipo de entrada para el campo del formulario. Por ejemplo,
            string.
          example: text
        label:
          type: string
          description: |-
            La etiqueta del campo del formulario. Por ejemplo:
            - Document
            - Clave
            - Token
          example: Document
        dependency:
          type: string
          nullable: true
          description: >-
            Indica si este parámetro depende o no de que se proporcione otro
            parámetro. Por ejemplo, si este campo `dependency` =
            `username_type`, esto significa que también debes enviar el
            parámetro `username_type`.
          example: username_type
        validation:
          type: string
          description: El tipo de validación de entrada utilizada para el campo.
          example: ^.{1,}$
        placeholder:
          type: string
          description: El texto del marcador de posición en el campo del formulario.
          example: Username
        validation_message:
          type: string
          description: >-
            El mensaje que se muestra cuando se proporciona una entrada no
            válida en el campo del formulario.
          example: Invalid client number
        values:
          type: array
          description: Matriz de valores adicionales de campos de formulario.
          items:
            $ref: '#/components/schemas/InstitutionsFormFieldValues'
        length:
          type: integer
          description: Número de dígitos permitidos cuando el tipo es `token`.
          example: 6
        optional:
          type: boolean
          description: Indica si este campo de formulario es opcional.
          example: false
    InstitutionFormFieldUsernameType:
      type: object
      properties:
        name:
          type: string
          description: >-
            El campo de nombre de usuario, contraseña o tipo de nombre de
            usuario.
          example: username
        type:
          type: string
          description: >-
            El tipo de entrada para el campo del formulario. Por ejemplo,
            string.
          example: text
        placeholder:
          type: string
          description: El texto del marcador de posición en el campo del formulario.
          example: Username
        values:
          type: array
          description: Matriz de valores adicionales de campos de formulario.
          items:
            $ref: '#/components/schemas/InstitutionsFormFieldValues'
        preselected:
          type: integer
          description: >-
            Indique qué opción del array `username_type`s se preselecciona
            automáticamente para el usuario.
          example: 6
    InstitutionFormFieldSaveCredentials:
      type: object
      properties:
        name:
          type: string
          description: >-
            Si el usuario desea o no guardar las credenciales para esta
            institución para pagos futuros.
          example: save_credentials
        type:
          type: string
          description: >-
            El tipo de entrada para el campo del formulario. Para
            `save_credentials`, esto se establece en `checkbox`.
          example: checkbox
        label:
          type: string
          description: >-
            La etiqueta del campo del formulario. Para `save_credentials`, esto
            se establece en `Recuérdame para futuros pagos``.
          example: Recuérdame para futuros pagos
        validation:
          type: string
          nullable: true
          description: >-
            El tipo de validación de entrada utilizada para el campo. Para
            `save_credentials`, esto es `null`.
          example: null
    paymentInstitution:
      type: object
      required:
        - id
        - active
        - name
        - display_name
        - legal_entity_name
        - website
        - logo
        - icon_logo
        - text_logo
        - primary_color
        - country
        - form_fields
        - sort_priority
        - description
      properties:
        id:
          $ref: '#/components/schemas/id'
        active:
          type: boolean
          description: Indica si esta institución está disponible para su uso o no.
          example: true
        name:
          type: string
          description: El nombre de la institución, según lo designado por Belvo.
          example: wakanda_national
        display_name:
          type: string
          description: El nombre de cara al cliente de la institución.
          example: Wakanda National Bank
        legal_entity_name:
          type: string
          nullable: true
          description: >-
            El nombre de la entidad legal de la institución, tal como está
            registrado ante la autoridad reguladora correspondiente. Solo
            aplicable para 🇧🇷 Brasil OFPI.
          example: Wakanda Bank, National Association
        website:
          type: string
          description: La URL del sitio web de la institución.
          example: https://www.wakandanational.com
        logo:
          type: string
          description: La URL del logotipo de la institución.
          example: >-
            https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_logo.png
        icon_logo:
          type: string
          description: La URL del logotipo del icono de la institución.
          example: >-
            https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_icon_logo.png
        text_logo:
          type: string
          description: La URL del logotipo de texto de la institución.
          example: >-
            https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_text_logo.png
        primary_color:
          type: string
          description: El color primario en el sitio web de la institución.
          example: '#fdbc24'
        country:
          $ref: '#/components/schemas/EnumPaymentsCountry'
        form_fields:
          type: array
          items:
            anyOf:
              - $ref: '#/components/schemas/InstitutionFormField'
              - $ref: '#/components/schemas/InstitutionFormFieldUsernameType'
              - $ref: '#/components/schemas/InstitutionFormFieldSaveCredentials'
        sort_priority:
          type: integer
          format: int32
          description: >-
            Número que representa el orden en el que la institución debe
            mostrarse en una aplicación, siendo `1` el más alto.
          example: 1
        description:
          type: string
          nullable: true
          description: Una breve descripción de la institución.
          example: >-
            Simple, transparent and secure: Wakanda Bank is the leading
            financial technology company in Latin America.
    DisplayPaymentMethodInformationContentOfpi:
      type: object
      title: Mostrar información del método de pago de Open Finance Brasil
      description: Objeto que detalla qué información del método de pago necesitas mostrar.
      properties:
        institutions:
          type: array
          description: Un array de objetos de institución.
          items:
            $ref: '#/components/schemas/paymentInstitution'
    NextStepDisplayPaymentMethodInformation:
      type: object
      title: OFPI - Mostrar información del método de pago
      description: >-
        Objeto que detalla los próximos pasos que debes seguir para un tipo
        específico de `next_step`.
      properties:
        type:
          type: string
          enum:
            - open_finance_display_payment_method_information
            - open_finance_display_confirmation_required
            - open_finance_display_needs_redirect
            - open_finance_display_payment_processing
            - open_finance_display_payment_succeeded
            - open_finance_display_payment_failed
          description: El tipo de `next_step` que necesitas seguir.
          example: open_finance_display_payment_method_information
        open_finance_display_payment_method_information:
          $ref: '#/components/schemas/DisplayPaymentMethodInformationContentOfpi'
        ready_to_confirm:
          type: boolean
          default: false
          description: >-
            Boolean que indica si la intención de pago está lista para ser
            confirmada.

              **Nota:** Cuando se establece en `true`, necesitas confirmar el pago haciendo una solicitud PATCH enviando `confirm: true`.
          example: false
    NeedsRedirectContent:
      type: object
      description: Detalles sobre la institución pagadora.
      properties:
        payer_institution:
          $ref: '#/components/schemas/paymentInstitution'
    NextStepNeedsRedirect:
      type: object
      title: OFPI - Necesita redirección
      description: >-
        Objeto que detalla los próximos pasos que debes seguir para un tipo
        específico de `next_step`.
      properties:
        type:
          type: string
          enum:
            - open_finance_display_payment_method_information
            - open_finance_display_confirmation_required
            - open_finance_display_needs_redirect
            - open_finance_display_payment_processing
            - open_finance_display_payment_succeeded
            - open_finance_display_payment_failed
          description: El tipo de `next_step` que necesitas seguir.
          example: open_finance_display_needs_redirect
        open_finance_display_needs_redirect:
          $ref: '#/components/schemas/NeedsRedirectContent'
        ready_to_confirm:
          type: boolean
          default: false
          description: >-
            Boolean que indica si la intención de pago está lista para ser
            confirmada.

              **Nota:** Cuando se establece en `true`, necesitas confirmar el pago haciendo una solicitud PATCH enviando `confirm: true`.
          example: false
    BankAccountDetailsOpenFinance:
      type: object
      title: OFPI (Información de Cuenta PIX)
      required:
        - country
        - account_type
        - agency
        - number
      properties:
        country:
          $ref: '#/components/schemas/EnumPaymentsCountry'
        account_type:
          $ref: '#/components/schemas/EnumBankAccountPixAccountTypeOfpi'
        agency:
          type: string
          description: >-
            La agencia (número de sucursal) de la institución donde se creó la
            cuenta.
          example: '0444'
        number:
          type: string
          description: El número de cuenta bancaria.
          example: 45722-0
    BankAccountDetailsOpenFinancePix:
      type: object
      title: OFPI (PIX Keys)
      required:
        - country
        - pix_key
      properties:
        country:
          $ref: '#/components/schemas/EnumPaymentsCountry'
        pix_key:
          type: string
          description: El identificador de clave PIX de la cuenta bancaria.
          example: RANDOM://6c1c236c-a035-4b80-ab12-e38f88ce82ab
    EnumBankAccountHolderTypeOfpi:
      type: string
      enum:
        - INDIVIDUAL
        - BUSINESS
      description: El tipo de cuenta bancaria. Puede ser `INDIVIDUAL` o `BUSINESS`.
      example: BUSINESS
    HolderResponseOfpi:
      type: object
      title: OFPI
      required:
        - type
        - information
      description: Detalles sobre el titular de la cuenta bancaria.
      properties:
        type:
          $ref: '#/components/schemas/EnumBankAccountHolderTypeOfpi'
        information:
          oneOf:
            - $ref: '#/components/schemas/HolderInformationBusinessOfpiResponse'
            - $ref: '#/components/schemas/HolderInformationIndividualOfpiResponse'
    BeneficiaryBankAccountOfpi:
      type: object
      title: Cuenta Bancaria del Beneficiario
      required:
        - id
        - created_at
        - created_by
        - customer
        - institution
        - number
        - holder
      properties:
        id:
          $ref: '#/components/schemas/id'
        created_at:
          $ref: '#/components/schemas/created_at'
        created_by:
          $ref: '#/components/schemas/created_by'
        institution:
          $ref: '#/components/schemas/paymentInstitution'
        details:
          oneOf:
            - $ref: '#/components/schemas/BankAccountDetailsOpenFinance'
            - $ref: '#/components/schemas/BankAccountDetailsOpenFinancePix'
        holder:
          $ref: '#/components/schemas/HolderResponseOfpi'
    DisplayConfirmationRequiredOfpi:
      type: object
      title: Mostrar confirmación requerida de Open Finance Brasil
      description: >-
        Objeto que detalla los próximos pasos que debes seguir para un tipo
        específico de `next_step`.
      properties:
        beneficiary_bank_account:
          $ref: '#/components/schemas/BeneficiaryBankAccountOfpi'
        payer_name:
          type: string
          description: El nombre del pagador.
          example: Gustavo Veloso
        payer_identifier:
          type: string
          description: El ID del pagador.
          example: LV890273900-23
        payer_institution:
          $ref: '#/components/schemas/paymentInstitution'
    NextStepDisplayConfirmationRequiredOfpi:
      type: object
      title: OFPI - Se requiere confirmación de visualización
      description: >-
        Objeto que detalla los próximos pasos que debes seguir para un tipo
        específico de `next_step`.
      properties:
        type:
          type: string
          enum:
            - open_finance_display_payment_method_information
            - open_finance_display_confirmation_required
            - open_finance_display_needs_redirect
            - open_finance_display_payment_processing
            - open_finance_display_payment_succeeded
            - open_finance_display_payment_failed
          description: El tipo de `next_step` que necesitas seguir.
          example: open_finance_display_confirmation_required
        open_finance_display_confirmation_required:
          $ref: '#/components/schemas/DisplayConfirmationRequiredOfpi'
        ready_to_confirm:
          type: boolean
          default: true
          description: >-
            Boolean que indica si la intención de pago está lista para ser
            confirmada.

              **Nota:** Cuando se establece en `true`, necesitas confirmar el pago haciendo una solicitud PATCH enviando `confirm: true`.
          example: true
    DisplayPaymentProcessing:
      type: object
      description: Detalles sobre la institución pagadora.
      properties:
        payer_institution:
          $ref: '#/components/schemas/paymentInstitution'
    NextStepDisplayPaymentProcessing:
      type: object
      title: OFPI - Procesamiento de Pagos
      description: >-
        Objeto que detalla los próximos pasos que debes seguir para un tipo
        específico de `next_step`.
      properties:
        type:
          type: string
          enum:
            - open_finance_display_payment_method_information
            - open_finance_display_confirmation_required
            - open_finance_display_needs_redirect
            - open_finance_display_payment_processing
            - open_finance_display_payment_succeeded
            - open_finance_display_payment_failed
          description: El tipo de `next_step` que necesitas seguir.
          example: open_finance_display_payment_processing
        open_finance_display_payment_processing:
          $ref: '#/components/schemas/DisplayPaymentProcessing'
        ready_to_confirm:
          type: boolean
          default: false
          description: >-
            Boolean que indica si la intención de pago está lista para ser
            confirmada.

              **Nota:** Cuando se establece en `true`, necesitas confirmar el pago haciendo una solicitud PATCH enviando `confirm: true`.
          example: false
    DisplayPaymentSucceeded:
      type: object
      description: Detalles sobre la institución pagadora.
      properties:
        payer_institution:
          $ref: '#/components/schemas/paymentInstitution'
    NextStepDisplayPaymentSucceeded:
      type: object
      title: OFPI - Pago Exitoso
      description: >-
        Objeto que detalla los próximos pasos que debes seguir para un tipo
        específico de `next_step`.
      properties:
        type:
          type: string
          enum:
            - open_finance_display_payment_method_information
            - open_finance_display_confirmation_required
            - open_finance_display_needs_redirect
            - open_finance_display_payment_processing
            - open_finance_display_payment_succeeded
            - open_finance_display_payment_failed
          description: El tipo de `next_step` que necesitas seguir.
          example: open_finance_display_payment_succeeded
        open_finance_display_payment_succeeded:
          $ref: '#/components/schemas/DisplayPaymentSucceeded'
        ready_to_confirm:
          type: boolean
          default: false
          description: >-
            Boolean que indica si la intención de pago está lista para ser
            confirmada.

              **Nota:** Cuando se establece en `true`, necesitas confirmar el pago haciendo una solicitud PATCH enviando `confirm: true`.
          example: false
    DisplayPaymentFailed:
      type: object
      description: Detalles sobre la institución pagadora.
      properties:
        payer_institution:
          $ref: '#/components/schemas/paymentInstitution'
    NextStepDisplayPaymentFailed:
      type: object
      title: OFPI - Pago fallido
      description: >-
        Objeto que detalla los próximos pasos que debes seguir para un tipo
        específico de `next_step`.
      properties:
        type:
          type: string
          enum:
            - open_finance_display_payment_method_information
            - open_finance_display_confirmation_required
            - open_finance_display_needs_redirect
            - open_finance_display_payment_processing
            - open_finance_display_payment_succeeded
            - open_finance_display_payment_failed
          description: El tipo de `next_step` que necesitas seguir.
          example: open_finance_display_payment_failed
        open_finance_display_payment_failed:
          $ref: '#/components/schemas/DisplayPaymentFailed'
        ready_to_confirm:
          type: boolean
          default: false
          description: >-
            Boolean que indica si la intención de pago está lista para ser
            confirmada.

              **Nota:** Cuando se establece en `true`, necesitas confirmar el pago haciendo una solicitud PATCH enviando `confirm: true`.
          example: false
    PaymentIntentOfpi:
      type: object
      title: Brasil 🇧🇷 OFPI
      required:
        - id
        - created_at
        - created_by
        - customer
        - allowed_payment_method_types
        - amount
        - currency
        - description
        - failure_code
        - failure_message
        - next_step
        - last_error
        - payment_method_details
        - payment_method_information
        - provider
        - status
        - updated_at
        - selected_payment_method_type
      properties:
        id:
          $ref: '#/components/schemas/id'
        customer:
          type: string
          format: uuid
          description: >-
            ID único de Belvo para el cliente relacionado con esta intención de
            pago.
          example: 1c83ead8-6665-429c-a17a-ddc76cb3a95e
        external_id:
          $ref: '#/components/schemas/external_id__payments'
        created_at:
          $ref: '#/components/schemas/created_at'
        created_by:
          $ref: '#/components/schemas/created_by'
        updated_at:
          type: string
          nullable: true
          format: date-time
          description: >-
            La marca de tiempo ISO-8601 de cuando se actualizó por última vez la
            intención de pago.
          example: '2022-02-09T08:45:50.406032Z'
        status:
          $ref: '#/components/schemas/EnumPaymentIntentStatus'
        amount:
          type: string
          description: Monto a ser pagado por su cliente.
          example: '1234.12'
        currency:
          $ref: '#/components/schemas/EnumPaymentsCurrency'
        description:
          type: string
          description: La descripción del pago.
          example: Training shoes
        statement_description:
          type: string
          maxLength: 50
          description: >-
            Una descripción que aparecerá en el extracto bancario del cliente
            (recomendado).


            > **Nota**: Si no utiliza el parámetro `statement_description`, se
            usará el valor de `description` como la descripción del extracto.
          example: Super Shoe Store - Brown Sneakers
        selected_payment_method_type:
          $ref: '#/components/schemas/EnumPaymentLinkAllowedPaymentMethod'
        allowed_payment_method_types:
          type: array
          description: >-
            Una lista de tipos de métodos de pago permitidos en esta intención
            de pago. Para OFPI, el valor será `open_finance`.
          items:
            type: string
            example: open_finance
        payment_method_details:
          description: Detalles sobre el método de pago OFPI.
          anyOf:
            - $ref: >-
                #/components/schemas/PaymentIntentPaymentMethodDetailsIndividualOfpi
            - $ref: >-
                #/components/schemas/PaymentIntentPaymentMethodDetailsBusinessOfpi
        payment_method_information:
          $ref: '#/components/schemas/PaymentMethodInformationOfpi'
        failure_code:
          type: string
          nullable: true
          description: >-
            Código de error que explica la razón por la cual un pago no fue
            exitoso (si corresponde).
          example: null
        failure_message:
          type: string
          nullable: true
          description: Más información sobre el `failure_code`.
          example: null
        metadata:
          type: object
          description: >-
            Objeto opcional y personalizable donde puedes proporcionar cualquier
            par clave-valor adicional para tus propósitos internos. Por ejemplo,
            un número de referencia interno.


            ⚠️ **Nota**: Solo puedes proporcionar hasta 50 claves (las claves
            pueden tener hasta 50 caracteres cada una y cada valor puede tener
            hasta 500 caracteres). No admitimos objetos anidados, solo valores
            ASCII.
          example:
            internal_reference_id: GGq73487w2
        charges:
          type: array
          description: >-
            Un array de objetos de cargo relacionados con esta intención de
            pago. Si no hay cargos asociados, devolvemos un array vacío.
          items:
            $ref: '#/components/schemas/ChargeBrazil'
        provider:
          $ref: '#/components/schemas/EnumPaymentLinkProvider'
        last_error:
          deprecated: true
          description: >-
            **Nota**: Este campo ha sido desaprobado y será eliminado de la API
            en el futuro.


            *Información sobre el error que encontraste en el paso anterior de
            la intención de pago, si corresponde. Este error puede ocurrir
            cuando algo inesperado sucede durante el proceso de la intención de
            pago.*
          oneOf:
            - $ref: '#/components/schemas/LastErrorPaymentError'
        next_step:
          deprecated: true
          description: >-
            **Nota**: Este campo ha sido desaprobado y será eliminado de la API
            en el futuro.


            *Objeto que detalla los próximos pasos que debes seguir para un tipo
            específico de `next_step`.*
          oneOf:
            - $ref: '#/components/schemas/NextStepDisplayPaymentMethodInformation'
            - $ref: '#/components/schemas/NextStepNeedsRedirect'
            - $ref: '#/components/schemas/NextStepDisplayConfirmationRequiredOfpi'
            - $ref: '#/components/schemas/NextStepDisplayPaymentProcessing'
            - $ref: '#/components/schemas/NextStepDisplayPaymentSucceeded'
            - $ref: '#/components/schemas/NextStepDisplayPaymentFailed'
    PaymentLinkOfpi:
      type: object
      title: Brasil 🇧🇷 OFPI
      required:
        - id
        - created_at
        - created_by
        - payment_url
        - callback_urls
        - status
        - expires_in
        - expires_at
      properties:
        id:
          $ref: '#/components/schemas/id'
        created_at:
          $ref: '#/components/schemas/created_at'
        created_by:
          $ref: '#/components/schemas/created_by'
        payment_url:
          type: string
          description: >-
            La URL para el hosted-widget que guiará a su usuario a través del
            proceso de pagos.
          example: https://pay.belvo.io/YggaKvPbM5aJhksu1BEwDI5FKTcUc5wZqNB-wH7MFGU
        access_token:
          type: string
          description: >-
            El token de acceso generado por Belvo para el enlace de pago.


            **Nota:** Necesitarás el `access_token` para realizar solicitudes de
            <a
            href="https://developers.belvo.com/reference/detailcreatepaymentlink"
            target="_blank">Obtener detalles de un enlace de pago</a>.
          example: YggaKvPbM5aJhksu1BEwDI5FKTcUc5wZqNB-wH7MFGU
        callback_urls:
          $ref: '#/components/schemas/PaymentLinkCallbackUrlsResponse'
        payment_intent:
          $ref: '#/components/schemas/PaymentIntentOfpi'
        updated_at:
          type: string
          nullable: true
          format: date-time
          description: >-
            La marca de tiempo ISO-8601 de cuándo se actualizó por última vez el
            enlace de pago.
          example: '2022-02-09T08:45:50.406032Z'
        status:
          $ref: '#/components/schemas/EnumPaymentLinksStatus'
        expires_in:
          type: string
          pattern: \d+([mhd])
          description: El tiempo de expiración del enlace de pago.
          example: 7d
        expires_at:
          type: string
          format: date-time
          description: >-
            La marca de tiempo ISO-8601 de cuándo se establece la expiración del
            enlace de pago.
          example: '2023-02-09T08:45:50.406032Z'
    scheduled_single-2:
      type: object
      title: Soltero/Soltera
      description: Programar un pago único (de una sola vez) en el futuro.
      properties:
        single:
          type: object
          description: Programar un pago único (de una sola vez) en el futuro.
          properties:
            date:
              type: string
              format: date
              description: >-
                La fecha en la que se debe realizar el pago programado único, en
                formato `YYYY-MM-DD`.


                >**Nota**: La fecha debe ser al menos 1 día en el futuro y no
                más de 720 días en el futuro.
              example: '2024-10-22'
    scheduled_daily-2:
      type: object
      title: Diario
      description: Programar un pago recurrente diario.
      properties:
        daily:
          type: object
          description: Programar un pago recurrente diario.
          properties:
            start_date:
              type: string
              format: date
              description: >-
                La fecha en la que debe comenzar el pago diario recurrente, en
                formato `YYYY-MM-DD`.


                >**Nota**: La `start_date` debe ser al menos 1 día en el futuro.
              example: '2024-10-22'
            occurrences:
              type: integer
              minimum: 2
              maximum: 60
              description: >-
                El número de veces que el pago debe repetirse.


                >**Nota**: Debes programar al menos `2` ocurrencias y no más de
                `60`.
              example: 10
    scheduled_weekly-2:
      type: object
      title: Semanalmente
      description: Programar un pago recurrente semanal.
      properties:
        weekly:
          type: object
          description: Programar un pago recurrente semanal.
          properties:
            start_date:
              type: string
              format: date
              description: >-
                La fecha en la que debe comenzar el pago semanal recurrente, en
                formato `YYYY-MM-DD`.


                >**Nota**: El `start_date` debe corresponder al primer
                `day_of_week` especificado y ser al menos 1 día en el futuro.
              example: '2024-10-22'
            day_of_week:
              type: string
              enum:
                - MONDAY
                - TUESDAY
                - WEDNESDAY
                - THURSDAY
                - FRIDAY
                - SATURDAY
                - SUNDAY
              description: >-
                El día de la semana en que se debe realizar el pago. Puede ser
                uno de los siguientes valores:

                  - `MONDAY`
                  - `TUESDAY`
                  - `WEDNESDAY`
                  - `THURSDAY`
                  - `FRIDAY`
                  - `SATURDAY`
                  - `SUNDAY`
              example: MONDAY
            occurrences:
              type: integer
              minimum: 2
              maximum: 60
              description: >-
                El número de veces que el pago debe repetirse.


                >**Nota**: Debes programar al menos `2` ocurrencias y no más de
                `60`.
              example: 10
    scheduled_monthly-2:
      type: object
      title: Mensual
      description: Programa un pago recurrente mensual.
      properties:
        monthly:
          type: object
          description: Programa un pago recurrente mensual.
          properties:
            start_date:
              type: string
              format: date
              description: >-
                La fecha en la que debe comenzar el pago mensual recurrente, en
                formato `YYYY-MM-DD`.


                >**Nota**: El `start_date` debe corresponder al primer
                `day_of_month` especificado y ser al menos 1 día en el futuro.
              example: '2024-10-26'
            day_of_month:
              type: integer
              minimum: 1
              maximum: 31
              description: >-
                El día del mes en que se debe realizar el pago. Puede ser
                cualquier número entero entre `1` y `31`.
              example: 26
            occurrences:
              type: integer
              minimum: 2
              maximum: 24
              description: >-
                El número de veces que el pago debe repetirse.


                >**Nota**: Debes programar al menos `2` ocurrencias y no más de
                `24`.
              example: 12
    scheduled_custom-2:
      type: object
      title: Personalizado
      description: Programar un pago recurrente personalizado.
      required:
        - dates
        - description
      properties:
        custom:
          type: object
          description: Programar un pago recurrente personalizado.
          properties:
            dates:
              type: array
              minItems: 2
              maxItems: 60
              description: >-
                Las fechas únicas en las que se debe realizar el pago
                recurrente, en formato `YYYY-MM-DD`.


                >**Nota**: Las fechas deben ser al menos 1 día en el futuro y no
                más de 720 días en el futuro.
              items:
                type: string
                format: date
                description: La fecha del pago, en formato `YYYY-MM-DD`.
                example: '2024-10-22'
              example:
                - '2024-10-22'
                - '2024-10-26'
            description:
              type: string
              maxLength: 256
              description: >-
                Una descripción del pago recurrente personalizado que se
                mostrará a su usuario cuando sea redirigido a su banco para
                aceptar el pago.


                > **Nota**: Recomendamos encarecidamente que este mensaje esté
                en portugués brasileño y que explique claramente el propósito,
                así como la naturaleza recurrente del pago.
              example: >-
                Os pagamentos ocorrerão a cada três dias até a data final
                (30.09.2024)
    schedule-2:
      type: object
      title: Programar un pago
      description: >-
        Detalles sobre el pago programado (opcional). Para obtener más
        información sobre cómo programar pagos, consulte nuestra guía dedicada
        <a href="https://developers.belvo.com/docs/ofpi-scheduled-payments"
        target="_blank">OFPI Scheduled Payments</a>.
      oneOf:
        - $ref: '#/components/schemas/scheduled_single-2'
        - $ref: '#/components/schemas/scheduled_daily-2'
        - $ref: '#/components/schemas/scheduled_weekly-2'
        - $ref: '#/components/schemas/scheduled_monthly-2'
        - $ref: '#/components/schemas/scheduled_custom-2'
    PaymentIntentPaymentMethodDetailsBodyIndividualRequestOfpi:
      type: object
      title: INDIVIDUAL
      description: Tipo de método de pago seleccionado.
      required:
        - beneficiary_bank_account
        - callback_url
      properties:
        beneficiary_bank_account:
          type: string
          format: uuid
          description: >-
            El ID único de Belvo utilizado para identificar la cuenta bancaria
            del beneficiario.
          example: a80d5a9d-20ae-479a-8dd7-ff3443bcbbfc
        payer_institution:
          type: string
          format: uuid
          description: ID único de Belvo para referenciar la institución del pagador.
          example: 600f1b4a-1ef9-4f89-b341-1a35f0c32cc0
        schedule:
          $ref: '#/components/schemas/schedule-2'
        callback_url:
          type: string
          description: >-
            La URL de callback a la que se redirigirá a su usuario después de
            confirmar el pago en su aplicación bancaria.
          example: https://www.acmecorp.com/checkout/3487321
    PaymentIntentPaymentMethodDetailsBodyBusinessRequestOfpi:
      type: object
      title: NEGOCIOS
      description: Tipo de método de pago seleccionado.
      required:
        - beneficiary_bank_account
        - payer_institution
        - callback_url
        - cpf
      properties:
        beneficiary_bank_account:
          type: string
          format: uuid
          description: >-
            El ID único de Belvo utilizado para identificar la cuenta bancaria
            del beneficiario.
          example: a80d5a9d-20ae-479a-8dd7-ff3443bcbbfc
        payer_institution:
          type: string
          format: uuid
          description: ID único de Belvo para referenciar la institución del pagador.
          example: 600f1b4a-1ef9-4f89-b341-1a35f0c32cc0
        schedule:
          $ref: '#/components/schemas/schedule-2'
        callback_url:
          type: string
          description: >-
            La URL de callback a la que se redirigirá a su usuario después de
            confirmar el pago en su aplicación bancaria.
          example: https://www.acmecorp.com/checkout/3487321
        cpf:
          type: string
          description: >-
            El número de CPF del cliente. Solo se requiere cuando el
            `customer_type` es `BUSINESS`.
          example: 9744477770
    CreatePaymentIntentOfpi:
      type: object
      title: Intención de Pago (Solo)
      description: Crea una intención de pago utilizando un cliente previamente creado.
      required:
        - amount
        - customer
        - description
        - allowed_payment_method_types
        - selected_payment_method_type
        - payment_method_details
        - confirm
      properties:
        amount:
          type: string
          title: cadena
          pattern: \d+(?:\.\d{1,2})?
          example: '1234.12'
          description: >-
            Cantidad a pagar por su cliente. Para OFPI, puede enviar números con
            hasta dos decimales, separados por un `.` punto. Por ejemplo:
            `1234.12`
        customer:
          type: string
          format: uuid
          description: ID único de Belvo para referenciar a su cliente creado previamente.
          example: 06dc2f14-1217-4480-9b36-550a944a39d1
        external_id:
          $ref: '#/components/schemas/external_id__payments'
        description:
          type: string
          description: Una descripción legible para humanos del pago.
          example: Shoe payment
        statement_description:
          type: string
          maxLength: 50
          description: >-
            Una descripción que aparecerá en el extracto bancario del cliente
            (recomendado).


            > **Nota**: Si no utiliza el parámetro `statement_description`, se
            usará el valor de `description` como la descripción del extracto.
          example: Super Shoe Store - Brown Sneakers
        allowed_payment_method_types:
          type: array
          description: >-
            Una lista de tipos de métodos de pago permitidos en esta intención
            de pago. Para Brasil (OFPI), este valor debe establecerse en
            `open_finance`.
          minItems: 1
          maxItems: 1
          items:
            $ref: '#/components/schemas/EnumPaymentLinkAllowedPaymentMethod'
        payment_method_details:
          type: object
          description: Detalles sobre el método de pago OFPI.
          required:
            - open_finance
          properties:
            open_finance:
              oneOf:
                - $ref: >-
                    #/components/schemas/PaymentIntentPaymentMethodDetailsBodyIndividualRequestOfpi
                - $ref: >-
                    #/components/schemas/PaymentIntentPaymentMethodDetailsBodyBusinessRequestOfpi
        confirm:
          type: boolean
          default: false
          description: >-
            Boolean que confirma la intención de pago.


            **Nota:** Enviar este parámetro configurado en `true` confirma la
            intención de pago.
          example: false
        metadata:
          type: object
          description: >-
            Objeto opcional y personalizable donde puedes proporcionar cualquier
            par clave-valor adicional para tus propósitos internos. Por ejemplo,
            un número de referencia interno para la intención de pago.


            ⚠️ **Nota**: Solo puedes proporcionar hasta 50 claves (las claves
            pueden tener hasta 50 caracteres cada una y cada valor puede tener
            hasta 500 caracteres). No admitimos objetos anidados, solo valores
            ASCII.
          example:
            internal_reference_id: GGq73487w2
        provider:
          $ref: '#/components/schemas/EnumPaymentLinkProvider'
    PaymentIntentPaymentMethodDetailsBodyIndividualRequestOfpiBankAccount:
      type: object
      title: INDIVIDUAL
      description: Tipo de método de pago seleccionado.
      required:
        - beneficiary_bank_account
        - payer_institution
        - callback_url
      properties:
        beneficiary_bank_account:
          $ref: '#/components/schemas/CreateBankAccountOfpiIndividual'
        payer_institution:
          type: string
          format: uuid
          description: ID único de Belvo para referenciar la institución del pagador.
          example: 600f1b4a-1ef9-4f89-b341-1a35f0c32cc0
        callback_url:
          type: string
          description: >-
            La URL de callback a la que se redirigirá a su usuario después de
            confirmar el pago en su aplicación bancaria.
          example: https://www.acmecorp.com/checkout/3487321
        schedule:
          $ref: '#/components/schemas/schedule-2'
    PaymentIntentPaymentMethodDetailsBodyBusinessRequestOfpiBankAccount:
      type: object
      title: NEGOCIOS
      description: Tipo de método de pago seleccionado.
      required:
        - beneficiary_bank_account
        - payer_institution
        - callback_url
        - cpf
      properties:
        beneficiary_bank_account:
          $ref: '#/components/schemas/CreateBankAccountOfpiBusiness'
        payer_institution:
          type: string
          format: uuid
          description: ID único de Belvo para referenciar la institución del pagador.
          example: 600f1b4a-1ef9-4f89-b341-1a35f0c32cc0
        schedule:
          $ref: '#/components/schemas/schedule-2'
        callback_url:
          type: string
          description: >-
            La URL de callback a la que se redirigirá a su usuario después de
            confirmar el pago en su aplicación bancaria.
          example: https://www.acmecorp.com/checkout/3487321
        cpf:
          type: string
          description: >-
            El número de CPF del cliente. Solo se requiere cuando el
            `customer_type` es `BUSINESS`.
          example: 9744477770
    CreatePaymentIntentAndCustomerOfpi:
      type: object
      title: Cliente, Cuenta Bancaria e Intención de Pago
      description: >-
        Crear un cliente, cuenta bancaria e intención de pago para Brasil
        (OFPI).
      required:
        - amount
        - customer
        - description
        - allowed_payment_method_types
        - selected_payment_method_type
        - payment_method_details
        - confirm
      properties:
        amount:
          type: string
          title: cadena
          pattern: \d+(?:\.\d{1,2})?
          example: '1234.12'
          description: >-
            Cantidad a pagar por su cliente. Para OFPI, puede enviar números con
            hasta dos decimales, separados por un `.` punto. Por ejemplo:
            `1234.12`
        customer:
          $ref: '#/components/schemas/CreateCustomerOfpi'
        external_id:
          $ref: '#/components/schemas/external_id__payments'
        description:
          type: string
          description: Una descripción legible para humanos del pago.
          example: Shoe payment
        statement_description:
          type: string
          maxLength: 50
          description: >-
            Una descripción que aparecerá en el extracto bancario del cliente
            (recomendado).


            > **Nota**: Si no utiliza el parámetro `statement_description`, se
            usará el valor de `description` como la descripción del extracto.
          example: Super Shoe Store - Brown Sneakers
        allowed_payment_method_types:
          type: array
          description: >-
            Una lista de tipos de métodos de pago permitidos en esta intención
            de pago. Para Brasil (OFPI), este valor debe establecerse en
            `open_finance`.
          minItems: 1
          maxItems: 1
          items:
            $ref: '#/components/schemas/EnumPaymentLinkAllowedPaymentMethod'
        payment_method_details:
          type: object
          description: Detalles sobre el método de pago OFPI.
          required:
            - open_finance
          properties:
            open_finance:
              oneOf:
                - $ref: >-
                    #/components/schemas/PaymentIntentPaymentMethodDetailsBodyIndividualRequestOfpiBankAccount
                - $ref: >-
                    #/components/schemas/PaymentIntentPaymentMethodDetailsBodyBusinessRequestOfpiBankAccount
        confirm:
          type: boolean
          default: false
          description: >-
            Boolean que confirma la intención de pago.


            > 📘 Proporcione `payer_institution`

            >

            > Para confirmar la intención de pago (`confirm: true`), debe
            proporcionar el parámetro `payer_institution`.


            **Nota:** Enviar este parámetro configurado en `true` confirma la
            intención de pago.
          example: false
        metadata:
          type: object
          description: >-
            Objeto opcional y personalizable donde puedes proporcionar cualquier
            par clave-valor adicional para tus propósitos internos. Por ejemplo,
            un número de referencia interno para la intención de pago.


            ⚠️ **Nota**: Solo puedes proporcionar hasta 50 claves (las claves
            pueden tener hasta 50 caracteres cada una y cada valor puede tener
            hasta 500 caracteres). No admitimos objetos anidados, solo valores
            ASCII.
          example:
            internal_reference_id: GGq73487w2
        provider:
          $ref: '#/components/schemas/EnumPaymentLinkProvider'
    PatchPaymentIntentOfpi:
      type: object
      required:
        - payment_method_details
      properties:
        payment_method_details:
          type: object
          required:
            - open_finance
          description: >-
            Objeto que contiene campos adicionales requeridos para el flujo de
            intención de pago.
          properties:
            open_finance:
              type: object
              properties:
                payer_institution:
                  type: string
                  format: uuid
                  description: ID único de Belvo para la institución del pagador.
                  example: db201c6a-e0ee-4caa-92d6-72b480d6d86f
                beneficiary_bank_account:
                  type: string
                  format: uuid
                  description: ID único de Belvo para la cuenta bancaria del beneficiario.
                  example: a80d5a9d-20ae-479a-8dd7-ff3443bcbbfc
        confirm:
          type: boolean
          default: false
          description: >-
            Boolean que indica si esta solicitud confirma la intención de pago.


            **Nota:** Deberás enviar este parámetro configurado en `true` cuando
            el siguiente paso de la intención de pago devuelva
            `ready_to_confirm: true`, lo que significa que la intención de pago
            está lista para ser confirmada.
          example: true
    ContractDebtor:
      type: object
      description: >-
        Detalles sobre el "propietario" del contrato. Esta es la persona o
        entidad que está en deuda con el beneficiario (que puede ser diferente
        del pagador). Por ejemplo, el contrato podría estar a nombre de un padre
        (`contract_debtor`), aunque es uno de los hijos quien realmente está
        realizando los pagos (`payer`).
      required:
        - identifier
        - name
      properties:
        identifier:
          type: string
          minLength: 11
          maxLength: 14
          pattern: ^[0-9]{11,14}$
          description: >-
            El CPF o CNPJ del deudor. Para CPF, debe tener 11 caracteres. Para
            CNPJ, debe tener 14 caracteres.
          example: '12345678901'
        name:
          type: string
          minLength: 1
          maxLength: 120
          pattern: ^([A-Za-zÀ-ÖØ-öø-ÿ,.@:&*+_<>()!?/\\$%\d' -]{0,120})$
          description: El nombre completo del deudor.
          example: João da Silva
    PaymentConfigurationFixed:
      type: object
      title: PIX_DE_FIJO_AUTOMÁTICO
      description: >-
        Detalles de configuración para el método de pago
        `PIX_OF_AUTOMATIC_FIXED`.
      properties:
        amount:
          type: string
          pattern: ^-?\d{1,15}\.\d{2,4}$
          description: |-
            {% admonition type="warning" name="Solo para Pagos Fijos" %}
              Solo para Pagos Fijos (`PIX_OF_AUTOMATIC_FIXED`).
            {% /admonition %}

            El monto que se le cobrará a su cliente.
          example: '10000.05'
        statement_description:
          type: string
          minLength: 1
          maxLength: 140
          pattern: '[\w\W\s]{1,140}'
          description: La descripción que aparecerá en el extracto bancario de su cliente.
          example: Monthly Gym - Premium Plan
        frequency:
          type: string
          enum:
            - WEEKLY
            - MONTHLY
            - QUARTERLY
            - BIANNUAL
            - YEARLY
          description: |-
            La frecuencia con la que se realizarán los pagos. Puede ser:
            - `WEEKLY`
            - `MONTHLY`
            - `QUARTERLY`
            - `BIANNUAL`
            - `YEARLY`
          example: MONTHLY
        start_date:
          type: string
          format: date
          description: >-
            La fecha en que comenzará la autorización (y el primer pago del
            'cycle'), en formato `YYYY-MM-DD`.
          example: '2025-06-01'
        end_date:
          type: string
          format: date
          nullable: true
          description: >-
            La fecha en que finalizará la autorización, en formato `YYYY-MM-DD`.
            Si no se envía un `end_date`, la Autorización de Pago será válida
            por un período indefinido.
          example: '2026-06-01'
        contract_id:
          type: string
          minLength: 1
          maxLength: 35
          pattern: ^[a-zA-Z0-9]{1,35}$
          description: El ID del contrato del comerciante con el cliente para el servicio.
          example: PREMIUMPLAN123456
        contract_debtor:
          $ref: '#/components/schemas/ContractDebtor'
        retries:
          type: boolean
          default: false
          description: >-
            Boolean que indica si se permiten los reintentos de pago. Por
            defecto, esto se establece en `false`.
          example: true
        authorization_url:
          type: string
          format: uri
          minLength: 1
          maxLength: 2048
          description: La URL a la que se debe redirigir al usuario para autorizar el pago.
          example: https://auth.belvo.com/authorize?token=abc123def456
        first_payment:
          type: object
          description: >-
            Detalles sobre el primer pago inmediato. (Solo aplicable para
            `PIX_OF_AUTOMATIC_FIXED` y `PIX_OF_AUTOMATIC_VARIABLE`.)
          properties:
            date:
              type: string
              format: date
              description: >-
                La fecha en la que se debe realizar el pago, en formato
                `YYYY-MM-DD`.
              example: '2025-05-15'
            amount:
              type: string
              pattern: ^-?\d{1,15}\.\d{2,4}$
              description: >-
                El monto a pagar. El valor nunca puede exceder el `amount`
                (Fijo) o el `maximum_amount` (Variable) establecido en la
                Autorización de Pago.
              example: '3000.02'
    PaymentConfigurationVariable:
      type: object
      title: PIX_OF_AUTOMATIC_VARIABLE
      description: >-
        Detalles de configuración para el método de pago
        `PIX_OF_AUTOMATIC_VARIABLE`.
      properties:
        minimum_amount:
          type: string
          pattern: ^-?\d{1,15}\.\d{2,4}$
          description: |-
            {% admonition type="warning" name="Solo para Pagos Variables" %}
              Solo para Pagos Variables (`PIX_OF_AUTOMATIC_VARIABLE`).
            {% /admonition %}

            El monto mínimo que se le cobrará a su cliente.
          example: '10000.01'
        maximum_amount:
          type: string
          pattern: ^-?\d{1,15}\.\d{2,4}$
          description: |-
            {% admonition type="warning" name="Solo para Pagos Variables" %}
              Solo para Pagos Variables (`PIX_OF_AUTOMATIC_VARIABLE`).
            {% /admonition %}

            El monto máximo que se le cobrará a su cliente.
          example: '50000.50'
        statement_description:
          type: string
          minLength: 1
          maxLength: 140
          pattern: '[\w\W\s]{1,140}'
          description: La descripción que aparecerá en el extracto bancario de su cliente.
          example: Monthly Gym - Premium Plan
        frequency:
          type: string
          enum:
            - WEEKLY
            - MONTHLY
            - QUARTERLY
            - BIANNUAL
            - YEARLY
          description: |-
            La frecuencia con la que se realizarán los pagos. Puede ser:
            - `WEEKLY`
            - `MONTHLY`
            - `QUARTERLY`
            - `BIANNUAL`
            - `YEARLY`
          example: MONTHLY
        start_date:
          type: string
          format: date
          description: >-
            La fecha en que comenzará la autorización (y el primer pago del
            'cycle'), en formato `YYYY-MM-DD`.
          example: '2025-06-01'
        end_date:
          type: string
          format: date
          nullable: true
          description: >-
            La fecha en que finalizará la autorización, en formato `YYYY-MM-DD`.
            Si no se envía un `end_date`, la Autorización de Pago será válida
            por un período indefinido.
          example: '2026-06-01'
        contract_id:
          type: string
          minLength: 1
          maxLength: 35
          pattern: ^[a-zA-Z0-9]{1,35}$
          description: El ID del contrato del comerciante con el cliente para el servicio.
          example: PREMIUMPLAN123456
        contract_debtor:
          $ref: '#/components/schemas/ContractDebtor'
        retries:
          type: boolean
          default: false
          description: >-
            Boolean que indica si se permiten los reintentos de pago. Por
            defecto, esto se establece en `false`.
          example: true
        authorization_url:
          type: string
          format: uri
          minLength: 1
          maxLength: 2048
          description: La URL a la que se debe redirigir al usuario para autorizar el pago.
          example: https://auth.belvo.com/authorize?token=abc123def456
        first_payment:
          type: object
          description: >-
            Detalles sobre el primer pago inmediato. (Solo aplicable para
            `PIX_OF_AUTOMATIC_FIXED` y `PIX_OF_AUTOMATIC_VARIABLE`.)
          properties:
            date:
              type: string
              format: date
              description: >-
                La fecha en la que se debe realizar el pago, en formato
                `YYYY-MM-DD`.
              example: '2025-05-15'
            amount:
              type: string
              pattern: ^-?\d{1,15}\.\d{2,4}$
              description: >-
                El monto a pagar. El valor nunca puede exceder el `amount`
                (Fijo) o el `maximum_amount` (Variable) establecido en la
                Autorización de Pago.
              example: '3000.02'
    metadata__payments:
      type: object
      description: >-
        Objeto opcional y personalizable donde puedes proporcionar cualquier par
        clave-valor adicional para tus propósitos internos. Por ejemplo, un
        número de referencia interno para la intención de pago.


        {% admonition type="info" name="Limitaciones de Metadata" %}
          Solo puedes proporcionar hasta 50 claves (las claves pueden tener hasta 50 caracteres cada una y cada valor puede tener hasta 500 caracteres). No soportamos objetos anidados, solo valores ASCII.
        {% /admonition %}
      maxProperties: 50
      additionalProperties:
        type: string
        maxLength: 500
        pattern: "^[\0-\x7F]*$"
      example:
        internal_reference_id: GGq73487w2
    PaymentAuthorization:
      type: object
      title: Autorización de Pago
      description: Detalles de Autorización de Pago.
      required:
        - id
        - created_at
        - updated_at
        - status
        - status_reason_code
        - status_reason_message
        - status_updated_at
        - authorized_at
        - external_id
        - description
        - return_url
        - payment_method
        - payer
        - beneficiary
        - payment_method_configuration
        - charges
      properties:
        id:
          type: string
          format: uuid
          pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
          description: El Belvo ID para la Autorización de Pago.
          example: 9fc68b84-f2d6-4142-b2ad-9d2d1ad70432
        created_at:
          type: string
          format: date-time
          description: >-
            La marca de tiempo ISO-8601 de cuando se creó la Autorización de
            Pago.
          example: '2025-05-20T09:55:02Z'
        updated_at:
          type: string
          format: date-time
          description: >-
            La marca de tiempo ISO-8601 de cuándo se actualizó por última vez la
            Autorización de Pago.
          example: '2025-05-20T09:55:02Z'
        status:
          type: string
          description: El estado actual de la Autorización de Pago.
          enum:
            - AWAITING_AUTHORIZATION
            - AUTHORIZED
            - AUTHORIZATION_FAILED
            - EXPIRED
            - CANCELLED
            - COMPLETED
          example: AWAITING_AUTHORIZATION
        status_reason_code:
          type: string
          nullable: true
          description: >-
            Un código que indica la razón del estado actual (cuando sea
            aplicable).
          example: null
        status_reason_message:
          type: string
          nullable: true
          description: >-
            Un mensaje legible por humanos que explica la razón del estado
            actual (cuando sea aplicable).
          example: null
        status_updated_at:
          type: string
          format: date-time
          description: >-
            La marca de tiempo ISO-8601 de cuando se actualizó por última vez el
            estado.
          example: '2025-05-20T09:55:02Z'
        authorized_at:
          type: string
          format: date-time
          nullable: true
          description: >-
            La marca de tiempo ISO-8601 de cuando la Autorización de Pago fue
            autorizada por el usuario.
          example: '2025-05-20T09:55:02Z'
        external_id:
          type: string
          format: uuid
          pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
          nullable: true
          description: El ID interno del comerciante para la autorización.
          example: c169a8a9-e9f5-48db-9f4a-818caef9356b
        description:
          type: string
          minLength: 1
          maxLength: 140
          pattern: ^[\w\W\s]+$
          description: Una descripción interna utilizada solo por el comerciante.
          example: Internal description used by the merchant only
        return_url:
          type: string
          format: uri
          minLength: 1
          maxLength: 2048
          description: >-
            La URL a la que el usuario será redirigido después de la
            autorización.
          example: https://merchant.com/return
        payment_method:
          type: string
          enum:
            - PIX_OF_AUTOMATIC_FIXED
            - PIX_OF_AUTOMATIC_VARIABLE
          description: El método de pago que fue autorizado.
          example: PIX_OF_AUTOMATIC_FIXED
        payer:
          type: object
          description: Detalles sobre el pagador.
          properties:
            customer:
              type: string
              format: uuid
              pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
              description: El Belvo ID para el cliente.
              example: 533e7a9b-e6c7-4bd4-be79-3a3c3bd78044
            institution:
              type: string
              format: uuid
              pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
              description: El ID de Belvo de la institución que el pagador utilizará.
              example: 770932b4-8f1f-4b0f-8470-1c605903fdb2
            representative_identifier:
              type: string
              minLength: 11
              maxLength: 14
              pattern: ^[0-9]{11,14}$
              description: >-
                En el caso de que el cliente sea una empresa, el CPF del
                representante autorizado para realizar pagos.
              example: '12345678901122'
        beneficiary:
          type: object
          description: Detalles sobre el beneficiario del pago.
          properties:
            type:
              type: string
              enum:
                - BANK_ACCOUNT
              description: El tipo de cuenta del beneficiario.
              example: BANK_ACCOUNT
            target:
              type: string
              format: uuid
              pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
              description: El Belvo ID de la cuenta bancaria que recibirá fondos.
              example: b6278377-f710-4d1a-a026-7bab757256d0
        payment_method_configuration:
          type: object
          description: Detalles de configuración para el método de pago.
          oneOf:
            - $ref: '#/components/schemas/PaymentConfigurationFixed'
            - $ref: '#/components/schemas/PaymentConfigurationVariable'
        charges:
          type: array
          minItems: 0
          description: Una lista de IDs de Charge asociados con la Autorización de Pago.
          items:
            type: string
            format: uuid
            description: El Belvo ID del Charge.
            example: 7d159b21-9f25-4365-9fa2-734d20797819
        metadata:
          $ref: '#/components/schemas/metadata__payments'
    CustomerObject:
      type: object
      title: CPF o CNPJ
      description: >-
        Detalles del cliente que realiza pagos al beneficiario. Si el cliente
        existe, devolvemos su ID de Belvo. Si no, creamos un nuevo cliente y
        devolvemos el ID de Belvo recién asignado.
      required:
        - identifier
        - name
      properties:
        identifier:
          type: string
          minLength: 11
          maxLength: 14
          pattern: ^[0-9]{11,14}$
          description: >-
            El CPF o CNPJ del cliente. Para CPF, debe tener 11 caracteres. Para
            CNPJ, debe tener 14 caracteres.
          example: '12345678901'
        name:
          type: string
          minLength: 1
          maxLength: 120
          pattern: ^([A-Za-zÀ-ÖØ-öø-ÿ,.@:&*+_<>()!?/\\$%\d' -]{0,120})$
          description: El nombre completo del cliente.
          example: João da Silva
        external_id:
          $ref: '#/components/schemas/external_id__payments'
    CustomerId:
      type: string
      title: ID de Belvo
      format: uuid
      description: >-
        El ID de Belvo del cliente previamente creado que realizará los pagos al
        beneficiario.


        {% admonition type="warning" name="Cliente de Payments-BR.V2" %}
          El ID de cliente proporcionado debe ser uno que se haya creado utilizando la versión `Payments-BR.V2` de nuestra API. Por ejemplo, usando la opción de Detalles de Cuenta Bancaria al crear la Autorización de Pago, o el endpoint Crear un Cliente con el encabezado `X-Belvo-API-Resource-Version: Payments-BR.V2`.
          Si proporcionas un ID que no cumple con la versión `Payments-BR.V2`, recibirás el siguiente error: `The customer does not exist or is invalid.`.
        {% /admonition %}
      example: c169a8a9-e9f5-48db-9f4a-818caef9356b
    BankAccountObject:
      type: object
      title: Detalles de la Cuenta Bancaria
      description: >-
        Detalles de la cuenta bancaria que se va a registrar. Si la cuenta
        bancaria existe, devolvemos su ID de Belvo. Si no, creamos una nueva
        cuenta bancaria y devolvemos el ID de Belvo recién asignado.
      required:
        - details
        - holder
      properties:
        holder:
          type: object
          description: Detalles del titular de la cuenta.
          required:
            - identifier
            - name
          properties:
            identifier:
              type: string
              minLength: 11
              maxLength: 14
              pattern: ^[0-9]{11,14}$
              description: >-
                El CPF (11 dígitos) o CNPJ (14 dígitos) del titular de la
                cuenta.


                {% admonition type="info" name="Pix Automático" %}
                  En el caso de Pix Automático (`payment_method` es `PIX_OF_AUTOMATICO_FIXED` o `PIX_OF_AUTOMATICO_VARIABLE`), el `identifier` debe ser un CNPJ (14 dígitos).
                {% /admonition %}
              example: '12345678901122'
            name:
              type: string
              maxLength: 120
              pattern: ^([A-Za-zÀ-ÖØ-öø-ÿ,.@:&*+_<>()!?/\\$%\d' -]{0,120})$
              description: El nombre completo o nombre comercial del titular de la cuenta.
              example: Frangos Enlatados
        details:
          type: object
          description: Detalles de la cuenta bancaria.
          required:
            - account_type
            - agency
            - institution
            - number
          properties:
            account_type:
              type: string
              enum:
                - CHECKINGS
                - SAVINGS
                - PAYMENTS
              description: |-
                El tipo de cuenta bancaria. Puede ser:
                  - `CHECKINGS` (también conocida como Conta Corrente en Brasil)
                  - `SAVINGS` (también conocida como Conta Poupança en Brasil)
                  - `PAYMENTS` (también conocida como Conta de Pagamento Instantâneo o Conta de Pagamento en Brasil)
              example: CHECKINGS
            agency:
              type: string
              minLength: 1
              maxLength: 4
              pattern: ^[0-9]{1,4}$
              description: >-
                La agencia (número de sucursal) de la institución donde se creó
                la cuenta.
              example: '0444'
            institution:
              type: string
              format: uuid
              description: El Belvo ID de la institución financiera.
              example: f512d996-583a-4a91-8b5b-eba2e103b068
            number:
              type: string
              pattern: ^[0-9]{1,20}$
              minLength: 1
              maxLength: 20
              description: >-
                El número de cuenta bancaria.


                {% admonition type="info" name="Caracteres válidos para el
                número de cuenta" %}
                  Solo puedes enviar números (`^[0-9]+$`) en la cadena. Por ejemplo, `"457220"` es un número de cuenta bancaria válido, mientras que "`45722-0`" es inválido ya que contiene un guion (`-`).
                {% /admonition %}
              example: '457220'
        external_id:
          $ref: '#/components/schemas/external_id__payments'
        metadata:
          $ref: '#/components/schemas/metadata__payments'
    BankAccountId:
      type: string
      title: ID de cuenta bancaria
      format: uuid
      description: >-
        El ID de Belvo de la cuenta bancaria que registraste previamente y que
        recibirá fondos.


        {% admonition type="warning" name="Cuenta Bancaria de Payments-BR.V2" %}
          El ID de cuenta bancaria proporcionado debe ser uno que se haya creado utilizando la versión `Payments-BR.V2` de nuestra API. Por ejemplo, usando la opción de Detalles de Cuenta Bancaria al crear la Autorización de Pago, o el endpoint de Registro de Cuenta Bancaria con el encabezado `X-Belvo-API-Resource-Version: Payments-BR.V2`.
          Si proporcionas un ID que no cumple con la versión `Payments-BR.V2`, recibirás el siguiente error: `The bank account does not exist or is invalid.`.
        {% /admonition %}
      example: b6278377-f710-4d1a-a026-7bab757256d0
    CreatePaymentAuthorizationFixed:
      type: object
      title: Fijo
      description: Crear una Autorización de Pago Fijo.
      required:
        - payment_method
        - description
        - return_url
        - payer
        - beneficiary
        - payment_method_configuration
      properties:
        payment_method:
          type: string
          enum:
            - PIX_OF_AUTOMATIC_FIXED
          description: >-
            El método de pago a autorizar. Para pagos fijos, esto debe
            establecerse en `PIX_OF_AUTOMATIC_FIXED`.
          example: PIX_OF_AUTOMATIC_FIXED
        description:
          type: string
          description: Una descripción interna para el comerciante.
          minLength: 1
          maxLength: 140
          pattern: '[\w\W\s]{1,140}'
          example: Monthly gym subscription payment
        external_id:
          type: string
          format: uuid
          description: >-
            (Muy Recomendado) El ID interno del comerciante para la
            autorización.
          example: c169a8a9-e9f5-48db-9f4a-818caef9356b
        return_url:
          type: string
          format: uri
          description: >-
            La URL a la que el usuario debe ser redirigido después de autorizar
            el pago en la institución.
          example: https://merchant.com/return
        payer:
          type: object
          description: Detalles sobre el pagador.
          required:
            - customer
          properties:
            customer:
              description: >-
                Detalles del cliente que realiza pagos al beneficiario. Puedes
                proporcionar el CPF o CNPJ del cliente, o su Belvo ID. Si
                proporcionas el Belvo ID, debe ser un UUID de un cliente que ya
                ha sido creado en Belvo. Si proporcionas el CPF o CNPJ,
                verificaremos si el cliente existe en Belvo. Si el cliente
                existe, devolvemos su Belvo ID. Si no, creamos un nuevo cliente
                y devolvemos el Belvo ID recién asignado.
              oneOf:
                - $ref: '#/components/schemas/CustomerObject'
                - $ref: '#/components/schemas/CustomerId'
            institution:
              type: string
              description: >-
                El ID de Belvo de la institución que el pagador utilizará para
                pagar el servicio del comerciante. Para obtener el ID de Belvo
                de una institución, utiliza el [endpoint de
                Instituciones](https://developers.belvo.com/apis/belvoopenapispec/payment-institutions-(brazil)/listpaymentinstitutionsbrazil).
              example: ef685cf7-d143-4671-a1e5-4d1d019a3f5c
            representative_identifier:
              type: string
              minLength: 14
              maxLength: 14
              pattern: ^[0-9]{14}$
              description: >-
                En el caso de que el cliente sea una empresa, este es el CPF del
                representante autorizado para realizar pagos en nombre de la
                empresa.
              example: '12345678901234'
        beneficiary:
          type: object
          description: Detalles sobre el beneficiario del pago.
          required:
            - type
            - target
          properties:
            type:
              type: string
              enum:
                - BANK_ACCOUNT
              description: >-
                El tipo de cuenta del beneficiario. Actualmente, esto debe
                establecerse en `BANK_ACCOUNT`.
              example: BANK_ACCOUNT
            target:
              oneOf:
                - $ref: '#/components/schemas/BankAccountObject'
                - $ref: '#/components/schemas/BankAccountId'
              description: >-
                Detalles sobre la cuenta bancaria que recibirá los fondos.
                Puedes proporcionar los detalles completos de la cuenta bancaria
                o el Belvo ID. Si proporcionas los detalles completos de la
                cuenta bancaria, verificaremos si la cuenta bancaria existe en
                Belvo. Si la cuenta bancaria existe, devolveremos su Belvo ID.
                Si no, crearemos una nueva cuenta bancaria y devolveremos el
                Belvo ID asignado recientemente.
        payment_method_configuration:
          type: object
          description: Detalles sobre el pago.
          required:
            - amount
            - statement_description
            - frequency
            - start_date
            - contract_id
            - contract_debtor
          properties:
            amount:
              type: number
              format: float
              description: |-
                {% admonition type="warning" name="Solo para Pagos Fijos" %}
                  Solo para Pagos Fijos (`PIX_OF_AUTOMATIC_FIXED`).
                {% /admonition %}

                El monto que se le cobrará a su cliente.
              example: 10000.05
            statement_description:
              type: string
              minLength: 1
              maxLength: 140
              pattern: '[\w\W\s]{1,140}'
              description: >-
                La descripción que aparecerá en el extracto bancario de su
                cliente.
              example: Monthly Gym - Premium Plan
            frequency:
              type: string
              enum:
                - WEEKLY
                - MONTHLY
                - QUARTERLY
                - BIANNUAL
                - YEARLY
              description: |-
                La frecuencia con la que se realizarán los pagos. Puede ser:
                - `WEEKLY`
                - `MONTHLY`
                - `QUARTERLY`
                - `BIANNUAL`
                - `YEARLY`
              example: MONTHLY
            start_date:
              type: string
              format: date
              description: >-
                La fecha en que comenzará la autorización (y el primer pago del
                'cycle'), en formato `YYYY-MM-DD`. Debe ser al menos dos días a
                partir de la fecha actual.
              example: '2025-06-01'
            end_date:
              type: string
              format: date
              description: >-
                {% admonition type="info" name="Solo enviar cuando se conozca la
                end_date" %}
                  Si conoces la fecha de finalización de la autorización, puedes enviarla. Si no, puedes omitir el envío de este campo. Sin embargo, no envíes una cadena vacía o `null` como valor para este campo, ya que esto causará un error.
                {% /admonition %}


                La fecha en que finalizará la autorización, en formato
                `YYYY-MM-DD`. Si no se envía una `end_date`, la Autorización de
                Pago será válida por un período indefinido.
              example: '2026-06-01'
            contract_id:
              type: string
              minLength: 1
              maxLength: 35
              pattern: ^[a-zA-Z0-9]{1,35}$
              description: >-
                El ID del contrato del comerciante con el cliente para el
                servicio.
              example: PREMIUMPLAN123456
            contract_debtor:
              $ref: '#/components/schemas/ContractDebtor'
            retries:
              type: boolean
              default: false
              description: >-
                Boolean que indica si se permiten los reintentos de pago. Por
                defecto, esto se establece en `false`.
              example: true
            first_payment:
              type: object
              description: >-
                {% admonition type="warning" name="En Beta" %}
                  Esta función está actualmente en beta y solo está disponible para clientes seleccionados. Si estás interesado en usar esta función, por favor contacta a tu representante de Belvo.
                {% /admonition %}


                Detalles sobre el primer pago inmediato. (Solo aplicable para
                `PIX_OF_AUTOMATIC_FIXED` y `PIX_OF_AUTOMATIC_VARIABLE`.)
              properties:
                date:
                  type: string
                  format: date
                  description: >-
                    La fecha en la que se debe realizar el pago, en formato
                    `YYYY-MM-DD`. Puede establecerse en la fecha "de hoy". Si la
                    fecha es una fecha futura, debe ser anterior a la
                    `start_date`.
                  example: '2025-05-15'
                amount:
                  type: number
                  format: float
                  description: >-
                    El monto a pagar. El valor nunca puede exceder el `amount`
                    (Fijo) o el `maximum_amount` (Variable) establecido en la
                    Autorización de Pago.
                  example: 3000.02
        metadata:
          $ref: '#/components/schemas/metadata__payments'
    CreatePaymentAuthorizationVariable:
      type: object
      title: Variable
      description: Crear una Autorización de Pago Variable.
      required:
        - payment_method
        - description
        - return_url
        - payer
        - beneficiary
        - payment_method_configuration
      properties:
        payment_method:
          type: string
          enum:
            - PIX_OF_AUTOMATIC_VARIABLE
          description: >-
            El método de pago a autorizar. Para pagos variables, esto debe
            establecerse en `PIX_OF_AUTOMATIC_VARIABLE`.
          example: PIX_OF_AUTOMATIC_VARIABLE
        description:
          type: string
          description: Una descripción interna para el comerciante.
          minLength: 1
          maxLength: 140
          pattern: '[\w\W\s]{1,140}'
          example: Monthly gym subscription payment
        external_id:
          type: string
          format: uuid
          description: >-
            (Muy Recomendado) El ID interno del comerciante para la
            autorización.
          example: c169a8a9-e9f5-48db-9f4a-818caef9356b
        return_url:
          type: string
          format: uri
          description: >-
            La URL a la que el usuario debe ser redirigido después de autorizar
            el pago en la institución.
          example: https://merchant.com/return
        payer:
          type: object
          description: Detalles sobre el pagador.
          required:
            - customer
          properties:
            customer:
              description: >-
                Detalles del cliente que realiza pagos al beneficiario. Puede
                proporcionar el CPF o CNPJ del cliente, o su Belvo ID. Si
                proporciona el CPF o CNPJ, verificaremos si el cliente existe en
                Belvo. Si el cliente existe, devolvemos su Belvo ID. Si no,
                creamos un nuevo cliente y devolvemos el Belvo ID asignado
                recientemente.
              oneOf:
                - $ref: '#/components/schemas/CustomerObject'
                - $ref: '#/components/schemas/CustomerId'
            institution:
              type: string
              description: >-
                El ID de Belvo de la institución que el pagador utilizará para
                pagar el servicio del comerciante. Para obtener el ID de Belvo
                de una institución, utiliza el [endpoint de
                Instituciones](https://developers.belvo.com/apis/belvoopenapispec/payment-institutions-(brazil)/listpaymentinstitutionsbrazil).
              example: ef685cf7-d143-4671-a1e5-4d1d019a3f5c
            representative_identifier:
              type: string
              minLength: 14
              maxLength: 14
              pattern: ^[0-9]{14}$
              description: >-
                En el caso de que el cliente sea una empresa, este es el CPF del
                representante autorizado para realizar pagos en nombre de la
                empresa.
              example: '12345678901234'
        beneficiary:
          type: object
          description: Detalles sobre el beneficiario del pago.
          required:
            - type
            - target
          properties:
            type:
              type: string
              enum:
                - BANK_ACCOUNT
              description: >-
                El tipo de cuenta del beneficiario. Actualmente, esto debe
                establecerse en `BANK_ACCOUNT`.
              example: BANK_ACCOUNT
            target:
              oneOf:
                - $ref: '#/components/schemas/BankAccountObject'
                - $ref: '#/components/schemas/BankAccountId'
              description: >-
                Detalles sobre la cuenta bancaria que recibirá los fondos.
                Puedes proporcionar los detalles completos de la cuenta bancaria
                o el Belvo ID. Si proporcionas los detalles completos de la
                cuenta bancaria, verificaremos si la cuenta bancaria existe en
                Belvo. Si la cuenta bancaria existe, devolveremos su Belvo ID.
                Si no, crearemos una nueva cuenta bancaria y devolveremos el
                Belvo ID asignado recientemente.
        payment_method_configuration:
          type: object
          description: Detalles sobre el pago.
          required:
            - minimum_amount
            - maximum_amount
            - statement_description
            - frequency
            - start_date
            - contract_id
            - contract_debtor
          properties:
            minimum_amount:
              type: number
              format: float
              description: |-
                {% admonition type="warning" name="Solo para Pagos Variables" %}
                  Solo para Pagos Variables (`PIX_OF_AUTOMATIC_VARIABLE`).
                {% /admonition %}

                El monto mínimo que se le cobrará a su cliente.
              example: 10000.01
            maximum_amount:
              type: number
              format: float
              description: >-
                {% admonition type="warning" name="Solo para Pagos Variables" %}
                  Solo para Pagos Variables (`PIX_OF_AUTOMATIC_VARIABLE`).
                {% /admonition %}


                El monto máximo que se le puede cobrar a su cliente. Tenga en
                cuenta que durante el proceso de otorgamiento de consentimiento,
                el cliente puede establecer un monto máximo que sea inferior a
                este valor.
              example: 50000.5
            statement_description:
              type: string
              minLength: 1
              maxLength: 140
              pattern: '[\w\W\s]{1,140}'
              description: >-
                La descripción que aparecerá en el extracto bancario de su
                cliente.
              example: Monthly Gym - Premium Plan
            frequency:
              type: string
              enum:
                - WEEKLY
                - MONTHLY
                - QUARTERLY
                - BIANNUAL
                - YEARLY
              description: |-
                La frecuencia con la que se realizarán los pagos. Puede ser:
                - `WEEKLY`
                - `MONTHLY`
                - `QUARTERLY`
                - `BIANNUAL`
                - `YEARLY`
              example: MONTHLY
            start_date:
              type: string
              format: date
              description: >-
                La fecha en que comenzará la autorización (y el primer pago del
                'cycle'), en formato `YYYY-MM-DD`. Debe ser al menos dos días a
                partir de la fecha actual.
              example: '2025-06-01'
            end_date:
              type: string
              format: date
              description: >-
                {% admonition type="info" name="Solo enviar cuando se conozca la
                end_date" %}
                  Si conoces la fecha de finalización de la autorización, puedes enviarla. Si no, puedes omitir el envío de este campo. Sin embargo, no envíes una cadena vacía o `null` como valor para este campo, ya que esto causará un error.
                {% /admonition %}


                La fecha en que finalizará la autorización, en formato
                `YYYY-MM-DD`. Si no se envía una `end_date`, la Autorización de
                Pago será válida por un período indefinido.
              example: '2026-06-01'
            contract_id:
              type: string
              minLength: 1
              maxLength: 35
              pattern: ^[a-zA-Z0-9]{1,35}$
              description: >-
                El ID del contrato del comerciante con el cliente para el
                servicio.
              example: PREMIUMPLAN123456
            contract_debtor:
              $ref: '#/components/schemas/ContractDebtor'
            retries:
              type: boolean
              default: false
              description: >-
                Boolean que indica si se permiten los reintentos de pago. Por
                defecto, esto se establece en `false`.
              example: true
            first_payment:
              type: object
              description: >-
                {% admonition type="warning" name="En Beta" %}
                  Esta función está actualmente en beta y solo está disponible para clientes seleccionados. Si estás interesado en usar esta función, por favor contacta a tu representante de Belvo.
                {% /admonition %}


                Detalles sobre el primer pago inmediato. Solo aplicable para
                `PIX_OF_AUTOMATIC_FIXED` y `PIX_OF_AUTOMATIC_VARIABLE`.
              properties:
                date:
                  type: string
                  format: date
                  description: >-
                    La fecha en la que se debe realizar el pago, en formato
                    `YYYY-MM-DD`. Puede establecerse en la fecha "de hoy". Si la
                    fecha es una fecha futura, debe ser anterior a la
                    `start_date`.
                  example: '2025-05-15'
                amount:
                  type: number
                  format: float
                  description: >-
                    El monto a pagar. El valor nunca puede exceder el `amount`
                    (Fijo) o el `maximum_amount` (Variable) establecido en la
                    Autorización de Pago.
                  example: 3000.02
        metadata:
          $ref: '#/components/schemas/metadata__payments'
    ChargeV2:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/id'
        created_at:
          $ref: '#/components/schemas/created_at'
        status_updated_at:
          type: string
          format: date-time
          nullable: true
          description: >-
            La marca de tiempo ISO-8601 de cuando se actualizó por última vez el
            estado del Cargo.
          example: '2025-06-09T08:45:50.406032Z'
        status:
          type: string
          enum:
            - PENDING
            - SCHEDULED
            - SETTLED
            - CANCELED
            - FAILED
          description: |-
            El estado actual del Cargo. Puede ser uno de los siguientes valores:

              - `PENDING`
              - `SCHEDULED`
              - `SETTLED`
              - `CANCELED`
              - `FAILED`
          example: PENDING
        status_reason_code:
          type: string
          nullable: true
          description: El código de motivo para el estado actual del Cargo, si corresponde.
          example: null
        status_reason_message:
          type: string
          nullable: true
          description: Más información sobre el `status_reason_code`.
          example: null
        amount:
          type: string
          nullable: true
          description: El monto del Charge.
          example: '100.12'
        date:
          type: string
          format: date
          nullable: true
          description: La fecha original del Cargo.
          example: '2025-06-09'
        end_to_end_id:
          type: string
          nullable: true
          description: >-
            El ID de extremo a extremo del Cargo. Este es un identificador único
            para la transacción que se puede utilizar para rastrearla a través
            de diferentes sistemas.
          example: 1234567890abcdef
        statement_description:
          type: string
          minLength: 1
          maxLength: 140
          description: >-
            La descripción que aparecerá en el extracto bancario del cliente (si
            se proporciona).
          example: Super Shoe Store - Brown Sneakers
        external_id:
          $ref: '#/components/schemas/external_id__payments'
        beneficiary:
          type: object
          description: Información sobre el beneficiario del Cargo.
          properties:
            bank_account:
              type: object
              description: Información sobre la cuenta bancaria del beneficiario.
              properties:
                id:
                  type: string
                  format: uuid
                  description: >-
                    ID único de Belvo utilizado para identificar la cuenta
                    bancaria del beneficiario.
                  example: 088bc38f-1430-40c5-a5d2-80bd67189d11
                holder:
                  type: object
                  description: >-
                    Información sobre el titular de la cuenta bancaria del
                    beneficiario.
                  properties:
                    name:
                      type: string
                      description: >-
                        El nombre completo del titular de la cuenta bancaria del
                        beneficiario.
                      example: Jane Smith
                    identifier:
                      type: string
                      description: >-
                        El identificador del titular de la cuenta bancaria del
                        beneficiario. Puede ser un CPF (11 caracteres) o un CNPJ
                        (14 caracteres).
                      minLength: 11
                      maxLength: 14
                      example: '12345678901'
                details:
                  type: object
                  description: Detalles de la cuenta bancaria del beneficiario.
                  properties:
                    institution:
                      type: string
                      format: uuid
                      description: >-
                        El ID único de Belvo utilizado para identificar el banco
                        del beneficiario.
                      example: f47ac10b-58cc-4372-a567-0e02b2c3d479
                    agency:
                      type: string
                      description: >-
                        El número de agencia de la cuenta bancaria del
                        beneficiario.
                      example: '5678'
                    number:
                      type: string
                      description: >-
                        El número de cuenta de la cuenta bancaria del
                        beneficiario.
                      example: '987654321'
                    account_type:
                      type: string
                      description: >-
                        El tipo de la cuenta bancaria del beneficiario. Puede
                        ser `CHECKINGS`, `SAVINGS` o `PAYMENTS`.
                      example: SAVINGS
                    code:
                      type: string
                      description: El código ISPB del banco del beneficiario.
                      example: '678901'
        payer:
          type: object
          description: Información sobre el pagador del Cargo.
          properties:
            bank_account:
              type: object
              description: Información sobre la cuenta bancaria del pagador.
              properties:
                holder:
                  type: object
                  description: >-
                    Información sobre el titular de la cuenta bancaria del
                    pagador.
                  properties:
                    identifier:
                      type: string
                      description: >-
                        El identificador del titular de la cuenta bancaria del
                        pagador. Puede ser un CPF (11 caracteres) o un CNPJ (14
                        caracteres).
                      minLength: 11
                      maxLength: 14
                      example: '12345678902'
                details:
                  type: object
                  description: Detalles de la cuenta bancaria del pagador.
                  properties:
                    institution:
                      type: string
                      format: uuid
                      description: >-
                        ID único de Belvo utilizado para identificar el banco
                        del pagador.
                    code:
                      type: string
                      description: El código ISPB del banco del pagador.
                      example: '123345'
                    account_type:
                      type: string
                      description: >-
                        El tipo de la cuenta bancaria del pagador. Puede ser
                        `CHECKINGS`, `SAVINGS` o `PAYMENTS`.
                      example: CHECKINGS
                    agency:
                      type: string
                      description: El número de agencia de la cuenta bancaria del pagador.
                      example: '1234'
                    number:
                      type: string
                      description: El número de cuenta de la cuenta bancaria del pagador.
                      example: '123456789'
        metadata:
          $ref: '#/components/schemas/metadata__payments'
    CreateChargePixAutomaticoDefaultBankAccount:
      type: object
      title: Cobro por Cuenta Bancaria Predeterminada
      description: >-
        Cree un Cargo para la cuenta bancaria predeterminada asociada con la
        Autorización de Pago.
      required:
        - amount
        - date
        - statement_description
      properties:
        amount:
          type: number
          format: float
          minimum: 0.01
          description: >-
            El monto del pago.


            - Para `PIX_OF_AUTOMATIC_FIXED`, este debe ser el mismo valor que
            enviaste en la autorización.

            - Para `PIX_OF_AUTOMATIC_VARIABLE`, este debe estar entre los
            valores `minimum` y `maximum` que enviaste en la autorización.
          example: 100.01
        date:
          type: string
          format: date
          description: >-
            La fecha en la que se debe realizar el pago, en formato
            `YYYY-MM-DD`. Debe ser al menos dos días después de la fecha actual.
          example: '2025-05-15'
        statement_description:
          type: string
          minLength: 1
          maxLength: 140
          pattern: '[\w\W\s]{1,140}'
          description: La descripción que aparecerá en el extracto bancario de su cliente.
          example: Monthly Gym - Premium Plan
        external_id:
          $ref: '#/components/schemas/external_id__payments'
        metadata:
          $ref: '#/components/schemas/metadata__payments'
    CreateChargePixAutomaticoDifferentBankAccount:
      type: object
      title: Cobro para una Cuenta Bancaria Diferente
      description: >-
        Crear un Cargo para una cuenta bancaria que no estaba originalmente
        asociada con la Autorización de Pago.
      required:
        - amount
        - date
        - statement_description
        - beneficiary
      properties:
        amount:
          type: number
          format: float
          minimum: 0.01
          description: >-
            El monto del pago.


            - Para `PIX_OF_AUTOMATIC_FIXED`, este debe ser el mismo valor que
            enviaste en la autorización.

            - Para `PIX_OF_AUTOMATIC_VARIABLE`, este debe estar entre los
            valores `minimum` y `maximum` que enviaste en la autorización.
          example: 100.01
        date:
          type: string
          format: date
          description: >-
            La fecha en la que se debe realizar el pago, en formato
            `YYYY-MM-DD`. Debe ser al menos dos días después de la fecha actual.
          example: '2025-05-15'
        statement_description:
          type: string
          minLength: 1
          maxLength: 140
          pattern: '[\w\W\s]{1,140}'
          description: La descripción que aparecerá en el extracto bancario de su cliente.
          example: Monthly Gym - Premium Plan
        beneficiary:
          type: object
          description: Detalles de la cuenta bancaria que recibirá el pago.
          required:
            - target
          properties:
            target:
              type: string
              format: uuid
              description: >-
                El Belvo ID de la cuenta bancaria que registraste previamente y
                que recibirá fondos. Para obtener más información sobre cómo
                registrar una cuenta bancaria, consulta el [endpoint Register
                Bank
                Account](https://developers.belvo.com/apis/belvoopenapispec/bank-accounts-(brazil)/registerbankaccountbrazil).
              example: 046f9af7-1813-4830-b4e6-5231e8111ca1
        external_id:
          $ref: '#/components/schemas/external_id__payments'
        metadata:
          $ref: '#/components/schemas/metadata__payments'
    EnrollmentBiometricPix:
      type: object
      description: Detalles sobre la inscripción del dispositivo para pagos Biometric Pix.
      properties:
        id:
          type: string
          format: uuid
          description: Identificador único de Belvo de la inscripción.
          example: 600f1b4a-1ef9-4f89-b341-1a35f0c32cc0
        created_by:
          type: string
          format: uuid
          description: El Belvo ID del comerciante que creó la inscripción.
          example: dbdce1e9-d089-4b7d-804b-51dd07748202
        created_at:
          type: string
          format: date-time
          description: >-
            La marca de tiempo ISO-8601 de cuando se creó el punto de datos en
            la base de datos de Belvo.
          example: '2024-11-26T11:20:57.389056Z'
        updated_at:
          type: string
          format: date-time
          description: >-
            La marca de tiempo ISO-8601 de cuándo se actualizó por última vez la
            inscripción.
          example: '2024-11-26T11:20:57.389058Z'
        external_id:
          $ref: '#/components/schemas/external_id__payments'
        type:
          type: string
          enum:
            - open_finance_biometric_pix
          description: |-
            El tipo de inscripción. Para la OFPI de 🇧🇷 Brasil, puede ser:

              - `open_finance_biometric_pix`: Para pagos biométricos utilizando la red PIX.
          example: open_finance_biometric_pix
        status:
          type: string
          enum:
            - PENDING
            - SUCCEEDED
            - CANCELED
            - FAILED
          description: |-
            El estado de la inscripción del dispositivo. Puede ser:

            - `PENDING`: La inscripción está pendiente.
            - `SUCCEEDED`: La inscripción fue exitosa.
            - `CANCELED`: La inscripción fue cancelada.
            - `FAILED`: La inscripción falló.
          example: PENDING
        details:
          type: object
          description: Detalles sobre la inscripción
          properties:
            status:
              type: string
              enum:
                - AWAITING_ACCOUNT_HOLDER_VALIDATION
                - AWAITING_ENROLLMENT
                - AUTHORIZED
                - REJECTED
                - REVOKED
              description: |-
                El estado de la inscripción de Biometric Pix. Puede ser:

                  - `AWAITING_ACCOUNT_HOLDER_VALIDATION`: El titular de la cuenta necesita validar la inscripción enviando sus datos biométricos.
                  - `AWAITING_ENROLLMENT`: La información de inscripción ha sido enviada a la institución y está siendo evaluada.
                  - `AUTHORIZED`: La inscripción ha sido autorizada.
                  - `REJECTED`: La institución ha rechazado la inscripción.
                  - `REVOKED`: El usuario o la institución han revocado la inscripción.
              example: AWAITING_ACCOUNT_HOLDER_VALIDATION
            customer:
              type: string
              format: uuid
              description: ID único de Belvo para referenciar al cliente.
              example: c860809f-e96d-4d50-9588-f40ffab77302
            institution:
              type: string
              format: uuid
              description: >-
                El ID único de Belvo para referenciar la institución en la que
                el dispositivo está registrado.
              example: 600f1b4a-1ef9-4f89-b341-1a35f0c32cc0
            platform:
              type: string
              enum:
                - ANDROID
                - BROWSER
                - CROSS_PLATFORM
                - IOS
              description: |-
                La plataforma del dispositivo que se va a inscribir. Puede ser:

                  - `ANDROID`: Para dispositivos Android.
                  - `BROWSER`: Para navegadores web.
                  - `CROSS_PLATFORM`: Para dispositivos multiplataforma.
                  - `IOS`: Para dispositivos iOS.
              example: ANDROID
            name:
              type: string
              nullable: true
              description: Un nombre interno para este registro de dispositivo.
              example: 600f1b4a-Mobile
            callback_url:
              type: string
              format: uri
              description: >-
                La URL a la que se redirigirá a su usuario después de completar
                el proceso de inscripción.
              example: https://example.com/enrollment-in-progress
            redirect_url:
              type: string
              format: uri
              description: >-
                La URL para redirigir al usuario a completar su inscripción en
                la institución.
              example: https://www.acmecorp.com/checkout/3487321
            risk_signals:
              type: string
              description: >-
                Una cadena ofuscada (`******`) utilizada para indicar que se han
                proporcionado señales de riesgo.
              example: '******'
        metadata:
          type: object
          description: >-
            Objeto opcional y personalizable donde puedes proporcionar cualquier
            par clave-valor adicional para tus propósitos internos. Por ejemplo,
            un número de referencia interno para la inscripción.


            ⚠️ **Nota**: Solo puedes proporcionar hasta 50 claves (las claves
            pueden tener hasta 50 caracteres cada una y cada valor puede tener
            hasta 500 caracteres). No admitimos objetos anidados, solo valores
            ASCII.
          example:
            internal_reference_id: GGq73487w2
    CustomerIdPaymentWidget:
      title: ID de Cliente de Belvo
      type: string
      format: uuid
      description: ID único de Belvo para referenciar al cliente.
      example: c860809f-e96d-4d50-9588-f40ffab77302
    CustomerPaymentWidget:
      title: CPF del cliente
      type: object
      required:
        - identifier
      properties:
        identifier:
          type: string
          minLength: 11
          maxLength: 11
          description: El número de CPF del cliente.
          example: '10187609363'
        name:
          type: string
          minLength: 5
          maxLength: 200
          description: >-
            El nombre completo del cliente para el que desea crear o listar
            inscripciones.
          example: Gustavo Veloso
        external_id:
          $ref: '#/components/schemas/external_id__payments'
    EnrollmentBiometricPaymentWidget:
      type: object
      description: >-
        El objeto `enrollment` contiene información clave que se requiere para
        inscribir el dispositivo del usuario con su institución o para listar
        las inscripciones asociadas con el usuario.
      required:
        - type
        - details
        - metadata
      properties:
        type:
          type: string
          enum:
            - open_finance_biometric_pix
          description: |-
            El tipo de inscripción. Para la OFPI de 🇧🇷 Brasil, puede ser:

              - `open_finance_biometric_pix`: Para pagos biométricos utilizando la red PIX.
          example: open_finance_biometric_pix
        external_id:
          $ref: '#/components/schemas/external_id__payments'
        details:
          type: object
          required:
            - customer
            - platform
          description: Los detalles de la inscripción que se va a crear.
          properties:
            name:
              type: string
              maxLength: 140
              description: >-
                Un nombre legible para humanos para la inscripción del
                dispositivo.
              example: 600f1b4a-Mobile
            customer:
              description: >-
                El cliente para el que deseas crear o listar inscripciones.
                Puedes proporcionar el ID de Belvo o el CPF del cliente.


                > 📘 Nuevos clientes

                >

                > Si proporcionas un CPF para un usuario que no existe en Belvo,
                crearemos un nuevo cliente con el CPF proporcionado.
              oneOf:
                - $ref: '#/components/schemas/CustomerIdPaymentWidget'
                - $ref: '#/components/schemas/CustomerPaymentWidget'
            institution:
              type: string
              format: uuid
              description: >-
                **Opcional**: ID único de Belvo para referenciar la institución
                del pagador.


                Si proporcionas el ID de la institución, el widget omitirá el
                paso de selección de la institución.
              example: 600f1b4a-1ef9-4f89-b341-1a35f0c32cc0
        metadata:
          type: object
          description: >-
            Objeto opcional y personalizable donde puedes proporcionar cualquier
            par clave-valor adicional para tus propósitos internos. Por ejemplo,
            un número de referencia interno.


            ⚠️ **Nota**: Solo puedes proporcionar hasta 50 claves (las claves
            pueden tener hasta 50 caracteres cada una y cada valor puede tener
            hasta 500 caracteres). No admitimos objetos anidados, solo valores
            ASCII.
          example:
            internal_reference_id: GGq73487w2
    IndividualRequestBiometricPix:
      type: object
      title: INDIVIDUAL
      description: Detalles sobre el método de pago Biometric Pix.
      required:
        - open_finance_biometric_pix
      properties:
        open_finance_biometric_pix:
          type: object
          description: >-
            Detalles sobre el método de pago Biometric Pix para clientes
            individuales.
          required:
            - beneficiary_bank_account
          properties:
            beneficiary_bank_account:
              type: string
              format: uuid
              description: >-
                El ID único de Belvo utilizado para identificar la cuenta
                bancaria del beneficiario.
              example: a80d5a9d-20ae-479a-8dd7-ff3443bcbbfc
            enrollment:
              type: string
              format: uuid
              description: >-
                El `enrollment.id` para la intención de pago.


                > 📘 Nota

                >

                > Si pasas el `enrollment.id` en la solicitud, el widget omitirá
                la pantalla de "Listar inscripciones" y solicitará
                automáticamente al usuario su escaneo biométrico.
              example: 7dc245e3-5f75-4534-bafa-431fc0893593
    PaymentIntentBiometricWidget:
      type: object
      title: Intención de Pago para Biometric Pix
      description: Crear un Pago Pix Biométrico para Brasil (OFPI).
      required:
        - amount
        - description
        - allowed_payment_method_types
        - selected_payment_method_type
        - payment_method_details
        - metadata
      properties:
        amount:
          type: string
          title: cadena
          pattern: \d+(?:\.\d{1,2})?
          example: '1234.12'
          description: >-
            Cantidad a pagar por su cliente. Para OFPI, puede enviar números con
            hasta dos decimales, separados por un `.` punto. Por ejemplo:
            `1234.12`
        external_id:
          $ref: '#/components/schemas/external_id__payments'
        description:
          type: string
          description: Una descripción legible para humanos del pago.
          example: Shoe payment
        statement_description:
          type: string
          maxLength: 50
          description: >-
            Una descripción que aparecerá en el extracto bancario del cliente
            (recomendado).


            > **Nota**: Si no utiliza el parámetro `statement_description`, se
            usará el valor de `description` como la descripción del extracto.
          example: Super Shoe Store - Brown Sneakers
        allowed_payment_method_types:
          type: array
          description: >-
            Una lista de tipos de métodos de pago permitidos en esta intención
            de pago. Para OFPI de 🇧🇷 Brasil, puede ser:

              - `open_finance`: Para pagos regulares.
              - `open_finance_biometric_pix`: Para pagos biométricos utilizando la red PIX.
          minItems: 1
          maxItems: 1
          items:
            type: string
            enum:
              - open_finance_biometric_pix
            description: >-
              Tipo de método de pago seleccionado. Para pagos Biometric Pix en
              Brasil, esto debe establecerse en `open_finance_biometric_pix`.
            example: open_finance_biometric_pix
        payment_method_details:
          description: Detalles sobre el método de pago Biometric Pix.
          oneOf:
            - $ref: '#/components/schemas/IndividualRequestBiometricPix'
        metadata:
          type: object
          description: >-
            Objeto opcional y personalizable donde puedes proporcionar cualquier
            par clave-valor adicional para tus propósitos internos. Por ejemplo,
            un número de referencia interno.


            ⚠️ **Nota**: Solo puedes proporcionar hasta 50 claves (las claves
            pueden tener hasta 50 caracteres cada una y cada valor puede tener
            hasta 500 caracteres). No admitimos objetos anidados, solo valores
            ASCII.
          example:
            internal_reference_id: GGq73487w2
    CallbackUrlsBiometricPaymentWidget:
      type: object
      description: >-
        En el objeto `callback_urls`, **debes** agregar enlaces a donde tu
        usuario debe ser redirigido en los siguientes casos:


        - success (tu usuario completó con éxito el proceso de inscripción o
        pago)

        - exit (tu usuario salió del widget antes de completar el proceso de
        inscripción o pago)
      required:
        - success
        - exit
      properties:
        success:
          type: string
          description: >-
            La URL a la que se redirige a tu usuario cuando completa con éxito
            la inscripción o el pago.
          example: your_deeplink_here://success
        exit:
          type: string
          description: >-
            La URL a la que se redirige a tu usuario cuando sale del proceso
            antes de completar la inscripción o el pago.
          example: your_deeplink_here://exit
    BrandingBiometricWidget:
      type: object
      description: Agrega elementos de marca personalizados al widget Biometric Pix.
      required:
        - company_name
      properties:
        color_scheme:
          type: string
          enum:
            - LIGHT
            - DARK
          description: >-
            El esquema de color del widget. Puedes elegir entre `LIGHT` y
            `DARK`. Por defecto, el widget utiliza el esquema de color `LIGHT`.


            > 📘 Personalización del esquema de color

            >

            > Si deseas personalizar aún más los colores para estos modos,
            consulta el parámetro `theme`.
          default: LIGHT
          example: LIGHT
        company_name:
          type: string
          description: El nombre de la empresa que se mostrará en el widget.
          example: Acme Inc.
    ThemeBiometricWidget:
      type: object
      description: >-
        Utiliza el array `theme` para añadir más personalización a tu esquema de
        color elegido. Para obtener detalles sobre todas las posibles
        personalizaciones, consulta nuestra guía dedicada de <a
        href="https://developers.belvo.com/docs/branding-and-customization-biometric-pix-widget"
        target="_blank">Branding and Customization (Biometric Pix Widget)</a>.
      required:
        - css_key
        - value
      properties:
        css_key:
          type: string
          description: Nombre de la variable CSS del widget.
          example: '--color-primary-base'
        value:
          type: string
          description: El código HEX para el `css_key`.
          example: '#907AD6'
    BiometricPaymentWidgetRequest:
      type: object
      title: Widget de Pago (Biometric Pix) Access Token
      required:
        - use_case
        - widget
      properties:
        use_cases:
          type: array
          minItems: 1
          maxItems: 2
          description: >-
            El caso de uso del widget Biometric Pix. Puedes elegir:

              - `ENROLLMENT`: Usa esta opción si deseas registrar el dispositivo de tu usuario en el servicio Biometric Pix.
              - `PAYMENT_INTENT`: Usa esta opción si deseas crear un pago para una transacción de Biometric Pix.

            > 📘 Usar el widget tanto para registro como para pagos.

            >

            > Si pasas ambos casos de uso, `ENROLLMENT` y `PAYMENT_INTENT`, el
            widget primero registrará al usuario y luego creará una intención de
            pago.
          items:
            type: string
            enum:
              - ENROLLMENT
              - PAYMENT_INTENT
          example:
            - ENROLLMENT
            - PAYMENT_INTENT
        widget:
          type: object
          required:
            - callback_urls
            - branding
          description: >-
            El objeto `widget` contiene información adicional sobre cómo
            configurar el widget, incluyendo detalles de inscripción\*,
            información de pago\* y URLs de callback.


            > 📘 Objetos condicionalmente requeridos

            >

            > Los objetos `enrollment` y `payment_intent` son requeridos
            condicionalmente, según los `use_cases` que proporciones. Para
            simplificar tu integración, te recomendamos que siempre pases ambos
            casos de uso (`ENROLLMENT` así como `PAYMENT_INTENT`), y luego pases
            tanto los objetos `enrollment` como `payment_intent`.
          properties:
            enrollment:
              $ref: '#/components/schemas/EnrollmentBiometricPaymentWidget'
            payment_intent:
              $ref: '#/components/schemas/PaymentIntentBiometricWidget'
            callback_urls:
              $ref: '#/components/schemas/CallbackUrlsBiometricPaymentWidget'
            branding:
              $ref: '#/components/schemas/BrandingBiometricWidget'
            top_tier_institutions:
              type: array
              minItems: 1
              maxItems: 5
              uniqueItems: true
              description: >-
                (Opcional) Un array de instituciones para mostrar inicialmente
                en el widget (los usuarios aún podrán buscar otras
                instituciones). Puedes seleccionar entre 1 a 5 instituciones de
                la lista disponible. Las instituciones se mostrarán en el orden
                en que las proporciones en el array. Si no pasas este parámetro,
                el widget mostrará todas las instituciones disponibles.
              items:
                type: string
                enum:
                  - nubank_retail
                  - inter_retail
                  - picpay_retail
                  - mercadopago_retail
                  - itau_retail
                  - santander_retail
                  - c6_retail
                  - bradesco_retail
                  - banco_do_brasil_retail
                  - sicredi_retail
                  - btg_retail
                  - caixa_retail
                  - pan_retail
                  - pagseguro_retail
              example:
                - nubank_retail
                - picpay_retail
                - mercadopago_retail
                - itau_retail
            theme:
              type: array
              description: >-
                Utiliza el array `theme` para añadir más personalización a tu
                esquema de color elegido. Para obtener detalles sobre todas las
                posibles personalizaciones, consulta nuestra guía dedicada de <a
                href="https://developers.belvo.com/docs/branding-and-customization-biometric-pix-widget"
                target="_blank">Branding and Customization (Biometric Pix
                Widget)</a>.
              items:
                $ref: '#/components/schemas/ThemeBiometricWidget'
  responses:
    401_unauthorized_error:
      description: No autorizado
      content:
        application/json:
          schema:
            type: array
            items:
              anyOf:
                - $ref: '#/components/schemas/UnauthorizedError'
                - $ref: '#/components/schemas/401_consent_without_accounts_error'
    403_access_denied_error:
      description: Acceso a la API de Belvo denegado
      content:
        application/json:
          schema:
            type: array
            description: >-
              Este error ocurre cuando intentas acceder al recurso de Belvo sin
              los permisos correctos.
            items:
              $ref: '#/components/schemas/AccessToResourceDenied'
    404_not_found_error:
      description: Error No Encontrado
      content:
        application/json:
          schema:
            type: array
            items:
              $ref: '#/components/schemas/404NotFoundError'
    408_request_timeout_error:
      description: Tiempo de espera de la solicitud agotado
      content:
        application/json:
          schema:
            type: array
            title: Tiempo de espera de la solicitud agotado
            description: >-
              Belvo tiene un límite en cuanto al tiempo que toma iniciar sesión,
              recuperar datos de la cuenta y cerrar sesión. Se produce un tiempo
              de espera cuando hay una cantidad muy alta de datos y no se pudo
              obtener todo dentro del tiempo asignado.
            items:
              $ref: '#/components/schemas/RequestTimeoutError'
    500_unexpected_error:
      description: Error inesperado
      content:
        application/json:
          schema:
            type: array
            title: Error inesperado
            description: >-
              Este error ocurre cuando nosotros (Belvo) hemos encontrado un
              error interno del sistema (lo sentimos) o debido a una respuesta
              no compatible de la institución.
            items:
              $ref: '#/components/schemas/UnexpectedError'
    400_bad_request_error:
      description: Error de solicitud incorrecta
      content:
        application/json:
          schema:
            type: array
            items:
              anyOf:
                - $ref: '#/components/schemas/TooManySessionsError'
                - $ref: '#/components/schemas/LoginError'
                - $ref: '#/components/schemas/SessionExpiredError'
                - $ref: '#/components/schemas/ValidationError'
                - $ref: '#/components/schemas/InstitutionDownError'
                - $ref: '#/components/schemas/InstitutionUnavailableError'
                - $ref: '#/components/schemas/InstitutionInactiveError'
                - $ref: '#/components/schemas/InvalidLinkError'
                - $ref: '#/components/schemas/400InvalidCredentialsStorageError'
                - $ref: '#/components/schemas/400InvalidFetchHistorical'
                - $ref: '#/components/schemas/400InvalidResourcesError'
                - $ref: '#/components/schemas/UnconfirmedLinkError'
                - $ref: '#/components/schemas/UnsupportedOperationError'
                - $ref: '#/components/schemas/InvalidPeriodError'
    428_token_required_error:
      description: Se requiere token MFA
      content:
        application/json:
          schema:
            type: array
            items:
              $ref: '#/components/schemas/TokenRequiredResponse'
    409_link_already_refreshed:
      description: Conflicto - Enlace ya actualizado
      content:
        application/json:
          schema:
            type: array
            items:
              type: object
              properties:
                code:
                  type: string
                  description: >-
                    Un código de error único (`link_refreshed`) 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 <a
                    href="https://developers.belvo.com/docs/belvo-api-errors#409-link_refreshed"
                    target="_blank">errores 409 link_refreshed</a>.
                  example: link_refreshed
                message:
                  type: string
                  description: |-
                    Una breve descripción del error.

                    Para los errores `link_refreshed`, la descripción es:

                      - `El enlace ya ha sido actualizado. Por favor, espere X minutos antes de intentarlo de nuevo.`
                  example: >-
                    The link has already been refreshed. Please wait 7 minutes
                    before trying again.
                request_id:
                  $ref: '#/components/schemas/request_id'
    202_accepted_response:
      description: Solicitud Aceptada (cuando `X-Belvo-Request-Mode` es `async`)
      content:
        application/json:
          schema:
            type: object
            properties:
              request_id:
                type: string
                description: >-
                  El ID único para esta solicitud. Recomendamos que almacene
                  este valor para identificar más tarde qué evento de webhook se
                  relaciona con una solicitud asincrónica.
                example: b5d0106ac9cc43d5b36199fe831f6bbe
    401_payments_unauthorized_error:
      description: Error de autenticación
      content:
        application/json:
          schema:
            type: array
            items:
              $ref: '#/components/schemas/401UnauthorizedError'
  examples:
    AccountsOfdaChecking:
      summary: Verificación de OFDA Brasil
      description: Ejemplo de una cuenta corriente (OFDA Brasil).
      value:
        - id: 0d3ffb69-f83b-456e-ad8e-208d0998d71d
          link: 30cb4806-6e00-48a4-91c9-ca55968576c8
          institution:
            name: ofmockbank_br_retail
            type: bank
          collected_at: '2019-09-27T13:01:41.941Z'
          created_at: '2022-02-09T08:45:50.406032Z'
          last_accessed_at: '2021-03-09T10:28:40.000Z'
          category: CHECKING_ACCOUNT
          balance_type: ASSET
          overdraft:
            used: 10000.99
            arranged: 99.99
            unarranged: 99.99
          type: CONTA_DEPOSITO_A_VISTA
          subtype: INDIVIDUAL
          name: null
          number: '11188222'
          agency: '6272'
          check_digit: '4'
          balance:
            current: 999.99
            available: 15000
            blocked: 41233.07
            automatically_invested: 15000
          currency: BRL
          public_identification_name: AGENCY/NUMBER
          public_identification_value: 6272/11188222
          internal_identification: '92792126019929279212650822221989319252576'
          credit_data: null
          loan_data: null
          funds_data: null
    AccountsOfdaCreditCard:
      summary: Tarjeta de Crédito OFDA Brasil
      description: Ejemplo de una cuenta de tarjeta de crédito (OFDA Brasil).
      value:
        - id: 0d3ffb69-f83b-456e-ad8e-208d0998d71d
          link: 30cb4806-6e00-48a4-91c9-ca55968576c8
          institution:
            name: ofmockbank_br_retail
            type: bank
          collected_at: '2019-09-27T13:01:41.941Z'
          created_at: '2022-02-09T08:45:50.406032Z'
          last_accessed_at: '2021-03-09T10:28:40.000Z'
          category: CREDIT_CARD
          balance_type: LIABILITY
          overdraft: null
          type: GRAFITE
          subtype: Dinners Elo Grafite
          name: Dinners Grafite
          number: '4057068115181'
          agency: '6272'
          check_digit: '7'
          balance:
            current: 5874.13
            available: 5621.12
            blocked: 60.32
            automatically_invested: 131.5
          currency: BRL
          public_identification_name: CREDIT_CARD_NUMBER
          public_identification_value: '8921'
          internal_identification: '92792126019929279212650822221989319252576'
          credit_data:
            cards:
              - is_multiple: false
                identification_number: '8921'
            limits:
              - type: LIMITE_CREDITO_TOTAL
                line_name: CREDITO_A_VISTA
                card_number: '8921'
                used_amount: 7500.05
                credit_limit: 23000.98
                available_amount: 15500.93
                is_limit_flexible: true
                consolidation_type: CONSOLIDADO
                line_name_additional_info: NA
            network: DINERS_CLUB
            collected_at: '2023-07-24T00:46:24.431038Z'
            credit_limit: 23000.98
            cutting_date: null
            interest_rate: null
            minimum_payment: 0
            monthly_payment: null
            last_payment_date: null
            next_payment_date: null
            last_period_balance: null
            no_interest_payment: null
            network_additional_info: null
          loan_data: null
          funds_data: null
    AccountsOfdaLoanData:
      summary: Préstamo OFDA Brasil
      description: Ejemplo de una cuenta de préstamo (OFDA Brasil).
      value:
        - id: 0d3ffb69-f83b-456e-ad8e-208d0998d71d
          link: 30cb4806-6e00-48a4-91c9-ca55968576c8
          institution:
            name: ofmockbank_br_retail
            type: bank
          collected_at: '2019-09-27T13:01:41.941Z'
          created_at: '2022-02-09T08:45:50.406032Z'
          last_accessed_at: '2021-03-09T10:28:40.000Z'
          category: LOAN_ACCOUNT
          balance_type: LIABILITY
          overdraft: null
          type: EMPRESTIMOS
          subtype: CREDITO_PESSOAL_SEM_CONSIGNACAO
          name: Aquisição de equipamentos
          number: '4057068115181'
          agency: '6272'
          check_digit: '7'
          balance:
            current: 5874.13
            available: 5621.12
            blocked: 0
            automatically_invested: 0
          currency: BRL
          public_identification_name: NUMBER
          public_identification_value: '90847453264'
          internal_identification: '92792126019929279212650822221989319252576'
          credit_data: null
          loan_data:
            fees:
              - code: ADMNISTRACAO
                name: Taxa de administracao
                rate: 0
                type: null
                value: 200.5
                fee_charge: FIXED
                fee_charge_type: SINGLE
            loan_code: 1.1815210402110117e+39
            loan_type: CREDITO_PESSOAL_SEM_CONSIGNACAO
            principal: null
            limit_date: null
            collaterals:
              - type: CESSAO_DIREITOS_CREDITORIOS
                amount: 15000.31
                subtype: ACOES_DEBENTURES
                currency: BRL
            cutting_day: null
            payment_day: null
            collected_at: '2023-07-24T00:46:44.756806Z'
            consignee_id: '13832718000196'
            credit_limit: null
            cutting_date: null
            interest_rate: null
            interest_rates:
              - name: NOMINAL
                type: YEARLY
                value: 0.015
                interest_rate_data:
                  type: AA
                  tax_type: NOMINAL_TAX
                  rate_type: SIMPLE_RATE
                  pre_fixed_rate: 0.015
                  additional_info: NA
                  post_fixed_rate: 0
                  calculation_base: 21/252
                  reference_index_info: null
                  reference_index_type: PRE_FIXED
                  reference_index_subtype: PRE_FIXADO
            contract_amount: 12070.6
            contract_number: '90847453264'
            monthly_payment: null
            payment_due_day: null
            settlement_date: '2021-06-21'
            balloon_payments:
              - amount: 0
                currency: BRL
                due_date: '2020-01-10'
            contract_end_date: '2023-01-08'
            last_payment_date: null
            next_payment_date: null
            contracted_charges:
              - info: NA
                rate: 0.06
                type: LATE_PAYMENT_PENALTY_FEE
            disbursement_dates:
              - '2022-01-08'
            contract_start_date: '2022-01-08'
            last_period_balance: null
            no_interest_payment: null
            outstanding_balance: 14402.379
            total_effective_cost: 0.015
            amortization_schedule: PRICE
            installment_frequency: OTHER
            outstanding_principal: null
            contract_remaining_total: 727
            amortization_schedule_info: NA
            first_installment_due_date: '2022-01-08'
            installment_frequency_info: DIA
            number_of_installments_paid: 3
            contract_remaining_frequency: DAY
            number_of_installments_total: 730
            number_of_installments_past_due: 1
            number_of_installments_outstanding: 727
            installments_contract_term_frequency: DAY
          funds_data: null
    AccountsOfdaCheckingDetail:
      summary: Verificación de OFDA Brasil
      description: Ejemplo de una cuenta corriente (OFDA Brasil).
      value:
        id: 0d3ffb69-f83b-456e-ad8e-208d0998d71d
        link: 30cb4806-6e00-48a4-91c9-ca55968576c8
        institution:
          name: ofmockbank_br_retail
          type: bank
        collected_at: '2019-09-27T13:01:41.941Z'
        created_at: '2022-02-09T08:45:50.406032Z'
        last_accessed_at: '2021-03-09T10:28:40.000Z'
        category: CHECKING_ACCOUNT
        balance_type: ASSET
        overdraft:
          used: 10000.99
          arranged: 99.99
          unarranged: 99.99
        type: CONTA_DEPOSITO_A_VISTA
        subtype: INDIVIDUAL
        name: null
        number: '11188222'
        agency: '6272'
        check_digit: '4'
        balance:
          current: 999.99
          available: 15000
          blocked: 41233.07
          automatically_invested: 15000
        currency: BRL
        public_identification_name: AGENCY/NUMBER
        public_identification_value: 6272/11188222
        internal_identification: '92792126019929279212650822221989319252576'
        credit_data: null
        loan_data: null
        funds_data: null
    AccountsOfdaCreditCardDetail:
      summary: Tarjeta de Crédito OFDA Brasil
      description: Ejemplo de una cuenta de tarjeta de crédito (OFDA Brasil).
      value:
        id: 0d3ffb69-f83b-456e-ad8e-208d0998d71d
        link: 30cb4806-6e00-48a4-91c9-ca55968576c8
        institution:
          name: ofmockbank_br_retail
          type: bank
        collected_at: '2019-09-27T13:01:41.941Z'
        created_at: '2022-02-09T08:45:50.406032Z'
        last_accessed_at: '2021-03-09T10:28:40.000Z'
        category: CREDIT_CARD
        balance_type: LIABILITY
        overdraft: null
        type: GRAFITE
        subtype: Dinners Elo Grafite
        name: Dinners Grafite
        number: '4057068115181'
        agency: '6272'
        check_digit: '7'
        balance:
          current: 5874.13
          available: 5621.12
          blocked: 60.32
          automatically_invested: 131.5
        currency: BRL
        public_identification_name: CREDIT_CARD_NUMBER
        public_identification_value: '8921'
        internal_identification: '92792126019929279212650822221989319252576'
        credit_data:
          cards:
            - is_multiple: false
              identification_number: '8921'
          limits:
            - type: LIMITE_CREDITO_TOTAL
              line_name: CREDITO_A_VISTA
              card_number: '8921'
              used_amount: 7500.05
              credit_limit: 23000.98
              available_amount: 15500.93
              is_limit_flexible: true
              consolidation_type: CONSOLIDADO
              line_name_additional_info: NA
          network: DINERS_CLUB
          collected_at: '2023-07-24T00:46:24.431038Z'
          credit_limit: 23000.98
          cutting_date: null
          interest_rate: null
          minimum_payment: 0
          monthly_payment: null
          last_payment_date: null
          next_payment_date: null
          last_period_balance: null
          no_interest_payment: null
          network_additional_info: null
        loan_data: null
        funds_data: null
    AccountsOfdaLoanDataDetail:
      summary: Préstamo OFDA Brasil
      description: Ejemplo de una cuenta de préstamo (OFDA Brasil).
      value:
        id: 0d3ffb69-f83b-456e-ad8e-208d0998d71d
        link: 30cb4806-6e00-48a4-91c9-ca55968576c8
        institution:
          name: ofmockbank_br_retail
          type: bank
        collected_at: '2019-09-27T13:01:41.941Z'
        created_at: '2022-02-09T08:45:50.406032Z'
        last_accessed_at: '2021-03-09T10:28:40.000Z'
        category: LOAN_ACCOUNT
        balance_type: LIABILITY
        overdraft: null
        type: EMPRESTIMOS
        subtype: CREDITO_PESSOAL_SEM_CONSIGNACAO
        name: Aquisição de equipamentos
        number: '4057068115181'
        agency: '6272'
        check_digit: '7'
        balance:
          current: 5874.13
          available: 5621.12
          blocked: 0
          automatically_invested: 0
        currency: BRL
        public_identification_name: NUMBER
        public_identification_value: '90847453264'
        internal_identification: '92792126019929279212650822221989319252576'
        credit_data: null
        loan_data:
          fees:
            - code: ADMNISTRACAO
              name: Taxa de administracao
              rate: 0
              type: null
              value: 200.5
              fee_charge: FIXED
              fee_charge_type: SINGLE
          loan_code: 1.1815210402110117e+39
          loan_type: CREDITO_PESSOAL_SEM_CONSIGNACAO
          principal: null
          limit_date: null
          collaterals:
            - type: CESSAO_DIREITOS_CREDITORIOS
              amount: 15000.31
              subtype: ACOES_DEBENTURES
              currency: BRL
          cutting_day: null
          payment_day: null
          collected_at: '2023-07-24T00:46:44.756806Z'
          consignee_id: '13832718000196'
          credit_limit: null
          cutting_date: null
          interest_rate: null
          interest_rates:
            - name: NOMINAL
              type: YEARLY
              value: 0.015
              interest_rate_data:
                type: AA
                tax_type: NOMINAL_TAX
                rate_type: SIMPLE_RATE
                pre_fixed_rate: 0.015
                additional_info: NA
                post_fixed_rate: 0
                calculation_base: 21/252
                reference_index_info: null
                reference_index_type: PRE_FIXED
                reference_index_subtype: PRE_FIXADO
          contract_amount: 12070.6
          contract_number: '90847453264'
          monthly_payment: null
          payment_due_day: null
          settlement_date: '2021-06-21'
          balloon_payments:
            - amount: 0
              currency: BRL
              due_date: '2020-01-10'
          contract_end_date: '2023-01-08'
          last_payment_date: null
          next_payment_date: null
          contracted_charges:
            - info: NA
              rate: 0.06
              type: LATE_PAYMENT_PENALTY_FEE
          disbursement_dates:
            - '2022-01-08'
          contract_start_date: '2022-01-08'
          last_period_balance: null
          no_interest_payment: null
          outstanding_balance: 14402.379
          total_effective_cost: 0.015
          amortization_schedule: PRICE
          installment_frequency: OTHER
          outstanding_principal: null
          contract_remaining_total: 727
          amortization_schedule_info: NA
          first_installment_due_date: '2022-01-08'
          installment_frequency_info: DIA
          number_of_installments_paid: 3
          contract_remaining_frequency: DAY
          number_of_installments_total: 730
          number_of_installments_past_due: 1
          number_of_installments_outstanding: 727
          installments_contract_term_frequency: DAY
        funds_data: null
    OwnerOfdaIndividualPaginated:
      summary: Individual OFDA Brasil
      description: Ejemplo de un individuo (OFDA Brasil).
      value:
        count: 108
        next: >-
          https://sandbox.belvo.com/api/{endpoint}/?link=1bd948f7-245d-4313-b604-34d1044cb908page=2
        previous: null
        results:
          - id: c749315b-eec2-435d-a458-06912878564f
            link: 30cb4806-6e00-48a4-91c9-ca55968576c8
            internal_identification: 7e5838e4
            collected_at: '2019-09-27T13:01:41.941Z'
            created_at: '2022-02-09T08:45:50.406032Z'
            display_name: Jack Oswald White
            social_name: O Piadista
            birth_date: '1988-07-15'
            marital_status: SINGLE
            marital_status_additional_info: It's complicated
            gender: MALE
            companies_id:
              - '01773247000103'
            is_local_resident: true
            document_id:
              document_type: CPF
              document_number: 235578435-S
            additional_documents:
              - type: DRIVERS_LICENSE
                type_additional_info: Learner's licence
                number: DL-7896829-7
                check_digit: '7'
                issue_date: '2019-01-01'
                expiration_date: '2019-01-01'
                country_of_issuance: CAN
                additional_info: The document has water damage
            nationalities:
              - info: CAN
                documents:
                  - type: DRIVERS_LICENSE
                    number: DL-7896829-7
                    issue_date: '2019-01-01'
                    expiration_date: '2019-01-01'
                    country_of_issuance: CAN
                    additional_info: The document has water damage
            email: johndoe@belvo.com
            emails:
              - is_main: true
                email: homen_morcego@gmail.com
            address: Carrer de la Llacuna, 162, 08018 Barcelona
            addresses:
              - is_main: true
                address: Av Naburo Ykesaki, 1270
                additional_info: In between two palm trees
                district_name: CENTRO
                town: Brasilia
                town_code: '3550308'
                state: SP
                postcode: '17500001'
                country_name: Brasil
                country_code: BRA
                latitude: '-23.5475000'
                longitude: '-46.6361100'
            phone_number: +52-XXX-XXX-XXXX
            phone_numbers:
              - is_main: true
                type: MOBILE
                additional_info: This is their work mobile number.
                number: '29875132'
                country_code: '351'
                area_code: '21'
                extension: '932'
            filiations:
              - type: MOTHER
                civil_name: Bruce Wayne
                social_name: The Dark Knight
            financial_profile:
              company_id: '50685362000135'
              occuptation_code: BRAZIL_OCCUPATION_CODE
              occupation_description: '01'
              informed_income:
                frequency: MONTHLY
                amount: 45391.89
                currency: BRL
                date: '2020-03-19'
              patrimony:
                amount: 45391.89
                currency: BRL
                year: 2020
            financial_relation:
              start_date: '2021-05-21T08:30:00Z'
              product_services:
                - CONTA_DEPOSITO_A_VISTA
              product_services_additional_info: Joint account with Robin
              procurators:
                - type: LEGAL_REPRESENTATIVE
                  civil_name: Alfred Thaddeus Pennyworth
                  social_name: Alfred Pennyworth
                  document_number: '73677831148'
              products:
                - type: SAVINGS_ACCOUNT
                  subtype: CONJUNTA_SIMPLES
                  agency: '6272'
                  clearing_code: '001'
                  number: '24550245'
                  check_digit: '7'
    OwnerOfdaBusinessPaginated:
      summary: Negocios OFDA Brasil
      description: Ejemplo de un negocio (OFDA Brazil).
      value:
        count: 108
        next: >-
          https://sandbox.belvo.com/api/{endpoint}/?link=1bd948f7-245d-4313-b604-34d1044cb908page=2
        previous: null
        results:
          - id: c749315b-eec2-435d-a458-06912878564f
            link: 30cb4806-6e00-48a4-91c9-ca55968576c8
            internal_identification: 7e5838e4
            collected_at: '2019-09-27T13:01:41.941Z'
            created_at: '2022-02-09T08:45:50.406032Z'
            company_name: Wayne Enterprises
            trade_name: WayneCorp
            incorporation_date: '1988-07-15'
            companies_id:
              - '01773247000103'
            document_id:
              document_type: CPF
              document_number: 235578435-S
            additional_documents:
              - type: EIN
                number: DL-7896829-7
                expiration_date: '2019-01-01'
                country_of_issuance: CAN
            email: johndoe@belvo.com
            emails:
              - is_main: true
                email: homen_morcego@gmail.com
            address: Carrer de la Llacuna, 162, 08018 Barcelona
            addresses:
              - is_main: true
                address: Av Naburo Ykesaki, 1270
                additional_info: In between two palm trees
                district_name: CENTRO
                town: Brasilia
                town_code: '3550308'
                state: SP
                postcode: '17500001'
                country_name: Brasil
                country_code: BRA
                latitude: '-23.5475000'
                longitude: '-46.6361100'
            phone_number: +52-XXX-XXX-XXXX
            phone_numbers:
              - is_main: true
                type: MOBILE
                additional_info: This is their work mobile number.
                number: '29875132'
                country_code: '351'
                area_code: '21'
                extension: '932'
            parties:
              - person_type: INDIVIDUAL
                type: MEMBER
                display_name: Jack Oswald White
                social_name: O Piadista
                company_name: Wayne Enterprises
                trade_name: WayneCorp
                start_date: '2021-07-15'
                percentage_type: 0.51
                document_type: CPF
                document_number: DL-7896829-7
                document_issue_date: '2019-01-01'
                document_expiration_date: '2019-01-01'
                document_country: CAN
                document_additional_info: Confirmed CPF with their driver's licence.
            financial_profile:
              economic_activities:
                - is_main: true
                  code: '8599604'
              informed_revenue:
                frequency: MONTHLY
                frequency_additional_info: Recently switched from weekly to monthly.
                amount: 45391.89
                currency: BRL
                year: 2022
              patrimony:
                amount: 45391.89
                currency: BRL
                date: '2022-12-12'
            financial_relation:
              start_date: '2021-05-21T08:30:00Z'
              product_services:
                - CONTA_DEPOSITO_A_VISTA
              procurators:
                - type: LEGAL_REPRESENTATIVE
                  civil_name: Alfred Thaddeus Pennyworth
                  social_name: Alfred Pennyworth
                  document_number: '73677831148'
              products:
                - type: SAVINGS_ACCOUNT
                  subtype: CONJUNTA_SIMPLES
                  agency: '6272'
                  clearing_code: '001'
                  number: '24550245'
                  check_digit: '7'
    OwnerOfdaIndividual:
      summary: Individual OFDA Brasil
      description: Ejemplo de un individuo (OFDA Brasil).
      value:
        - id: c749315b-eec2-435d-a458-06912878564f
          link: 30cb4806-6e00-48a4-91c9-ca55968576c8
          internal_identification: 7e5838e4
          collected_at: '2019-09-27T13:01:41.941Z'
          created_at: '2022-02-09T08:45:50.406032Z'
          display_name: Jack Oswald White
          social_name: O Piadista
          birth_date: '1988-07-15'
          marital_status: SINGLE
          marital_status_additional_info: It's complicated
          gender: MALE
          companies_id:
            - '01773247000103'
          is_local_resident: true
          document_id:
            document_type: CPF
            document_number: 235578435-S
          additional_documents:
            - type: DRIVERS_LICENSE
              type_additional_info: Learner's licence
              number: DL-7896829-7
              check_digit: '7'
              issue_date: '2019-01-01'
              expiration_date: '2019-01-01'
              country_of_issuance: CAN
              additional_info: The document has water damage
          nationalities:
            - info: CAN
              documents:
                - type: DRIVERS_LICENSE
                  number: DL-7896829-7
                  issue_date: '2019-01-01'
                  expiration_date: '2019-01-01'
                  country_of_issuance: CAN
                  additional_info: The document has water damage
          email: johndoe@belvo.com
          emails:
            - is_main: true
              email: homen_morcego@gmail.com
          address: Carrer de la Llacuna, 162, 08018 Barcelona
          addresses:
            - is_main: true
              address: Av Naburo Ykesaki, 1270
              additional_info: In between two palm trees
              district_name: CENTRO
              town: Brasilia
              town_code: '3550308'
              state: SP
              postcode: '17500001'
              country_name: Brasil
              country_code: BRA
              latitude: '-23.5475000'
              longitude: '-46.6361100'
          phone_number: +52-XXX-XXX-XXXX
          phone_numbers:
            - is_main: true
              type: MOBILE
              additional_info: This is their work mobile number.
              number: '29875132'
              country_code: '351'
              area_code: '21'
              extension: '932'
          filiations:
            - type: MOTHER
              civil_name: Bruce Wayne
              social_name: The Dark Knight
          financial_profile:
            company_id: '50685362000135'
            occuptation_code: BRAZIL_OCCUPATION_CODE
            occupation_description: '01'
            informed_income:
              frequency: MONTHLY
              amount: 45391.89
              currency: BRL
              date: '2020-03-19'
            patrimony:
              amount: 45391.89
              currency: BRL
              year: 2020
          financial_relation:
            start_date: '2021-05-21T08:30:00Z'
            product_services:
              - CONTA_DEPOSITO_A_VISTA
            product_services_additional_info: Joint account with Robin
            procurators:
              - type: LEGAL_REPRESENTATIVE
                civil_name: Alfred Thaddeus Pennyworth
                social_name: Alfred Pennyworth
                document_number: '73677831148'
            products:
              - type: SAVINGS_ACCOUNT
                subtype: CONJUNTA_SIMPLES
                agency: '6272'
                clearing_code: '001'
                number: '24550245'
                check_digit: '7'
    OwnerOfdaBusiness:
      summary: Negocios OFDA Brasil
      description: Ejemplo de un negocio (OFDA Brazil).
      value:
        - id: c749315b-eec2-435d-a458-06912878564f
          link: 30cb4806-6e00-48a4-91c9-ca55968576c8
          internal_identification: 7e5838e4
          collected_at: '2019-09-27T13:01:41.941Z'
          created_at: '2022-02-09T08:45:50.406032Z'
          company_name: Wayne Enterprises
          trade_name: WayneCorp
          incorporation_date: '1988-07-15'
          companies_id:
            - '01773247000103'
          document_id:
            document_type: CPF
            document_number: 235578435-S
          additional_documents:
            - type: EIN
              number: DL-7896829-7
              expiration_date: '2019-01-01'
              country_of_issuance: CAN
          email: johndoe@belvo.com
          emails:
            - is_main: true
              email: homen_morcego@gmail.com
          address: Carrer de la Llacuna, 162, 08018 Barcelona
          addresses:
            - is_main: true
              address: Av Naburo Ykesaki, 1270
              additional_info: In between two palm trees
              district_name: CENTRO
              town: Brasilia
              town_code: '3550308'
              state: SP
              postcode: '17500001'
              country_name: Brasil
              country_code: BRA
              latitude: '-23.5475000'
              longitude: '-46.6361100'
          phone_number: +52-XXX-XXX-XXXX
          phone_numbers:
            - is_main: true
              type: MOBILE
              additional_info: This is their work mobile number.
              number: '29875132'
              country_code: '351'
              area_code: '21'
              extension: '932'
          parties:
            - person_type: INDIVIDUAL
              type: MEMBER
              display_name: Jack Oswald White
              social_name: O Piadista
              company_name: Wayne Enterprises
              trade_name: WayneCorp
              start_date: '2021-07-15'
              percentage_type: 0.51
              document_type: CPF
              document_number: DL-7896829-7
              document_issue_date: '2019-01-01'
              document_expiration_date: '2019-01-01'
              document_country: CAN
              document_additional_info: Confirmed CPF with their driver's licence.
          financial_profile:
            economic_activities:
              - is_main: true
                code: '8599604'
            informed_revenue:
              frequency: MONTHLY
              frequency_additional_info: Recently switched from weekly to monthly.
              amount: 45391.89
              currency: BRL
              year: 2022
            patrimony:
              amount: 45391.89
              currency: BRL
              date: '2022-12-12'
          financial_relation:
            start_date: '2021-05-21T08:30:00Z'
            product_services:
              - CONTA_DEPOSITO_A_VISTA
            procurators:
              - type: LEGAL_REPRESENTATIVE
                civil_name: Alfred Thaddeus Pennyworth
                social_name: Alfred Pennyworth
                document_number: '73677831148'
            products:
              - type: SAVINGS_ACCOUNT
                subtype: CONJUNTA_SIMPLES
                agency: '6272'
                clearing_code: '001'
                number: '24550245'
                check_digit: '7'
    OwnerOfdaIndividuaDetail:
      summary: Individual OFDA Brasil
      description: Ejemplo de un individuo (OFDA Brasil).
      value:
        id: c749315b-eec2-435d-a458-06912878564f
        link: 30cb4806-6e00-48a4-91c9-ca55968576c8
        internal_identification: 7e5838e4
        collected_at: '2019-09-27T13:01:41.941Z'
        created_at: '2022-02-09T08:45:50.406032Z'
        display_name: Jack Oswald White
        social_name: O Piadista
        birth_date: '1988-07-15'
        marital_status: SINGLE
        marital_status_additional_info: It's complicated
        gender: MALE
        companies_id:
          - '01773247000103'
        is_local_resident: true
        document_id:
          document_type: CPF
          document_number: 235578435-S
        additional_documents:
          - type: DRIVERS_LICENSE
            type_additional_info: Learner's licence
            number: DL-7896829-7
            check_digit: '7'
            issue_date: '2019-01-01'
            expiration_date: '2019-01-01'
            country_of_issuance: CAN
            additional_info: The document has water damage
        nationalities:
          - info: CAN
            documents:
              - type: DRIVERS_LICENSE
                number: DL-7896829-7
                issue_date: '2019-01-01'
                expiration_date: '2019-01-01'
                country_of_issuance: CAN
                additional_info: The document has water damage
        email: johndoe@belvo.com
        emails:
          - is_main: true
            email: homen_morcego@gmail.com
        address: Carrer de la Llacuna, 162, 08018 Barcelona
        addresses:
          - is_main: true
            address: Av Naburo Ykesaki, 1270
            additional_info: In between two palm trees
            district_name: CENTRO
            town: Brasilia
            town_code: '3550308'
            state: SP
            postcode: '17500001'
            country_name: Brasil
            country_code: BRA
            latitude: '-23.5475000'
            longitude: '-46.6361100'
        phone_number: +52-XXX-XXX-XXXX
        phone_numbers:
          - is_main: true
            type: MOBILE
            additional_info: This is their work mobile number.
            number: '29875132'
            country_code: '351'
            area_code: '21'
            extension: '932'
        filiations:
          - type: MOTHER
            civil_name: Bruce Wayne
            social_name: The Dark Knight
        financial_profile:
          company_id: '50685362000135'
          occuptation_code: BRAZIL_OCCUPATION_CODE
          occupation_description: '01'
          informed_income:
            frequency: MONTHLY
            amount: 45391.89
            currency: BRL
            date: '2020-03-19'
          patrimony:
            amount: 45391.89
            currency: BRL
            year: 2020
        financial_relation:
          start_date: '2021-05-21T08:30:00Z'
          product_services:
            - CONTA_DEPOSITO_A_VISTA
          product_services_additional_info: Joint account with Robin
          procurators:
            - type: LEGAL_REPRESENTATIVE
              civil_name: Alfred Thaddeus Pennyworth
              social_name: Alfred Pennyworth
              document_number: '73677831148'
          products:
            - type: SAVINGS_ACCOUNT
              subtype: CONJUNTA_SIMPLES
              agency: '6272'
              clearing_code: '001'
              number: '24550245'
              check_digit: '7'
    OwnerOfdaBusinessDetail:
      summary: Negocios OFDA Brasil
      description: Ejemplo de un negocio (OFDA Brazil).
      value:
        id: c749315b-eec2-435d-a458-06912878564f
        link: 30cb4806-6e00-48a4-91c9-ca55968576c8
        internal_identification: 7e5838e4
        collected_at: '2019-09-27T13:01:41.941Z'
        created_at: '2022-02-09T08:45:50.406032Z'
        company_name: Wayne Enterprises
        trade_name: WayneCorp
        incorporation_date: '1988-07-15'
        companies_id:
          - '01773247000103'
        document_id:
          document_type: CPF
          document_number: 235578435-S
        additional_documents:
          - type: EIN
            number: DL-7896829-7
            expiration_date: '2019-01-01'
            country_of_issuance: CAN
        email: johndoe@belvo.com
        emails:
          - is_main: true
            email: homen_morcego@gmail.com
        address: Carrer de la Llacuna, 162, 08018 Barcelona
        addresses:
          - is_main: true
            address: Av Naburo Ykesaki, 1270
            additional_info: In between two palm trees
            district_name: CENTRO
            town: Brasilia
            town_code: '3550308'
            state: SP
            postcode: '17500001'
            country_name: Brasil
            country_code: BRA
            latitude: '-23.5475000'
            longitude: '-46.6361100'
        phone_number: +52-XXX-XXX-XXXX
        phone_numbers:
          - is_main: true
            type: MOBILE
            additional_info: This is their work mobile number.
            number: '29875132'
            country_code: '351'
            area_code: '21'
            extension: '932'
        parties:
          - person_type: INDIVIDUAL
            type: MEMBER
            display_name: Jack Oswald White
            social_name: O Piadista
            company_name: Wayne Enterprises
            trade_name: WayneCorp
            start_date: '2021-07-15'
            percentage_type: 0.51
            document_type: CPF
            document_number: DL-7896829-7
            document_issue_date: '2019-01-01'
            document_expiration_date: '2019-01-01'
            document_country: CAN
            document_additional_info: Confirmed CPF with their driver's licence.
        financial_profile:
          economic_activities:
            - is_main: true
              code: '8599604'
          informed_revenue:
            frequency: MONTHLY
            frequency_additional_info: Recently switched from weekly to monthly.
            amount: 45391.89
            currency: BRL
            year: 2022
          patrimony:
            amount: 45391.89
            currency: BRL
            date: '2022-12-12'
        financial_relation:
          start_date: '2021-05-21T08:30:00Z'
          product_services:
            - CONTA_DEPOSITO_A_VISTA
          procurators:
            - type: LEGAL_REPRESENTATIVE
              civil_name: Alfred Thaddeus Pennyworth
              social_name: Alfred Pennyworth
              document_number: '73677831148'
          products:
            - type: SAVINGS_ACCOUNT
              subtype: CONJUNTA_SIMPLES
              agency: '6272'
              clearing_code: '001'
              number: '24550245'
              check_digit: '7'
    imss_example_paginated:
      summary: Ejemplo de IMSS
      description: Ejemplo de una respuesta paginada del IMSS.
      value:
        count: 20
        next: https://sandbox.belvo.com/api/employment-records/?page=2
        previous: null
        results:
          - id: fef05fc8-7357-4a4a-9d29-55038ea31a04
            link: 27c1d5cf-e8fb-433a-a2f7-d246de199c01
            created_at: '2022-02-09T08:45:50.406032Z'
            collected_at: '2022-02-09T08:45:50.406032Z'
            report_date: '2023-01-19'
            internal_identification: BLPM951331IONVGR54
            personal_data:
              official_name: Bruce Banner del Torro
              first_name: Bruce
              last_name: Banner del Torro
              email: bruce.banner@avengers.com
              birth_date: '2022-02-09'
              entitlements:
                entitled_to_health_insurance: true
                entitled_to_company_benefits: true
                valid_until: null
                status: EMPLOYED
              document_ids:
                - document_type: NSS
                  document_number: '10277663582'
                - document_type: CURP
                  document_number: BLPM951331IONVGR54
            social_security_summary:
              weeks_redeemed: 0
              weeks_reinstated: 0
              weeks_contributed: 188
            employment_records:
              - collected_at: '2022-02-09T08:45:50.406032Z'
                employer: Batman Enterprises CDMX
                employer_id: 780-BAT-88769-CDMX
                start_date: '2019-10-10'
                end_date: '2019-12-31'
                weeks_employed: 12
                state: DISTRITO FEDERAL
                most_recent_base_salary: 762.54
                monthly_salary: 762.54
                currency: MXN
                employment_status_updates:
                  - event: HIRED
                    base_salary: 1033.09
                    update_date: '2021-09-01'
            employment_scores:
              - score: 722
                period: 3
                version: 1.0.0
              - score: 612
                period: 6
                version: 1.0.0
              - score: 570
                period: 12
                version: 1.0.0
            files:
              - type: ReporteSemanasCotizadas_190123
                value: '=PDF_BINARY='
    issste_example_paginated:
      summary: Ejemplo ISSSTE
      description: Ejemplo de una respuesta paginada de ISSSTE.
      value:
        count: 20
        next: https://sandbox.belvo.com/api/employment-records/?page=2
        previous: null
        results:
          - id: fef05fc8-7357-4a4a-9d29-55038ea31a04
            link: 27c1d5cf-e8fb-433a-a2f7-d246de199c01
            created_at: '2022-02-09T08:45:50.406032Z'
            collected_at: '2022-02-09T08:45:50.406032Z'
            report_date: '2023-01-19'
            internal_identification: BAOC850505HCCRPL00
            personal_data:
              official_name: Clint Barton de Hacienda
              first_name: Clint
              last_name: Barton de Hacienda
              email: clint.hacienda@avengers.com
              birth_date: '2022-02-09'
              entitlements:
                entitled_to_health_insurance: true
                entitled_to_company_benefits: true
                valid_until: null
                status: EMPLOYED
              document_ids:
                - document_type: NSS
                  document_number: '21388774693'
                - document_type: CURP
                  document_number: BAOC850505HCCRPL00
                - document_type: RFC
                  document_number: BAOC850505EB7
            social_security_summary: null
            employment_records:
              - collected_at: '2022-02-09T08:45:50.406032Z'
                employer: Vengadores incorpora;Empresas Stark
                employer_id: null
                start_date: '2019-10-10'
                end_date: '2019-12-31'
                weeks_employed: 12
                state: null
                most_recent_base_salary: 762.54
                monthly_salary: 762.54
                currency: MXN
                employment_status_updates:
                  - event: NORMAL
                    base_salary: 1033.09
                    update_date: '2021-09-01'
            employment_scores: null
            files:
              - type: ReporteSemanasCotizadas_190123
                value: '=PDF_BINARY='
    imss_example:
      summary: Ejemplo de IMSS
      description: Ejemplo de una respuesta del IMSS.
      value:
        - id: fef05fc8-7357-4a4a-9d29-55038ea31a04
          link: 27c1d5cf-e8fb-433a-a2f7-d246de199c01
          created_at: '2022-02-09T08:45:50.406032Z'
          collected_at: '2022-02-09T08:45:50.406032Z'
          report_date: '2023-01-19'
          internal_identification: BLPM951331IONVGR54
          personal_data:
            official_name: Bruce Banner del Torro
            first_name: Bruce
            last_name: Banner del Torro
            email: bruce.banner@avengers.com
            birth_date: '2022-02-09'
            entitlements:
              entitled_to_health_insurance: true
              entitled_to_company_benefits: true
              valid_until: null
              status: EMPLOYED
            document_ids:
              - document_type: NSS
                document_number: '10277663582'
              - document_type: CURP
                document_number: BLPM951331IONVGR54
          social_security_summary:
            weeks_redeemed: 0
            weeks_reinstated: 0
            weeks_contributed: 188
          employment_records:
            - collected_at: '2022-02-09T08:45:50.406032Z'
              employer: Batman Enterprises CDMX
              employer_id: 780-BAT-88769-CDMX
              start_date: '2019-10-10'
              end_date: '2019-12-31'
              weeks_employed: 12
              state: DISTRITO FEDERAL
              most_recent_base_salary: 762.54
              monthly_salary: 762.54
              currency: MXN
              employment_status_updates:
                - event: HIRED
                  base_salary: 1033.09
                  update_date: '2021-09-01'
          employment_scores:
            - score: 722
              period: 3
              version: 1.0.0
            - score: 612
              period: 6
              version: 1.0.0
            - score: 570
              period: 12
              version: 1.0.0
          files:
            - type: ReporteSemanasCotizadas_190123
              value: '=PDF_BINARY='
    issste_example:
      summary: Ejemplo ISSSTE
      description: Ejemplo de una respuesta del ISSSTE.
      value:
        - id: fef05fc8-7357-4a4a-9d29-55038ea31a04
          link: 27c1d5cf-e8fb-433a-a2f7-d246de199c01
          created_at: '2022-02-09T08:45:50.406032Z'
          collected_at: '2022-02-09T08:45:50.406032Z'
          report_date: '2023-01-19'
          internal_identification: BAOC850505HCCRPL00
          personal_data:
            official_name: Clint Barton de Hacienda
            first_name: Clint
            last_name: Barton de Hacienda
            email: clint.hacienda@avengers.com
            birth_date: '2022-02-09'
            entitlements:
              entitled_to_health_insurance: true
              entitled_to_company_benefits: true
              valid_until: null
              status: EMPLOYED
            document_ids:
              - document_type: NSS
                document_number: '21388774693'
              - document_type: CURP
                document_number: BAOC850505HCCRPL00
              - document_type: RFC
                document_number: BAOC850505EB7
          social_security_summary: null
          employment_records:
            - collected_at: '2022-02-09T08:45:50.406032Z'
              employer: Vengadores incorpora;Empresas Stark
              employer_id: null
              start_date: '2019-10-10'
              end_date: '2019-12-31'
              weeks_employed: 12
              state: null
              most_recent_base_salary: 762.54
              monthly_salary: 762.54
              currency: MXN
              employment_status_updates:
                - event: NORMAL
                  base_salary: 1033.09
                  update_date: '2021-09-01'
          employment_scores: null
          files:
            - type: ReporteSemanasCotizadas_190123
              value: '=PDF_BINARY='
    imss_example_detail:
      summary: Ejemplo de IMSS
      description: Ejemplo de una respuesta del IMSS.
      value:
        id: fef05fc8-7357-4a4a-9d29-55038ea31a04
        link: 27c1d5cf-e8fb-433a-a2f7-d246de199c01
        created_at: '2022-02-09T08:45:50.406032Z'
        collected_at: '2022-02-09T08:45:50.406032Z'
        report_date: '2023-01-19'
        internal_identification: BLPM951331IONVGR54
        personal_data:
          official_name: Bruce Banner del Torro
          first_name: Bruce
          last_name: Banner del Torro
          email: bruce.banner@avengers.com
          birth_date: '2022-02-09'
          entitlements:
            entitled_to_health_insurance: true
            entitled_to_company_benefits: true
            valid_until: null
            status: EMPLOYED
          document_ids:
            - document_type: NSS
              document_number: '10277663582'
            - document_type: CURP
              document_number: BLPM951331IONVGR54
        social_security_summary:
          weeks_redeemed: 0
          weeks_reinstated: 0
          weeks_contributed: 188
        employment_records:
          - collected_at: '2022-02-09T08:45:50.406032Z'
            employer: Batman Enterprises CDMX
            employer_id: 780-BAT-88769-CDMX
            start_date: '2019-10-10'
            end_date: '2019-12-31'
            weeks_employed: 12
            state: DISTRITO FEDERAL
            most_recent_base_salary: 762.54
            monthly_salary: 762.54
            currency: MXN
            employment_status_updates:
              - event: HIRED
                base_salary: 1033.09
                update_date: '2021-09-01'
        employment_scores:
          - score: 722
            period: 3
            version: 1.0.0
          - score: 612
            period: 6
            version: 1.0.0
          - score: 570
            period: 12
            version: 1.0.0
        files:
          - type: ReporteSemanasCotizadas_190123
            value: '=PDF_BINARY='
    issste_example_detail:
      summary: Ejemplo ISSSTE
      description: Ejemplo de una respuesta del ISSSTE.
      value:
        id: fef05fc8-7357-4a4a-9d29-55038ea31a04
        link: 27c1d5cf-e8fb-433a-a2f7-d246de199c01
        created_at: '2022-02-09T08:45:50.406032Z'
        collected_at: '2022-02-09T08:45:50.406032Z'
        report_date: '2023-01-19'
        internal_identification: BAOC850505HCCRPL00
        personal_data:
          official_name: Clint Barton de Hacienda
          first_name: Clint
          last_name: Barton de Hacienda
          email: clint.hacienda@avengers.com
          birth_date: '2022-02-09'
          entitlements:
            entitled_to_health_insurance: true
            entitled_to_company_benefits: true
            valid_until: null
            status: EMPLOYED
          document_ids:
            - document_type: NSS
              document_number: '21388774693'
            - document_type: CURP
              document_number: BAOC850505HCCRPL00
            - document_type: RFC
              document_number: BAOC850505EB7
        social_security_summary: null
        employment_records:
          - collected_at: '2022-02-09T08:45:50.406032Z'
            employer: Vengadores incorpora;Empresas Stark
            employer_id: null
            start_date: '2019-10-10'
            end_date: '2019-12-31'
            weeks_employed: 12
            state: null
            most_recent_base_salary: 762.54
            monthly_salary: 762.54
            currency: MXN
            employment_status_updates:
              - event: NORMAL
                base_salary: 1033.09
                update_date: '2021-09-01'
        employment_scores: null
        files:
          - type: ReporteSemanasCotizadas_190123
            value: '=PDF_BINARY='
    InvoiceIngresoPaginated:
      summary: Factura de Ingreso
      description: Ejemplo de una factura de tipo *Ingreso*.
      value:
        count: 110
        next: >-
          https://sandbox.belvo.com/api/{endpoint}/?link=1bd948f7-245d-4313-b604-34d1044cb908page=2
        previous: null
        results:
          - id: 90d90e38-0087-4b6d-b6dc-94ea561bb9cb
            link: 1bd948f7-245d-4313-b604-34d1044cb908
            collected_at: '2022-02-09T08:45:50.406032Z'
            created_at: '2022-02-09T08:46:20.406032Z'
            invoice_identification: 862B9918-3K6H-4E0B-NAI9-2BE2D833B840
            invoice_date: '2020-12-24'
            status: Vigente
            invoice_type: Ingreso
            type: OUTFLOW
            sender_id: GHTF980303F7
            sender_name: Roberto Martinez Diaz
            sender_tax_fraud_status: NO_TAX_FRAUD_STATUS
            receiver_id: MNMK3203409H1
            receiver_name: ACNE SA DE CV
            receiver_tax_fraud_status: NO_TAX_FRAUD_STATUS
            cancelation_status: null
            cancelation_update_date: null
            certification_date: '2020-12-24'
            certification_authority: FGV330542BG6
            payment_type: '04'
            payment_type_description: null
            payment_method: PUE
            usage: G03
            place_of_issue: '11000'
            version: '3.3'
            invoice_details:
              - description: Messaging services.
                product_identification: '78102206'
                quantity: 1
                unit_code: E48
                unit_description: Unidad de servicio
                unit_amount: 25
                pre_tax_amount: 25
                tax_percentage: 16
                tax_amount: 4
                total_amount: 29
                retained_taxes: []
                collected_at: '2022-02-09T08:45:50.406032Z'
            currency: MXN
            subtotal_amount: 25
            exchange_rate: 1
            tax_amount: 4
            discount_amount: 0
            total_amount: 29
            payments: []
            payroll: null
            folio: '28'
            xml: '=XML-STRING='
            warnings:
              code: warning_code
              message: warning message
    InvoicePagoPaginated:
      summary: Factura Pago
      description: Ejemplo de una factura de tipo *Pago*.
      value:
        count: 110
        next: >-
          https://sandbox.belvo.com/api/{endpoint}/?link=1bd948f7-245d-4313-b604-34d1044cb908page=2
        previous: null
        results:
          - id: 90d90e38-0087-4b6d-b6dc-94ea561bb9cb
            link: 1bd948f7-245d-4313-b604-34d1044cb908
            collected_at: '2022-02-09T08:45:50.406032Z'
            created_at: '2022-02-09T08:46:20.406032Z'
            invoice_identification: 862B9918-3K6H-4E0B-NAI9-2BE2D833B840
            invoice_date: '2020-12-24'
            status: Vigente
            invoice_type: Pago
            type: OUTFLOW
            sender_id: GHTF980303F7
            sender_name: Roberto Martinez Diaz
            sender_tax_fraud_status: NO_TAX_FRAUD_STATUS
            receiver_id: MNMK3203409H1
            receiver_name: ACNE SA DE CV
            receiver_tax_fraud_status: NO_TAX_FRAUD_STATUS
            cancelation_status: null
            cancelation_update_date: null
            certification_date: '2020-12-24'
            certification_authority: FGV330542BG6
            payment_type: null
            payment_type_description: null
            payment_method: null
            usage: P01
            place_of_issue: '11000'
            version: '3.3'
            invoice_details:
              - description: Pago
                product_identification: '84111506'
                quantity: 1
                unit_amount: 0
                unit_code: ACT
                unit_description: null
                pre_tax_amount: 0
                tax_percentage: 0
                tax_amount: 0
                total_amount: 0
                retained_taxes: []
                collected_at: '2022-02-09T08:45:50.406032Z'
            currency: MXN
            subtotal_amount: 0
            exchange_rate: null
            tax_amount: 0
            discount_amount: 0
            total_amount: 0
            payments:
              - date: '2020-03-17T12:00:00.000Z'
                payment_type: '03'
                currency: BRL
                exchange_rate: '3.75'
                amount: 8000.5
                operation_number: '831840'
                beneficiary_rfc: BNM840515VB1
                beneficiary_account_number: '12343453245633'
                payer_rfc: BKJM840515VB1
                payer_account_number: '13343663245699'
                payer_bank_name: CITI BANAMEX
                related_documents:
                  - invoice_identification: 7EE015F3-6311-11EA-B02A-00155D014007
                    currency: MXN
                    payment_method: PPD
                    previous_balance: 18877.84
                    amount_paid: 8000
                    outstanding_balance: 10877.84
            payroll: null
            folio: '28'
            xml: '=XML-STRING='
            warnings:
              code: warning_code
              message: warning message
    InvoiceNominaPaginated:
      summary: Factura de Nómina
      description: Ejemplo de una factura de tipo *Nomina*.
      value:
        count: 110
        next: >-
          https://sandbox.belvo.com/api/{endpoint}/?link=1bd948f7-245d-4313-b604-34d1044cb908page=2
        previous: null
        results:
          - id: 90d90e38-0087-4b6d-b6dc-94ea561bb9cb
            link: 1bd948f7-245d-4313-b604-34d1044cb908
            collected_at: '2022-02-09T08:45:50.406032Z'
            created_at: '2022-02-09T08:46:20.406032Z'
            invoice_identification: 862B9918-3K6H-4E0B-NAI9-2BE2D833B840
            invoice_date: '2020-12-24'
            status: Vigente
            invoice_type: Nómina
            type: INFLOW
            sender_id: GHTF980303F7
            sender_name: ACNE SA DE CV
            sender_tax_fraud_status: NO_TAX_FRAUD_STATUS
            receiver_id: MNMK3203409H1
            receiver_name: Roberto Martinez Diaz
            receiver_tax_fraud_status: NO_TAX_FRAUD_STATUS
            cancelation_status: null
            cancelation_update_date: null
            certification_date: '2020-12-24'
            certification_authority: FGV330542BG6
            payment_type: '99'
            payment_type_description: null
            payment_method: PUE
            usage: P01
            place_of_issue: '11000'
            version: '3.3'
            invoice_details:
              - description: Payroll payment
                product_identification: '84111505'
                quantity: 1
                unit_code: ACT
                unit_description: null
                unit_amount: 20400.1
                total_amount: 20400.1
                pre_tax_amount: 20400.1
                tax_percentage: 0
                tax_amount: 0
                retained_taxes: []
                collected_at: '2022-02-09T08:45:50.406032Z'
            currency: MXN
            subtotal_amount: 20400.1
            exchange_rate: 1
            tax_amount: 0
            discount_amount: 5000
            total_amount: 15400.1
            payments: []
            payroll:
              days: 30
              type: O
              amount: 20400.1
              date_to: '2020-12-31'
              version: '1.2'
              date_from: '2020-12-01'
              collected_at: '2022-02-09T08:45:50.406032Z'
              payment_date: '2020-12-24'
            folio: '28'
            xml: '=XML-STRING='
            warnings:
              code: warning_code
              message: warning message
    InvoiceEgresoPaginated:
      summary: Factura de Egreso
      description: Ejemplo de una factura de tipo *Egreso*.
      value:
        count: 110
        next: >-
          https://sandbox.belvo.com/api/{endpoint}/?link=1bd948f7-245d-4313-b604-34d1044cb908page=2
        previous: null
        results:
          - id: 90d90e38-0087-4b6d-b6dc-94ea561bb9cb
            link: 1bd948f7-245d-4313-b604-34d1044cb908
            collected_at: '2022-02-09T08:45:50.406032Z'
            created_at: '2022-02-09T08:46:20.406032Z'
            invoice_identification: 862B9918-3K6H-4E0B-NAI9-2BE2D833B840
            invoice_date: '2020-12-24'
            status: Vigente
            invoice_type: Egreso
            type: INFLOW
            sender_id: GHTF980303F7
            sender_name: Roberto Martinez Diaz
            sender_tax_fraud_status: NO_TAX_FRAUD_STATUS
            receiver_id: MNMK3203409H1
            receiver_name: ACNE SA DE CV
            receiver_tax_fraud_status: NO_TAX_FRAUD_STATUS
            cancelation_status: null
            cancelation_update_date: null
            certification_date: '2020-12-24'
            certification_authority: FGV330542BG6
            payment_type: '04'
            payment_type_description: null
            payment_method: PUE
            usage: G03
            place_of_issue: '11000'
            version: '3.3'
            invoice_details:
              - product_identification: '78111500'
                description: Service refund
                unit_code: E48
                unit_description: Unidad de servicio
                quantity: 1
                unit_amount: 25
                pre_tax_amount: 25
                tax_percentage: 16
                tax_amount: 4
                total_amount: 29
                retained_taxes: []
                collected_at: '2022-02-09T08:45:50.406032Z'
            currency: MXN
            subtotal_amount: 25
            exchange_rate: 1
            tax_amount: 4
            discount_amount: 0
            total_amount: 29
            payments: []
            payroll: null
            folio: '28'
            xml: '=XML-STRING='
            warnings:
              code: warning_code
              message: warning message
    InvoiceTrasladoPaginated:
      summary: Factura de Traslado
      description: Ejemplo de una factura tipo *Traslado*.
      value:
        count: 110
        next: >-
          https://sandbox.belvo.com/api/{endpoint}/?link=1bd948f7-245d-4313-b604-34d1044cb908page=2
        previous: null
        results:
          - id: 90d90e38-0087-4b6d-b6dc-94ea561bb9cb
            link: 1bd948f7-245d-4313-b604-34d1044cb908
            collected_at: '2022-02-09T08:45:50.406032Z'
            created_at: '2022-02-09T08:46:20.406032Z'
            invoice_identification: 862B9918-3K6H-4E0B-NAI9-2BE2D833B840
            invoice_date: '2020-12-24'
            status: Vigente
            invoice_type: Traslado
            type: INFLOW
            sender_id: GHTF980303F7
            sender_name: ACNE SA DE CV
            sender_tax_fraud_status: NO_TAX_FRAUD_STATUS
            receiver_id: MNMK3203409H1
            receiver_name: CARGOS S.A. DE C.V.
            receiver_tax_fraud_status: NO_TAX_FRAUD_STATUS
            cancelation_status: null
            cancelation_update_date: null
            certification_date: '2020-12-24'
            certification_authority: FGV330542BG6
            payment_type: null
            payment_type_description: null
            payment_method: null
            usage: G03
            place_of_issue: '11000'
            version: '3.3'
            invoice_details:
              - description: FLETE
                product_identification: '78101802'
                quantity: 1
                unit_code: E48
                unit_description: Unidad de servicio
                unit_amount: 21000
                pre_tax_amount: 21000
                tax_percentage: 16
                tax_amount: 0
                total_amount: 21000
                retained_taxes: []
                collected_at: '2022-02-09T08:45:50.406032Z'
            currency: MXN
            subtotal_amount: 0
            exchange_rate: 1
            tax_amount: 0
            discount_amount: 0
            total_amount: 0
            payments: []
            payroll: null
            folio: '28'
            xml: '=XML-STRING='
            warnings:
              code: warning_code
              message: warning message
    InvoiceIngreso:
      summary: Factura de Ingreso
      description: Ejemplo de una factura de tipo *Ingreso*.
      value:
        - id: 90d90e38-0087-4b6d-b6dc-94ea561bb9cb
          link: 1bd948f7-245d-4313-b604-34d1044cb908
          collected_at: '2022-02-09T08:45:50.406032Z'
          created_at: '2022-02-09T08:46:20.406032Z'
          invoice_identification: 862B9918-3K6H-4E0B-NAI9-2BE2D833B840
          invoice_date: '2020-12-24'
          status: Vigente
          invoice_type: Ingreso
          type: OUTFLOW
          sender_id: GHTF980303F7
          sender_name: Roberto Martinez Diaz
          sender_tax_fraud_status: NO_TAX_FRAUD_STATUS
          receiver_id: MNMK3203409H1
          receiver_name: ACNE SA DE CV
          receiver_tax_fraud_status: NO_TAX_FRAUD_STATUS
          cancelation_status: null
          cancelation_update_date: null
          certification_date: '2020-12-24'
          certification_authority: FGV330542BG6
          payment_type: '04'
          payment_type_description: null
          payment_method: PUE
          usage: G03
          place_of_issue: '11000'
          version: '3.3'
          invoice_details:
            - description: Messaging services.
              product_identification: '78102206'
              quantity: 1
              unit_code: E48
              unit_description: Unidad de servicio
              unit_amount: 25
              pre_tax_amount: 25
              tax_percentage: 16
              tax_amount: 4
              total_amount: 29
              retained_taxes: []
              collected_at: '2022-02-09T08:45:50.406032Z'
          currency: MXN
          subtotal_amount: 25
          exchange_rate: 1
          tax_amount: 4
          discount_amount: 0
          total_amount: 29
          payments: []
          payroll: null
          folio: '28'
          xml: '=XML-STRING='
          warnings:
            code: warning_code
            message: warning message
    InvoicePago:
      summary: Factura Pago
      description: Ejemplo de una factura de tipo *Pago*.
      value:
        - id: 90d90e38-0087-4b6d-b6dc-94ea561bb9cb
          link: 1bd948f7-245d-4313-b604-34d1044cb908
          collected_at: '2022-02-09T08:45:50.406032Z'
          created_at: '2022-02-09T08:46:20.406032Z'
          invoice_identification: 862B9918-3K6H-4E0B-NAI9-2BE2D833B840
          invoice_date: '2020-12-24'
          status: Vigente
          invoice_type: Pago
          type: OUTFLOW
          sender_id: GHTF980303F7
          sender_name: Roberto Martinez Diaz
          sender_tax_fraud_status: NO_TAX_FRAUD_STATUS
          receiver_id: MNMK3203409H1
          receiver_name: ACNE SA DE CV
          receiver_tax_fraud_status: NO_TAX_FRAUD_STATUS
          cancelation_status: null
          cancelation_update_date: null
          certification_date: '2020-12-24'
          certification_authority: FGV330542BG6
          payment_type: null
          payment_type_description: null
          payment_method: null
          usage: P01
          place_of_issue: '11000'
          version: '3.3'
          invoice_details:
            - description: Pago
              product_identification: '84111506'
              quantity: 1
              unit_amount: 0
              unit_code: ACT
              unit_description: null
              pre_tax_amount: 0
              tax_percentage: 0
              tax_amount: 0
              total_amount: 0
              retained_taxes: []
              collected_at: '2022-02-09T08:45:50.406032Z'
          currency: MXN
          subtotal_amount: 0
          exchange_rate: null
          tax_amount: 0
          discount_amount: 0
          total_amount: 0
          payments:
            - date: '2020-03-17T12:00:00.000Z'
              payment_type: '03'
              currency: BRL
              exchange_rate: '3.75'
              amount: 8000.5
              operation_number: '831840'
              beneficiary_rfc: BNM840515VB1
              beneficiary_account_number: '12343453245633'
              payer_rfc: BKJM840515VB1
              payer_account_number: '13343663245699'
              payer_bank_name: CITI BANAMEX
              related_documents:
                - invoice_identification: 7EE015F3-6311-11EA-B02A-00155D014007
                  currency: MXN
                  payment_method: PPD
                  previous_balance: 18877.84
                  amount_paid: 8000
                  outstanding_balance: 10877.84
          payroll: null
          folio: '28'
          xml: '=XML-STRING='
          warnings:
            code: warning_code
            message: warning message
    InvoiceNomina:
      summary: Factura de Nómina
      description: Ejemplo de una factura de tipo *Nomina*.
      value:
        - id: 90d90e38-0087-4b6d-b6dc-94ea561bb9cb
          link: 1bd948f7-245d-4313-b604-34d1044cb908
          collected_at: '2022-02-09T08:45:50.406032Z'
          created_at: '2022-02-09T08:46:20.406032Z'
          invoice_identification: 862B9918-3K6H-4E0B-NAI9-2BE2D833B840
          invoice_date: '2020-12-24'
          status: Vigente
          invoice_type: Nómina
          type: INFLOW
          sender_id: GHTF980303F7
          sender_name: ACNE SA DE CV
          sender_tax_fraud_status: NO_TAX_FRAUD_STATUS
          receiver_id: MNMK3203409H1
          receiver_name: Roberto Martinez Diaz
          receiver_tax_fraud_status: NO_TAX_FRAUD_STATUS
          cancelation_status: null
          cancelation_update_date: null
          certification_date: '2020-12-24'
          certification_authority: FGV330542BG6
          payment_type: '99'
          payment_type_description: null
          payment_method: PUE
          usage: P01
          place_of_issue: '11000'
          version: '3.3'
          invoice_details:
            - description: Payroll payment
              product_identification: '84111505'
              quantity: 1
              unit_code: ACT
              unit_description: null
              unit_amount: 20400.1
              total_amount: 20400.1
              pre_tax_amount: 20400.1
              tax_percentage: 0
              tax_amount: 0
              retained_taxes: []
              collected_at: '2022-02-09T08:45:50.406032Z'
          currency: MXN
          subtotal_amount: 20400.1
          exchange_rate: 1
          tax_amount: 0
          discount_amount: 5000
          total_amount: 15400.1
          payments: []
          payroll:
            days: 30
            type: O
            amount: 20400.1
            date_to: '2020-12-31'
            version: '1.2'
            date_from: '2020-12-01'
            collected_at: '2022-02-09T08:45:50.406032Z'
            payment_date: '2020-12-24'
            periodicity: MONTHLY
            earnings_breakdown:
              - type: SALARY
                taxable_amount: 20400.1
                vat_free_amount: 0
              - type: BONUS
                taxable_amount: 1012.1
                vat_free_amount: 0
            tax_deductions:
              - type: UNION_FEES
                amount: 1505
            other_payments:
              - type: EMPLOYMENT_SUBSIDY
                amount: 1505
          folio: '28'
          xml: '=XML-STRING='
          warnings:
            code: warning_code
            message: warning message
    InvoiceEgreso:
      summary: Factura de Egreso
      description: Ejemplo de una factura de tipo *Egreso*.
      value:
        - id: 90d90e38-0087-4b6d-b6dc-94ea561bb9cb
          link: 1bd948f7-245d-4313-b604-34d1044cb908
          collected_at: '2022-02-09T08:45:50.406032Z'
          created_at: '2022-02-09T08:46:20.406032Z'
          invoice_identification: 862B9918-3K6H-4E0B-NAI9-2BE2D833B840
          invoice_date: '2020-12-24'
          status: Vigente
          invoice_type: Egreso
          type: INFLOW
          sender_id: GHTF980303F7
          sender_name: Roberto Martinez Diaz
          sender_tax_fraud_status: NO_TAX_FRAUD_STATUS
          receiver_id: MNMK3203409H1
          receiver_name: ACNE SA DE CV
          receiver_tax_fraud_status: NO_TAX_FRAUD_STATUS
          cancelation_status: null
          cancelation_update_date: null
          certification_date: '2020-12-24'
          certification_authority: FGV330542BG6
          payment_type: '04'
          payment_type_description: null
          payment_method: PUE
          usage: G03
          place_of_issue: '11000'
          version: '3.3'
          invoice_details:
            - product_identification: '78111500'
              description: Service refund
              unit_code: E48
              unit_description: Unidad de servicio
              quantity: 1
              unit_amount: 25
              pre_tax_amount: 25
              tax_percentage: 16
              tax_amount: 4
              total_amount: 29
              retained_taxes: []
              collected_at: '2022-02-09T08:45:50.406032Z'
          currency: MXN
          subtotal_amount: 25
          exchange_rate: 1
          tax_amount: 4
          discount_amount: 0
          total_amount: 29
          payments: []
          payroll: null
          folio: '28'
          xml: '=XML-STRING='
          warnings:
            code: warning_code
            message: warning message
    InvoiceTraslado:
      summary: Factura de Traslado
      description: Ejemplo de una factura tipo *Traslado*.
      value:
        - id: 90d90e38-0087-4b6d-b6dc-94ea561bb9cb
          link: 1bd948f7-245d-4313-b604-34d1044cb908
          collected_at: '2022-02-09T08:45:50.406032Z'
          created_at: '2022-02-09T08:46:20.406032Z'
          invoice_identification: 862B9918-3K6H-4E0B-NAI9-2BE2D833B840
          invoice_date: '2020-12-24'
          status: Vigente
          invoice_type: Traslado
          type: INFLOW
          sender_id: GHTF980303F7
          sender_name: ACNE SA DE CV
          sender_tax_fraud_status: NO_TAX_FRAUD_STATUS
          receiver_id: MNMK3203409H1
          receiver_name: CARGOS S.A. DE C.V.
          receiver_tax_fraud_status: NO_TAX_FRAUD_STATUS
          cancelation_status: null
          cancelation_update_date: null
          certification_date: '2020-12-24'
          certification_authority: FGV330542BG6
          payment_type: null
          payment_type_description: null
          payment_method: null
          usage: G03
          place_of_issue: '11000'
          version: '3.3'
          invoice_details:
            - description: FLETE
              product_identification: '78101802'
              quantity: 1
              unit_code: E48
              unit_description: Unidad de servicio
              unit_amount: 21000
              pre_tax_amount: 21000
              tax_percentage: 16
              tax_amount: 0
              total_amount: 21000
              retained_taxes: []
              collected_at: '2022-02-09T08:45:50.406032Z'
          currency: MXN
          subtotal_amount: 0
          exchange_rate: 1
          tax_amount: 0
          discount_amount: 0
          total_amount: 0
          payments: []
          payroll: null
          folio: '28'
          xml: '=XML-STRING='
          warnings:
            code: warning_code
            message: warning message
    InvoiceIngresoDetail:
      summary: Factura de Ingreso
      description: Ejemplo de una factura de tipo *Ingreso*.
      value:
        id: 90d90e38-0087-4b6d-b6dc-94ea561bb9cb
        link: 1bd948f7-245d-4313-b604-34d1044cb908
        collected_at: '2022-02-09T08:45:50.406032Z'
        created_at: '2022-02-09T08:46:20.406032Z'
        invoice_identification: 862B9918-3K6H-4E0B-NAI9-2BE2D833B840
        invoice_date: '2020-12-24'
        status: Vigente
        invoice_type: Ingreso
        type: OUTFLOW
        sender_id: GHTF980303F7
        sender_name: Roberto Martinez Diaz
        sender_tax_fraud_status: NO_TAX_FRAUD_STATUS
        receiver_id: MNMK3203409H1
        receiver_name: ACNE SA DE CV
        receiver_tax_fraud_status: NO_TAX_FRAUD_STATUS
        cancelation_status: null
        cancelation_update_date: null
        certification_date: '2020-12-24'
        certification_authority: FGV330542BG6
        payment_type: '04'
        payment_type_description: null
        payment_method: PUE
        usage: G03
        place_of_issue: '11000'
        version: '3.3'
        invoice_details:
          - description: Messaging services.
            product_identification: '78102206'
            quantity: 1
            unit_code: E48
            unit_description: Unidad de servicio
            unit_amount: 25
            pre_tax_amount: 25
            tax_percentage: 16
            tax_amount: 4
            total_amount: 29
            retained_taxes: []
            collected_at: '2022-02-09T08:45:50.406032Z'
        currency: MXN
        subtotal_amount: 25
        exchange_rate: 1
        tax_amount: 4
        discount_amount: 0
        total_amount: 29
        payments: []
        payroll: null
        folio: '28'
        xml: '=XML-STRING='
        warnings:
          code: warning_code
          message: warning message
    InvoicePagoDetail:
      summary: Factura Pago
      description: Ejemplo de una factura de tipo *Pago*.
      value:
        id: 90d90e38-0087-4b6d-b6dc-94ea561bb9cb
        link: 1bd948f7-245d-4313-b604-34d1044cb908
        collected_at: '2022-02-09T08:45:50.406032Z'
        created_at: '2022-02-09T08:46:20.406032Z'
        invoice_identification: 862B9918-3K6H-4E0B-NAI9-2BE2D833B840
        invoice_date: '2020-12-24'
        status: Vigente
        invoice_type: Pago
        type: OUTFLOW
        sender_id: GHTF980303F7
        sender_name: Roberto Martinez Diaz
        sender_tax_fraud_status: NO_TAX_FRAUD_STATUS
        receiver_id: MNMK3203409H1
        receiver_name: ACNE SA DE CV
        receiver_tax_fraud_status: NO_TAX_FRAUD_STATUS
        cancelation_status: null
        cancelation_update_date: null
        certification_date: '2020-12-24'
        certification_authority: FGV330542BG6
        payment_type: null
        payment_type_description: null
        payment_method: null
        usage: P01
        place_of_issue: '11000'
        version: '3.3'
        invoice_details:
          - description: Pago
            product_identification: '84111506'
            quantity: 1
            unit_amount: 0
            unit_code: ACT
            unit_description: null
            pre_tax_amount: 0
            tax_percentage: 0
            tax_amount: 0
            total_amount: 0
            retained_taxes: []
            collected_at: '2022-02-09T08:45:50.406032Z'
        currency: MXN
        subtotal_amount: 0
        exchange_rate: null
        tax_amount: 0
        discount_amount: 0
        total_amount: 0
        payments:
          - date: '2020-03-17T12:00:00.000Z'
            payment_type: '03'
            currency: BRL
            exchange_rate: '3.75'
            amount: 8000.5
            operation_number: '831840'
            beneficiary_rfc: BNM840515VB1
            beneficiary_account_number: '12343453245633'
            payer_rfc: BKJM840515VB1
            payer_account_number: '13343663245699'
            payer_bank_name: CITI BANAMEX
            related_documents:
              - invoice_identification: 7EE015F3-6311-11EA-B02A-00155D014007
                currency: MXN
                payment_method: PPD
                previous_balance: 18877.84
                amount_paid: 8000
                outstanding_balance: 10877.84
        payroll: null
        folio: '28'
        xml: '=XML-STRING='
        warnings:
          code: warning_code
          message: warning message
    InvoiceNominaDetail:
      summary: Factura de Nómina
      description: Ejemplo de una factura de tipo *Nomina*.
      value:
        id: 90d90e38-0087-4b6d-b6dc-94ea561bb9cb
        link: 1bd948f7-245d-4313-b604-34d1044cb908
        collected_at: '2022-02-09T08:45:50.406032Z'
        created_at: '2022-02-09T08:46:20.406032Z'
        invoice_identification: 862B9918-3K6H-4E0B-NAI9-2BE2D833B840
        invoice_date: '2020-12-24'
        status: Vigente
        invoice_type: Nómina
        type: INFLOW
        sender_id: GHTF980303F7
        sender_name: ACNE SA DE CV
        sender_tax_fraud_status: NO_TAX_FRAUD_STATUS
        receiver_id: MNMK3203409H1
        receiver_name: Roberto Martinez Diaz
        receiver_tax_fraud_status: NO_TAX_FRAUD_STATUS
        cancelation_status: null
        cancelation_update_date: null
        certification_date: '2020-12-24'
        certification_authority: FGV330542BG6
        payment_type: '99'
        payment_type_description: null
        payment_method: PUE
        usage: P01
        place_of_issue: '11000'
        version: '3.3'
        invoice_details:
          - description: Payroll payment
            product_identification: '84111505'
            quantity: 1
            unit_code: ACT
            unit_description: null
            unit_amount: 20400.1
            total_amount: 20400.1
            pre_tax_amount: 20400.1
            tax_percentage: 0
            tax_amount: 0
            retained_taxes: []
            collected_at: '2022-02-09T08:45:50.406032Z'
        currency: MXN
        subtotal_amount: 20400.1
        exchange_rate: 1
        tax_amount: 0
        discount_amount: 5000
        total_amount: 15400.1
        payments: []
        payroll:
          days: 30
          type: O
          amount: 20400.1
          date_to: '2020-12-31'
          version: '1.2'
          date_from: '2020-12-01'
          collected_at: '2022-02-09T08:45:50.406032Z'
          payment_date: '2020-12-24'
          periodicity: MONTHLY
          earnings_breakdown:
            - type: SALARY
              taxable_amount: 20400.1
              vat_free_amount: 0
            - type: BONUS
              taxable_amount: 1012.1
              vat_free_amount: 0
          tax_deductions:
            - type: UNION_FEES
              amount: 1505
          other_payments:
            - type: EMPLOYMENT_SUBSIDY
              amount: 1505
        folio: '28'
        xml: '=XML-STRING='
        warnings:
          code: warning_code
          message: warning message
    InvoiceEgresoDetail:
      summary: Factura de Egreso
      description: Ejemplo de una factura de tipo *Egreso*.
      value:
        id: 90d90e38-0087-4b6d-b6dc-94ea561bb9cb
        link: 1bd948f7-245d-4313-b604-34d1044cb908
        collected_at: '2022-02-09T08:45:50.406032Z'
        created_at: '2022-02-09T08:46:20.406032Z'
        invoice_identification: 862B9918-3K6H-4E0B-NAI9-2BE2D833B840
        invoice_date: '2020-12-24'
        status: Vigente
        invoice_type: Egreso
        type: INFLOW
        sender_id: GHTF980303F7
        sender_name: Roberto Martinez Diaz
        sender_tax_fraud_status: NO_TAX_FRAUD_STATUS
        receiver_id: MNMK3203409H1
        receiver_name: ACNE SA DE CV
        receiver_tax_fraud_status: NO_TAX_FRAUD_STATUS
        cancelation_status: null
        cancelation_update_date: null
        certification_date: '2020-12-24'
        certification_authority: FGV330542BG6
        payment_type: '04'
        payment_type_description: null
        payment_method: PUE
        usage: G03
        place_of_issue: '11000'
        version: '3.3'
        invoice_details:
          - product_identification: '78111500'
            description: Service refund
            unit_code: E48
            unit_description: Unidad de servicio
            quantity: 1
            unit_amount: 25
            pre_tax_amount: 25
            tax_percentage: 16
            tax_amount: 4
            total_amount: 29
            retained_taxes: []
            collected_at: '2022-02-09T08:45:50.406032Z'
        currency: MXN
        subtotal_amount: 25
        exchange_rate: 1
        tax_amount: 4
        discount_amount: 0
        total_amount: 29
        payments: []
        payroll: null
        folio: '28'
        xml: '=XML-STRING='
        warnings:
          code: warning_code
          message: warning message
    InvoiceTrasladoDetail:
      summary: Factura de Traslado
      description: Ejemplo de una factura tipo *Traslado*.
      value:
        id: 90d90e38-0087-4b6d-b6dc-94ea561bb9cb
        link: 1bd948f7-245d-4313-b604-34d1044cb908
        collected_at: '2022-02-09T08:45:50.406032Z'
        created_at: '2022-02-09T08:46:20.406032Z'
        invoice_identification: 862B9918-3K6H-4E0B-NAI9-2BE2D833B840
        invoice_date: '2020-12-24'
        status: Vigente
        invoice_type: Traslado
        type: INFLOW
        sender_id: GHTF980303F7
        sender_name: ACNE SA DE CV
        sender_tax_fraud_status: NO_TAX_FRAUD_STATUS
        receiver_id: MNMK3203409H1
        receiver_name: CARGOS S.A. DE C.V.
        receiver_tax_fraud_status: NO_TAX_FRAUD_STATUS
        cancelation_status: null
        cancelation_update_date: null
        certification_date: '2020-12-24'
        certification_authority: FGV330542BG6
        payment_type: null
        payment_type_description: null
        payment_method: null
        usage: G03
        place_of_issue: '11000'
        version: '3.3'
        invoice_details:
          - description: FLETE
            product_identification: '78101802'
            quantity: 1
            unit_code: E48
            unit_description: Unidad de servicio
            unit_amount: 21000
            pre_tax_amount: 21000
            tax_percentage: 16
            tax_amount: 0
            total_amount: 21000
            retained_taxes: []
            collected_at: '2022-02-09T08:45:50.406032Z'
        currency: MXN
        subtotal_amount: 0
        exchange_rate: 1
        tax_amount: 0
        discount_amount: 0
        total_amount: 0
        payments: []
        payroll: null
        folio: '28'
        xml: '=XML-STRING='
        warnings:
          code: warning_code
          message: warning message
    TaxReturnPersonalListPaginated:
      summary: Declaración de impuestos personal
      description: Ejemplo de una lista de declaraciones de impuestos personales
      value:
        count: 101
        next: >-
          https://sandbox.belvo.com/api/{endpoint}/?link=1bd948f7-245d-4313-b604-34d1044cb908page=2
        previous: null
        results:
          - id: 02589c41-ba22-4d44-8558-8111cc751318
            link: 19697249-01b8-443e-a451-76bfc5fbeebf
            collected_at: '2022-02-09T08:45:50.406032Z'
            created_at: '2022-02-09T08:46:20.406032Z'
            informacion_general:
              ejercicio: 2018
              fecha_hora_presentacion: '2020-01-07T17:28:00-05:00'
              numero_operacion: '00000000001'
              periodo_declaracion: Del Ejercicio
              rfc: ABCD111111A11
              tipo_declaracion: Normal
              nombre: JOHN DOE
            sueldos_salarios:
              retenedores:
                - rfc_retenedor: ABCD222222A22
                  nombre_denominacion_razon_social: ACME CORP
                  ingresos_exentos: 118263
                  ingreso_anual: 2265
                  subsidio_empleo: 0
              impuesto_retenido: 19497
              ingreso_anual: 118263
              ingresos_acumulables: 115998
              ingresos_exentos: 2265
              subsidio_empleo: 0
            servicios_profesionales:
              deducciones_autorizadas:
                deducciones_autorizadas: 11870
                otras_deducciones: null
                detalle_deducciones:
                  - tipo_deduccion: GASTOS
                    concepto: GASOLINA Y MANTENIMIENTO DE TRANSPORTE
                    monto_detallado: 9682
                  - tipo_deduccion: GASTOS
                    concepto: COMPRAS Y GASTOS GENERALES
                    monto_detallado: 2188
                total_deducciones_autorizadas: 11870
              ingresos:
                ingresos_acumulables: 46000
                ingresos_exentos: null
                otros_ingresos: null
                total_ingresos: 46000
              resultado_fiscal:
                utilidad_fiscal: 34130
                ptu_pagada_ejercicio: 0
                perdidas_fiscales_ejercicios_anteriores_aplicadas: 0
                utilidad_gravable: 34130
              pagos_provisionales:
                pagos_provisionales_efectuados_en_ejercicio: 0
              retenciones_isr:
                isr_retenido_personas_morales: 4600
            deducciones_personales:
              honorarios_medicos_dentales_hospitalarios:
                - rfc_emisor: ABC333333A33
                  monto_deducible: 258.83
                - rfc_emisor: ABC333333A33
                  monto_deducible: 258.83
                - rfc_emisor: ABC444444A44
                  monto_deducible: 1000
                - rfc_emisor: ABC333333A33
                  monto_deducible: 258.83
                - rfc_emisor: ABC333333A33
                  monto_deducible: 258.83
                - rfc_emisor: ABC333333A33
                  monto_deducible: 258.83
                - rfc_emisor: ABC333333A33
                  monto_deducible: 258.83
                - rfc_emisor: ABC444444A44
                  monto_deducible: 502.34
                - rfc_emisor: ABC333333A33
                  monto_deducible: 258.83
                - rfc_emisor: ABC333333A33
                  monto_deducible: 258.83
                - rfc_emisor: ABC333333A33
                  monto_deducible: 258.83
                - rfc_emisor: ABC444444A55
                  monto_deducible: 14183.1
                - rfc_emisor: ABC444444A66
                  monto_deducible: 1658
                - rfc_emisor: ABC444444A77
                  monto_deducible: 1600
                - rfc_emisor: ABC444444A88
                  monto_deducible: 1064
                - rfc_emisor: ABC444444A99
                  monto_deducible: 927.57
              donativos:
                - rfc_emisor: ABC555555A99
                  monto_deducible: 10.03
              aportaciones_voluntarias_complementarias_al_sar:
                - rfc_emisor: ABC666666A99
                  monto_deducible: 12.03
                - rfc_emisor: ABC777777A99
                  monto_deducible: 87.22
              primas_por_seguros_de_gasto_medico:
                - rfc_emisor: ABC777777A99
                  monto_deducible: 20.03
            determinacion_impuesto:
              base_gravable: 126864
              deducciones_personales: 23264
              ingresos_acumulables: 150128
              isr_favorable: 10308
              isr_conforme_tarifa_final: 13789
              isr_retenido: 24097
              num_clabe: '000000000000000001'
              nombre_banco: BANCO SA
              pagos_provisionales: 0
              titular_clabe_permite_verificacion: SÍ
              accion_saldo_a_favor: DEVOLUCIÓN
            retenciones:
              sueldos_salarios:
                - rfc_retenedor: ABC444444A99
                  monto_retenciones: 118263
                  retenciones_isr: 19497
              dividendos: []
              servicios_profesionales:
                - rfc_retenedor: ABC444444A00
                  monto_retenciones: 46000
                  retenciones_isr: 4600
            dividendos:
              monto_acumulable_dividendos_utilidades: null
              monto_total_isr_pagado_sociedad: null
            datos_informativos:
              credito_fiscal_autorizado_proyectos_investigacion_desarrollo: 0
              credito_fiscal_autorizado_proyectos_apoyo_deporte_alto_rendimiento: 0
              credito_fiscal_autorizado_proyectos_inversion_artes: 0
              credito_fiscal_autorizado_inversion_equipos_fijos: 0
              credito_fiscal_autorizado_produccion_distribucion_cinematografica: 0
              saldo_credito_fiscal_autorizado_anteriores_investigacion_desarrollo: 0
              saldo_credito_fiscal_anteriores_proyectos_inversion_artes: 0
              saldo_credito_fiscal_anteriores_produccion_distribucion_cinematografica: 0
            pdf: '=PDF-STRING='
            receipt_pdf: '=PDF-STRING='
            type: yearly
    TaxReturnPersonalListMonthlyPaginatedPFAE:
      summary: Declaración de Impuestos Personal Mensual (PFAe)
      description: >-
        Ejemplo de una lista de declaraciones mensuales de impuestos personales
        tipo PFAE
      value:
        count: 101
        next: >-
          https://sandbox.belvo.com/api/{endpoint}/?link=1bd948f7-245d-4313-b604-34d1044cb908page=2
        previous: null
        results:
          - collected_at: '2022-02-09T08:45:50.406032Z'
            created_at: '2022-02-09T08:46:20.406032Z'
            informacion_general:
              rfc: null
              nombre: null
              tipo_declaracion: null
              ejercicio: null
              periodo_declaracion: null
              fecha_hora_presentacion: null
              numero_operacion: null
            isr:
              tipo: PFAE
              determinacion:
                ingresos_periodos_anteriores: 0
                ingresos_periodo: 0
                total_ingresos: 0
                compras_gastos_periodos_anteriores: 1596
                compra_gastos_periodo: 399
                total_compras_gastos: 1995
                base_gravable_pago_provisional: 0
                isr_causado: 0
                pagos_provisionales_efectuados_anterioridad: 0
                isr_retenido_periodos_anteriores: 0
                impuesto_retenido: 0
                isr_cargo: 0
              detalle_del_pago:
                a_cargo: 0
                parte_actualizada: 0
                recargos: 0
                total_contribuciones: 0
                total_aplicaciones: 0
                cantidad_a_cargo: 0
                cantidad_a_pagar: 0
            iva:
              determinacion:
                actividades_gravadas_tasa_16: 0
                actividades_gravadas_tasa_0: 0
                actividades_exentas: 0
                iva_cobrado_periodo_tasa_16: 0
                iva_acreditable_periodo: 0
                iva_retenido: 0
                saldo_a_favor: null
                impuesto_a_favor: null
              detalle_del_pago:
                total_contribuciones: 0
                total_aplicaciones: 0
                cantidad_a_cargo: 0
                cantidad_a_pagar: 0
                a_favor: null
            pdf: '===PDF_BINARY===='
            receipt_pdf: '===PDF_BINARY===='
            type: monthly
    TaxReturnPersonalListMonthlyPaginatedPFAI:
      summary: Declaración de Impuestos Personal Mensual (PFAI)
      description: >-
        Ejemplo de una lista de declaraciones de impuestos personales mensuales
        tipo PFAI
      value:
        count: 101
        next: >-
          https://sandbox.belvo.com/api/{endpoint}/?link=1bd948f7-245d-4313-b604-34d1044cb908page=2
        previous: null
        results:
          - collected_at: '2022-02-09T08:45:50.406032Z'
            created_at: '2022-02-09T08:46:20.406032Z'
            informacion_general:
              rfc: null
              nombre: null
              tipo_declaracion: null
              ejercicio: null
              periodo_declaracion: null
              fecha_hora_presentacion: null
              numero_operacion: null
            isr:
              tipo: PFAE
              determinacion:
                ingresos_periodos_anteriores: 0
                ingresos_periodo: 0
                total_ingresos: 0
                compras_gastos_periodos_anteriores: 1596
                compra_gastos_periodo: 399
                total_compras_gastos: 1995
                base_gravable_pago_provisional: 0
                isr_causado: 0
                pagos_provisionales_efectuados_anterioridad: 0
                isr_retenido_periodos_anteriores: 0
                impuesto_retenido: 0
                isr_cargo: 0
                tipo_de_deduccíon: dedduccíon opicional
                optas_por_el_cálculo_acumulado: 'NO'
                deduccíon_opcional: 700
                impuesto_predial: 0
                total_deducciones_autorizadas: 700
                tienes_facilidades_administrativas_o_estímulos_deducibles: 'NO'
              detalle_del_pago:
                a_cargo: 0
                parte_actualizada: 0
                recargos: 0
                total_contribuciones: 0
                total_aplicaciones: 0
                cantidad_a_cargo: 0
                cantidad_a_pagar: 0
            iva:
              determinacion:
                actividades_gravadas_tasa_16: 0
                actividades_gravadas_tasa_0: 0
                actividades_exentas: 0
                iva_cobrado_periodo_tasa_16: 0
                iva_acreditable_periodo: 0
                iva_retenido: 0
                saldo_a_favor: null
                impuesto_a_favor: null
                impuesto_a_cargo: 54
                cantidad_a_cargo: 54
              detalle_del_pago:
                total_contribuciones: 0
                total_aplicaciones: 0
                cantidad_a_cargo: 0
                cantidad_a_pagar: 0
                a_favor: null
            pdf: '===PDF_BINARY===='
            receipt_pdf: '===PDF_BINARY===='
            type: monthly
    TaxReturnBusinessListPaginated:
      summary: Negocio de Declaración de Impuestos
      description: Ejemplo de una lista de declaraciones de impuestos empresariales
      value:
        count: 101
        next: >-
          https://sandbox.belvo.com/api/{endpoint}/?link=1bd948f7-245d-4313-b604-34d1044cb908page=2
        previous: null
        results:
          - id: 02589c41-ba22-4d44-8558-8111cc751318
            link: 19697249-01b8-443e-a451-76bfc5fbeebf
            collected_at: '2022-02-09T08:45:50.406032Z'
            created_at: '2022-02-09T08:46:20.406032Z'
            informacion_general:
              ejercicio: 2018
              fecha_hora_presentacion: '2020-01-07T16:55:00-06:00'
              numero_operacion: '000000000001'
              periodo_declaracion: Del Ejercicio
              rfc: ABC1111111A1
              tipo_declaracion: Normal
              tipo_complementaria: null
              denominacion_razon_social: ACME CORP
            datos_adicionales:
              indica_si_optas_por_dictaminar_tus_estados_financieros: 'NO'
              estas_obligado_a_presentar_la_informacion_sobre_tu_situacion_fiscal: 'NO'
              estas_obligado_unicamente_por_supuesto_distinto_al_de_haber_realizado_operaciones_con_residentes_extranjero: SIN SELECCIÓN
              estas_obligado_unicamente_por_supuesto_distinto_al_de_haber_realizado_operaciones_con_residentes_extranjero_inferiores_100mdp: SIN SELECCIÓN
              optas_por_presentar_informacion_sobre_tu_situacion_fiscal: SIN SELECCIÓN
              indica_si_te_dedicas_exclisivamente_a_generacion_energia_fuentes_renovables_o_cogeneracion_electricidad_eficiente: 'NO'
            estado_resultados:
              ventas_servicios_nacionales:
                partes_relacionadas: null
                partes_no_relacionadas: 911165
                total: 911165
              ventas_servicios_extranjero:
                partes_relacionadas: null
                partes_no_relacionadas: null
                total: null
              devoluciones_descuentos_bonificaciones_ventas_nacionales:
                partes_relacionadas: null
                partes_no_relacionadas: null
                total: null
              devoluciones_descuentos_bonificaciones_ventas_extranjero:
                partes_relacionadas: null
                partes_no_relacionadas: null
                total: null
              ingresos_netos:
                partes_relacionadas: null
                partes_no_relacionadas: 911165
                total: 911165
              inventario_inicial: null
              compras_netas_nacionales:
                partes_relacionadas: null
                partes_no_relacionadas: null
                total: null
              compras_netas_importacion:
                partes_relacionadas: null
                partes_no_relacionadas: null
                total: null
              inventario_final: null
              costo_mercancias: null
              mano_de_obra:
                partes_relacionadas: null
                partes_no_relacionadas: null
                total: null
              maquilas:
                partes_relacionadas: null
                partes_no_relacionadas: null
                total: null
              gastos_indirectos_fabricacion:
                partes_relacionadas: null
                partes_no_relacionadas: null
                total: null
              costo_ventas_servicios: null
              utilidad_bruta: 911165
              perdida_bruta: null
              gastos_operacion:
                partes_relacionadas: null
                partes_no_relacionadas: 499540
                total: 499540
              utilidad_operacion: 411625
              perdida_operacion: null
              intereses_devengados_a_favor_nacionales:
                partes_relacionadas: null
                partes_no_relacionadas: null
                total: null
              intereses_devengados_a_favor_extranjero:
                partes_relacionadas: null
                partes_no_relacionadas: null
                total: null
              intereses_moratorios_a_favor_nacionales:
                partes_relacionadas: null
                partes_no_relacionadas: null
                total: null
              intereses_moratorios_a_favor_extranjero:
                partes_relacionadas: null
                partes_no_relacionadas: null
                total: null
              ganancia_cambiaria:
                partes_relacionadas: null
                partes_no_relacionadas: null
                total: null
              intereses_devengados_a_cargo_nacionales:
                partes_relacionadas: null
                partes_no_relacionadas: null
                total: null
              intereses_devengados_a_cargo_extranjero:
                partes_relacionadas: null
                partes_no_relacionadas: null
                total: null
              intereses_moratorios_a_cargo_nacionales:
                partes_relacionadas: null
                partes_no_relacionadas: null
                total: null
              intereses_moratorios_a_cargo_extranjero:
                partes_relacionadas: null
                partes_no_relacionadas: null
                total: null
              perdida_cambiaria:
                partes_relacionadas: null
                partes_no_relacionadas: null
                total: null
              resultado_posicion_monetaria_favorable:
                partes_relacionadas: null
                partes_no_relacionadas: null
                total: null
              resultado_posicion_monetaria_desfavorable:
                partes_relacionadas: null
                partes_no_relacionadas: null
                total: null
              otras_operaciones_financieras_nacionales:
                partes_relacionadas: null
                partes_no_relacionadas: null
                total: null
              otras_operaciones_financieras_extranjero:
                partes_relacionadas: null
                partes_no_relacionadas: null
                total: null
              otras_operaciones_financieras: null
              resultado_integral_financiamiento: null
              otros_gastos_nacionales: null
              otros_gastos_extranjero: null
              otros_gastos: null
              otros_productos_nacionales: null
              otros_productos_extranjero: null
              otros_productos: null
              ingresos_partidas_discontinuas_extraordinarias: null
              gastos_partidas_discontinuas_extraordinarias: null
              utilidad_antes_impuesto: 411625
              perdida_antes_impuesto: null
              isr: 113002
              ietu: null
              impac: null
              ptu: null
              utilidad_participacion_subsidiaria: null
              perdida_participacion_subsidiaria: null
              efectos_reexpresion_favorables_excepto_resultado_posicion_monetaria: null
              efectos_reexpresion_desfavorables_excepto_resultado_posicion_monetaria: null
              utilidad_neta: 298623
              perdida_neta: null
            estado_posicion_financiera_balance:
              activo:
                efectivo_caja_depositos_instituciones_credito_nacionales: 726644
                efectivo_caja_depositos_instituciones_credito_extranjero: null
                inversiones_valores_instituciones_nacionales_excepto_acciones: null
                inversiones_valores_instituciones_extranjero_excepto_acciones: null
                cuentas_documentos_por_cobrar_nacionales:
                  partes_relacionadas: null
                  partes_no_relacionadas: null
                  total: null
                cuentas_documentos_por_cobrar_extranjero:
                  partes_relacionadas: null
                  partes_no_relacionadas: null
                  total: null
                contribuciones_a_favor: null
                inventarios: null
                otros_activos_circulantes: 13277
                inversiones_en_acciones_nacionales: null
                inversiones_en_acciones_extranjero: null
                inversiones_en_acciones_total: null
                terrenos: null
                construcciones: null
                construcciones_en_proceso: null
                maquinaria_y_equipo: null
                mobiliario_y_equipo_oficina: null
                equipo_de_computo: null
                equipo_de_transporte: null
                otros_activos_fijos: 12756
                depreciacion_acumulada: -106
                cargos_y_gastos_diferidos: 9319
                amortizacion_acumulada: null
                suma_activo: 761890
              pasivo:
                cuentas_documentos_por_pagar_nacionales:
                  partes_relacionadas: null
                  partes_no_relacionadas: 268227
                  total: 268227
                cuentas_documentos_por_pagar_extranjero:
                  partes_relacionadas: null
                  partes_no_relacionadas: null
                  total: null
                contribuciones_por_pagar: 223490
                anticipos_de_clientes:
                  partes_relacionadas: null
                  partes_no_relacionadas: null
                  total: null
                aportaciones_futuros_aumentos_de_capital: null
                otros_pasivos: null
                suma_pasivo: 491717
              capital_contable:
                capital_social_proveniente_aportaciones: 10000
                capital_social_proveniente_capitalizacion: null
                reservas: null
                otras_cuentas_capital: null
                aportaciones_futuros_aumentos_de_capital: null
                utilidades_acumuladas: null
                utilidad_del_ejercicio: 298623
                perdidas_acumuladas: -38450
                perdida_del_ejercicio: null
                exceso_en_actualizacion_capital: null
                insuficiencia_en_actualizacion_capital: null
                actualizacion_del_capital_contable: null
                suma_capital_contable: 270173
                suma_pasivo_mas_capital_contable: 761890
            conciliacion_entre_resultado_contable_fiscal:
              utilidad_o_perdida_neta: 298623
              efectos_reexpresion: null
              resultado_posicion_monetaria: null
              utilidad_o_perdida_neta_historica: 298623
              ingresos_fiscales_no_contables: 95
              ajuste_anual_inflacion_acumulable: 95
              anticipos_de_clientes: null
              intereses_moratorios_efectivamente_cobrados: null
              ganancia_en_enajenacion_acciones_por_reembolso_capital: null
              ganancia_en_enajenacion_de_terrenos_y_activo_fijo: null
              inventario_acumulable_del_ejercicio: null
              otros_ingresos_fiscales_no_contables: null
              deducciones_contables_no_fiscales: 117415
              costo_de_ventas_contable: null
              depreciacion_y_amortizacion_contable: 106
              gastos_que_no_reunen_requisitos_fiscales: 4307
              isr_ietu_impac_ptu: 113002
              perdida_contable_enajenacion_de_acciones: null
              perdida_contable_enajenacion_de_activo_fijo: null
              perdida_en_participacion_subsidiaria: null
              intereses_devengados_que_exceden_valor_mercado_y_moratorios_pagados_o_no: 0
              otras_deducciones_contables_no_fiscales: 0
              deducciones_fiscales_no_contables: 0
              ajuste_anual_inflacion_deducible: null
              costo_vendido_fiscal: null
              deduccion_inversiones: null
              estimulo_fiscal_por_deduccion_inmediata_inversiones: null
              donacion_bienes_basicos_subsistencia_humana: 0
              estimulo_fiscal_contratacion_personas_discapacidad_yo_mayores: 0
              deduccion_impuesto_sobre_renta_retenido_personas_discapacidad_yo_mayores: 0
              perdida_fiscal_en_enajenacion_acciones: null
              perdida_fiscal_en_enajenacion_de_terrenos_y_activo_fijo: null
              intereses_moratorios_efectivamente_pagados: null
              otras_deducciones_fiscales_no_contables: null
              ingresos_contables_no_fiscales: null
              intereses_moratorios_devengados_a_favor_cobrados_o_no: null
              anticipos_de_clientes_ejercicios_anteriores: null
              saldos_a_favor_impuestos_y_su_actualizacion: null
              utilidad_contable_enajenacion_de_activo_fijo: null
              utilidad_contable_enajenacion_de_acciones: null
              utilidad_en_participacion_subsidiaria: null
              otros_ingresos_contables_no_fiscales: null
              utilidad_o_perdida_fiscal_antes_de_ptu: 416133
            deducciones_autorizadas:
              sueldos_salarios: null
              honorarios_pagados_a_personas_fisicas: null
              regalias_y_asistencia_tecnica: null
              donativos_otorgados: null
              uso_o_goce_temporal_de_bienes_pagados_a_personas_fisicas: null
              fletes_y_acarreos_pagados_a_parsonas_fisicas: null
              contribuciones_pagadas_excepto_isr_ietu_impac_iva_ieps: null
              seguros_fianzas: null
              perdida_por_creditos_incobrables: null
              viaticos_y_gastos_viaje: 59527
              combustible_y_lubricantes: null
              credito_al_salario_no_disminuido_de_contribuciones: null
              aportaciones_sar_infonavit_y_jubilaciones_vejez: null
              aportaciones_para_fondos_de_pensiones_y_jubilaciones: null
              cuotas_imss: null
              consumos_en_restaurantes: 11254
              perdida_por_operaciones_financieras_derivadas: null
              deduccion_por_concepto_de_ayuda_alimentaria_para_trabajadores: null
              monto_total_pagos_que_sean_ingresos_exentos_para_trabajador: null
              monto_deducible_al_47_pagos_son_ingresos_exentos_para_trabajador: null
              monto_deducible_al_53_pagos_son_ingresos_exentos_para_trabajador: null
              uso_o_goce_temporal_de_automoviles_baterias_electricas_o_electricos_con_motor_combustion_o_hidrogeno: null
              otras_deducciones_autorizadas: 424346
              total_deducciones_autorizadas: 495127
            cifras_cierre_ejercicio:
              perdidas_fiscales_de_ejercicios_anteriores_pendientes_de_amortizar_actualiazadas: null
              saldo_promedio_anual_de_creditos: 142795
              saldo_promedio_anual_de_deudas: 144765
              coeficiente_de_utilidad_por_aplicar_en_ejercicio_siguiente: 0.4567
              porcentaje_de_participacion_consolidable: null
              isr_causado_en_exceso_del_impac_en_los_3_ejercicios_anteriores_pendientes_aplicar: null
              saldo_actualizado_de_cuenta_de_utilidad_fiscal_neta_2013_y_anteriores: null
              saldo_actualizado_de_cuenta_de_utilidad_fiscal_neta_a_partir_2014_y_anteriores: null
              saldo_actualizado_de_cuenta_de_utilidad_fiscal_reinvertida: null
              saldo_actualizado_de_cuenta_de_capital_de_aportacion: null
              saldo_de_cuenta_de_utilidad_fiscal_neta_por_inversion_en_renovables: null
            determinacion_del_impuesto_sobre_la_renta:
              determinacion_del_impuesto_sobre_la_renta:
                total_ingresos_acumulables: 911260
                total_deducciones_autorizadas_y_deduccion_inmediata_inversiones: 495126
                deduccion_adicional_por_pago_servicios_personales_en_operacion_maquila: null
                utilidad_o_perdida_fiscal_antes_de_ptu: 416134
                ptu_pagada_en_el_ejercicio: null
                utilidad_fiscal_del_ejercicio: 416134
                perdidas_fiscales_de_ejercicios_anteriores_que_se_aplican_en_ejercicio: 39462
                resultado_fiscal: 376672
                impuesto_causado_en_ejercicio: 113002
                tienes_estimulos_fiscales_a_acreditar: SIN SELECCIÓN
                impuesto_sobre_la_renta_del_ejercicio: 113002
                pagos_provisionales_efectuados_enterados_a_federacion: null
                impuesto_retenido_al_contribuyente: null
                impuesto_acreditable_pagado_en_extranjero: null
                impuesto_acreditable_por_dividendos_o_utilidades_distribuidos: null
                otras_cantidades_a_cargo: null
                otras_cantidades_a_favor: null
                diferencia_a_cargo: 113002
                isr_a_cargo_del_ejercicio: 113002
                isr_a_favor_del_ejercicio: null
              impuesto_sobre_ingresos_sujetos_a_regimenes_fiscales_preferentes: null
              datos_informativos_ejercicio:
                monto_aplicado_del_estimulo_fiscal_de_chatarrizacion: 0
                monto_deducible_de_pagos_efectuados_por_uso_o_goce_temporal_automoviles: 0
                impac_recuperado_en_ejercicio_derivado_de_deconsolidacion: 0
                ingresos_obtenidos_por_apoyos_gubernamentales: 0
                gastos_realidados_en_ejercicio_por_proyectos_en_investigacion_desarrollo_tecnologico: 0
                credito_fiscal_autorizado_en_ejercicio_por_proyectos_en_investigacion_desarrollo_tecnologico_pendiente_aplicar: 0
                credito_fiscal_autorizado_en_ejercicio_por_proyectos_de_inversion_en_artes_pendiente_aplicar: 0
                credito_fiscal_autorizado_en_ejercicio_por_inversion_en_proyectos_programas_para_deporte_de_alto_rendimiento_pendiente_aplicar: 0
                saldo_pendiente_aplicar_por_inversion_en_equipos_de_alimentacion_vehiculos_electricos: 0
                credito_fiscal_autorizado_en_ejercicio_a_produccion_distribucion_cinematografica_nacional_pendiente_aplicar: 0
              datos_informativos_ejercicios_anteriores_aplicados_en_ejercicio:
                total_estimulo_produccion_y_distribucion_cinematografica_nacional_ejercicios_anteriores_aplicado_en_ejercicio: null
                saldo_credito_fiscal_autorizado_ejercicios_anteriores_por_inversion_en_proyectos_programas_para_deporte_alto_rendimiento_pendiente_aplicar: 0
                saldo_credito_fiscal_autorizado_ejercicios_anteriores_por_proyectos_investigacion_desarrollo_tecnologico_pendiente_aplicar: 0
                saldo_credito_fiscal_autorizado_ejercicios_anteriores_por_proyectos_inversion_artes_pendiente_aplicar: 0
                saldo_credito_fiscal_autorizado_ejercicios_anteriores_a_produccion_distribucion_nacional_pendiente_aplicar: 0
            dividendos_o_utilidades_distribuidos:
              provenientes_de_cuenta_de_utilidad_fisica_neta_cufin_generada_en_2013_y_anteriores: null
              provenientes_de_cuenta_de_utilidad_fisica_neta_cufin_generada_a_partir_de_2014: null
              provenientes_de_cuenta_de_utilidad_fisica_neta_reinvertida_cufinre: null
              no_provenientes_de_cufin_ni_cufinre_en_efectivo: null
              no_provenientes_de_cufin_ni_cufinre_en_acciones: null
              monto_del_impuesto_pagado_no_proveniente_de_cufin_ni_cufinre: null
              monto_del_impuesto_pagado_de_utilidades_provenientes_de_cufinre: null
              provenientes_de_cuenta_de_utilidad_fiscal_neta_por_inversion_en_energia_de_fuentes_renovables_o_sistemas_cogeneracion_electricidad_eficiente: null
            detalle_pago_r1_isr_personas_morales:
              a_cargo: 113002
              parte_actualizada: null
              recargos: null
              multa_por_correccion: null
              total_contribuciones: 113002
              desea_aplicar_alguna_compensacion_o_estimulo: 'NO'
              cantidad_a_cargo: 113002
              opta_por_pagar_parcialidades: SIN SELECCIÓN
              importe_de_primera_parcialidad: null
              importe_sin_primera_parcialidad: null
              cantidad_a_favor: null
              cantidad_a_pagar: 113002
            pdf: '=PDF-STRING='
            receipt_pdf: '=PDF-STRING='
            type: yearly
    TaxReturnBusinessListMonthlyPaginated:
      summary: Declaración de Impuestos Empresarial Mensual
      description: Ejemplo de una lista de declaraciones de impuestos comerciales mensuales
      value:
        count: 101
        next: >-
          https://sandbox.belvo.com/api/{endpoint}/?link=1bd948f7-245d-4313-b604-34d1044cb908page=2
        previous: null
        results:
          - collected_at: '2022-02-09T08:45:50.406032Z'
            created_at: '2022-02-09T08:46:20.406032Z'
            informacion_general:
              rfc: DPA950805RR2
              denominacion_razon_social: Aloha Mahalo SC
              tipo_declaracion: Normal
              ejercicio: 2020
              periodo_declaracion: Diciembre
              fecha_hora_presentacion: '2021-01-18T19:24:00-06:00'
              numero_operacion: '400475119'
              tipo_complementaria: null
            determinacion_isr:
              personas_morales_regimen_general:
                suma_ingresos_nominales_meses_anteriores_ejercicio: 69848414
                estimulos_acreditables: null
                ingresos_nominales_mes_que_declara: 6482479
                reducciones: null
                total_ingresos_nominales: 76330893
                impuestos_del_periodo: 284098
                coeficiente_utilidad: 0.2318
                pagos_provisionales_efectuados_anterioridad: 303039
                utilidad_fiscal_pago_provisional: 17693501
                impuesto_retenido: 29925
                ptu: null
                otras_cantidades_a_cargo_contribuyente: null
                iventario_acumulable: null
                otras_cantidades_a_favor_contribuyente: null
                anticipos_rendimientos_distribuidos_periodo: 16746509
                diferencia_a_cargo: 0
                perdidas_fiscales_ejercicios_anteriores_pendientes: null
                estimulo_fiscal_deduccion_inmediata: null
                impuesto_correspondiente_participacion_consolidable: null
                deduccion_adicional_fomento_primer_empleo: null
                porcentaje_participacion_consolidable: null
                base_gravable_pago_provisional: 946992
                impuesto_a_cargo: 0
                isr_causado: 284098
                ieps_alcohol: null
            detalle_pago_isr:
              r1_isr_personas_morales:
                a_cargo: 0
                acreditamiento_sorteo_buen_fin: null
                parte_actualizada: null
                diesel_marino: null
                recargos: null
                total_aplicaciones: 0
                multa_por_correccion: null
                fecha_pago_realizado_anterioridad: null
                total_de_contribuciones: 0
                monto_pagado_anterioridad: null
                credito_al_salario: null
                importe_pagado_ultimas_48_hrs: null
                subsidio_empleo: null
                cantidad_a_cargo: 0
                impuesto_a_depositos_efectivo_acreditable: null
                aplica_primera_parcialidad: 'NO'
                compensaciones: null
                credito_ieps_diesel: null
                diesel_automotriz_transporte: null
                cantidad_a_favor: null
                uso_infraestructura_carretera_cuota: null
                cantidad_a_pagar: 0
                otros_estimulos: null
                importe_1ra_parcialidad: null
                importe_sin_1ra_parcialidad: null
              r12_isr_retenciones_por_salarios:
                a_cargo: 415945
                acreditamiento_sorteos: null
                parte_actualizada: 0
                diesel_marino: null
                recargos: 0
                total_aplicaciones: 379
                multa_por_correccion: null
                fecha_pago_realizado_anterioridad: null
                total_de_contribuciones: 415945
                monto_pagado_anterioridad: null
                credito_al_salario: null
                importe_pagado_ultimas_48_hrs: null
                subsidio_empleo: 379
                cantidad_a_cargo: 415566
                impuesto_a_depositos_efectivo_acreditable: null
                aplica_primera_parcialidad: 'NO'
                compensaciones: null
                credito_ieps_diesel: null
                diesel_automotriz_transporte: null
                cantidad_a_favor: null
                otros_estimulos: null
                cantidad_a_pagar: 415566
                importe_1ra_parcialidad: null
                importe_sin_1ra_parcialidad: null
              r13_isr_retenciones_por_asimilados_a_salarios:
                a_cargo: 254588
                acreditamiento_sorteos: null
                parte_actualizada: 0
                diesel_marino: null
                recargos: 0
                total_aplicaciones: 0
                multa_por_correccion: null
                fecha_pago_realizado_anterioridad: null
                total_de_contribuciones: 254588
                monto_pagado_anterioridad: null
                credito_al_salario: null
                importe_pagado_ultimas_48_hrs: null
                subsidio_empleo: null
                cantidad_a_cargo: 254588
                impuesto_a_depositos_efectivo_acreditable: null
                aplica_primera_parcialidad: 'NO'
                compensaciones: null
                credito_ieps_diesel: null
                diesel_automotriz_transporte: null
                cantidad_a_favor: null
                otros_estimulos: null
                cantidad_a_pagar: 254588
                importe_1ra_parcialidad: null
                importe_sin_1ra_parcialidad: null
              r14_isr_retenciones_por_servicios_profesionales:
                a_cargo: 104482
                acreditamiento_sorteos: null
                parte_actualizada: 0
                diesel_marino: null
                recargos: 0
                total_aplicaciones: 0
                multa_por_correccion: null
                fecha_pago_realizado_anterioridad: null
                total_de_contribuciones: 104482
                monto_pagado_anterioridad: null
                credito_al_salario: null
                importe_pagado_ultimas_48_hrs: null
                subsidio_empleo: null
                cantidad_a_cargo: 104482
                impuesto_a_depositos_efectivo_acreditable: null
                aplica_primera_parcialidad: 'NO'
                compensaciones: null
                credito_ieps_diesel: null
                diesel_automotriz_transporte: null
                cantidad_a_favor: null
                otros_estimulos: null
                cantidad_a_pagar: 104482
                importe_1ra_parcialidad: null
                importe_sin_1ra_parcialidad: null
            determinacion_iva:
              montos_actos_actividades_pagados:
                total_actos_actividades_pagados_tasa_16: 2094706
                total_actos_actividades_pagados_importacion_bienes_tasa_11: null
                total_actos_actividades_sujetos_estimulo_rfn: 0
                total_actos_actividades_pagados_tasa_0: 0
                total_actos_actividades_pagados_importacion_bienes_tasa_16: null
                total_actos_actividades_pagados_no_paga_iva: 0
              detalle_total_actos_actividades_pagados_tasa_16:
                intereses_pagados_tasa_16: null
                otros_actos_pagados_tasa_16: 2094706
                regalias_pagadas_tasa_16: null
                total_actos_pagados_tasa_16: 2094706
              determinacion_iva_acreditable:
                total_iva_actos_actividades_pagados_tasa_16: 335153
                iva_trasladado_o_pagado_adquisicion_bienes_distintos_inversiones_actos_no_obligados_pago_impuesto: null
                iva_pagado_sujeto_estimulo_rfn: null
                iva_trasladado_o_pagado_importacion_inversiones_actos_no_obligados_pago_impuesto: null
                total_actos_actividades_pagados_importacion_bienes_tasa_16: 0
                iva_bienes_utilizados_indistintamente_actos_gravados_o_actos_no_obligados_pago_impuesto: 0
                proporcion_utilizada_conforme_art_5: null
                total_iva_trasladado_contribuyente: 335153
                proporcion_utilizada_conforme_art_5_b: null
                iva_trasladado_adquisicion_bienes_distintos_inversiones_actos_gravados: 335153
                iva_pagado_importacion_adquisicion_bienes_distintos_inversiones_actos_gravados: null
                iva_acreditable: 335153
                monto_acreditable_actualizado_a_incrementar_derivado_ajuste: null
                iva_pagado_importacion_inversiones_actos_gravados: null
                total_iva_acreditable_periodo: 335153
                total_iva_actos_actividades_gravados: 335153
                total_actos_actividades_pagados_importacion_bienes_tasa_11: null
                iva_trasladado_adquisicion_inversiones_actos_gravados: null
                iva_acreditable_bienes_utilizados_indistintamente_actos_gravados_o_actos_no_obligados_pago_impuesto: null
              determinacion_iva:
                valor_actos_actividades_gravados_tasa_16: 6457950
                otras_cantidades_a_favor_contribuyente: null
                valor_actos_actividades_gravados_tasa_11: null
                cantidad_a_cargo: 312421
                valor_actos_actividades_gravados_tasa_0_exportacion: null
                saldo_a_favor: null
                valor_actos_actividades_gravados_tasa_9_otros: null
                devolucion_inmediata_obtenida: null
                suma_actos_actividades_gravados: 6457950
                saldo_a_favor_periodo: 0
                valor_actos_actividades_no_se_deba_pagar_impuesto_exentos: null
                acreditamiento_saldo_favor_periodos_anteriores: null
                impuesto_causado: 1033272
                diferencia_a_cargo: 312421
                cantidad_actualizada_a_reintegrarse_derivada_de_ajuste: null
                ieps_acreditable_alcohol: null
                iva_retenido_al_contribuyente: 385698
                impuesto_a_cargo: 312421
                total_iva_acreditable: 335153
                remanente_saldo_favor_ieps_alcohol: null
                otras_cantidades_a_cargo_contribuyente: null
              detalle_valor_actos_actividades_gravados_tasa_16:
                intereses_cobrados_tasa_16: null
                otros_actos_actividades_gravados_tasa_16: 6457950
                regalias_entre_partes_relacionadas_tasa_16: null
                total_actos_actividades_gravados_tasa_16: 6457950
            detalle_pago_iva:
              r21_iva:
                a_cargo: 312421
                cretificados_tesofe: null
                a_favor: null
                diesel_marino: null
                parte_actualizada: 0
                total_aplicaciones: 0
                recargos: 0
                fecha_pago_realizado_anterioridad: null
                multa_por_correccion: null
                monto_pagado_anterioridad: null
                total_de_contribuciones: 312421
                importe_pagado_ultimas_48_hrs: null
                credito_al_salario: null
                cantidad_a_cargo: 312421
                subsidio_empleo: null
                aplica_primera_parcialidad: 'NO'
                compensaciones: null
                diesel_automotriz_transporte: null
                uso_infraestructura_carretera_cuota: null
                cantidad_a_favor: null
                otros_estimulos: null
                cantidad_a_pagar: 312421
                importe_1ra_parcialidad: null
                importe_sin_1ra_parcialidad: null
              r21_iva_retenciones:
                a_cargo: 111448
                diesel_marino: null
                parte_actualizada: 0
                total_aplicaciones: 0
                recargos: 0
                fecha_pago_realizado_anterioridad: null
                multa_por_correccion: null
                monto_pagado_anterioridad: null
                total_de_contribuciones: 111448
                importe_pagado_ultimas_48_hrs: null
                credito_al_salario: null
                cantidad_a_cargo: 111448
                subsidio_empleo: null
                aplica_primera_parcialidad: 'NO'
                compensaciones: null
                credito_ieps_diesel: null
                otros_estimulos: null
                cantidad_a_favor: null
                cretificados_tesofe: null
                cantidad_a_pagar: 111448
                importe_1ra_parcialidad: null
                importe_sin_1ra_parcialidad: null
            pdf: '===PDF_BINARY===='
            receipt_pdf: '===PDF_BINARY===='
            type: monthly
    TaxReturnPersonalList:
      summary: Anual Personal
      description: Ejemplo de una lista de declaraciones de impuestos personales
      value:
        - id: 02589c41-ba22-4d44-8558-8111cc751318
          link: 19697249-01b8-443e-a451-76bfc5fbeebf
          collected_at: '2022-02-09T08:45:50.406032Z'
          created_at: '2022-02-09T08:46:20.406032Z'
          informacion_general:
            ejercicio: 2018
            fecha_hora_presentacion: '2020-01-07T17:28:00-05:00'
            numero_operacion: '00000000001'
            periodo_declaracion: Del Ejercicio
            rfc: ABCD111111A11
            tipo_declaracion: Normal
            nombre: JOHN DOE
          sueldos_salarios:
            retenedores:
              - rfc_retenedor: ABCD222222A22
                nombre_denominacion_razon_social: ACME CORP
                ingresos_exentos: 118263
                ingreso_anual: 2265
                subsidio_empleo: 0
            impuesto_retenido: 19497
            ingreso_anual: 118263
            ingresos_acumulables: 115998
            ingresos_exentos: 2265
            subsidio_empleo: 0
          servicios_profesionales:
            deducciones_autorizadas:
              deducciones_autorizadas: 11870
              otras_deducciones: null
              detalle_deducciones:
                - tipo_deduccion: GASTOS
                  concepto: GASOLINA Y MANTENIMIENTO DE TRANSPORTE
                  monto_detallado: 9682
                - tipo_deduccion: GASTOS
                  concepto: COMPRAS Y GASTOS GENERALES
                  monto_detallado: 2188
              total_deducciones_autorizadas: 11870
            ingresos:
              ingresos_acumulables: 46000
              ingresos_exentos: null
              otros_ingresos: null
              total_ingresos: 46000
            resultado_fiscal:
              utilidad_fiscal: 34130
              ptu_pagada_ejercicio: 0
              perdidas_fiscales_ejercicios_anteriores_aplicadas: 0
              utilidad_gravable: 34130
            pagos_provisionales:
              pagos_provisionales_efectuados_en_ejercicio: 0
            retenciones_isr:
              isr_retenido_personas_morales: 4600
          deducciones_personales:
            honorarios_medicos_dentales_hospitalarios:
              - rfc_emisor: ABC333333A33
                monto_deducible: 258.83
              - rfc_emisor: ABC333333A33
                monto_deducible: 258.83
              - rfc_emisor: ABC444444A44
                monto_deducible: 1000
              - rfc_emisor: ABC333333A33
                monto_deducible: 258.83
              - rfc_emisor: ABC333333A33
                monto_deducible: 258.83
              - rfc_emisor: ABC333333A33
                monto_deducible: 258.83
              - rfc_emisor: ABC333333A33
                monto_deducible: 258.83
              - rfc_emisor: ABC444444A44
                monto_deducible: 502.34
              - rfc_emisor: ABC333333A33
                monto_deducible: 258.83
              - rfc_emisor: ABC333333A33
                monto_deducible: 258.83
              - rfc_emisor: ABC333333A33
                monto_deducible: 258.83
              - rfc_emisor: ABC444444A55
                monto_deducible: 14183.1
              - rfc_emisor: ABC444444A66
                monto_deducible: 1658
              - rfc_emisor: ABC444444A77
                monto_deducible: 1600
              - rfc_emisor: ABC444444A88
                monto_deducible: 1064
              - rfc_emisor: ABC444444A99
                monto_deducible: 927.57
            donativos:
              - rfc_emisor: ABC555555A99
                monto_deducible: 10.03
            aportaciones_voluntarias_complementarias_al_sar:
              - rfc_emisor: ABC666666A99
                monto_deducible: 12.03
              - rfc_emisor: ABC777777A99
                monto_deducible: 87.22
            primas_por_seguros_de_gasto_medico:
              - rfc_emisor: ABC777777A99
                monto_deducible: 20.03
          determinacion_impuesto:
            base_gravable: 126864
            deducciones_personales: 23264
            ingresos_acumulables: 150128
            isr_favorable: 10308
            isr_conforme_tarifa_final: 13789
            isr_retenido: 24097
            num_clabe: '000000000000000001'
            nombre_banco: BANCO SA
            pagos_provisionales: 0
            titular_clabe_permite_verificacion: SÍ
            accion_saldo_a_favor: DEVOLUCIÓN
          retenciones:
            sueldos_salarios:
              - rfc_retenedor: ABC444444A99
                monto_retenciones: 118263
                retenciones_isr: 19497
            dividendos: []
            servicios_profesionales:
              - rfc_retenedor: ABC444444A00
                monto_retenciones: 46000
                retenciones_isr: 4600
          dividendos:
            monto_acumulable_dividendos_utilidades: null
            monto_total_isr_pagado_sociedad: null
          datos_informativos:
            credito_fiscal_autorizado_proyectos_investigacion_desarrollo: 0
            credito_fiscal_autorizado_proyectos_apoyo_deporte_alto_rendimiento: 0
            credito_fiscal_autorizado_proyectos_inversion_artes: 0
            credito_fiscal_autorizado_inversion_equipos_fijos: 0
            credito_fiscal_autorizado_produccion_distribucion_cinematografica: 0
            saldo_credito_fiscal_autorizado_anteriores_investigacion_desarrollo: 0
            saldo_credito_fiscal_anteriores_proyectos_inversion_artes: 0
            saldo_credito_fiscal_anteriores_produccion_distribucion_cinematografica: 0
          pdf: '=PDF-STRING='
          receipt_pdf: '=PDF-STRING='
    TaxReturnPersonalListMonthlyPFAE:
      summary: Mensual Personal (PFAE)
      description: Ejemplo de una declaración de impuestos personal mensual tipo PFAE
      value:
        - collected_at: '2022-02-09T08:45:50.406032Z'
          created_at: '2022-02-09T08:46:20.406032Z'
          informacion_general:
            rfc: null
            nombre: null
            tipo_declaracion: null
            ejercicio: null
            periodo_declaracion: null
            fecha_hora_presentacion: null
            numero_operacion: null
          isr:
            tipo: PFAE
            determinacion:
              ingresos_periodos_anteriores: 0
              ingresos_periodo: 0
              total_ingresos: 0
              compras_gastos_periodos_anteriores: 1596
              compra_gastos_periodo: 399
              total_compras_gastos: 1995
              base_gravable_pago_provisional: 0
              isr_causado: 0
              pagos_provisionales_efectuados_anterioridad: 0
              isr_retenido_periodos_anteriores: 0
              impuesto_retenido: 0
              isr_cargo: 0
            detalle_del_pago:
              a_cargo: 0
              parte_actualizada: 0
              recargos: 0
              total_contribuciones: 0
              total_aplicaciones: 0
              cantidad_a_cargo: 0
              cantidad_a_pagar: 0
          iva:
            determinacion:
              actividades_gravadas_tasa_16: 0
              actividades_gravadas_tasa_0: 0
              actividades_exentas: 0
              iva_cobrado_periodo_tasa_16: 0
              iva_acreditable_periodo: 0
              iva_retenido: 0
              saldo_a_favor: null
              impuesto_a_favor: null
            detalle_del_pago:
              total_contribuciones: 0
              total_aplicaciones: 0
              cantidad_a_cargo: 0
              cantidad_a_pagar: 0
              a_favor: null
          pdf: '===PDF_BINARY===='
          receipt_pdf: '===PDF_BINARY===='
          type: monthly
    TaxReturnPersonalListMonthlyPFAI:
      summary: Mensual Personal (PFAI)
      description: Ejemplo de una declaración de impuestos personales mensual tipo PFAI
      value:
        - collected_at: '2022-02-09T08:45:50.406032Z'
          created_at: '2022-02-09T08:46:20.406032Z'
          informacion_general:
            rfc: null
            nombre: null
            tipo_declaracion: null
            ejercicio: null
            periodo_declaracion: null
            fecha_hora_presentacion: null
            numero_operacion: null
          isr:
            tipo: PFAE
            determinacion:
              ingresos_periodos_anteriores: 0
              ingresos_periodo: 0
              total_ingresos: 0
              compras_gastos_periodos_anteriores: 1596
              compra_gastos_periodo: 399
              total_compras_gastos: 1995
              base_gravable_pago_provisional: 0
              isr_causado: 0
              pagos_provisionales_efectuados_anterioridad: 0
              isr_retenido_periodos_anteriores: 0
              impuesto_retenido: 0
              isr_cargo: 0
              tipo_de_deduccíon: dedduccíon opicional
              optas_por_el_cálculo_acumulado: 'NO'
              deduccíon_opcional: 700
              impuesto_predial: 0
              total_deducciones_autorizadas: 700
              tienes_facilidades_administrativas_o_estímulos_deducibles: 'NO'
            detalle_del_pago:
              a_cargo: 0
              parte_actualizada: 0
              recargos: 0
              total_contribuciones: 0
              total_aplicaciones: 0
              cantidad_a_cargo: 0
              cantidad_a_pagar: 0
          iva:
            determinacion:
              actividades_gravadas_tasa_16: 0
              actividades_gravadas_tasa_0: 0
              actividades_exentas: 0
              iva_cobrado_periodo_tasa_16: 0
              iva_acreditable_periodo: 0
              iva_retenido: 0
              saldo_a_favor: null
              impuesto_a_favor: null
              impuesto_a_cargo: 54
              cantidad_a_cargo: 54
            detalle_del_pago:
              total_contribuciones: 0
              total_aplicaciones: 0
              cantidad_a_cargo: 0
              cantidad_a_pagar: 0
              a_favor: null
          pdf: '===PDF_BINARY===='
          receipt_pdf: '===PDF_BINARY===='
          type: monthly
    TaxReturnBusinessList:
      summary: Anual de Negocios
      description: Ejemplo de una lista de declaraciones de impuestos empresariales
      value:
        - id: 02589c41-ba22-4d44-8558-8111cc751318
          link: 19697249-01b8-443e-a451-76bfc5fbeebf
          collected_at: '2022-02-09T08:45:50.406032Z'
          created_at: '2022-02-09T08:46:20.406032Z'
          informacion_general:
            ejercicio: 2018
            fecha_hora_presentacion: '2020-01-07T16:55:00-06:00'
            numero_operacion: '000000000001'
            periodo_declaracion: Del Ejercicio
            rfc: ABC1111111A1
            tipo_declaracion: Normal
            tipo_complementaria: null
            denominacion_razon_social: ACME CORP
          datos_adicionales:
            indica_si_optas_por_dictaminar_tus_estados_financieros: 'NO'
            estas_obligado_a_presentar_la_informacion_sobre_tu_situacion_fiscal: 'NO'
            estas_obligado_unicamente_por_supuesto_distinto_al_de_haber_realizado_operaciones_con_residentes_extranjero: SIN SELECCIÓN
            estas_obligado_unicamente_por_supuesto_distinto_al_de_haber_realizado_operaciones_con_residentes_extranjero_inferiores_100mdp: SIN SELECCIÓN
            optas_por_presentar_informacion_sobre_tu_situacion_fiscal: SIN SELECCIÓN
            indica_si_te_dedicas_exclisivamente_a_generacion_energia_fuentes_renovables_o_cogeneracion_electricidad_eficiente: 'NO'
          estado_resultados:
            ventas_servicios_nacionales:
              partes_relacionadas: null
              partes_no_relacionadas: 911165
              total: 911165
            ventas_servicios_extranjero:
              partes_relacionadas: null
              partes_no_relacionadas: null
              total: null
            devoluciones_descuentos_bonificaciones_ventas_nacionales:
              partes_relacionadas: null
              partes_no_relacionadas: null
              total: null
            devoluciones_descuentos_bonificaciones_ventas_extranjero:
              partes_relacionadas: null
              partes_no_relacionadas: null
              total: null
            ingresos_netos:
              partes_relacionadas: null
              partes_no_relacionadas: 911165
              total: 911165
            inventario_inicial: null
            compras_netas_nacionales:
              partes_relacionadas: null
              partes_no_relacionadas: null
              total: null
            compras_netas_importacion:
              partes_relacionadas: null
              partes_no_relacionadas: null
              total: null
            inventario_final: null
            costo_mercancias: null
            mano_de_obra:
              partes_relacionadas: null
              partes_no_relacionadas: null
              total: null
            maquilas:
              partes_relacionadas: null
              partes_no_relacionadas: null
              total: null
            gastos_indirectos_fabricacion:
              partes_relacionadas: null
              partes_no_relacionadas: null
              total: null
            costo_ventas_servicios: null
            utilidad_bruta: 911165
            perdida_bruta: null
            gastos_operacion:
              partes_relacionadas: null
              partes_no_relacionadas: 499540
              total: 499540
            utilidad_operacion: 411625
            perdida_operacion: null
            intereses_devengados_a_favor_nacionales:
              partes_relacionadas: null
              partes_no_relacionadas: null
              total: null
            intereses_devengados_a_favor_extranjero:
              partes_relacionadas: null
              partes_no_relacionadas: null
              total: null
            intereses_moratorios_a_favor_nacionales:
              partes_relacionadas: null
              partes_no_relacionadas: null
              total: null
            intereses_moratorios_a_favor_extranjero:
              partes_relacionadas: null
              partes_no_relacionadas: null
              total: null
            ganancia_cambiaria:
              partes_relacionadas: null
              partes_no_relacionadas: null
              total: null
            intereses_devengados_a_cargo_nacionales:
              partes_relacionadas: null
              partes_no_relacionadas: null
              total: null
            intereses_devengados_a_cargo_extranjero:
              partes_relacionadas: null
              partes_no_relacionadas: null
              total: null
            intereses_moratorios_a_cargo_nacionales:
              partes_relacionadas: null
              partes_no_relacionadas: null
              total: null
            intereses_moratorios_a_cargo_extranjero:
              partes_relacionadas: null
              partes_no_relacionadas: null
              total: null
            perdida_cambiaria:
              partes_relacionadas: null
              partes_no_relacionadas: null
              total: null
            resultado_posicion_monetaria_favorable:
              partes_relacionadas: null
              partes_no_relacionadas: null
              total: null
            resultado_posicion_monetaria_desfavorable:
              partes_relacionadas: null
              partes_no_relacionadas: null
              total: null
            otras_operaciones_financieras_nacionales:
              partes_relacionadas: null
              partes_no_relacionadas: null
              total: null
            otras_operaciones_financieras_extranjero:
              partes_relacionadas: null
              partes_no_relacionadas: null
              total: null
            otras_operaciones_financieras: null
            resultado_integral_financiamiento: null
            otros_gastos_nacionales: null
            otros_gastos_extranjero: null
            otros_gastos: null
            otros_productos_nacionales: null
            otros_productos_extranjero: null
            otros_productos: null
            ingresos_partidas_discontinuas_extraordinarias: null
            gastos_partidas_discontinuas_extraordinarias: null
            utilidad_antes_impuesto: 411625
            perdida_antes_impuesto: null
            isr: 113002
            ietu: null
            impac: null
            ptu: null
            utilidad_participacion_subsidiaria: null
            perdida_participacion_subsidiaria: null
            efectos_reexpresion_favorables_excepto_resultado_posicion_monetaria: null
            efectos_reexpresion_desfavorables_excepto_resultado_posicion_monetaria: null
            utilidad_neta: 298623
            perdida_neta: null
          estado_posicion_financiera_balance:
            activo:
              efectivo_caja_depositos_instituciones_credito_nacionales: 726644
              efectivo_caja_depositos_instituciones_credito_extranjero: null
              inversiones_valores_instituciones_nacionales_excepto_acciones: null
              inversiones_valores_instituciones_extranjero_excepto_acciones: null
              cuentas_documentos_por_cobrar_nacionales:
                partes_relacionadas: null
                partes_no_relacionadas: null
                total: null
              cuentas_documentos_por_cobrar_extranjero:
                partes_relacionadas: null
                partes_no_relacionadas: null
                total: null
              contribuciones_a_favor: null
              inventarios: null
              otros_activos_circulantes: 13277
              inversiones_en_acciones_nacionales: null
              inversiones_en_acciones_extranjero: null
              inversiones_en_acciones_total: null
              terrenos: null
              construcciones: null
              construcciones_en_proceso: null
              maquinaria_y_equipo: null
              mobiliario_y_equipo_oficina: null
              equipo_de_computo: null
              equipo_de_transporte: null
              otros_activos_fijos: 12756
              depreciacion_acumulada: -106
              cargos_y_gastos_diferidos: 9319
              amortizacion_acumulada: null
              suma_activo: 761890
            pasivo:
              cuentas_documentos_por_pagar_nacionales:
                partes_relacionadas: null
                partes_no_relacionadas: 268227
                total: 268227
              cuentas_documentos_por_pagar_extranjero:
                partes_relacionadas: null
                partes_no_relacionadas: null
                total: null
              contribuciones_por_pagar: 223490
              anticipos_de_clientes:
                partes_relacionadas: null
                partes_no_relacionadas: null
                total: null
              aportaciones_futuros_aumentos_de_capital: null
              otros_pasivos: null
              suma_pasivo: 491717
            capital_contable:
              capital_social_proveniente_aportaciones: 10000
              capital_social_proveniente_capitalizacion: null
              reservas: null
              otras_cuentas_capital: null
              aportaciones_futuros_aumentos_de_capital: null
              utilidades_acumuladas: null
              utilidad_del_ejercicio: 298623
              perdidas_acumuladas: -38450
              perdida_del_ejercicio: null
              exceso_en_actualizacion_capital: null
              insuficiencia_en_actualizacion_capital: null
              actualizacion_del_capital_contable: null
              suma_capital_contable: 270173
              suma_pasivo_mas_capital_contable: 761890
          conciliacion_entre_resultado_contable_fiscal:
            utilidad_o_perdida_neta: 298623
            efectos_reexpresion: null
            resultado_posicion_monetaria: null
            utilidad_o_perdida_neta_historica: 298623
            ingresos_fiscales_no_contables: 95
            ajuste_anual_inflacion_acumulable: 95
            anticipos_de_clientes: null
            intereses_moratorios_efectivamente_cobrados: null
            ganancia_en_enajenacion_acciones_por_reembolso_capital: null
            ganancia_en_enajenacion_de_terrenos_y_activo_fijo: null
            inventario_acumulable_del_ejercicio: null
            otros_ingresos_fiscales_no_contables: null
            deducciones_contables_no_fiscales: 117415
            costo_de_ventas_contable: null
            depreciacion_y_amortizacion_contable: 106
            gastos_que_no_reunen_requisitos_fiscales: 4307
            isr_ietu_impac_ptu: 113002
            perdida_contable_enajenacion_de_acciones: null
            perdida_contable_enajenacion_de_activo_fijo: null
            perdida_en_participacion_subsidiaria: null
            intereses_devengados_que_exceden_valor_mercado_y_moratorios_pagados_o_no: 0
            otras_deducciones_contables_no_fiscales: 0
            deducciones_fiscales_no_contables: 0
            ajuste_anual_inflacion_deducible: null
            costo_vendido_fiscal: null
            deduccion_inversiones: null
            estimulo_fiscal_por_deduccion_inmediata_inversiones: null
            donacion_bienes_basicos_subsistencia_humana: 0
            estimulo_fiscal_contratacion_personas_discapacidad_yo_mayores: 0
            deduccion_impuesto_sobre_renta_retenido_personas_discapacidad_yo_mayores: 0
            perdida_fiscal_en_enajenacion_acciones: null
            perdida_fiscal_en_enajenacion_de_terrenos_y_activo_fijo: null
            intereses_moratorios_efectivamente_pagados: null
            otras_deducciones_fiscales_no_contables: null
            ingresos_contables_no_fiscales: null
            intereses_moratorios_devengados_a_favor_cobrados_o_no: null
            anticipos_de_clientes_ejercicios_anteriores: null
            saldos_a_favor_impuestos_y_su_actualizacion: null
            utilidad_contable_enajenacion_de_activo_fijo: null
            utilidad_contable_enajenacion_de_acciones: null
            utilidad_en_participacion_subsidiaria: null
            otros_ingresos_contables_no_fiscales: null
            utilidad_o_perdida_fiscal_antes_de_ptu: 416133
          deducciones_autorizadas:
            sueldos_salarios: null
            honorarios_pagados_a_personas_fisicas: null
            regalias_y_asistencia_tecnica: null
            donativos_otorgados: null
            uso_o_goce_temporal_de_bienes_pagados_a_personas_fisicas: null
            fletes_y_acarreos_pagados_a_parsonas_fisicas: null
            contribuciones_pagadas_excepto_isr_ietu_impac_iva_ieps: null
            seguros_fianzas: null
            perdida_por_creditos_incobrables: null
            viaticos_y_gastos_viaje: 59527
            combustible_y_lubricantes: null
            credito_al_salario_no_disminuido_de_contribuciones: null
            aportaciones_sar_infonavit_y_jubilaciones_vejez: null
            aportaciones_para_fondos_de_pensiones_y_jubilaciones: null
            cuotas_imss: null
            consumos_en_restaurantes: 11254
            perdida_por_operaciones_financieras_derivadas: null
            deduccion_por_concepto_de_ayuda_alimentaria_para_trabajadores: null
            monto_total_pagos_que_sean_ingresos_exentos_para_trabajador: null
            monto_deducible_al_47_pagos_son_ingresos_exentos_para_trabajador: null
            monto_deducible_al_53_pagos_son_ingresos_exentos_para_trabajador: null
            uso_o_goce_temporal_de_automoviles_baterias_electricas_o_electricos_con_motor_combustion_o_hidrogeno: null
            otras_deducciones_autorizadas: 424346
            total_deducciones_autorizadas: 495127
          cifras_cierre_ejercicio:
            perdidas_fiscales_de_ejercicios_anteriores_pendientes_de_amortizar_actualiazadas: null
            saldo_promedio_anual_de_creditos: 142795
            saldo_promedio_anual_de_deudas: 144765
            coeficiente_de_utilidad_por_aplicar_en_ejercicio_siguiente: 0.4567
            porcentaje_de_participacion_consolidable: null
            isr_causado_en_exceso_del_impac_en_los_3_ejercicios_anteriores_pendientes_aplicar: null
            saldo_actualizado_de_cuenta_de_utilidad_fiscal_neta_2013_y_anteriores: null
            saldo_actualizado_de_cuenta_de_utilidad_fiscal_neta_a_partir_2014_y_anteriores: null
            saldo_actualizado_de_cuenta_de_utilidad_fiscal_reinvertida: null
            saldo_actualizado_de_cuenta_de_capital_de_aportacion: null
            saldo_de_cuenta_de_utilidad_fiscal_neta_por_inversion_en_renovables: null
          determinacion_del_impuesto_sobre_la_renta:
            determinacion_del_impuesto_sobre_la_renta:
              total_ingresos_acumulables: 911260
              total_deducciones_autorizadas_y_deduccion_inmediata_inversiones: 495126
              deduccion_adicional_por_pago_servicios_personales_en_operacion_maquila: null
              utilidad_o_perdida_fiscal_antes_de_ptu: 416134
              ptu_pagada_en_el_ejercicio: null
              utilidad_fiscal_del_ejercicio: 416134
              perdidas_fiscales_de_ejercicios_anteriores_que_se_aplican_en_ejercicio: 39462
              resultado_fiscal: 376672
              impuesto_causado_en_ejercicio: 113002
              tienes_estimulos_fiscales_a_acreditar: SIN SELECCIÓN
              impuesto_sobre_la_renta_del_ejercicio: 113002
              pagos_provisionales_efectuados_enterados_a_federacion: null
              impuesto_retenido_al_contribuyente: null
              impuesto_acreditable_pagado_en_extranjero: null
              impuesto_acreditable_por_dividendos_o_utilidades_distribuidos: null
              otras_cantidades_a_cargo: null
              otras_cantidades_a_favor: null
              diferencia_a_cargo: 113002
              isr_a_cargo_del_ejercicio: 113002
              isr_a_favor_del_ejercicio: null
            impuesto_sobre_ingresos_sujetos_a_regimenes_fiscales_preferentes: null
            datos_informativos_ejercicio:
              monto_aplicado_del_estimulo_fiscal_de_chatarrizacion: 0
              monto_deducible_de_pagos_efectuados_por_uso_o_goce_temporal_automoviles: 0
              impac_recuperado_en_ejercicio_derivado_de_deconsolidacion: 0
              ingresos_obtenidos_por_apoyos_gubernamentales: 0
              gastos_realidados_en_ejercicio_por_proyectos_en_investigacion_desarrollo_tecnologico: 0
              credito_fiscal_autorizado_en_ejercicio_por_proyectos_en_investigacion_desarrollo_tecnologico_pendiente_aplicar: 0
              credito_fiscal_autorizado_en_ejercicio_por_proyectos_de_inversion_en_artes_pendiente_aplicar: 0
              credito_fiscal_autorizado_en_ejercicio_por_inversion_en_proyectos_programas_para_deporte_de_alto_rendimiento_pendiente_aplicar: 0
              saldo_pendiente_aplicar_por_inversion_en_equipos_de_alimentacion_vehiculos_electricos: 0
              credito_fiscal_autorizado_en_ejercicio_a_produccion_distribucion_cinematografica_nacional_pendiente_aplicar: 0
            datos_informativos_ejercicios_anteriores_aplicados_en_ejercicio:
              total_estimulo_produccion_y_distribucion_cinematografica_nacional_ejercicios_anteriores_aplicado_en_ejercicio: null
              saldo_credito_fiscal_autorizado_ejercicios_anteriores_por_inversion_en_proyectos_programas_para_deporte_alto_rendimiento_pendiente_aplicar: 0
              saldo_credito_fiscal_autorizado_ejercicios_anteriores_por_proyectos_investigacion_desarrollo_tecnologico_pendiente_aplicar: 0
              saldo_credito_fiscal_autorizado_ejercicios_anteriores_por_proyectos_inversion_artes_pendiente_aplicar: 0
              saldo_credito_fiscal_autorizado_ejercicios_anteriores_a_produccion_distribucion_nacional_pendiente_aplicar: 0
          dividendos_o_utilidades_distribuidos:
            provenientes_de_cuenta_de_utilidad_fisica_neta_cufin_generada_en_2013_y_anteriores: null
            provenientes_de_cuenta_de_utilidad_fisica_neta_cufin_generada_a_partir_de_2014: null
            provenientes_de_cuenta_de_utilidad_fisica_neta_reinvertida_cufinre: null
            no_provenientes_de_cufin_ni_cufinre_en_efectivo: null
            no_provenientes_de_cufin_ni_cufinre_en_acciones: null
            monto_del_impuesto_pagado_no_proveniente_de_cufin_ni_cufinre: null
            monto_del_impuesto_pagado_de_utilidades_provenientes_de_cufinre: null
            provenientes_de_cuenta_de_utilidad_fiscal_neta_por_inversion_en_energia_de_fuentes_renovables_o_sistemas_cogeneracion_electricidad_eficiente: null
          detalle_pago_r1_isr_personas_morales:
            a_cargo: 113002
            parte_actualizada: null
            recargos: null
            multa_por_correccion: null
            total_contribuciones: 113002
            desea_aplicar_alguna_compensacion_o_estimulo: 'NO'
            cantidad_a_cargo: 113002
            opta_por_pagar_parcialidades: SIN SELECCIÓN
            importe_de_primera_parcialidad: null
            importe_sin_primera_parcialidad: null
            cantidad_a_favor: null
            cantidad_a_pagar: 113002
          pdf: '=PDF-STRING='
          receipt_pdf: '=PDF-STRING='
    TaxReturnBusinessListMonthly:
      summary: Negocios Mensual
      description: Ejemplo de una declaración de impuestos empresariales mensual
      value:
        - collected_at: '2022-02-09T08:45:50.406032Z'
          created_at: '2022-02-09T08:46:20.406032Z'
          informacion_general:
            rfc: DPA950805RR2
            denominacion_razon_social: Aloha Mahalo SC
            tipo_declaracion: Normal
            ejercicio: 2020
            periodo_declaracion: Diciembre
            fecha_hora_presentacion: '2021-01-18T19:24:00-06:00'
            numero_operacion: '400475119'
            tipo_complementaria: null
          determinacion_isr:
            personas_morales_regimen_general:
              suma_ingresos_nominales_meses_anteriores_ejercicio: 69848414
              estimulos_acreditables: null
              ingresos_nominales_mes_que_declara: 6482479
              reducciones: null
              total_ingresos_nominales: 76330893
              impuestos_del_periodo: 284098
              coeficiente_utilidad: 0.2318
              pagos_provisionales_efectuados_anterioridad: 303039
              utilidad_fiscal_pago_provisional: 17693501
              impuesto_retenido: 29925
              ptu: null
              otras_cantidades_a_cargo_contribuyente: null
              iventario_acumulable: null
              otras_cantidades_a_favor_contribuyente: null
              anticipos_rendimientos_distribuidos_periodo: 16746509
              diferencia_a_cargo: 0
              perdidas_fiscales_ejercicios_anteriores_pendientes: null
              estimulo_fiscal_deduccion_inmediata: null
              impuesto_correspondiente_participacion_consolidable: null
              deduccion_adicional_fomento_primer_empleo: null
              porcentaje_participacion_consolidable: null
              base_gravable_pago_provisional: 946992
              impuesto_a_cargo: 0
              isr_causado: 284098
              ieps_alcohol: null
          detalle_pago_isr:
            r1_isr_personas_morales:
              a_cargo: 0
              acreditamiento_sorteo_buen_fin: null
              parte_actualizada: null
              diesel_marino: null
              recargos: null
              total_aplicaciones: 0
              multa_por_correccion: null
              fecha_pago_realizado_anterioridad: null
              total_de_contribuciones: 0
              monto_pagado_anterioridad: null
              credito_al_salario: null
              importe_pagado_ultimas_48_hrs: null
              subsidio_empleo: null
              cantidad_a_cargo: 0
              impuesto_a_depositos_efectivo_acreditable: null
              aplica_primera_parcialidad: 'NO'
              compensaciones: null
              credito_ieps_diesel: null
              diesel_automotriz_transporte: null
              cantidad_a_favor: null
              uso_infraestructura_carretera_cuota: null
              cantidad_a_pagar: 0
              otros_estimulos: null
              importe_1ra_parcialidad: null
              importe_sin_1ra_parcialidad: null
            r12_isr_retenciones_por_salarios:
              a_cargo: 415945
              acreditamiento_sorteos: null
              parte_actualizada: 0
              diesel_marino: null
              recargos: 0
              total_aplicaciones: 379
              multa_por_correccion: null
              fecha_pago_realizado_anterioridad: null
              total_de_contribuciones: 415945
              monto_pagado_anterioridad: null
              credito_al_salario: null
              importe_pagado_ultimas_48_hrs: null
              subsidio_empleo: 379
              cantidad_a_cargo: 415566
              impuesto_a_depositos_efectivo_acreditable: null
              aplica_primera_parcialidad: 'NO'
              compensaciones: null
              credito_ieps_diesel: null
              diesel_automotriz_transporte: null
              cantidad_a_favor: null
              otros_estimulos: null
              cantidad_a_pagar: 415566
              importe_1ra_parcialidad: null
              importe_sin_1ra_parcialidad: null
            r13_isr_retenciones_por_asimilados_a_salarios:
              a_cargo: 254588
              acreditamiento_sorteos: null
              parte_actualizada: 0
              diesel_marino: null
              recargos: 0
              total_aplicaciones: 0
              multa_por_correccion: null
              fecha_pago_realizado_anterioridad: null
              total_de_contribuciones: 254588
              monto_pagado_anterioridad: null
              credito_al_salario: null
              importe_pagado_ultimas_48_hrs: null
              subsidio_empleo: null
              cantidad_a_cargo: 254588
              impuesto_a_depositos_efectivo_acreditable: null
              aplica_primera_parcialidad: 'NO'
              compensaciones: null
              credito_ieps_diesel: null
              diesel_automotriz_transporte: null
              cantidad_a_favor: null
              otros_estimulos: null
              cantidad_a_pagar: 254588
              importe_1ra_parcialidad: null
              importe_sin_1ra_parcialidad: null
            r14_isr_retenciones_por_servicios_profesionales:
              a_cargo: 104482
              acreditamiento_sorteos: null
              parte_actualizada: 0
              diesel_marino: null
              recargos: 0
              total_aplicaciones: 0
              multa_por_correccion: null
              fecha_pago_realizado_anterioridad: null
              total_de_contribuciones: 104482
              monto_pagado_anterioridad: null
              credito_al_salario: null
              importe_pagado_ultimas_48_hrs: null
              subsidio_empleo: null
              cantidad_a_cargo: 104482
              impuesto_a_depositos_efectivo_acreditable: null
              aplica_primera_parcialidad: 'NO'
              compensaciones: null
              credito_ieps_diesel: null
              diesel_automotriz_transporte: null
              cantidad_a_favor: null
              otros_estimulos: null
              cantidad_a_pagar: 104482
              importe_1ra_parcialidad: null
              importe_sin_1ra_parcialidad: null
          determinacion_iva:
            montos_actos_actividades_pagados:
              total_actos_actividades_pagados_tasa_16: 2094706
              total_actos_actividades_pagados_importacion_bienes_tasa_11: null
              total_actos_actividades_sujetos_estimulo_rfn: 0
              total_actos_actividades_pagados_tasa_0: 0
              total_actos_actividades_pagados_importacion_bienes_tasa_16: null
              total_actos_actividades_pagados_no_paga_iva: 0
            detalle_total_actos_actividades_pagados_tasa_16:
              intereses_pagados_tasa_16: null
              otros_actos_pagados_tasa_16: 2094706
              regalias_pagadas_tasa_16: null
              total_actos_pagados_tasa_16: 2094706
            determinacion_iva_acreditable:
              total_iva_actos_actividades_pagados_tasa_16: 335153
              iva_trasladado_o_pagado_adquisicion_bienes_distintos_inversiones_actos_no_obligados_pago_impuesto: null
              iva_pagado_sujeto_estimulo_rfn: null
              iva_trasladado_o_pagado_importacion_inversiones_actos_no_obligados_pago_impuesto: null
              total_actos_actividades_pagados_importacion_bienes_tasa_16: 0
              iva_bienes_utilizados_indistintamente_actos_gravados_o_actos_no_obligados_pago_impuesto: 0
              proporcion_utilizada_conforme_art_5: null
              total_iva_trasladado_contribuyente: 335153
              proporcion_utilizada_conforme_art_5_b: null
              iva_trasladado_adquisicion_bienes_distintos_inversiones_actos_gravados: 335153
              iva_pagado_importacion_adquisicion_bienes_distintos_inversiones_actos_gravados: null
              iva_acreditable: 335153
              monto_acreditable_actualizado_a_incrementar_derivado_ajuste: null
              iva_pagado_importacion_inversiones_actos_gravados: null
              total_iva_acreditable_periodo: 335153
              total_iva_actos_actividades_gravados: 335153
              total_actos_actividades_pagados_importacion_bienes_tasa_11: null
              iva_trasladado_adquisicion_inversiones_actos_gravados: null
              iva_acreditable_bienes_utilizados_indistintamente_actos_gravados_o_actos_no_obligados_pago_impuesto: null
            determinacion_iva:
              valor_actos_actividades_gravados_tasa_16: 6457950
              otras_cantidades_a_favor_contribuyente: null
              valor_actos_actividades_gravados_tasa_11: null
              cantidad_a_cargo: 312421
              valor_actos_actividades_gravados_tasa_0_exportacion: null
              saldo_a_favor: null
              valor_actos_actividades_gravados_tasa_9_otros: null
              devolucion_inmediata_obtenida: null
              suma_actos_actividades_gravados: 6457950
              saldo_a_favor_periodo: 0
              valor_actos_actividades_no_se_deba_pagar_impuesto_exentos: null
              acreditamiento_saldo_favor_periodos_anteriores: null
              impuesto_causado: 1033272
              diferencia_a_cargo: 312421
              cantidad_actualizada_a_reintegrarse_derivada_de_ajuste: null
              ieps_acreditable_alcohol: null
              iva_retenido_al_contribuyente: 385698
              impuesto_a_cargo: 312421
              total_iva_acreditable: 335153
              remanente_saldo_favor_ieps_alcohol: null
              otras_cantidades_a_cargo_contribuyente: null
            detalle_valor_actos_actividades_gravados_tasa_16:
              intereses_cobrados_tasa_16: null
              otros_actos_actividades_gravados_tasa_16: 6457950
              regalias_entre_partes_relacionadas_tasa_16: null
              total_actos_actividades_gravados_tasa_16: 6457950
          detalle_pago_iva:
            r21_iva:
              a_cargo: 312421
              cretificados_tesofe: null
              a_favor: null
              diesel_marino: null
              parte_actualizada: 0
              total_aplicaciones: 0
              recargos: 0
              fecha_pago_realizado_anterioridad: null
              multa_por_correccion: null
              monto_pagado_anterioridad: null
              total_de_contribuciones: 312421
              importe_pagado_ultimas_48_hrs: null
              credito_al_salario: null
              cantidad_a_cargo: 312421
              subsidio_empleo: null
              aplica_primera_parcialidad: 'NO'
              compensaciones: null
              diesel_automotriz_transporte: null
              uso_infraestructura_carretera_cuota: null
              cantidad_a_favor: null
              otros_estimulos: null
              cantidad_a_pagar: 312421
              importe_1ra_parcialidad: null
              importe_sin_1ra_parcialidad: null
            r21_iva_retenciones:
              a_cargo: 111448
              diesel_marino: null
              parte_actualizada: 0
              total_aplicaciones: 0
              recargos: 0
              fecha_pago_realizado_anterioridad: null
              multa_por_correccion: null
              monto_pagado_anterioridad: null
              total_de_contribuciones: 111448
              importe_pagado_ultimas_48_hrs: null
              credito_al_salario: null
              cantidad_a_cargo: 111448
              subsidio_empleo: null
              aplica_primera_parcialidad: 'NO'
              compensaciones: null
              credito_ieps_diesel: null
              otros_estimulos: null
              cantidad_a_favor: null
              cretificados_tesofe: null
              cantidad_a_pagar: 111448
              importe_1ra_parcialidad: null
              importe_sin_1ra_parcialidad: null
          pdf: '===PDF_BINARY===='
          receipt_pdf: '===PDF_BINARY===='
          type: monthly
    TaxReturnPersonalListDetail:
      summary: Declaración de impuestos personal
      description: Ejemplo de una lista de declaraciones de impuestos personales
      value:
        id: 02589c41-ba22-4d44-8558-8111cc751318
        link: 19697249-01b8-443e-a451-76bfc5fbeebf
        collected_at: '2022-02-09T08:45:50.406032Z'
        created_at: '2022-02-09T08:46:20.406032Z'
        informacion_general:
          ejercicio: 2018
          fecha_hora_presentacion: '2020-01-07T17:28:00-05:00'
          numero_operacion: '00000000001'
          periodo_declaracion: Del Ejercicio
          rfc: ABCD111111A11
          tipo_declaracion: Normal
          nombre: JOHN DOE
        sueldos_salarios:
          retenedores:
            - rfc_retenedor: ABCD222222A22
              nombre_denominacion_razon_social: ACME CORP
              ingresos_exentos: 118263
              ingreso_anual: 2265
              subsidio_empleo: 0
          impuesto_retenido: 19497
          ingreso_anual: 118263
          ingresos_acumulables: 115998
          ingresos_exentos: 2265
          subsidio_empleo: 0
        servicios_profesionales:
          deducciones_autorizadas:
            deducciones_autorizadas: 11870
            otras_deducciones: null
            detalle_deducciones:
              - tipo_deduccion: GASTOS
                concepto: GASOLINA Y MANTENIMIENTO DE TRANSPORTE
                monto_detallado: 9682
              - tipo_deduccion: GASTOS
                concepto: COMPRAS Y GASTOS GENERALES
                monto_detallado: 2188
            total_deducciones_autorizadas: 11870
          ingresos:
            ingresos_acumulables: 46000
            ingresos_exentos: null
            otros_ingresos: null
            total_ingresos: 46000
          resultado_fiscal:
            utilidad_fiscal: 34130
            ptu_pagada_ejercicio: 0
            perdidas_fiscales_ejercicios_anteriores_aplicadas: 0
            utilidad_gravable: 34130
          pagos_provisionales:
            pagos_provisionales_efectuados_en_ejercicio: 0
          retenciones_isr:
            isr_retenido_personas_morales: 4600
        deducciones_personales:
          honorarios_medicos_dentales_hospitalarios:
            - rfc_emisor: ABC333333A33
              monto_deducible: 258.83
            - rfc_emisor: ABC333333A33
              monto_deducible: 258.83
            - rfc_emisor: ABC444444A44
              monto_deducible: 1000
            - rfc_emisor: ABC333333A33
              monto_deducible: 258.83
            - rfc_emisor: ABC333333A33
              monto_deducible: 258.83
            - rfc_emisor: ABC333333A33
              monto_deducible: 258.83
            - rfc_emisor: ABC333333A33
              monto_deducible: 258.83
            - rfc_emisor: ABC444444A44
              monto_deducible: 502.34
            - rfc_emisor: ABC333333A33
              monto_deducible: 258.83
            - rfc_emisor: ABC333333A33
              monto_deducible: 258.83
            - rfc_emisor: ABC333333A33
              monto_deducible: 258.83
            - rfc_emisor: ABC444444A55
              monto_deducible: 14183.1
            - rfc_emisor: ABC444444A66
              monto_deducible: 1658
            - rfc_emisor: ABC444444A77
              monto_deducible: 1600
            - rfc_emisor: ABC444444A88
              monto_deducible: 1064
            - rfc_emisor: ABC444444A99
              monto_deducible: 927.57
          donativos:
            - rfc_emisor: ABC555555A99
              monto_deducible: 10.03
          aportaciones_voluntarias_complementarias_al_sar:
            - rfc_emisor: ABC666666A99
              monto_deducible: 12.03
            - rfc_emisor: ABC777777A99
              monto_deducible: 87.22
          primas_por_seguros_de_gasto_medico:
            - rfc_emisor: ABC777777A99
              monto_deducible: 20.03
        determinacion_impuesto:
          base_gravable: 126864
          deducciones_personales: 23264
          ingresos_acumulables: 150128
          isr_favorable: 10308
          isr_conforme_tarifa_final: 13789
          isr_retenido: 24097
          num_clabe: '000000000000000001'
          nombre_banco: BANCO SA
          pagos_provisionales: 0
          titular_clabe_permite_verificacion: SÍ
          accion_saldo_a_favor: DEVOLUCIÓN
        retenciones:
          sueldos_salarios:
            - rfc_retenedor: ABC444444A99
              monto_retenciones: 118263
              retenciones_isr: 19497
          dividendos: []
          servicios_profesionales:
            - rfc_retenedor: ABC444444A00
              monto_retenciones: 46000
              retenciones_isr: 4600
        dividendos:
          monto_acumulable_dividendos_utilidades: null
          monto_total_isr_pagado_sociedad: null
        datos_informativos:
          credito_fiscal_autorizado_proyectos_investigacion_desarrollo: 0
          credito_fiscal_autorizado_proyectos_apoyo_deporte_alto_rendimiento: 0
          credito_fiscal_autorizado_proyectos_inversion_artes: 0
          credito_fiscal_autorizado_inversion_equipos_fijos: 0
          credito_fiscal_autorizado_produccion_distribucion_cinematografica: 0
          saldo_credito_fiscal_autorizado_anteriores_investigacion_desarrollo: 0
          saldo_credito_fiscal_anteriores_proyectos_inversion_artes: 0
          saldo_credito_fiscal_anteriores_produccion_distribucion_cinematografica: 0
        pdf: '=PDF-STRING='
        receipt_pdf: '=PDF-STRING='
    TaxReturnPersonalListMonthlyPFAEDetail:
      summary: Declaración de Impuestos Personal Mensual (PFAE)
      description: Ejemplo de una declaración de impuestos personal mensual tipo PFAE
      value:
        collected_at: '2022-02-09T08:45:50.406032Z'
        created_at: '2022-02-09T08:46:20.406032Z'
        informacion_general:
          rfc: null
          nombre: null
          tipo_declaracion: null
          ejercicio: null
          periodo_declaracion: null
          fecha_hora_presentacion: null
          numero_operacion: null
        isr:
          tipo: PFAE
          determinacion:
            ingresos_periodos_anteriores: 0
            ingresos_periodo: 0
            total_ingresos: 0
            compras_gastos_periodos_anteriores: 1596
            compra_gastos_periodo: 399
            total_compras_gastos: 1995
            base_gravable_pago_provisional: 0
            isr_causado: 0
            pagos_provisionales_efectuados_anterioridad: 0
            isr_retenido_periodos_anteriores: 0
            impuesto_retenido: 0
            isr_cargo: 0
          detalle_del_pago:
            a_cargo: 0
            parte_actualizada: 0
            recargos: 0
            total_contribuciones: 0
            total_aplicaciones: 0
            cantidad_a_cargo: 0
            cantidad_a_pagar: 0
        iva:
          determinacion:
            actividades_gravadas_tasa_16: 0
            actividades_gravadas_tasa_0: 0
            actividades_exentas: 0
            iva_cobrado_periodo_tasa_16: 0
            iva_acreditable_periodo: 0
            iva_retenido: 0
            saldo_a_favor: null
            impuesto_a_favor: null
          detalle_del_pago:
            total_contribuciones: 0
            total_aplicaciones: 0
            cantidad_a_cargo: 0
            cantidad_a_pagar: 0
            a_favor: null
        pdf: '===PDF_BINARY===='
        receipt_pdf: '===PDF_BINARY===='
        type: monthly
    TaxReturnPersonalListMonthlyPFAIDetail:
      summary: Declaración de Impuestos Personal Mensual (PFAI)
      description: Ejemplo de una declaración de impuestos personales mensual tipo PFAI
      value:
        collected_at: '2022-02-09T08:45:50.406032Z'
        created_at: '2022-02-09T08:46:20.406032Z'
        informacion_general:
          rfc: null
          nombre: null
          tipo_declaracion: null
          ejercicio: null
          periodo_declaracion: null
          fecha_hora_presentacion: null
          numero_operacion: null
        isr:
          tipo: PFAE
          determinacion:
            ingresos_periodos_anteriores: 0
            ingresos_periodo: 0
            total_ingresos: 0
            compras_gastos_periodos_anteriores: 1596
            compra_gastos_periodo: 399
            total_compras_gastos: 1995
            base_gravable_pago_provisional: 0
            isr_causado: 0
            pagos_provisionales_efectuados_anterioridad: 0
            isr_retenido_periodos_anteriores: 0
            impuesto_retenido: 0
            isr_cargo: 0
            tipo_de_deduccíon: dedduccíon opicional
            optas_por_el_cálculo_acumulado: 'NO'
            deduccíon_opcional: 700
            impuesto_predial: 0
            total_deducciones_autorizadas: 700
            tienes_facilidades_administrativas_o_estímulos_deducibles: 'NO'
          detalle_del_pago:
            a_cargo: 0
            parte_actualizada: 0
            recargos: 0
            total_contribuciones: 0
            total_aplicaciones: 0
            cantidad_a_cargo: 0
            cantidad_a_pagar: 0
        iva:
          determinacion:
            actividades_gravadas_tasa_16: 0
            actividades_gravadas_tasa_0: 0
            actividades_exentas: 0
            iva_cobrado_periodo_tasa_16: 0
            iva_acreditable_periodo: 0
            iva_retenido: 0
            saldo_a_favor: null
            impuesto_a_favor: null
            impuesto_a_cargo: 54
            cantidad_a_cargo: 54
          detalle_del_pago:
            total_contribuciones: 0
            total_aplicaciones: 0
            cantidad_a_cargo: 0
            cantidad_a_pagar: 0
            a_favor: null
        pdf: '===PDF_BINARY===='
        receipt_pdf: '===PDF_BINARY===='
        type: monthly
    TaxReturnBusinessListDetail:
      summary: Negocio de Declaración de Impuestos
      description: Ejemplo de una lista de declaraciones de impuestos empresariales
      value:
        id: 02589c41-ba22-4d44-8558-8111cc751318
        link: 19697249-01b8-443e-a451-76bfc5fbeebf
        collected_at: '2022-02-09T08:45:50.406032Z'
        created_at: '2022-02-09T08:46:20.406032Z'
        informacion_general:
          ejercicio: 2018
          fecha_hora_presentacion: '2020-01-07T16:55:00-06:00'
          numero_operacion: '000000000001'
          periodo_declaracion: Del Ejercicio
          rfc: ABC1111111A1
          tipo_declaracion: Normal
          tipo_complementaria: null
          denominacion_razon_social: ACME CORP
        datos_adicionales:
          indica_si_optas_por_dictaminar_tus_estados_financieros: 'NO'
          estas_obligado_a_presentar_la_informacion_sobre_tu_situacion_fiscal: 'NO'
          estas_obligado_unicamente_por_supuesto_distinto_al_de_haber_realizado_operaciones_con_residentes_extranjero: SIN SELECCIÓN
          estas_obligado_unicamente_por_supuesto_distinto_al_de_haber_realizado_operaciones_con_residentes_extranjero_inferiores_100mdp: SIN SELECCIÓN
          optas_por_presentar_informacion_sobre_tu_situacion_fiscal: SIN SELECCIÓN
          indica_si_te_dedicas_exclisivamente_a_generacion_energia_fuentes_renovables_o_cogeneracion_electricidad_eficiente: 'NO'
        estado_resultados:
          ventas_servicios_nacionales:
            partes_relacionadas: null
            partes_no_relacionadas: 911165
            total: 911165
          ventas_servicios_extranjero:
            partes_relacionadas: null
            partes_no_relacionadas: null
            total: null
          devoluciones_descuentos_bonificaciones_ventas_nacionales:
            partes_relacionadas: null
            partes_no_relacionadas: null
            total: null
          devoluciones_descuentos_bonificaciones_ventas_extranjero:
            partes_relacionadas: null
            partes_no_relacionadas: null
            total: null
          ingresos_netos:
            partes_relacionadas: null
            partes_no_relacionadas: 911165
            total: 911165
          inventario_inicial: null
          compras_netas_nacionales:
            partes_relacionadas: null
            partes_no_relacionadas: null
            total: null
          compras_netas_importacion:
            partes_relacionadas: null
            partes_no_relacionadas: null
            total: null
          inventario_final: null
          costo_mercancias: null
          mano_de_obra:
            partes_relacionadas: null
            partes_no_relacionadas: null
            total: null
          maquilas:
            partes_relacionadas: null
            partes_no_relacionadas: null
            total: null
          gastos_indirectos_fabricacion:
            partes_relacionadas: null
            partes_no_relacionadas: null
            total: null
          costo_ventas_servicios: null
          utilidad_bruta: 911165
          perdida_bruta: null
          gastos_operacion:
            partes_relacionadas: null
            partes_no_relacionadas: 499540
            total: 499540
          utilidad_operacion: 411625
          perdida_operacion: null
          intereses_devengados_a_favor_nacionales:
            partes_relacionadas: null
            partes_no_relacionadas: null
            total: null
          intereses_devengados_a_favor_extranjero:
            partes_relacionadas: null
            partes_no_relacionadas: null
            total: null
          intereses_moratorios_a_favor_nacionales:
            partes_relacionadas: null
            partes_no_relacionadas: null
            total: null
          intereses_moratorios_a_favor_extranjero:
            partes_relacionadas: null
            partes_no_relacionadas: null
            total: null
          ganancia_cambiaria:
            partes_relacionadas: null
            partes_no_relacionadas: null
            total: null
          intereses_devengados_a_cargo_nacionales:
            partes_relacionadas: null
            partes_no_relacionadas: null
            total: null
          intereses_devengados_a_cargo_extranjero:
            partes_relacionadas: null
            partes_no_relacionadas: null
            total: null
          intereses_moratorios_a_cargo_nacionales:
            partes_relacionadas: null
            partes_no_relacionadas: null
            total: null
          intereses_moratorios_a_cargo_extranjero:
            partes_relacionadas: null
            partes_no_relacionadas: null
            total: null
          perdida_cambiaria:
            partes_relacionadas: null
            partes_no_relacionadas: null
            total: null
          resultado_posicion_monetaria_favorable:
            partes_relacionadas: null
            partes_no_relacionadas: null
            total: null
          resultado_posicion_monetaria_desfavorable:
            partes_relacionadas: null
            partes_no_relacionadas: null
            total: null
          otras_operaciones_financieras_nacionales:
            partes_relacionadas: null
            partes_no_relacionadas: null
            total: null
          otras_operaciones_financieras_extranjero:
            partes_relacionadas: null
            partes_no_relacionadas: null
            total: null
          otras_operaciones_financieras: null
          resultado_integral_financiamiento: null
          otros_gastos_nacionales: null
          otros_gastos_extranjero: null
          otros_gastos: null
          otros_productos_nacionales: null
          otros_productos_extranjero: null
          otros_productos: null
          ingresos_partidas_discontinuas_extraordinarias: null
          gastos_partidas_discontinuas_extraordinarias: null
          utilidad_antes_impuesto: 411625
          perdida_antes_impuesto: null
          isr: 113002
          ietu: null
          impac: null
          ptu: null
          utilidad_participacion_subsidiaria: null
          perdida_participacion_subsidiaria: null
          efectos_reexpresion_favorables_excepto_resultado_posicion_monetaria: null
          efectos_reexpresion_desfavorables_excepto_resultado_posicion_monetaria: null
          utilidad_neta: 298623
          perdida_neta: null
        estado_posicion_financiera_balance:
          activo:
            efectivo_caja_depositos_instituciones_credito_nacionales: 726644
            efectivo_caja_depositos_instituciones_credito_extranjero: null
            inversiones_valores_instituciones_nacionales_excepto_acciones: null
            inversiones_valores_instituciones_extranjero_excepto_acciones: null
            cuentas_documentos_por_cobrar_nacionales:
              partes_relacionadas: null
              partes_no_relacionadas: null
              total: null
            cuentas_documentos_por_cobrar_extranjero:
              partes_relacionadas: null
              partes_no_relacionadas: null
              total: null
            contribuciones_a_favor: null
            inventarios: null
            otros_activos_circulantes: 13277
            inversiones_en_acciones_nacionales: null
            inversiones_en_acciones_extranjero: null
            inversiones_en_acciones_total: null
            terrenos: null
            construcciones: null
            construcciones_en_proceso: null
            maquinaria_y_equipo: null
            mobiliario_y_equipo_oficina: null
            equipo_de_computo: null
            equipo_de_transporte: null
            otros_activos_fijos: 12756
            depreciacion_acumulada: -106
            cargos_y_gastos_diferidos: 9319
            amortizacion_acumulada: null
            suma_activo: 761890
          pasivo:
            cuentas_documentos_por_pagar_nacionales:
              partes_relacionadas: null
              partes_no_relacionadas: 268227
              total: 268227
            cuentas_documentos_por_pagar_extranjero:
              partes_relacionadas: null
              partes_no_relacionadas: null
              total: null
            contribuciones_por_pagar: 223490
            anticipos_de_clientes:
              partes_relacionadas: null
              partes_no_relacionadas: null
              total: null
            aportaciones_futuros_aumentos_de_capital: null
            otros_pasivos: null
            suma_pasivo: 491717
          capital_contable:
            capital_social_proveniente_aportaciones: 10000
            capital_social_proveniente_capitalizacion: null
            reservas: null
            otras_cuentas_capital: null
            aportaciones_futuros_aumentos_de_capital: null
            utilidades_acumuladas: null
            utilidad_del_ejercicio: 298623
            perdidas_acumuladas: -38450
            perdida_del_ejercicio: null
            exceso_en_actualizacion_capital: null
            insuficiencia_en_actualizacion_capital: null
            actualizacion_del_capital_contable: null
            suma_capital_contable: 270173
            suma_pasivo_mas_capital_contable: 761890
        conciliacion_entre_resultado_contable_fiscal:
          utilidad_o_perdida_neta: 298623
          efectos_reexpresion: null
          resultado_posicion_monetaria: null
          utilidad_o_perdida_neta_historica: 298623
          ingresos_fiscales_no_contables: 95
          ajuste_anual_inflacion_acumulable: 95
          anticipos_de_clientes: null
          intereses_moratorios_efectivamente_cobrados: null
          ganancia_en_enajenacion_acciones_por_reembolso_capital: null
          ganancia_en_enajenacion_de_terrenos_y_activo_fijo: null
          inventario_acumulable_del_ejercicio: null
          otros_ingresos_fiscales_no_contables: null
          deducciones_contables_no_fiscales: 117415
          costo_de_ventas_contable: null
          depreciacion_y_amortizacion_contable: 106
          gastos_que_no_reunen_requisitos_fiscales: 4307
          isr_ietu_impac_ptu: 113002
          perdida_contable_enajenacion_de_acciones: null
          perdida_contable_enajenacion_de_activo_fijo: null
          perdida_en_participacion_subsidiaria: null
          intereses_devengados_que_exceden_valor_mercado_y_moratorios_pagados_o_no: 0
          otras_deducciones_contables_no_fiscales: 0
          deducciones_fiscales_no_contables: 0
          ajuste_anual_inflacion_deducible: null
          costo_vendido_fiscal: null
          deduccion_inversiones: null
          estimulo_fiscal_por_deduccion_inmediata_inversiones: null
          donacion_bienes_basicos_subsistencia_humana: 0
          estimulo_fiscal_contratacion_personas_discapacidad_yo_mayores: 0
          deduccion_impuesto_sobre_renta_retenido_personas_discapacidad_yo_mayores: 0
          perdida_fiscal_en_enajenacion_acciones: null
          perdida_fiscal_en_enajenacion_de_terrenos_y_activo_fijo: null
          intereses_moratorios_efectivamente_pagados: null
          otras_deducciones_fiscales_no_contables: null
          ingresos_contables_no_fiscales: null
          intereses_moratorios_devengados_a_favor_cobrados_o_no: null
          anticipos_de_clientes_ejercicios_anteriores: null
          saldos_a_favor_impuestos_y_su_actualizacion: null
          utilidad_contable_enajenacion_de_activo_fijo: null
          utilidad_contable_enajenacion_de_acciones: null
          utilidad_en_participacion_subsidiaria: null
          otros_ingresos_contables_no_fiscales: null
          utilidad_o_perdida_fiscal_antes_de_ptu: 416133
        deducciones_autorizadas:
          sueldos_salarios: null
          honorarios_pagados_a_personas_fisicas: null
          regalias_y_asistencia_tecnica: null
          donativos_otorgados: null
          uso_o_goce_temporal_de_bienes_pagados_a_personas_fisicas: null
          fletes_y_acarreos_pagados_a_parsonas_fisicas: null
          contribuciones_pagadas_excepto_isr_ietu_impac_iva_ieps: null
          seguros_fianzas: null
          perdida_por_creditos_incobrables: null
          viaticos_y_gastos_viaje: 59527
          combustible_y_lubricantes: null
          credito_al_salario_no_disminuido_de_contribuciones: null
          aportaciones_sar_infonavit_y_jubilaciones_vejez: null
          aportaciones_para_fondos_de_pensiones_y_jubilaciones: null
          cuotas_imss: null
          consumos_en_restaurantes: 11254
          perdida_por_operaciones_financieras_derivadas: null
          deduccion_por_concepto_de_ayuda_alimentaria_para_trabajadores: null
          monto_total_pagos_que_sean_ingresos_exentos_para_trabajador: null
          monto_deducible_al_47_pagos_son_ingresos_exentos_para_trabajador: null
          monto_deducible_al_53_pagos_son_ingresos_exentos_para_trabajador: null
          uso_o_goce_temporal_de_automoviles_baterias_electricas_o_electricos_con_motor_combustion_o_hidrogeno: null
          otras_deducciones_autorizadas: 424346
          total_deducciones_autorizadas: 495127
        cifras_cierre_ejercicio:
          perdidas_fiscales_de_ejercicios_anteriores_pendientes_de_amortizar_actualiazadas: null
          saldo_promedio_anual_de_creditos: 142795
          saldo_promedio_anual_de_deudas: 144765
          coeficiente_de_utilidad_por_aplicar_en_ejercicio_siguiente: 0.4567
          porcentaje_de_participacion_consolidable: null
          isr_causado_en_exceso_del_impac_en_los_3_ejercicios_anteriores_pendientes_aplicar: null
          saldo_actualizado_de_cuenta_de_utilidad_fiscal_neta_2013_y_anteriores: null
          saldo_actualizado_de_cuenta_de_utilidad_fiscal_neta_a_partir_2014_y_anteriores: null
          saldo_actualizado_de_cuenta_de_utilidad_fiscal_reinvertida: null
          saldo_actualizado_de_cuenta_de_capital_de_aportacion: null
          saldo_de_cuenta_de_utilidad_fiscal_neta_por_inversion_en_renovables: null
        determinacion_del_impuesto_sobre_la_renta:
          determinacion_del_impuesto_sobre_la_renta:
            total_ingresos_acumulables: 911260
            total_deducciones_autorizadas_y_deduccion_inmediata_inversiones: 495126
            deduccion_adicional_por_pago_servicios_personales_en_operacion_maquila: null
            utilidad_o_perdida_fiscal_antes_de_ptu: 416134
            ptu_pagada_en_el_ejercicio: null
            utilidad_fiscal_del_ejercicio: 416134
            perdidas_fiscales_de_ejercicios_anteriores_que_se_aplican_en_ejercicio: 39462
            resultado_fiscal: 376672
            impuesto_causado_en_ejercicio: 113002
            tienes_estimulos_fiscales_a_acreditar: SIN SELECCIÓN
            impuesto_sobre_la_renta_del_ejercicio: 113002
            pagos_provisionales_efectuados_enterados_a_federacion: null
            impuesto_retenido_al_contribuyente: null
            impuesto_acreditable_pagado_en_extranjero: null
            impuesto_acreditable_por_dividendos_o_utilidades_distribuidos: null
            otras_cantidades_a_cargo: null
            otras_cantidades_a_favor: null
            diferencia_a_cargo: 113002
            isr_a_cargo_del_ejercicio: 113002
            isr_a_favor_del_ejercicio: null
          impuesto_sobre_ingresos_sujetos_a_regimenes_fiscales_preferentes: null
          datos_informativos_ejercicio:
            monto_aplicado_del_estimulo_fiscal_de_chatarrizacion: 0
            monto_deducible_de_pagos_efectuados_por_uso_o_goce_temporal_automoviles: 0
            impac_recuperado_en_ejercicio_derivado_de_deconsolidacion: 0
            ingresos_obtenidos_por_apoyos_gubernamentales: 0
            gastos_realidados_en_ejercicio_por_proyectos_en_investigacion_desarrollo_tecnologico: 0
            credito_fiscal_autorizado_en_ejercicio_por_proyectos_en_investigacion_desarrollo_tecnologico_pendiente_aplicar: 0
            credito_fiscal_autorizado_en_ejercicio_por_proyectos_de_inversion_en_artes_pendiente_aplicar: 0
            credito_fiscal_autorizado_en_ejercicio_por_inversion_en_proyectos_programas_para_deporte_de_alto_rendimiento_pendiente_aplicar: 0
            saldo_pendiente_aplicar_por_inversion_en_equipos_de_alimentacion_vehiculos_electricos: 0
            credito_fiscal_autorizado_en_ejercicio_a_produccion_distribucion_cinematografica_nacional_pendiente_aplicar: 0
          datos_informativos_ejercicios_anteriores_aplicados_en_ejercicio:
            total_estimulo_produccion_y_distribucion_cinematografica_nacional_ejercicios_anteriores_aplicado_en_ejercicio: null
            saldo_credito_fiscal_autorizado_ejercicios_anteriores_por_inversion_en_proyectos_programas_para_deporte_alto_rendimiento_pendiente_aplicar: 0
            saldo_credito_fiscal_autorizado_ejercicios_anteriores_por_proyectos_investigacion_desarrollo_tecnologico_pendiente_aplicar: 0
            saldo_credito_fiscal_autorizado_ejercicios_anteriores_por_proyectos_inversion_artes_pendiente_aplicar: 0
            saldo_credito_fiscal_autorizado_ejercicios_anteriores_a_produccion_distribucion_nacional_pendiente_aplicar: 0
        dividendos_o_utilidades_distribuidos:
          provenientes_de_cuenta_de_utilidad_fisica_neta_cufin_generada_en_2013_y_anteriores: null
          provenientes_de_cuenta_de_utilidad_fisica_neta_cufin_generada_a_partir_de_2014: null
          provenientes_de_cuenta_de_utilidad_fisica_neta_reinvertida_cufinre: null
          no_provenientes_de_cufin_ni_cufinre_en_efectivo: null
          no_provenientes_de_cufin_ni_cufinre_en_acciones: null
          monto_del_impuesto_pagado_no_proveniente_de_cufin_ni_cufinre: null
          monto_del_impuesto_pagado_de_utilidades_provenientes_de_cufinre: null
          provenientes_de_cuenta_de_utilidad_fiscal_neta_por_inversion_en_energia_de_fuentes_renovables_o_sistemas_cogeneracion_electricidad_eficiente: null
        detalle_pago_r1_isr_personas_morales:
          a_cargo: 113002
          parte_actualizada: null
          recargos: null
          multa_por_correccion: null
          total_contribuciones: 113002
          desea_aplicar_alguna_compensacion_o_estimulo: 'NO'
          cantidad_a_cargo: 113002
          opta_por_pagar_parcialidades: SIN SELECCIÓN
          importe_de_primera_parcialidad: null
          importe_sin_primera_parcialidad: null
          cantidad_a_favor: null
          cantidad_a_pagar: 113002
        pdf: '=PDF-STRING='
        receipt_pdf: '=PDF-STRING='
    TaxReturnBusinessListMonthlyDetail:
      summary: Declaración de Impuestos Empresarial Mensual
      description: Ejemplo de una declaración de impuestos empresariales mensual
      value:
        collected_at: '2022-02-09T08:45:50.406032Z'
        created_at: '2022-02-09T08:46:20.406032Z'
        informacion_general:
          rfc: DPA950805RR2
          denominacion_razon_social: Aloha Mahalo SC
          tipo_declaracion: Normal
          ejercicio: 2020
          periodo_declaracion: Diciembre
          fecha_hora_presentacion: '2021-01-18T19:24:00-06:00'
          numero_operacion: '400475119'
          tipo_complementaria: null
        determinacion_isr:
          personas_morales_regimen_general:
            suma_ingresos_nominales_meses_anteriores_ejercicio: 69848414
            estimulos_acreditables: null
            ingresos_nominales_mes_que_declara: 6482479
            reducciones: null
            total_ingresos_nominales: 76330893
            impuestos_del_periodo: 284098
            coeficiente_utilidad: 0.2318
            pagos_provisionales_efectuados_anterioridad: 303039
            utilidad_fiscal_pago_provisional: 17693501
            impuesto_retenido: 29925
            ptu: null
            otras_cantidades_a_cargo_contribuyente: null
            iventario_acumulable: null
            otras_cantidades_a_favor_contribuyente: null
            anticipos_rendimientos_distribuidos_periodo: 16746509
            diferencia_a_cargo: 0
            perdidas_fiscales_ejercicios_anteriores_pendientes: null
            estimulo_fiscal_deduccion_inmediata: null
            impuesto_correspondiente_participacion_consolidable: null
            deduccion_adicional_fomento_primer_empleo: null
            porcentaje_participacion_consolidable: null
            base_gravable_pago_provisional: 946992
            impuesto_a_cargo: 0
            isr_causado: 284098
            ieps_alcohol: null
        detalle_pago_isr:
          r1_isr_personas_morales:
            a_cargo: 0
            acreditamiento_sorteo_buen_fin: null
            parte_actualizada: null
            diesel_marino: null
            recargos: null
            total_aplicaciones: 0
            multa_por_correccion: null
            fecha_pago_realizado_anterioridad: null
            total_de_contribuciones: 0
            monto_pagado_anterioridad: null
            credito_al_salario: null
            importe_pagado_ultimas_48_hrs: null
            subsidio_empleo: null
            cantidad_a_cargo: 0
            impuesto_a_depositos_efectivo_acreditable: null
            aplica_primera_parcialidad: 'NO'
            compensaciones: null
            credito_ieps_diesel: null
            diesel_automotriz_transporte: null
            cantidad_a_favor: null
            uso_infraestructura_carretera_cuota: null
            cantidad_a_pagar: 0
            otros_estimulos: null
            importe_1ra_parcialidad: null
            importe_sin_1ra_parcialidad: null
          r12_isr_retenciones_por_salarios:
            a_cargo: 415945
            acreditamiento_sorteos: null
            parte_actualizada: 0
            diesel_marino: null
            recargos: 0
            total_aplicaciones: 379
            multa_por_correccion: null
            fecha_pago_realizado_anterioridad: null
            total_de_contribuciones: 415945
            monto_pagado_anterioridad: null
            credito_al_salario: null
            importe_pagado_ultimas_48_hrs: null
            subsidio_empleo: 379
            cantidad_a_cargo: 415566
            impuesto_a_depositos_efectivo_acreditable: null
            aplica_primera_parcialidad: 'NO'
            compensaciones: null
            credito_ieps_diesel: null
            diesel_automotriz_transporte: null
            cantidad_a_favor: null
            otros_estimulos: null
            cantidad_a_pagar: 415566
            importe_1ra_parcialidad: null
            importe_sin_1ra_parcialidad: null
          r13_isr_retenciones_por_asimilados_a_salarios:
            a_cargo: 254588
            acreditamiento_sorteos: null
            parte_actualizada: 0
            diesel_marino: null
            recargos: 0
            total_aplicaciones: 0
            multa_por_correccion: null
            fecha_pago_realizado_anterioridad: null
            total_de_contribuciones: 254588
            monto_pagado_anterioridad: null
            credito_al_salario: null
            importe_pagado_ultimas_48_hrs: null
            subsidio_empleo: null
            cantidad_a_cargo: 254588
            impuesto_a_depositos_efectivo_acreditable: null
            aplica_primera_parcialidad: 'NO'
            compensaciones: null
            credito_ieps_diesel: null
            diesel_automotriz_transporte: null
            cantidad_a_favor: null
            otros_estimulos: null
            cantidad_a_pagar: 254588
            importe_1ra_parcialidad: null
            importe_sin_1ra_parcialidad: null
          r14_isr_retenciones_por_servicios_profesionales:
            a_cargo: 104482
            acreditamiento_sorteos: null
            parte_actualizada: 0
            diesel_marino: null
            recargos: 0
            total_aplicaciones: 0
            multa_por_correccion: null
            fecha_pago_realizado_anterioridad: null
            total_de_contribuciones: 104482
            monto_pagado_anterioridad: null
            credito_al_salario: null
            importe_pagado_ultimas_48_hrs: null
            subsidio_empleo: null
            cantidad_a_cargo: 104482
            impuesto_a_depositos_efectivo_acreditable: null
            aplica_primera_parcialidad: 'NO'
            compensaciones: null
            credito_ieps_diesel: null
            diesel_automotriz_transporte: null
            cantidad_a_favor: null
            otros_estimulos: null
            cantidad_a_pagar: 104482
            importe_1ra_parcialidad: null
            importe_sin_1ra_parcialidad: null
        determinacion_iva:
          montos_actos_actividades_pagados:
            total_actos_actividades_pagados_tasa_16: 2094706
            total_actos_actividades_pagados_importacion_bienes_tasa_11: null
            total_actos_actividades_sujetos_estimulo_rfn: 0
            total_actos_actividades_pagados_tasa_0: 0
            total_actos_actividades_pagados_importacion_bienes_tasa_16: null
            total_actos_actividades_pagados_no_paga_iva: 0
          detalle_total_actos_actividades_pagados_tasa_16:
            intereses_pagados_tasa_16: null
            otros_actos_pagados_tasa_16: 2094706
            regalias_pagadas_tasa_16: null
            total_actos_pagados_tasa_16: 2094706
          determinacion_iva_acreditable:
            total_iva_actos_actividades_pagados_tasa_16: 335153
            iva_trasladado_o_pagado_adquisicion_bienes_distintos_inversiones_actos_no_obligados_pago_impuesto: null
            iva_pagado_sujeto_estimulo_rfn: null
            iva_trasladado_o_pagado_importacion_inversiones_actos_no_obligados_pago_impuesto: null
            total_actos_actividades_pagados_importacion_bienes_tasa_16: 0
            iva_bienes_utilizados_indistintamente_actos_gravados_o_actos_no_obligados_pago_impuesto: 0
            proporcion_utilizada_conforme_art_5: null
            total_iva_trasladado_contribuyente: 335153
            proporcion_utilizada_conforme_art_5_b: null
            iva_trasladado_adquisicion_bienes_distintos_inversiones_actos_gravados: 335153
            iva_pagado_importacion_adquisicion_bienes_distintos_inversiones_actos_gravados: null
            iva_acreditable: 335153
            monto_acreditable_actualizado_a_incrementar_derivado_ajuste: null
            iva_pagado_importacion_inversiones_actos_gravados: null
            total_iva_acreditable_periodo: 335153
            total_iva_actos_actividades_gravados: 335153
            total_actos_actividades_pagados_importacion_bienes_tasa_11: null
            iva_trasladado_adquisicion_inversiones_actos_gravados: null
            iva_acreditable_bienes_utilizados_indistintamente_actos_gravados_o_actos_no_obligados_pago_impuesto: null
          determinacion_iva:
            valor_actos_actividades_gravados_tasa_16: 6457950
            otras_cantidades_a_favor_contribuyente: null
            valor_actos_actividades_gravados_tasa_11: null
            cantidad_a_cargo: 312421
            valor_actos_actividades_gravados_tasa_0_exportacion: null
            saldo_a_favor: null
            valor_actos_actividades_gravados_tasa_9_otros: null
            devolucion_inmediata_obtenida: null
            suma_actos_actividades_gravados: 6457950
            saldo_a_favor_periodo: 0
            valor_actos_actividades_no_se_deba_pagar_impuesto_exentos: null
            acreditamiento_saldo_favor_periodos_anteriores: null
            impuesto_causado: 1033272
            diferencia_a_cargo: 312421
            cantidad_actualizada_a_reintegrarse_derivada_de_ajuste: null
            ieps_acreditable_alcohol: null
            iva_retenido_al_contribuyente: 385698
            impuesto_a_cargo: 312421
            total_iva_acreditable: 335153
            remanente_saldo_favor_ieps_alcohol: null
            otras_cantidades_a_cargo_contribuyente: null
          detalle_valor_actos_actividades_gravados_tasa_16:
            intereses_cobrados_tasa_16: null
            otros_actos_actividades_gravados_tasa_16: 6457950
            regalias_entre_partes_relacionadas_tasa_16: null
            total_actos_actividades_gravados_tasa_16: 6457950
        detalle_pago_iva:
          r21_iva:
            a_cargo: 312421
            cretificados_tesofe: null
            a_favor: null
            diesel_marino: null
            parte_actualizada: 0
            total_aplicaciones: 0
            recargos: 0
            fecha_pago_realizado_anterioridad: null
            multa_por_correccion: null
            monto_pagado_anterioridad: null
            total_de_contribuciones: 312421
            importe_pagado_ultimas_48_hrs: null
            credito_al_salario: null
            cantidad_a_cargo: 312421
            subsidio_empleo: null
            aplica_primera_parcialidad: 'NO'
            compensaciones: null
            diesel_automotriz_transporte: null
            uso_infraestructura_carretera_cuota: null
            cantidad_a_favor: null
            otros_estimulos: null
            cantidad_a_pagar: 312421
            importe_1ra_parcialidad: null
            importe_sin_1ra_parcialidad: null
          r21_iva_retenciones:
            a_cargo: 111448
            diesel_marino: null
            parte_actualizada: 0
            total_aplicaciones: 0
            recargos: 0
            fecha_pago_realizado_anterioridad: null
            multa_por_correccion: null
            monto_pagado_anterioridad: null
            total_de_contribuciones: 111448
            importe_pagado_ultimas_48_hrs: null
            credito_al_salario: null
            cantidad_a_cargo: 111448
            subsidio_empleo: null
            aplica_primera_parcialidad: 'NO'
            compensaciones: null
            credito_ieps_diesel: null
            otros_estimulos: null
            cantidad_a_favor: null
            cretificados_tesofe: null
            cantidad_a_pagar: 111448
            importe_1ra_parcialidad: null
            importe_sin_1ra_parcialidad: null
        pdf: '===PDF_BINARY===='
        receipt_pdf: '===PDF_BINARY===='
        type: monthly
    TaxStatusPersonalListPaginated:
      summary: Estado Fiscal Personal
      description: Ejemplo de una lista de estado fiscal personal
      value:
        count: 101
        next: >-
          https://sandbox.belvo.com/api/{endpoint}/?link=1bd948f7-245d-4313-b604-34d1044cb908page=2
        previous: null
        results:
          - id: e88d29d1-3dc6-407f-825c-a9b50453e349
            link: 401d5a8e-79e2-472e-a1ca-8f4646f5cb24
            collected_at: '2022-02-09T08:45:50.406032Z'
            created_at: '2022-02-09T08:46:20.406032Z'
            place_and_date_of_issuance: BUENAVENTURA, CIUDAD DE MEXICO A 22 DE FEBRERO DE 2021
            official_name: Alfredo Gonzalo Robin
            id_cif: '2274235873432'
            tax_payer_information:
              rfc: GGTF770303G7
              curp: BEMP930403HDFLLT00
              name: Alfredo
              first_last_name: Gonzalo
              second_last_name: Robin
              start_operations_date: '2000-06-01'
              status_padron: ACTIVO
              last_status_change_date: '2000-06-01'
              commercial_name: Alfredo Gonzalo Robin
              social_name: null
              email: alfredo@robin.com
              phone: '667507132'
            address:
              postal_code: '21255'
              street_type: BOULEVARD (BLVD.)
              street: GENERAL GIMENO
              exterior_number: '4360'
              interior_number: PLANTA BAJA
              suburb: BUENAVENTURA
              locality: null
              municipality: ALTOS DE MIRAMAR
              state: CIUDAD DE MEXICO
              between_street:
                - street_one: CALLE PRINCIPE
                  street_two: CALLE NUEVA ROMA
            economic_activity:
              - order: '1'
                economic_activity: Asalariado
                percentage: '100'
                initial_date: '2014-11-05'
                end_date: null
            regimes:
              - regimen: Régimen de Sueldos y Salarios e Ingresos Asimilados a Salarios
                initial_date: '2003-01-01'
                end_date: null
            obligations:
              - obligation: Declaración informativa de IVA con la anual de ISR
                expiration: Conjuntamente con la declaración anual del ejercicio.
                initial_date: '2004-03-31'
                end_date: null
              - obligation: Pago definitivo mensual de IVA.
                expiration: >-
                  A más tardar el día 17 del mes inmediato posterior al periodo
                  que corresponda.
                initial_date: '2004-03-31'
                end_date: null
            digital_stamp: >-
              ||2020/09/26|GHTF980303F7|CONSTANCIA DE SITUACIÓN
              FISCAL|2044441088666600000034||
            digital_stamp_chain: >-
              ExpsnSA9t1adG7bn+Jj23kj43JK+XbMPxdOppwabhXD+pXseSqYowWWDna0mpUk3264lkj2345j23faNZB852dCDt9KAjel=
            pdf: '=PDF-STRING='
    TaxStatusBusinessListPaginated:
      summary: Estado Fiscal Empresarial
      description: Ejemplo de una lista de estados fiscales empresariales
      value:
        count: 101
        next: >-
          https://sandbox.belvo.com/api/{endpoint}/?link=1bd948f7-245d-4313-b604-34d1044cb908page=2
        previous: null
        results:
          - id: 6de34cb3-bf0d-445d-b832-7ec7781e2c6f
            link: 0b2edc42-7214-4c68-b22e-ae6885bf7c07
            collected_at: '2022-02-09T08:45:50.406032Z'
            created_at: '2022-02-09T08:46:20.406032Z'
            place_and_date_of_issuance: BUENAVENTURA, CIUDAD DE MEXICO A 22 DE FEBRERO DE 2021
            official_name: ACNE SA DE CV
            id_cif: '2274235873432'
            tax_payer_information:
              rfc: GHTF980303F7
              curp: null
              name: null
              first_last_name: null
              second_last_name: null
              start_operations_date: '1995-08-01'
              status_padron: ACTIVO
              last_status_change_date: '1995-08-01'
              commercial_name: null
              social_name: ACNE SA DE CV
              email: contact@acne.com
              phone: '555507122'
            address:
              postal_code: '21255'
              street_type: BOULEVARD (BLVD.)
              street: GENERAL GIMENO
              exterior_number: '4360'
              interior_number: PLANTA BAJA
              suburb: BUENAVENTURA
              locality: null
              municipality: ALTOS DE MIRAMAR
              state: CIUDAD DE MEXICO
              between_street:
                - street_one: CALLE PRINCIPE
                  street_two: CALLE NUEVA ROMA
            economic_activity:
              - order: '1'
                economic_activity: Otros servicios profesionales, científicos y técnicos
                percentage: '100'
                initial_date: '2014-11-05'
                end_date: null
            regimes:
              - regimen: Régimen General de Ley Personas Morales
                initial_date: '2003-01-01'
                end_date: null
            obligations:
              - obligation: Declaración informativa de IVA con la anual de ISR
                expiration: Conjuntamente con la declaración anual del ejercicio.
                initial_date: '2004-03-31'
                end_date: null
              - obligation: Pago definitivo mensual de IVA.
                expiration: >-
                  A más tardar el día 17 del mes inmediato posterior al periodo
                  que corresponda.
                initial_date: '2004-03-31'
                end_date: null
            digital_stamp: >-
              ||2020/04/26|GHTF980303F7|CONSTANCIA DE SITUACIÓN
              FISCAL|2044441088666600000034||
            digital_stamp_chain: >-
              EtenSA9t1adG7bn+Jj23kj43JK+XbMPxdOppwabhXD+pXseSqYowWWDna0mpUk3264lkj2345j23faNZB852dCDt9KAjow=
            pdf: '=PDF-STRING='
    TaxStatusPersonalList:
      summary: Estado Fiscal Personal
      description: Ejemplo de una lista de estado fiscal personal
      value:
        id: 6de34cb3-bf0d-445d-b832-7ec7781e2c6f
        link: 401d5a8e-79e2-472e-a1ca-8f4646f5cb24
        collected_at: '2022-02-09T08:45:50.406032Z'
        created_at: '2022-02-09T08:46:20.406032Z'
        place_and_date_of_issuance: BUENAVENTURA, CIUDAD DE MEXICO A 22 DE FEBRERO DE 2021
        official_name: Alfredo Gonzalo Robin
        id_cif: '2274235873432'
        tax_payer_information:
          rfc: GGTF770303G7
          curp: BEMP930403HDFLLT00
          name: Alfredo
          first_last_name: Gonzalo
          second_last_name: Robin
          start_operations_date: '2000-06-01'
          status_padron: ACTIVO
          last_status_change_date: '2000-06-01'
          commercial_name: Alfredo Gonzalo Robin
          social_name: null
          email: alfredo@robin.com
          phone: '667507132'
        address:
          postal_code: '21255'
          street_type: BOULEVARD (BLVD.)
          street: GENERAL GIMENO
          exterior_number: '4360'
          interior_number: PLANTA BAJA
          suburb: BUENAVENTURA
          locality: null
          municipality: ALTOS DE MIRAMAR
          state: CIUDAD DE MEXICO
          between_street:
            - street_one: CALLE PRINCIPE
              street_two: CALLE NUEVA ROMA
        economic_activity:
          - order: '1'
            economic_activity: Asalariado
            percentage: '100'
            initial_date: '2014-11-05'
            end_date: null
        regimes:
          - regimen: Régimen de Sueldos y Salarios e Ingresos Asimilados a Salarios
            initial_date: '2003-01-01'
            end_date: null
        obligations:
          - obligation: Declaración informativa de IVA con la anual de ISR
            expiration: Conjuntamente con la declaración anual del ejercicio.
            initial_date: '2004-03-31'
            end_date: null
          - obligation: Pago definitivo mensual de IVA.
            expiration: >-
              A más tardar el día 17 del mes inmediato posterior al periodo que
              corresponda.
            initial_date: '2004-03-31'
            end_date: null
        digital_stamp: >-
          ||2020/09/26|GHTF980303F7|CONSTANCIA DE SITUACIÓN
          FISCAL|2044441088666600000034||
        digital_stamp_chain: >-
          ExpsnSA9t1adG7bn+Jj23kj43JK+XbMPxdOppwabhXD+pXseSqYowWWDna0mpUk3264lkj2345j23faNZB852dCDt9KAjel=
        pdf: '=PDF-STRING='
    TaxStatusBusinessList:
      summary: Estado Fiscal Empresarial
      description: Ejemplo de una lista de estados fiscales empresariales
      value:
        id: 6de34cb3-bf0d-445d-b832-7ec7781e2c6f
        link: 0b2edc42-7214-4c68-b22e-ae6885bf7c07
        collected_at: '2022-02-09T08:45:50.406032Z'
        created_at: '2022-02-09T08:46:20.406032Z'
        place_and_date_of_issuance: BUENAVENTURA, CIUDAD DE MEXICO A 22 DE FEBRERO DE 2021
        official_name: ACNE SA DE CV
        id_cif: '2274235873432'
        tax_payer_information:
          rfc: GHTF980303F7
          curp: null
          name: null
          first_last_name: null
          second_last_name: null
          start_operations_date: '1995-08-01'
          status_padron: ACTIVO
          last_status_change_date: '1995-08-01'
          commercial_name: null
          social_name: ACNE SA DE CV
          email: contact@acne.com
          phone: '555507122'
        address:
          postal_code: '21255'
          street_type: BOULEVARD (BLVD.)
          street: GENERAL GIMENO
          exterior_number: '4360'
          interior_number: PLANTA BAJA
          suburb: BUENAVENTURA
          locality: null
          municipality: ALTOS DE MIRAMAR
          state: CIUDAD DE MEXICO
          between_street:
            - street_one: CALLE PRINCIPE
              street_two: CALLE NUEVA ROMA
        economic_activity:
          - order: '1'
            economic_activity: Otros servicios profesionales, científicos y técnicos
            percentage: '100'
            initial_date: '2014-11-05'
            end_date: null
        regimes:
          - regimen: Régimen General de Ley Personas Morales
            initial_date: '2003-01-01'
            end_date: null
        obligations:
          - obligation: Declaración informativa de IVA con la anual de ISR
            expiration: Conjuntamente con la declaración anual del ejercicio.
            initial_date: '2004-03-31'
            end_date: null
          - obligation: Pago definitivo mensual de IVA.
            expiration: >-
              A más tardar el día 17 del mes inmediato posterior al periodo que
              corresponda.
            initial_date: '2004-03-31'
            end_date: null
        digital_stamp: >-
          ||2020/04/26|GHTF980303F7|CONSTANCIA DE SITUACIÓN
          FISCAL|2044441088666600000034||
        digital_stamp_chain: >-
          EtenSA9t1adG7bn+Jj23kj43JK+XbMPxdOppwabhXD+pXseSqYowWWDna0mpUk3264lkj2345j23faNZB852dCDt9KAjow=
        pdf: null
    ChileInvoicesAll:
      summary: Lista de facturas
      description: Ejemplo de una lista de todas las facturas posibles.
      value:
        count: 10
        next: >-
          https://sandbox.belvo.com/api/{endpoint}/?link=1bd948f7-245d-4313-b604-34d1044cb908page=2
        previous: null
        results:
          - id: bfafa41d-48aa-4de0-9220-f2ca432cc51d
            link: 1f10cf48-4814-4cac-ae32-6c4ed5460a80
            created_at: '2025-02-10T20:26:06.643919Z'
            collected_at: '2025-02-10T20:25:49.468130Z'
            additional_data: null
            invoice_identification: e503b879d1645a2c38f9701b546d1a8327c490fe
            total_amount: 95866
            net_amount: 80560
            vat_amount: 0
            currency: CLP
            issue_date: '2024-03-06'
            received_at: '2024-03-06T11:25:40'
            acknowledged_at: null
            claim_date: null
            status: REGISTERED
            document_code: 61
            category: Del Giro
            folio: '57419308'
            sender_id: 11111111-2
            sender_name: INGENIERIA E BAILES LTDA
            receiver_id: 22222222-1
            receiver_name: MONITORES SPA
            type: OUTFLOW
            sale_invoice_details: null
            purchase_invoice_details:
              vat_refundable_amount: 15306
              vat_non_refundable_amount: 0
              vat_non_refundable_code: 0
              net_amount_fixed_assets: 0
              vat_fixed_assets: 0
              vat_common_use: 0
              tax_non_credit_amount: 0
              vat_non_withheld: 0
              tax_cigar_amount: 0
              tax_cigarettes_amount: 0
              tax_processed_tobacco_amount: 0
              tax_exempt_amount: 0
              credit_or_debit_note_on_purchase: 0
              additional_tax_code: null
              additional_tax_rate: null
              additional_tax_amount: 0
            summary_invoice_details: null
          - id: 0acb61a6-cd12-4ed9-b727-33fa717af526
            link: 10ccdce9-aa90-42bd-99ef-47a8a02e7b52
            created_at: '2025-02-10T22:49:47.003071Z'
            collected_at: '2025-02-10T22:49:39.234391Z'
            additional_data: null
            invoice_identification: 3c9e15a76b8d204f57a1639082d4c9f80e67b213
            total_amount: 0
            net_amount: 2488000
            vat_amount: 472720
            currency: CLP
            issue_date: '2024-09-26'
            received_at: '2024-09-26T13:37:40'
            acknowledged_at: '2024-09-27T11:27:47'
            claim_date: null
            status: REGISTERED
            document_code: 33
            category: Del Giro
            folio: '23'
            sender_id: 11111111-2
            sender_name: INGENIERIA E BAILES LTDA
            receiver_id: 22222222-1
            receiver_name: MONITORES SPA
            type: INFLOW
            sale_invoice_details:
              vat_amount: 472720
              vat_total_withheld: 0
              vat_partially_withheld: 0
              vat_non_withheld: 0
              vat_sales: 0
              vat_third_party: 0
              invoice_settlement_sender_id: null
              invoice_settlement_net_commission: 0
              invoice_settlement_exempt_commission: 0
              invoice_settlement_vat_commission: 0
              vat_past_due: 0
              reference_document_type: '0'
              reference_document_folio: null
              foreign_recipient_id: null
              foreign_recipient_nationality: null
              construction_sector_tax_credit: '0'
              tax_free_trade_zone_amount: null
              container_deposit_guarantee: 0
              is_free_of_charge: false
              periodic_billing_type: 0
              non_billable_amount: 0
              total_amount_for_period: 0
              domestic_transportation_amount: null
              international_transportation_amount: null
              branch_code: 76129014
              tax_exempt_amount: 0
              credit_or_debit_note_on_purchase: null
              additional_tax_code: null
              additional_tax_rate: null
              additional_tax_amount: 0
            purchase_invoice_details: null
            summary_invoice_details: null
          - id: 17de57b4-5c7d-424d-b623-680680f9cdf8
            link: 09915956-7031-4403-9382-5193bdfb6909
            created_at: '2025-02-10T20:29:42.785011Z'
            collected_at: '2025-02-10T20:29:27.111746Z'
            additional_data: null
            invoice_identification: 8a2f9b1d4e0c735619d834a526f1e07b9c35d641
            total_amount: 45000
            net_amount: 0
            vat_amount: 0
            currency: CLP
            issue_date: '2024-01-01'
            received_at: null
            acknowledged_at: null
            claim_date: null
            status: REGISTERED
            document_code: 48
            category: COMPROBANTE_PAGO
            folio: null
            sender_id: 11111111-2
            sender_name: null
            receiver_id: null
            receiver_name: null
            type: INFLOW
            sale_invoice_details: null
            purchase_invoice_details: null
            summary_invoice_details:
              updated_at: '2024-01-12T02:49:38-03:00'
              tax_exempt_amount: 0
              total_documents: 3
              month: 2024-01
    PurchaseInvoiceArray:
      summary: Factura de Compra
      description: Ejemplo de una factura de compra.
      value:
        - id: bfafa41d-48aa-4de0-9220-f2ca432cc51d
          link: 1f10cf48-4814-4cac-ae32-6c4ed5460a80
          created_at: '2025-02-10T20:26:06.643919Z'
          collected_at: '2025-02-10T20:25:49.468130Z'
          additional_data: null
          invoice_identification: e503b879d1645a2c38f9701b546d1a8327c490fe
          total_amount: 95866
          net_amount: 80560
          vat_amount: 0
          currency: CLP
          issue_date: '2024-03-06'
          received_at: '2024-03-06T11:25:40'
          acknowledged_at: null
          claim_date: null
          status: REGISTERED
          document_code: 61
          category: Del Giro
          folio: '57419308'
          sender_id: 11111111-2
          sender_name: INGENIERIA E BAILES LTDA
          receiver_id: 22222222-1
          receiver_name: MONITORES SPA
          type: OUTFLOW
          sale_invoice_details: null
          purchase_invoice_details:
            vat_refundable_amount: 15306
            vat_non_refundable_amount: 0
            vat_non_refundable_code: 0
            net_amount_fixed_assets: 0
            vat_fixed_assets: 0
            vat_common_use: 0
            tax_non_credit_amount: 0
            vat_non_withheld: 0
            tax_cigar_amount: 0
            tax_cigarettes_amount: 0
            tax_processed_tobacco_amount: 0
            tax_exempt_amount: 0
            credit_or_debit_note_on_purchase: 0
            additional_tax_code: null
            additional_tax_rate: null
            additional_tax_amount: 0
          summary_invoice_details: null
    SummaryInvoiceArray:
      summary: Detalles del Resumen de Factura
      description: Ejemplo de una factura del tipo *Summary Invoice Details*.
      value:
        - id: 17de57b4-5c7d-424d-b623-680680f9cdf8
          link: 09915956-7031-4403-9382-5193bdfb6909
          created_at: '2025-02-10T20:29:42.785011Z'
          collected_at: '2025-02-10T20:29:27.111746Z'
          additional_data: null
          invoice_identification: 8a2f9b1d4e0c735619d834a526f1e07b9c35d641
          total_amount: 45000
          net_amount: 0
          vat_amount: 0
          currency: CLP
          issue_date: '2024-01-01'
          received_at: null
          acknowledged_at: null
          claim_date: null
          status: REGISTERED
          document_code: 48
          category: COMPROBANTE_PAGO
          folio: null
          sender_id: 11111111-2
          sender_name: null
          receiver_id: null
          receiver_name: null
          type: INFLOW
          sale_invoice_details: null
          purchase_invoice_details: null
          summary_invoice_details:
            updated_at: '2024-01-12T02:49:38-03:00'
            tax_exempt_amount: 0
            total_documents: 3
            month: 2024-01
    SaleInvoiceArray:
      summary: Factura de Venta
      description: Ejemplo de una factura de venta.
      value:
        - id: 0acb61a6-cd12-4ed9-b727-33fa717af526
          link: 10ccdce9-aa90-42bd-99ef-47a8a02e7b52
          created_at: '2025-02-10T22:49:47.003071Z'
          collected_at: '2025-02-10T22:49:39.234391Z'
          additional_data: null
          invoice_identification: 3c9e15a76b8d204f57a1639082d4c9f80e67b213
          total_amount: 0
          net_amount: 2488000
          vat_amount: 472720
          currency: CLP
          issue_date: '2024-09-26'
          received_at: '2024-09-26T13:37:40'
          acknowledged_at: '2024-09-27T11:27:47'
          claim_date: null
          status: REGISTERED
          document_code: 33
          category: Del Giro
          folio: '23'
          sender_id: 11111111-2
          sender_name: INGENIERIA E BAILES LTDA
          receiver_id: 22222222-1
          receiver_name: MONITORES SPA
          type: INFLOW
          sale_invoice_details:
            vat_amount: 472720
            vat_total_withheld: 0
            vat_partially_withheld: 0
            vat_non_withheld: 0
            vat_sales: 0
            vat_third_party: 0
            invoice_settlement_sender_id: null
            invoice_settlement_net_commission: 0
            invoice_settlement_exempt_commission: 0
            invoice_settlement_vat_commission: 0
            vat_past_due: 0
            reference_document_type: '0'
            reference_document_folio: null
            foreign_recipient_id: null
            foreign_recipient_nationality: null
            construction_sector_tax_credit: '0'
            tax_free_trade_zone_amount: null
            container_deposit_guarantee: 0
            is_free_of_charge: false
            periodic_billing_type: 0
            non_billable_amount: 0
            total_amount_for_period: 0
            domestic_transportation_amount: null
            international_transportation_amount: null
            branch_code: 76129014
            tax_exempt_amount: 0
            credit_or_debit_note_on_purchase: null
            additional_tax_code: null
            additional_tax_rate: null
            additional_tax_amount: 0
          purchase_invoice_details: null
          summary_invoice_details: null
    PurchaseInvoiceDetails:
      summary: Factura de Compra
      description: Ejemplo de una factura de compra.
      value:
        id: bfafa41d-48aa-4de0-9220-f2ca432cc51d
        link: 1f10cf48-4814-4cac-ae32-6c4ed5460a80
        created_at: '2025-02-10T20:26:06.643919Z'
        collected_at: '2025-02-10T20:25:49.468130Z'
        additional_data: null
        invoice_identification: e503b879d1645a2c38f9701b546d1a8327c490fe
        total_amount: 95866
        net_amount: 80560
        vat_amount: 0
        currency: CLP
        issue_date: '2024-03-06'
        received_at: '2024-03-06T11:25:40'
        acknowledged_at: null
        claim_date: null
        status: REGISTERED
        document_code: 61
        category: Del Giro
        folio: '57419308'
        sender_id: 11111111-2
        sender_name: INGENIERIA E BAILES LTDA
        receiver_id: 22222222-1
        receiver_name: MONITORES SPA
        type: OUTFLOW
        sale_invoice_details: null
        purchase_invoice_details:
          vat_refundable_amount: 15306
          vat_non_refundable_amount: 0
          vat_non_refundable_code: 0
          net_amount_fixed_assets: 0
          vat_fixed_assets: 0
          vat_common_use: 0
          tax_non_credit_amount: 0
          vat_non_withheld: 0
          tax_cigar_amount: 0
          tax_cigarettes_amount: 0
          tax_processed_tobacco_amount: 0
          tax_exempt_amount: 0
          credit_or_debit_note_on_purchase: 0
          additional_tax_code: null
          additional_tax_rate: null
          additional_tax_amount: 0
        summary_invoice_details: null
    SummaryInvoiceDetails:
      summary: Detalles del Resumen de Factura
      description: Ejemplo de una factura del tipo *Summary Invoice Details*.
      value:
        id: 17de57b4-5c7d-424d-b623-680680f9cdf8
        link: 09915956-7031-4403-9382-5193bdfb6909
        created_at: '2025-02-10T20:29:42.785011Z'
        collected_at: '2025-02-10T20:29:27.111746Z'
        additional_data: null
        invoice_identification: 8a2f9b1d4e0c735619d834a526f1e07b9c35d641
        total_amount: 45000
        net_amount: 0
        vat_amount: 0
        currency: CLP
        issue_date: '2024-01-01'
        received_at: null
        acknowledged_at: null
        claim_date: null
        status: REGISTERED
        document_code: 48
        category: COMPROBANTE_PAGO
        folio: null
        sender_id: 11111111-2
        sender_name: null
        receiver_id: null
        receiver_name: null
        type: INFLOW
        sale_invoice_details: null
        purchase_invoice_details: null
        summary_invoice_details:
          updated_at: '2024-01-12T02:49:38-03:00'
          tax_exempt_amount: 0
          total_documents: 3
          month: 2024-01
    SaleInvoiceDetails:
      summary: Factura de Venta
      description: Ejemplo de una factura de venta.
      value:
        id: 0acb61a6-cd12-4ed9-b727-33fa717af526
        link: 10ccdce9-aa90-42bd-99ef-47a8a02e7b52
        created_at: '2025-02-10T22:49:47.003071Z'
        collected_at: '2025-02-10T22:49:39.234391Z'
        additional_data: null
        invoice_identification: 3c9e15a76b8d204f57a1639082d4c9f80e67b213
        total_amount: 0
        net_amount: 2488000
        vat_amount: 472720
        currency: CLP
        issue_date: '2024-09-26'
        received_at: '2024-09-26T13:37:40'
        acknowledged_at: '2024-09-27T11:27:47'
        claim_date: null
        status: REGISTERED
        document_code: 33
        category: Del Giro
        folio: '23'
        sender_id: 11111111-2
        sender_name: INGENIERIA E BAILES LTDA
        receiver_id: 22222222-1
        receiver_name: MONITORES SPA
        type: INFLOW
        sale_invoice_details:
          vat_amount: 472720
          vat_total_withheld: 0
          vat_partially_withheld: 0
          vat_non_withheld: 0
          vat_sales: 0
          vat_third_party: 0
          invoice_settlement_sender_id: null
          invoice_settlement_net_commission: 0
          invoice_settlement_exempt_commission: 0
          invoice_settlement_vat_commission: 0
          vat_past_due: 0
          reference_document_type: '0'
          reference_document_folio: null
          foreign_recipient_id: null
          foreign_recipient_nationality: null
          construction_sector_tax_credit: '0'
          tax_free_trade_zone_amount: null
          container_deposit_guarantee: 0
          is_free_of_charge: false
          periodic_billing_type: 0
          non_billable_amount: 0
          total_amount_for_period: 0
          domestic_transportation_amount: null
          international_transportation_amount: null
          branch_code: 76129014
          tax_exempt_amount: 0
          credit_or_debit_note_on_purchase: null
          additional_tax_code: null
          additional_tax_rate: null
          additional_tax_amount: 0
        purchase_invoice_details: null
        summary_invoice_details: null
    ResponseCustomerOfpiIndividualPaginated:
      summary: Individuo OFPI
      value:
        count: 110
        next: https://api.belvo.com/payments/{endpoint}/?page=2
        previous: null
        results:
          - id: 7c2be016-37e3-44e2-8643-db2eb1129a3f
            created_at: '2022-02-09T08:45:50.406032Z'
            created_by: 417514fe-50f6-42e9-a3eb-c71da00f014c
            customer_type: INDIVIDUAL
            name: Gustavo Veloso
            country: BRA
            email: gustavo.veloso@musicabrazil.br
            identifier: 23******00
            identifier_type: CPF
            address: Rua de Gustavo Veloso 432, 70200 Brasilia
            phone: 3210-9876
          - id: 7c2be016-37e3-44e2-8643-db2eb1129a3f
            created_at: '2022-02-09T08:45:50.406032Z'
            created_by: 417514fe-50f6-42e9-a3eb-c71da00f014c
            customer_type: INDIVIDUAL
            name: Gustavo Veloso
            country: BRA
            email: gustavo.veloso@musicabrazil.br
            identifier: 23******00
            identifier_type: CPF
            address: Rua de Gustavo Veloso 432, 70200 Brasilia
            phone: 3210-9876
    ResponseCustomerOfpiBusinessPaginated:
      summary: Negocio OFPI
      value:
        count: 110
        next: https://api.belvo.com/payments/{endpoint}/?page=2
        previous: null
        results:
          - id: 7c2be016-37e3-44e2-8643-db2eb1129a3f
            created_at: '2022-02-09T08:45:50.406032Z'
            created_by: 417514fe-50f6-42e9-a3eb-c71da00f014c
            customer_type: BUSINESS
            name: Music Production Brazil
            country: BRA
            email: finance@musicabrazil.br
            identifier: 00.000.000/0001-91
            identifier_type: CNPJ
            address: Rua de Gustavo Veloso 432, 70200 Brasilia
            phone: 3210-9876
          - id: 7c2be016-37e3-44e2-8643-db2eb1129a3f
            created_at: '2022-02-09T08:45:50.406032Z'
            created_by: 417514fe-50f6-42e9-a3eb-c71da00f014c
            customer_type: BUSINESS
            name: Music Production Brazil
            country: BRA
            email: finance@musicabrazil.br
            identifier: 00.000.000/0001-91
            identifier_type: CNPJ
            address: Rua de Gustavo Veloso 432, 70200 Brasilia
            phone: 3210-9876
    ResponseCustomerOfpiIndividual:
      summary: Individuo OFPI
      value:
        id: 7c2be016-37e3-44e2-8643-db2eb1129a3f
        created_at: '2022-02-09T08:45:50.406032Z'
        created_by: 417514fe-50f6-42e9-a3eb-c71da00f014c
        customer_type: INDIVIDUAL
        name: Gustavo Veloso
        country: BRA
        email: gustavo.veloso@musicabrazil.br
        identifier: 23******00
        identifier_type: CPF
        address: Rua de Gustavo Veloso 432, 70200 Brasilia
        phone: 3210-9876
    ResponseCustomerOfpiBusiness:
      summary: Negocio OFPI
      value:
        id: 7c2be016-37e3-44e2-8643-db2eb1129a3f
        created_at: '2022-02-09T08:45:50.406032Z'
        created_by: 417514fe-50f6-42e9-a3eb-c71da00f014c
        customer_type: BUSINESS
        name: Music Production Brazil
        country: BRA
        email: finance@musicabrazil.br
        identifier: 101*******4567
        identifier_type: CNPJ
        address: Rua de Gustavo Veloso 432, 70200 Brasilia
        phone: 3210-9876
    ResponseBankAccountBusinessPixInfoPaginated:
      summary: Cuenta bancaria empresarial (OFPI)
      value:
        count: 110
        next: https://api.belvo.com/payments/{endpoint}/?page=2
        previous: null
        results:
          - id: 90d90e38-0087-4b6d-b6dc-94ea561bb9cb
            created_at: '2023-02-15T07:52:31.998761Z'
            created_by: 417514fe-50f6-42e9-a3eb-c71da00f014c
            institution: f512d996-583a-4a91-8b5b-eba2e103b068
            customer: null
            holder:
              type: BUSINESS
              information:
                name: Music Production Brazil
                identifier_type: CNPJ
                identifier: 191
            details:
              country: BRA
              account_type: CHECKINGS
              agency: '0444'
              number: 45722-0
    ResponseBankAccountIndividualPixInfoPaginated:
      summary: Cuenta bancaria individual (OFPI)
      value:
        count: 110
        next: https://api.belvo.com/payments/{endpoint}/?page=2
        previous: null
        results:
          - id: 90d90e38-0087-4b6d-b6dc-94ea561bb9cb
            created_at: '2023-02-15T07:52:31.998761Z'
            created_by: 417514fe-50f6-42e9-a3eb-c71da00f014c
            institution: f512d996-583a-4a91-8b5b-eba2e103b068
            customer: 49f244ef-06cd-49cf-ad0c-f43796e370ad
            holder:
              type: INDIVIDUAL
              information:
                first_name: Gustavo
                last_name: Veloso
                identifier_type: CPF
                identifier: 23******00
            details:
              country: BRA
              account_type: CHECKINGS
              agency: '0444'
              number: 45722-0
    CreateBankAccountBusinessPixInfo:
      summary: Cuenta bancaria empresarial (OFPI)
      value:
        institution: f512d996-583a-4a91-8b5b-eba2e103b068
        external_id: c3c51aaf-aaa3-400c-926d-87ab62e195fd
        holder:
          type: BUSINESS
          information:
            name: Music Production Brazil
            identifier_type: CNPJ
            identifier: 191
        details:
          country: BRA
          account_type: CHECKINGS
          agency: '0444'
          number: 45722-0
    CreateBankAccountIndividualPixInfo:
      summary: Cuenta bancaria individual (OFPI)
      value:
        institution: f512d996-583a-4a91-8b5b-eba2e103b068
        external_id: c3c51aaf-aaa3-400c-926d-87ab62e195fd
        holder:
          type: INDIVIDUAL
          information:
            first_name: Gustavo
            last_name: Veloso
            identifier_type: CPF
            identifier: 191
        details:
          country: BRA
          account_type: CHECKINGS
          agency: '0111'
          number: 12344-0
    ResponseBankAccountBusinessPixInfo:
      summary: Cuenta bancaria empresarial (OFPI)
      value:
        id: 7c2be016-37e3-44e2-8643-db2eb1129a3f
        created_at: '2023-02-15T07:52:31.998761Z'
        created_by: 417514fe-50f6-42e9-a3eb-c71da00f014c
        institution: f512d996-583a-4a91-8b5b-eba2e103b068
        external_id: c3c51aaf-aaa3-400c-926d-87ab62e195fd
        customer: null
        holder:
          type: BUSINESS
          information:
            name: Music Production Brazil
            identifier_type: CNPJ
            identifier: 191
        details:
          country: BRA
          account_type: CHECKINGS
          agency: '0444'
          number: 45722-0
    ResponseBankAccountIndividualPixInfo:
      summary: Cuenta bancaria individual (OFPI)
      value:
        id: 7c2be016-37e3-44e2-8643-db2eb1129a3f
        created_at: '2023-02-15T07:52:31.998761Z'
        created_by: 417514fe-50f6-42e9-a3eb-c71da00f014c
        institution: f512d996-583a-4a91-8b5b-eba2e103b068
        external_id: c3c51aaf-aaa3-400c-926d-87ab62e195fd
        customer: 49f244ef-06cd-49cf-ad0c-f43796e370ad
        holder:
          type: INDIVIDUAL
          information:
            first_name: Gustavo
            last_name: Veloso
            identifier_type: CPF
            identifier: 23******00
        details:
          country: BRA
          account_type: CHECKINGS
          agency: '0444'
          number: 45722-0
x-tagGroups:
  - name: Core Resources
    tags:
      - Institutions
      - Links
      - Widget Access Token
      - Consents
  - name: Open Finance Data Aggregation (Brazil)
    tags:
      - Owners
      - Accounts
      - Balances
      - Transactions
      - Bills
      - Investments Brazil
      - Investment Transactions Brazil
  - name: Employments Brazil
    tags:
      - Employments Brazil
  - name: Employment Records Mexico
    tags:
      - Employment Records Mexico
      - Current Employments Mexico
  - name: Fiscal Mexico
    tags:
      - Invoices
      - Tax compliance status
      - Tax returns
      - Tax retentions
      - Tax status
      - Financial Statements
  - name: Fiscal Chile
    tags:
      - Invoices Chile
      - Tax Status Chile
      - Debt Reports Chile
  - name: Enrichment API
    tags:
      - Incomes
      - Recurring Expenses
      - Risk Insights
      - Employment Metrics
  - name: Payment Initiation (Brazil)
    tags:
      - Payment Initiation introduction (Brazil)
      - Payment Institutions (Brazil)
      - Customers (Brazil)
      - Bank Accounts (Brazil)
      - Payment Links (Brazil)
      - Payment Intents (Brazil)
      - Payment Authorizations (Brazil)
      - Biometric Pix Widget Access Token (Brazil)
      - Enrollments (Brazil)
      - Payment Transactions (Brazil)
x-readme:
  explorer-enabled: true
  proxy-enabled: true
  samples-enabled: true
  samples-languages:
    - curl
